Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type PipelineDeleteParams
- type PipelineGetParams
- type PipelineGetResponsedeprecated
- type PipelineGetResponseDestination
- type PipelineGetResponseDestinationBatch
- type PipelineGetResponseDestinationCompression
- type PipelineGetResponseDestinationCompressionType
- type PipelineGetResponseDestinationFormat
- type PipelineGetResponseDestinationPath
- type PipelineGetResponseDestinationType
- type PipelineGetResponseEnvelope
- type PipelineGetResponseSource
- type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineGetResponseSourceFormat
- type PipelineGetResponseSourceUnion
- type PipelineListParams
- type PipelineListResponse
- type PipelineListResponseResultdeprecated
- type PipelineListResponseResultInfo
- type PipelineListResponseResultsDestination
- type PipelineListResponseResultsDestinationBatch
- type PipelineListResponseResultsDestinationCompression
- type PipelineListResponseResultsDestinationCompressionType
- type PipelineListResponseResultsDestinationFormat
- type PipelineListResponseResultsDestinationPath
- type PipelineListResponseResultsDestinationType
- type PipelineListResponseResultsSource
- type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineListResponseResultsSourceFormat
- type PipelineListResponseResultsSourceUnion
- type PipelineNewParams
- type PipelineNewParamsDestination
- type PipelineNewParamsDestinationBatch
- type PipelineNewParamsDestinationCompression
- type PipelineNewParamsDestinationCompressionType
- type PipelineNewParamsDestinationCredentials
- type PipelineNewParamsDestinationFormat
- type PipelineNewParamsDestinationPath
- type PipelineNewParamsDestinationType
- type PipelineNewParamsSource
- type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineNewParamsSourceFormat
- type PipelineNewParamsSourceUnion
- type PipelineNewResponsedeprecated
- type PipelineNewResponseDestination
- type PipelineNewResponseDestinationBatch
- type PipelineNewResponseDestinationCompression
- type PipelineNewResponseDestinationCompressionType
- type PipelineNewResponseDestinationFormat
- type PipelineNewResponseDestinationPath
- type PipelineNewResponseDestinationType
- type PipelineNewResponseEnvelope
- type PipelineNewResponseSource
- type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineNewResponseSourceFormat
- type PipelineNewResponseSourceUnion
- type PipelineService
- func (r *PipelineService) Delete(ctx context.Context, pipelineName string, body PipelineDeleteParams, ...) (err error)deprecated
- func (r *PipelineService) Get(ctx context.Context, pipelineName string, query PipelineGetParams, ...) (res *PipelineGetResponse, err error)deprecated
- func (r *PipelineService) List(ctx context.Context, params PipelineListParams, opts ...option.RequestOption) (res *PipelineListResponse, err error)deprecated
- func (r *PipelineService) New(ctx context.Context, params PipelineNewParams, opts ...option.RequestOption) (res *PipelineNewResponse, err error)deprecated
- func (r *PipelineService) Update(ctx context.Context, pipelineName string, params PipelineUpdateParams, ...) (res *PipelineUpdateResponse, err error)deprecated
- type PipelineUpdateParams
- type PipelineUpdateParamsDestination
- type PipelineUpdateParamsDestinationBatch
- type PipelineUpdateParamsDestinationCompression
- type PipelineUpdateParamsDestinationCompressionType
- type PipelineUpdateParamsDestinationCredentials
- type PipelineUpdateParamsDestinationFormat
- type PipelineUpdateParamsDestinationPath
- type PipelineUpdateParamsDestinationType
- type PipelineUpdateParamsSource
- type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineUpdateParamsSourceFormat
- type PipelineUpdateParamsSourceUnion
- type PipelineUpdateResponsedeprecated
- type PipelineUpdateResponseDestination
- type PipelineUpdateResponseDestinationBatch
- type PipelineUpdateResponseDestinationCompression
- type PipelineUpdateResponseDestinationCompressionType
- type PipelineUpdateResponseDestinationFormat
- type PipelineUpdateResponseDestinationPath
- type PipelineUpdateResponseDestinationType
- type PipelineUpdateResponseEnvelope
- type PipelineUpdateResponseSource
- type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourcedeprecated
- type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat
- type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourcedeprecated
- type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS
- type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat
- type PipelineUpdateResponseSourceFormat
- type PipelineUpdateResponseSourceUnion
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type PipelineDeleteParams ¶
type PipelineGetParams ¶
type PipelineGetResponse
deprecated
type PipelineGetResponse struct {
// Specifies the pipeline identifier.
ID string `json:"id,required"`
Destination PipelineGetResponseDestination `json:"destination,required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint,required"`
// Defines the name of the pipeline.
Name string `json:"name,required"`
Source []PipelineGetResponseSource `json:"source,required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version,required"`
JSON pipelineGetResponseJSON `json:"-"`
}
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
Deprecated: deprecated
func (*PipelineGetResponse) UnmarshalJSON ¶
func (r *PipelineGetResponse) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseDestination ¶
type PipelineGetResponseDestination struct {
Batch PipelineGetResponseDestinationBatch `json:"batch,required"`
Compression PipelineGetResponseDestinationCompression `json:"compression,required"`
// Specifies the format of data to deliver.
Format PipelineGetResponseDestinationFormat `json:"format,required"`
Path PipelineGetResponseDestinationPath `json:"path,required"`
// Specifies the type of destination.
Type PipelineGetResponseDestinationType `json:"type,required"`
JSON pipelineGetResponseDestinationJSON `json:"-"`
}
func (*PipelineGetResponseDestination) UnmarshalJSON ¶
func (r *PipelineGetResponseDestination) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseDestinationBatch ¶
type PipelineGetResponseDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes int64 `json:"max_bytes,required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s,required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows,required"`
JSON pipelineGetResponseDestinationBatchJSON `json:"-"`
}
func (*PipelineGetResponseDestinationBatch) UnmarshalJSON ¶
func (r *PipelineGetResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseDestinationCompression ¶
type PipelineGetResponseDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type PipelineGetResponseDestinationCompressionType `json:"type,required"`
JSON pipelineGetResponseDestinationCompressionJSON `json:"-"`
}
func (*PipelineGetResponseDestinationCompression) UnmarshalJSON ¶
func (r *PipelineGetResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseDestinationCompressionType ¶
type PipelineGetResponseDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineGetResponseDestinationCompressionTypeNone PipelineGetResponseDestinationCompressionType = "none" PipelineGetResponseDestinationCompressionTypeGzip PipelineGetResponseDestinationCompressionType = "gzip" PipelineGetResponseDestinationCompressionTypeDeflate PipelineGetResponseDestinationCompressionType = "deflate" )
func (PipelineGetResponseDestinationCompressionType) IsKnown ¶
func (r PipelineGetResponseDestinationCompressionType) IsKnown() bool
type PipelineGetResponseDestinationFormat ¶
type PipelineGetResponseDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineGetResponseDestinationFormatJson PipelineGetResponseDestinationFormat = "json"
)
func (PipelineGetResponseDestinationFormat) IsKnown ¶
func (r PipelineGetResponseDestinationFormat) IsKnown() bool
type PipelineGetResponseDestinationPath ¶
type PipelineGetResponseDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket string `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename string `json:"filename"`
// Specifies the name pattern for directory.
Filepath string `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix string `json:"prefix"`
JSON pipelineGetResponseDestinationPathJSON `json:"-"`
}
func (*PipelineGetResponseDestinationPath) UnmarshalJSON ¶
func (r *PipelineGetResponseDestinationPath) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseDestinationType ¶
type PipelineGetResponseDestinationType string
Specifies the type of destination.
const (
PipelineGetResponseDestinationTypeR2 PipelineGetResponseDestinationType = "r2"
)
func (PipelineGetResponseDestinationType) IsKnown ¶
func (r PipelineGetResponseDestinationType) IsKnown() bool
type PipelineGetResponseEnvelope ¶
type PipelineGetResponseEnvelope struct {
// [DEPRECATED] Describes the configuration of a pipeline. Use the new
// streams/sinks/pipelines API instead.
//
// Deprecated: deprecated
Result PipelineGetResponse `json:"result,required"`
// Indicates whether the API call was successful.
Success bool `json:"success,required"`
JSON pipelineGetResponseEnvelopeJSON `json:"-"`
}
func (*PipelineGetResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseSource ¶
type PipelineGetResponseSource struct {
// Specifies the format of source data.
Format PipelineGetResponseSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
// This field can have the runtime type of
// [PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
CORS interface{} `json:"cors"`
JSON pipelineGetResponseSourceJSON `json:"-"`
// contains filtered or unexported fields
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineGetResponseSource) AsUnion ¶
func (r PipelineGetResponseSource) AsUnion() PipelineGetResponseSourceUnion
AsUnion returns a PipelineGetResponseSourceUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
func (*PipelineGetResponseSource) UnmarshalJSON ¶
func (r *PipelineGetResponseSource) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
Type string `json:"type,required"`
JSON pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON `json:"-"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON ¶
func (r *PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
CORS PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
JSON pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON ¶
func (r *PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins []string `json:"origins"`
JSON pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}
func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON ¶
func (r *PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON(data []byte) (err error)
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
func (PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown ¶
func (r PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown() bool
type PipelineGetResponseSourceFormat ¶
type PipelineGetResponseSourceFormat string
Specifies the format of source data.
const (
PipelineGetResponseSourceFormatJson PipelineGetResponseSourceFormat = "json"
)
func (PipelineGetResponseSourceFormat) IsKnown ¶
func (r PipelineGetResponseSourceFormat) IsKnown() bool
type PipelineGetResponseSourceUnion ¶
type PipelineGetResponseSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Union satisfied by PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource or PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
type PipelineListParams ¶
type PipelineListParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id,required"`
// Specifies which page to retrieve.
Page param.Field[string] `query:"page"`
// Specifies the number of pipelines per page.
PerPage param.Field[string] `query:"per_page"`
// Specifies the prefix of pipeline name to search.
Search param.Field[string] `query:"search"`
}
func (PipelineListParams) URLQuery ¶
func (r PipelineListParams) URLQuery() (v url.Values)
URLQuery serializes PipelineListParams's query parameters as `url.Values`.
type PipelineListResponse ¶
type PipelineListResponse struct {
ResultInfo PipelineListResponseResultInfo `json:"result_info,required"`
Results []PipelineListResponseResult `json:"results,required"`
// Indicates whether the API call was successful.
Success bool `json:"success,required"`
JSON pipelineListResponseJSON `json:"-"`
}
func (*PipelineListResponse) UnmarshalJSON ¶
func (r *PipelineListResponse) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResult
deprecated
type PipelineListResponseResult struct {
// Specifies the pipeline identifier.
ID string `json:"id,required"`
Destination PipelineListResponseResultsDestination `json:"destination,required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint,required"`
// Defines the name of the pipeline.
Name string `json:"name,required"`
Source []PipelineListResponseResultsSource `json:"source,required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version,required"`
JSON pipelineListResponseResultJSON `json:"-"`
}
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
Deprecated: deprecated
func (*PipelineListResponseResult) UnmarshalJSON ¶
func (r *PipelineListResponseResult) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultInfo ¶
type PipelineListResponseResultInfo struct {
// Indicates the number of items on current page.
Count float64 `json:"count,required"`
// Indicates the current page number.
Page float64 `json:"page,required"`
// Indicates the number of items per page.
PerPage float64 `json:"per_page,required"`
// Indicates the total number of items.
TotalCount float64 `json:"total_count,required"`
JSON pipelineListResponseResultInfoJSON `json:"-"`
}
func (*PipelineListResponseResultInfo) UnmarshalJSON ¶
func (r *PipelineListResponseResultInfo) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestination ¶
type PipelineListResponseResultsDestination struct {
Batch PipelineListResponseResultsDestinationBatch `json:"batch,required"`
Compression PipelineListResponseResultsDestinationCompression `json:"compression,required"`
// Specifies the format of data to deliver.
Format PipelineListResponseResultsDestinationFormat `json:"format,required"`
Path PipelineListResponseResultsDestinationPath `json:"path,required"`
// Specifies the type of destination.
Type PipelineListResponseResultsDestinationType `json:"type,required"`
JSON pipelineListResponseResultsDestinationJSON `json:"-"`
}
func (*PipelineListResponseResultsDestination) UnmarshalJSON ¶
func (r *PipelineListResponseResultsDestination) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestinationBatch ¶
type PipelineListResponseResultsDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes int64 `json:"max_bytes,required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s,required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows,required"`
JSON pipelineListResponseResultsDestinationBatchJSON `json:"-"`
}
func (*PipelineListResponseResultsDestinationBatch) UnmarshalJSON ¶
func (r *PipelineListResponseResultsDestinationBatch) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestinationCompression ¶
type PipelineListResponseResultsDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type PipelineListResponseResultsDestinationCompressionType `json:"type,required"`
JSON pipelineListResponseResultsDestinationCompressionJSON `json:"-"`
}
func (*PipelineListResponseResultsDestinationCompression) UnmarshalJSON ¶
func (r *PipelineListResponseResultsDestinationCompression) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestinationCompressionType ¶
type PipelineListResponseResultsDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineListResponseResultsDestinationCompressionTypeNone PipelineListResponseResultsDestinationCompressionType = "none" PipelineListResponseResultsDestinationCompressionTypeGzip PipelineListResponseResultsDestinationCompressionType = "gzip" PipelineListResponseResultsDestinationCompressionTypeDeflate PipelineListResponseResultsDestinationCompressionType = "deflate" )
func (PipelineListResponseResultsDestinationCompressionType) IsKnown ¶
func (r PipelineListResponseResultsDestinationCompressionType) IsKnown() bool
type PipelineListResponseResultsDestinationFormat ¶
type PipelineListResponseResultsDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineListResponseResultsDestinationFormatJson PipelineListResponseResultsDestinationFormat = "json"
)
func (PipelineListResponseResultsDestinationFormat) IsKnown ¶
func (r PipelineListResponseResultsDestinationFormat) IsKnown() bool
type PipelineListResponseResultsDestinationPath ¶
type PipelineListResponseResultsDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket string `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename string `json:"filename"`
// Specifies the name pattern for directory.
Filepath string `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix string `json:"prefix"`
JSON pipelineListResponseResultsDestinationPathJSON `json:"-"`
}
func (*PipelineListResponseResultsDestinationPath) UnmarshalJSON ¶
func (r *PipelineListResponseResultsDestinationPath) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestinationType ¶
type PipelineListResponseResultsDestinationType string
Specifies the type of destination.
const (
PipelineListResponseResultsDestinationTypeR2 PipelineListResponseResultsDestinationType = "r2"
)
func (PipelineListResponseResultsDestinationType) IsKnown ¶
func (r PipelineListResponseResultsDestinationType) IsKnown() bool
type PipelineListResponseResultsSource ¶
type PipelineListResponseResultsSource struct {
// Specifies the format of source data.
Format PipelineListResponseResultsSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
// This field can have the runtime type of
// [PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
CORS interface{} `json:"cors"`
JSON pipelineListResponseResultsSourceJSON `json:"-"`
// contains filtered or unexported fields
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineListResponseResultsSource) AsUnion ¶
func (r PipelineListResponseResultsSource) AsUnion() PipelineListResponseResultsSourceUnion
AsUnion returns a PipelineListResponseResultsSourceUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource.
func (*PipelineListResponseResultsSource) UnmarshalJSON ¶
func (r *PipelineListResponseResultsSource) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
Type string `json:"type,required"`
JSON pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON `json:"-"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON ¶
func (r *PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
CORS PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
JSON pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON ¶
func (r *PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins []string `json:"origins"`
JSON pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}
func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON ¶
func (r *PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
type PipelineListResponseResultsSourceFormat ¶
type PipelineListResponseResultsSourceFormat string
Specifies the format of source data.
const (
PipelineListResponseResultsSourceFormatJson PipelineListResponseResultsSourceFormat = "json"
)
func (PipelineListResponseResultsSourceFormat) IsKnown ¶
func (r PipelineListResponseResultsSourceFormat) IsKnown() bool
type PipelineListResponseResultsSourceUnion ¶
type PipelineListResponseResultsSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Union satisfied by PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource or PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource.
type PipelineNewParams ¶
type PipelineNewParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id,required"`
Destination param.Field[PipelineNewParamsDestination] `json:"destination,required"`
// Defines the name of the pipeline.
Name param.Field[string] `json:"name,required"`
Source param.Field[[]PipelineNewParamsSourceUnion] `json:"source,required"`
}
func (PipelineNewParams) MarshalJSON ¶
func (r PipelineNewParams) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestination ¶
type PipelineNewParamsDestination struct {
Batch param.Field[PipelineNewParamsDestinationBatch] `json:"batch,required"`
Compression param.Field[PipelineNewParamsDestinationCompression] `json:"compression,required"`
Credentials param.Field[PipelineNewParamsDestinationCredentials] `json:"credentials,required"`
// Specifies the format of data to deliver.
Format param.Field[PipelineNewParamsDestinationFormat] `json:"format,required"`
Path param.Field[PipelineNewParamsDestinationPath] `json:"path,required"`
// Specifies the type of destination.
Type param.Field[PipelineNewParamsDestinationType] `json:"type,required"`
}
func (PipelineNewParamsDestination) MarshalJSON ¶
func (r PipelineNewParamsDestination) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestinationBatch ¶
type PipelineNewParamsDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes param.Field[int64] `json:"max_bytes"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS param.Field[float64] `json:"max_duration_s"`
// Specifies rough maximum number of rows per file.
MaxRows param.Field[int64] `json:"max_rows"`
}
func (PipelineNewParamsDestinationBatch) MarshalJSON ¶
func (r PipelineNewParamsDestinationBatch) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestinationCompression ¶
type PipelineNewParamsDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type param.Field[PipelineNewParamsDestinationCompressionType] `json:"type"`
}
func (PipelineNewParamsDestinationCompression) MarshalJSON ¶
func (r PipelineNewParamsDestinationCompression) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestinationCompressionType ¶
type PipelineNewParamsDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineNewParamsDestinationCompressionTypeNone PipelineNewParamsDestinationCompressionType = "none" PipelineNewParamsDestinationCompressionTypeGzip PipelineNewParamsDestinationCompressionType = "gzip" PipelineNewParamsDestinationCompressionTypeDeflate PipelineNewParamsDestinationCompressionType = "deflate" )
func (PipelineNewParamsDestinationCompressionType) IsKnown ¶
func (r PipelineNewParamsDestinationCompressionType) IsKnown() bool
type PipelineNewParamsDestinationCredentials ¶
type PipelineNewParamsDestinationCredentials struct {
// Specifies the R2 Bucket Access Key Id.
AccessKeyID param.Field[string] `json:"access_key_id,required"`
// Specifies the R2 Endpoint.
Endpoint param.Field[string] `json:"endpoint,required"`
// Specifies the R2 Bucket Secret Access Key.
SecretAccessKey param.Field[string] `json:"secret_access_key,required"`
}
func (PipelineNewParamsDestinationCredentials) MarshalJSON ¶
func (r PipelineNewParamsDestinationCredentials) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestinationFormat ¶
type PipelineNewParamsDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineNewParamsDestinationFormatJson PipelineNewParamsDestinationFormat = "json"
)
func (PipelineNewParamsDestinationFormat) IsKnown ¶
func (r PipelineNewParamsDestinationFormat) IsKnown() bool
type PipelineNewParamsDestinationPath ¶
type PipelineNewParamsDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket param.Field[string] `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename param.Field[string] `json:"filename"`
// Specifies the name pattern for directory.
Filepath param.Field[string] `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix param.Field[string] `json:"prefix"`
}
func (PipelineNewParamsDestinationPath) MarshalJSON ¶
func (r PipelineNewParamsDestinationPath) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestinationType ¶
type PipelineNewParamsDestinationType string
Specifies the type of destination.
const (
PipelineNewParamsDestinationTypeR2 PipelineNewParamsDestinationType = "r2"
)
func (PipelineNewParamsDestinationType) IsKnown ¶
func (r PipelineNewParamsDestinationType) IsKnown() bool
type PipelineNewParamsSource ¶
type PipelineNewParamsSource struct {
// Specifies the format of source data.
Format param.Field[PipelineNewParamsSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication param.Field[bool] `json:"authentication"`
CORS param.Field[interface{}] `json:"cors"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineNewParamsSource) MarshalJSON ¶
func (r PipelineNewParamsSource) MarshalJSON() (data []byte, err error)
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON ¶
func (r PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON() (data []byte, err error)
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication param.Field[bool] `json:"authentication"`
CORS param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] `json:"cors"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON ¶
func (r PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON() (data []byte, err error)
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins param.Field[[]string] `json:"origins"`
}
func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON ¶
func (r PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON() (data []byte, err error)
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown ¶
func (r PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown() bool
type PipelineNewParamsSourceFormat ¶
type PipelineNewParamsSourceFormat string
Specifies the format of source data.
const (
PipelineNewParamsSourceFormatJson PipelineNewParamsSourceFormat = "json"
)
func (PipelineNewParamsSourceFormat) IsKnown ¶
func (r PipelineNewParamsSourceFormat) IsKnown() bool
type PipelineNewParamsSourceUnion ¶
type PipelineNewParamsSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Satisfied by pipelines.PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, pipelines.PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource, PipelineNewParamsSource.
type PipelineNewResponse
deprecated
type PipelineNewResponse struct {
// Specifies the pipeline identifier.
ID string `json:"id,required"`
Destination PipelineNewResponseDestination `json:"destination,required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint,required"`
// Defines the name of the pipeline.
Name string `json:"name,required"`
Source []PipelineNewResponseSource `json:"source,required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version,required"`
JSON pipelineNewResponseJSON `json:"-"`
}
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
Deprecated: deprecated
func (*PipelineNewResponse) UnmarshalJSON ¶
func (r *PipelineNewResponse) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseDestination ¶
type PipelineNewResponseDestination struct {
Batch PipelineNewResponseDestinationBatch `json:"batch,required"`
Compression PipelineNewResponseDestinationCompression `json:"compression,required"`
// Specifies the format of data to deliver.
Format PipelineNewResponseDestinationFormat `json:"format,required"`
Path PipelineNewResponseDestinationPath `json:"path,required"`
// Specifies the type of destination.
Type PipelineNewResponseDestinationType `json:"type,required"`
JSON pipelineNewResponseDestinationJSON `json:"-"`
}
func (*PipelineNewResponseDestination) UnmarshalJSON ¶
func (r *PipelineNewResponseDestination) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseDestinationBatch ¶
type PipelineNewResponseDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes int64 `json:"max_bytes,required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s,required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows,required"`
JSON pipelineNewResponseDestinationBatchJSON `json:"-"`
}
func (*PipelineNewResponseDestinationBatch) UnmarshalJSON ¶
func (r *PipelineNewResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseDestinationCompression ¶
type PipelineNewResponseDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type PipelineNewResponseDestinationCompressionType `json:"type,required"`
JSON pipelineNewResponseDestinationCompressionJSON `json:"-"`
}
func (*PipelineNewResponseDestinationCompression) UnmarshalJSON ¶
func (r *PipelineNewResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseDestinationCompressionType ¶
type PipelineNewResponseDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineNewResponseDestinationCompressionTypeNone PipelineNewResponseDestinationCompressionType = "none" PipelineNewResponseDestinationCompressionTypeGzip PipelineNewResponseDestinationCompressionType = "gzip" PipelineNewResponseDestinationCompressionTypeDeflate PipelineNewResponseDestinationCompressionType = "deflate" )
func (PipelineNewResponseDestinationCompressionType) IsKnown ¶
func (r PipelineNewResponseDestinationCompressionType) IsKnown() bool
type PipelineNewResponseDestinationFormat ¶
type PipelineNewResponseDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineNewResponseDestinationFormatJson PipelineNewResponseDestinationFormat = "json"
)
func (PipelineNewResponseDestinationFormat) IsKnown ¶
func (r PipelineNewResponseDestinationFormat) IsKnown() bool
type PipelineNewResponseDestinationPath ¶
type PipelineNewResponseDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket string `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename string `json:"filename"`
// Specifies the name pattern for directory.
Filepath string `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix string `json:"prefix"`
JSON pipelineNewResponseDestinationPathJSON `json:"-"`
}
func (*PipelineNewResponseDestinationPath) UnmarshalJSON ¶
func (r *PipelineNewResponseDestinationPath) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseDestinationType ¶
type PipelineNewResponseDestinationType string
Specifies the type of destination.
const (
PipelineNewResponseDestinationTypeR2 PipelineNewResponseDestinationType = "r2"
)
func (PipelineNewResponseDestinationType) IsKnown ¶
func (r PipelineNewResponseDestinationType) IsKnown() bool
type PipelineNewResponseEnvelope ¶
type PipelineNewResponseEnvelope struct {
// [DEPRECATED] Describes the configuration of a pipeline. Use the new
// streams/sinks/pipelines API instead.
//
// Deprecated: deprecated
Result PipelineNewResponse `json:"result,required"`
// Indicates whether the API call was successful.
Success bool `json:"success,required"`
JSON pipelineNewResponseEnvelopeJSON `json:"-"`
}
func (*PipelineNewResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseSource ¶
type PipelineNewResponseSource struct {
// Specifies the format of source data.
Format PipelineNewResponseSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
// This field can have the runtime type of
// [PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
CORS interface{} `json:"cors"`
JSON pipelineNewResponseSourceJSON `json:"-"`
// contains filtered or unexported fields
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineNewResponseSource) AsUnion ¶
func (r PipelineNewResponseSource) AsUnion() PipelineNewResponseSourceUnion
AsUnion returns a PipelineNewResponseSourceUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
func (*PipelineNewResponseSource) UnmarshalJSON ¶
func (r *PipelineNewResponseSource) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
Type string `json:"type,required"`
JSON pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON `json:"-"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON ¶
func (r *PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
CORS PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
JSON pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON ¶
func (r *PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins []string `json:"origins"`
JSON pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}
func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON ¶
func (r *PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON(data []byte) (err error)
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
func (PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown ¶
func (r PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown() bool
type PipelineNewResponseSourceFormat ¶
type PipelineNewResponseSourceFormat string
Specifies the format of source data.
const (
PipelineNewResponseSourceFormatJson PipelineNewResponseSourceFormat = "json"
)
func (PipelineNewResponseSourceFormat) IsKnown ¶
func (r PipelineNewResponseSourceFormat) IsKnown() bool
type PipelineNewResponseSourceUnion ¶
type PipelineNewResponseSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Union satisfied by PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource or PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
type PipelineService ¶
type PipelineService struct {
Options []option.RequestOption
}
PipelineService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPipelineService method instead.
func NewPipelineService ¶
func NewPipelineService(opts ...option.RequestOption) (r *PipelineService)
NewPipelineService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*PipelineService) Delete
deprecated
func (r *PipelineService) Delete(ctx context.Context, pipelineName string, body PipelineDeleteParams, opts ...option.RequestOption) (err error)
[DEPRECATED] Delete a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
Deprecated: deprecated
func (*PipelineService) Get
deprecated
func (r *PipelineService) Get(ctx context.Context, pipelineName string, query PipelineGetParams, opts ...option.RequestOption) (res *PipelineGetResponse, err error)
[DEPRECATED] Get configuration of a pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
Deprecated: deprecated
func (*PipelineService) List
deprecated
func (r *PipelineService) List(ctx context.Context, params PipelineListParams, opts ...option.RequestOption) (res *PipelineListResponse, err error)
[DEPRECATED] List, filter, and paginate pipelines in an account. Use the new /pipelines/v1/pipelines endpoint instead.
Deprecated: deprecated
func (*PipelineService) New
deprecated
func (r *PipelineService) New(ctx context.Context, params PipelineNewParams, opts ...option.RequestOption) (res *PipelineNewResponse, err error)
[DEPRECATED] Create a new pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
Deprecated: deprecated
func (*PipelineService) Update
deprecated
func (r *PipelineService) Update(ctx context.Context, pipelineName string, params PipelineUpdateParams, opts ...option.RequestOption) (res *PipelineUpdateResponse, err error)
[DEPRECATED] Update an existing pipeline. Use the new /pipelines/v1/pipelines endpoint instead.
Deprecated: deprecated
type PipelineUpdateParams ¶
type PipelineUpdateParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id,required"`
Destination param.Field[PipelineUpdateParamsDestination] `json:"destination,required"`
// Defines the name of the pipeline.
Name param.Field[string] `json:"name,required"`
Source param.Field[[]PipelineUpdateParamsSourceUnion] `json:"source,required"`
}
func (PipelineUpdateParams) MarshalJSON ¶
func (r PipelineUpdateParams) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestination ¶
type PipelineUpdateParamsDestination struct {
Batch param.Field[PipelineUpdateParamsDestinationBatch] `json:"batch,required"`
Compression param.Field[PipelineUpdateParamsDestinationCompression] `json:"compression,required"`
// Specifies the format of data to deliver.
Format param.Field[PipelineUpdateParamsDestinationFormat] `json:"format,required"`
Path param.Field[PipelineUpdateParamsDestinationPath] `json:"path,required"`
// Specifies the type of destination.
Type param.Field[PipelineUpdateParamsDestinationType] `json:"type,required"`
Credentials param.Field[PipelineUpdateParamsDestinationCredentials] `json:"credentials"`
}
func (PipelineUpdateParamsDestination) MarshalJSON ¶
func (r PipelineUpdateParamsDestination) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestinationBatch ¶
type PipelineUpdateParamsDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes param.Field[int64] `json:"max_bytes"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS param.Field[float64] `json:"max_duration_s"`
// Specifies rough maximum number of rows per file.
MaxRows param.Field[int64] `json:"max_rows"`
}
func (PipelineUpdateParamsDestinationBatch) MarshalJSON ¶
func (r PipelineUpdateParamsDestinationBatch) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestinationCompression ¶
type PipelineUpdateParamsDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type param.Field[PipelineUpdateParamsDestinationCompressionType] `json:"type"`
}
func (PipelineUpdateParamsDestinationCompression) MarshalJSON ¶
func (r PipelineUpdateParamsDestinationCompression) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestinationCompressionType ¶
type PipelineUpdateParamsDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineUpdateParamsDestinationCompressionTypeNone PipelineUpdateParamsDestinationCompressionType = "none" PipelineUpdateParamsDestinationCompressionTypeGzip PipelineUpdateParamsDestinationCompressionType = "gzip" PipelineUpdateParamsDestinationCompressionTypeDeflate PipelineUpdateParamsDestinationCompressionType = "deflate" )
func (PipelineUpdateParamsDestinationCompressionType) IsKnown ¶
func (r PipelineUpdateParamsDestinationCompressionType) IsKnown() bool
type PipelineUpdateParamsDestinationCredentials ¶
type PipelineUpdateParamsDestinationCredentials struct {
// Specifies the R2 Bucket Access Key Id.
AccessKeyID param.Field[string] `json:"access_key_id,required"`
// Specifies the R2 Endpoint.
Endpoint param.Field[string] `json:"endpoint,required"`
// Specifies the R2 Bucket Secret Access Key.
SecretAccessKey param.Field[string] `json:"secret_access_key,required"`
}
func (PipelineUpdateParamsDestinationCredentials) MarshalJSON ¶
func (r PipelineUpdateParamsDestinationCredentials) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestinationFormat ¶
type PipelineUpdateParamsDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineUpdateParamsDestinationFormatJson PipelineUpdateParamsDestinationFormat = "json"
)
func (PipelineUpdateParamsDestinationFormat) IsKnown ¶
func (r PipelineUpdateParamsDestinationFormat) IsKnown() bool
type PipelineUpdateParamsDestinationPath ¶
type PipelineUpdateParamsDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket param.Field[string] `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename param.Field[string] `json:"filename"`
// Specifies the name pattern for directory.
Filepath param.Field[string] `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix param.Field[string] `json:"prefix"`
}
func (PipelineUpdateParamsDestinationPath) MarshalJSON ¶
func (r PipelineUpdateParamsDestinationPath) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestinationType ¶
type PipelineUpdateParamsDestinationType string
Specifies the type of destination.
const (
PipelineUpdateParamsDestinationTypeR2 PipelineUpdateParamsDestinationType = "r2"
)
func (PipelineUpdateParamsDestinationType) IsKnown ¶
func (r PipelineUpdateParamsDestinationType) IsKnown() bool
type PipelineUpdateParamsSource ¶
type PipelineUpdateParamsSource struct {
// Specifies the format of source data.
Format param.Field[PipelineUpdateParamsSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication param.Field[bool] `json:"authentication"`
CORS param.Field[interface{}] `json:"cors"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineUpdateParamsSource) MarshalJSON ¶
func (r PipelineUpdateParamsSource) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON ¶
func (r PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat] `json:"format,required"`
Type param.Field[string] `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication param.Field[bool] `json:"authentication"`
CORS param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] `json:"cors"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON ¶
func (r PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins param.Field[[]string] `json:"origins"`
}
func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON ¶
func (r PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
type PipelineUpdateParamsSourceFormat ¶
type PipelineUpdateParamsSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateParamsSourceFormatJson PipelineUpdateParamsSourceFormat = "json"
)
func (PipelineUpdateParamsSourceFormat) IsKnown ¶
func (r PipelineUpdateParamsSourceFormat) IsKnown() bool
type PipelineUpdateParamsSourceUnion ¶
type PipelineUpdateParamsSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Satisfied by pipelines.PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, pipelines.PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource, PipelineUpdateParamsSource.
type PipelineUpdateResponse
deprecated
type PipelineUpdateResponse struct {
// Specifies the pipeline identifier.
ID string `json:"id,required"`
Destination PipelineUpdateResponseDestination `json:"destination,required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint,required"`
// Defines the name of the pipeline.
Name string `json:"name,required"`
Source []PipelineUpdateResponseSource `json:"source,required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version,required"`
JSON pipelineUpdateResponseJSON `json:"-"`
}
[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.
Deprecated: deprecated
func (*PipelineUpdateResponse) UnmarshalJSON ¶
func (r *PipelineUpdateResponse) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseDestination ¶
type PipelineUpdateResponseDestination struct {
Batch PipelineUpdateResponseDestinationBatch `json:"batch,required"`
Compression PipelineUpdateResponseDestinationCompression `json:"compression,required"`
// Specifies the format of data to deliver.
Format PipelineUpdateResponseDestinationFormat `json:"format,required"`
Path PipelineUpdateResponseDestinationPath `json:"path,required"`
// Specifies the type of destination.
Type PipelineUpdateResponseDestinationType `json:"type,required"`
JSON pipelineUpdateResponseDestinationJSON `json:"-"`
}
func (*PipelineUpdateResponseDestination) UnmarshalJSON ¶
func (r *PipelineUpdateResponseDestination) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseDestinationBatch ¶
type PipelineUpdateResponseDestinationBatch struct {
// Specifies rough maximum size of files.
MaxBytes int64 `json:"max_bytes,required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s,required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows,required"`
JSON pipelineUpdateResponseDestinationBatchJSON `json:"-"`
}
func (*PipelineUpdateResponseDestinationBatch) UnmarshalJSON ¶
func (r *PipelineUpdateResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseDestinationCompression ¶
type PipelineUpdateResponseDestinationCompression struct {
// Specifies the desired compression algorithm and format.
Type PipelineUpdateResponseDestinationCompressionType `json:"type,required"`
JSON pipelineUpdateResponseDestinationCompressionJSON `json:"-"`
}
func (*PipelineUpdateResponseDestinationCompression) UnmarshalJSON ¶
func (r *PipelineUpdateResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseDestinationCompressionType ¶
type PipelineUpdateResponseDestinationCompressionType string
Specifies the desired compression algorithm and format.
const ( PipelineUpdateResponseDestinationCompressionTypeNone PipelineUpdateResponseDestinationCompressionType = "none" PipelineUpdateResponseDestinationCompressionTypeGzip PipelineUpdateResponseDestinationCompressionType = "gzip" PipelineUpdateResponseDestinationCompressionTypeDeflate PipelineUpdateResponseDestinationCompressionType = "deflate" )
func (PipelineUpdateResponseDestinationCompressionType) IsKnown ¶
func (r PipelineUpdateResponseDestinationCompressionType) IsKnown() bool
type PipelineUpdateResponseDestinationFormat ¶
type PipelineUpdateResponseDestinationFormat string
Specifies the format of data to deliver.
const (
PipelineUpdateResponseDestinationFormatJson PipelineUpdateResponseDestinationFormat = "json"
)
func (PipelineUpdateResponseDestinationFormat) IsKnown ¶
func (r PipelineUpdateResponseDestinationFormat) IsKnown() bool
type PipelineUpdateResponseDestinationPath ¶
type PipelineUpdateResponseDestinationPath struct {
// Specifies the R2 Bucket to store files.
Bucket string `json:"bucket,required"`
// Specifies the name pattern to for individual data files.
Filename string `json:"filename"`
// Specifies the name pattern for directory.
Filepath string `json:"filepath"`
// Specifies the base directory within the bucket.
Prefix string `json:"prefix"`
JSON pipelineUpdateResponseDestinationPathJSON `json:"-"`
}
func (*PipelineUpdateResponseDestinationPath) UnmarshalJSON ¶
func (r *PipelineUpdateResponseDestinationPath) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseDestinationType ¶
type PipelineUpdateResponseDestinationType string
Specifies the type of destination.
const (
PipelineUpdateResponseDestinationTypeR2 PipelineUpdateResponseDestinationType = "r2"
)
func (PipelineUpdateResponseDestinationType) IsKnown ¶
func (r PipelineUpdateResponseDestinationType) IsKnown() bool
type PipelineUpdateResponseEnvelope ¶
type PipelineUpdateResponseEnvelope struct {
// [DEPRECATED] Describes the configuration of a pipeline. Use the new
// streams/sinks/pipelines API instead.
//
// Deprecated: deprecated
Result PipelineUpdateResponse `json:"result,required"`
// Indicates whether the API call was successful.
Success bool `json:"success,required"`
JSON pipelineUpdateResponseEnvelopeJSON `json:"-"`
}
func (*PipelineUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseSource ¶
type PipelineUpdateResponseSource struct {
// Specifies the format of source data.
Format PipelineUpdateResponseSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
// This field can have the runtime type of
// [PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
CORS interface{} `json:"cors"`
JSON pipelineUpdateResponseSourceJSON `json:"-"`
// contains filtered or unexported fields
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
func (PipelineUpdateResponseSource) AsUnion ¶
func (r PipelineUpdateResponseSource) AsUnion() PipelineUpdateResponseSourceUnion
AsUnion returns a PipelineUpdateResponseSourceUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
func (*PipelineUpdateResponseSource) UnmarshalJSON ¶
func (r *PipelineUpdateResponseSource) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource
deprecated
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
// Specifies the format of source data.
Format PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
Type string `json:"type,required"`
JSON pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON `json:"-"`
}
[DEPRECATED] Worker binding source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON ¶
func (r *PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat ¶
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource
deprecated
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
// Specifies the format of source data.
Format PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
Type string `json:"type,required"`
// Specifies whether authentication is required to send to this pipeline via HTTP.
Authentication bool `json:"authentication"`
CORS PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
JSON pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Deprecated: deprecated
func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON ¶
func (r *PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS ¶
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
// Specifies allowed origins to allow Cross Origin HTTP Requests.
Origins []string `json:"origins"`
JSON pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}
func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON ¶
func (r *PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON(data []byte) (err error)
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat ¶
type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)
type PipelineUpdateResponseSourceFormat ¶
type PipelineUpdateResponseSourceFormat string
Specifies the format of source data.
const (
PipelineUpdateResponseSourceFormatJson PipelineUpdateResponseSourceFormat = "json"
)
func (PipelineUpdateResponseSourceFormat) IsKnown ¶
func (r PipelineUpdateResponseSourceFormat) IsKnown() bool
type PipelineUpdateResponseSourceUnion ¶
type PipelineUpdateResponseSourceUnion interface {
// contains filtered or unexported methods
}
[DEPRECATED] HTTP source configuration. Use the new streams API instead.
Union satisfied by PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource or PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.
type RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.