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 ListField
- type ListFieldParam
- 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 PipelineDeleteV1Params
- type PipelineDeleteV1Response
- type PipelineDeleteV1ResponseEnvelope
- 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 PipelineGetV1Params
- type PipelineGetV1Response
- type PipelineGetV1ResponseEnvelope
- type PipelineGetV1ResponseTable
- type PipelineGetV1ResponseTablesType
- 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 PipelineListV1Params
- type PipelineListV1Response
- 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 PipelineNewV1Params
- type PipelineNewV1Response
- type PipelineNewV1ResponseEnvelope
- type PipelineService
- func (r *PipelineService) Delete(ctx context.Context, pipelineName string, body PipelineDeleteParams, ...) (err error)deprecated
- func (r *PipelineService) DeleteV1(ctx context.Context, pipelineID string, body PipelineDeleteV1Params, ...) (res *PipelineDeleteV1Response, err error)
- func (r *PipelineService) Get(ctx context.Context, pipelineName string, query PipelineGetParams, ...) (res *PipelineGetResponse, err error)deprecated
- func (r *PipelineService) GetV1(ctx context.Context, pipelineID string, query PipelineGetV1Params, ...) (res *PipelineGetV1Response, err error)
- func (r *PipelineService) List(ctx context.Context, params PipelineListParams, opts ...option.RequestOption) (res *PipelineListResponse, err error)deprecated
- func (r *PipelineService) ListV1(ctx context.Context, params PipelineListV1Params, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[PipelineListV1Response], err error)
- func (r *PipelineService) ListV1AutoPaging(ctx context.Context, params PipelineListV1Params, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[PipelineListV1Response]
- func (r *PipelineService) New(ctx context.Context, params PipelineNewParams, opts ...option.RequestOption) (res *PipelineNewResponse, err error)deprecated
- func (r *PipelineService) NewV1(ctx context.Context, params PipelineNewV1Params, opts ...option.RequestOption) (res *PipelineNewV1Response, err error)
- func (r *PipelineService) Update(ctx context.Context, pipelineName string, params PipelineUpdateParams, ...) (res *PipelineUpdateResponse, err error)deprecated
- func (r *PipelineService) ValidateSql(ctx context.Context, params PipelineValidateSqlParams, ...) (res *PipelineValidateSqlResponse, err error)
- 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 PipelineValidateSqlParams
- type PipelineValidateSqlResponse
- type PipelineValidateSqlResponseEnvelope
- type PipelineValidateSqlResponseGraph
- type PipelineValidateSqlResponseGraphEdge
- type PipelineValidateSqlResponseGraphNode
- type PipelineValidateSqlResponseTable
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SinkDeleteParams
- type SinkDeleteResponse
- type SinkDeleteResponseEnvelope
- type SinkGetParams
- type SinkGetResponse
- type SinkGetResponseConfig
- type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic
- type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy
- type SinkGetResponseConfigCloudflarePipelinesR2TablePublic
- type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming
- type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy
- type SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning
- type SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy
- type SinkGetResponseConfigUnion
- type SinkGetResponseEnvelope
- type SinkGetResponseFormat
- type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat
- type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression
- type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding
- type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat
- type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType
- type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat
- type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression
- type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType
- type SinkGetResponseFormatCompression
- type SinkGetResponseFormatDecimalEncoding
- type SinkGetResponseFormatTimestampFormat
- type SinkGetResponseFormatType
- type SinkGetResponseFormatUnion
- type SinkGetResponseSchema
- type SinkGetResponseType
- type SinkListParams
- type SinkListResponse
- type SinkListResponseConfig
- type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic
- type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy
- type SinkListResponseConfigCloudflarePipelinesR2TablePublic
- type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming
- type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy
- type SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning
- type SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy
- type SinkListResponseConfigUnion
- type SinkListResponseFormat
- type SinkListResponseFormatCloudflarePipelinesSinkJsonFormat
- type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression
- type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding
- type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat
- type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType
- type SinkListResponseFormatCloudflarePipelinesSinkParquetFormat
- type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression
- type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType
- type SinkListResponseFormatCompression
- type SinkListResponseFormatDecimalEncoding
- type SinkListResponseFormatTimestampFormat
- type SinkListResponseFormatType
- type SinkListResponseFormatUnion
- type SinkListResponseSchema
- type SinkListResponseType
- type SinkNewParams
- type SinkNewParamsConfig
- type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable
- type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy
- type SinkNewParamsConfigCloudflarePipelinesR2Table
- type SinkNewParamsConfigCloudflarePipelinesR2TableCredentials
- type SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming
- type SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy
- type SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning
- type SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy
- type SinkNewParamsConfigUnion
- type SinkNewParamsFormat
- type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat
- type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression
- type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding
- type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat
- type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType
- type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat
- type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression
- type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType
- type SinkNewParamsFormatCompression
- type SinkNewParamsFormatDecimalEncoding
- type SinkNewParamsFormatTimestampFormat
- type SinkNewParamsFormatType
- type SinkNewParamsFormatUnion
- type SinkNewParamsSchema
- type SinkNewParamsType
- type SinkNewResponse
- type SinkNewResponseConfig
- type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable
- type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy
- type SinkNewResponseConfigCloudflarePipelinesR2Table
- type SinkNewResponseConfigCloudflarePipelinesR2TableCredentials
- type SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming
- type SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy
- type SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning
- type SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy
- type SinkNewResponseConfigUnion
- type SinkNewResponseEnvelope
- type SinkNewResponseFormat
- type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat
- type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression
- type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding
- type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat
- type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType
- type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat
- type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression
- type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType
- type SinkNewResponseFormatCompression
- type SinkNewResponseFormatDecimalEncoding
- type SinkNewResponseFormatTimestampFormat
- type SinkNewResponseFormatType
- type SinkNewResponseFormatUnion
- type SinkNewResponseSchema
- type SinkNewResponseType
- type SinkService
- func (r *SinkService) Delete(ctx context.Context, sinkID string, body SinkDeleteParams, ...) (res *SinkDeleteResponse, err error)
- func (r *SinkService) Get(ctx context.Context, sinkID string, query SinkGetParams, ...) (res *SinkGetResponse, err error)
- func (r *SinkService) List(ctx context.Context, params SinkListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SinkListResponse], err error)
- func (r *SinkService) ListAutoPaging(ctx context.Context, params SinkListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SinkListResponse]
- func (r *SinkService) New(ctx context.Context, params SinkNewParams, opts ...option.RequestOption) (res *SinkNewResponse, err error)
- type SortDirection
- type SourceField
- type SourceFieldBinary
- type SourceFieldBinaryParam
- type SourceFieldBinaryType
- type SourceFieldBool
- type SourceFieldBoolParam
- type SourceFieldBoolType
- type SourceFieldFloat32
- type SourceFieldFloat32Param
- type SourceFieldFloat32Type
- type SourceFieldFloat64
- type SourceFieldFloat64Param
- type SourceFieldFloat64Type
- type SourceFieldInt32
- type SourceFieldInt32Param
- type SourceFieldInt32Type
- type SourceFieldInt64
- type SourceFieldInt64Param
- type SourceFieldInt64Type
- type SourceFieldJson
- type SourceFieldJsonParam
- type SourceFieldJsonType
- type SourceFieldList
- type SourceFieldListParam
- type SourceFieldListType
- type SourceFieldParam
- type SourceFieldString
- type SourceFieldStringParam
- type SourceFieldStringType
- type SourceFieldStruct
- type SourceFieldStructParam
- type SourceFieldStructType
- type SourceFieldTimestamp
- type SourceFieldTimestampParam
- type SourceFieldTimestampType
- type SourceFieldTimestampUnit
- type SourceFieldType
- type SourceFieldUnion
- type SourceFieldUnionParam
- type SourceFieldUnit
- type StreamDeleteParams
- type StreamDeleteResponse
- type StreamDeleteResponseEnvelope
- type StreamGetParams
- type StreamGetResponse
- type StreamGetResponseEnvelope
- type StreamGetResponseFormat
- type StreamGetResponseFormatCompression
- type StreamGetResponseFormatDecimalEncoding
- type StreamGetResponseFormatJson
- type StreamGetResponseFormatJsonDecimalEncoding
- type StreamGetResponseFormatJsonTimestampFormat
- type StreamGetResponseFormatJsonType
- type StreamGetResponseFormatParquet
- type StreamGetResponseFormatParquetCompression
- type StreamGetResponseFormatParquetType
- type StreamGetResponseFormatTimestampFormat
- type StreamGetResponseFormatType
- type StreamGetResponseFormatUnion
- type StreamGetResponseHTTP
- type StreamGetResponseHTTPCORS
- type StreamGetResponseSchema
- type StreamGetResponseWorkerBinding
- type StreamListParams
- type StreamListResponse
- type StreamListResponseFormat
- type StreamListResponseFormatCompression
- type StreamListResponseFormatDecimalEncoding
- type StreamListResponseFormatJson
- type StreamListResponseFormatJsonDecimalEncoding
- type StreamListResponseFormatJsonTimestampFormat
- type StreamListResponseFormatJsonType
- type StreamListResponseFormatParquet
- type StreamListResponseFormatParquetCompression
- type StreamListResponseFormatParquetType
- type StreamListResponseFormatTimestampFormat
- type StreamListResponseFormatType
- type StreamListResponseFormatUnion
- type StreamListResponseHTTP
- type StreamListResponseHTTPCORS
- type StreamListResponseSchema
- type StreamListResponseWorkerBinding
- type StreamNewParams
- type StreamNewParamsFormat
- type StreamNewParamsFormatCompression
- type StreamNewParamsFormatDecimalEncoding
- type StreamNewParamsFormatJson
- type StreamNewParamsFormatJsonDecimalEncoding
- type StreamNewParamsFormatJsonTimestampFormat
- type StreamNewParamsFormatJsonType
- type StreamNewParamsFormatParquet
- type StreamNewParamsFormatParquetCompression
- type StreamNewParamsFormatParquetType
- type StreamNewParamsFormatTimestampFormat
- type StreamNewParamsFormatType
- type StreamNewParamsFormatUnion
- type StreamNewParamsHTTP
- type StreamNewParamsHTTPCORS
- type StreamNewParamsSchema
- type StreamNewParamsWorkerBinding
- type StreamNewResponse
- type StreamNewResponseEnvelope
- type StreamNewResponseFormat
- type StreamNewResponseFormatCompression
- type StreamNewResponseFormatDecimalEncoding
- type StreamNewResponseFormatJson
- type StreamNewResponseFormatJsonDecimalEncoding
- type StreamNewResponseFormatJsonTimestampFormat
- type StreamNewResponseFormatJsonType
- type StreamNewResponseFormatParquet
- type StreamNewResponseFormatParquetCompression
- type StreamNewResponseFormatParquetType
- type StreamNewResponseFormatTimestampFormat
- type StreamNewResponseFormatType
- type StreamNewResponseFormatUnion
- type StreamNewResponseHTTP
- type StreamNewResponseHTTPCORS
- type StreamNewResponseSchema
- type StreamNewResponseWorkerBinding
- type StreamService
- func (r *StreamService) Delete(ctx context.Context, streamID string, body StreamDeleteParams, ...) (res *StreamDeleteResponse, err error)
- func (r *StreamService) Get(ctx context.Context, streamID string, query StreamGetParams, ...) (res *StreamGetResponse, err error)
- func (r *StreamService) List(ctx context.Context, params StreamListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[StreamListResponse], err error)
- func (r *StreamService) ListAutoPaging(ctx context.Context, params StreamListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[StreamListResponse]
- func (r *StreamService) New(ctx context.Context, params StreamNewParams, opts ...option.RequestOption) (res *StreamNewResponse, err error)
- func (r *StreamService) Update(ctx context.Context, streamID string, params StreamUpdateParams, ...) (res *StreamUpdateResponse, err error)
- type StreamUpdateParams
- type StreamUpdateParamsHTTP
- type StreamUpdateParamsHTTPCORS
- type StreamUpdateParamsWorkerBinding
- type StreamUpdateResponse
- type StreamUpdateResponseEnvelope
- type StreamUpdateResponseFormat
- type StreamUpdateResponseFormatCompression
- type StreamUpdateResponseFormatDecimalEncoding
- type StreamUpdateResponseFormatJson
- type StreamUpdateResponseFormatJsonDecimalEncoding
- type StreamUpdateResponseFormatJsonTimestampFormat
- type StreamUpdateResponseFormatJsonType
- type StreamUpdateResponseFormatParquet
- type StreamUpdateResponseFormatParquetCompression
- type StreamUpdateResponseFormatParquetType
- type StreamUpdateResponseFormatTimestampFormat
- type StreamUpdateResponseFormatType
- type StreamUpdateResponseFormatUnion
- type StreamUpdateResponseHTTP
- type StreamUpdateResponseHTTPCORS
- type StreamUpdateResponseSchema
- type StreamUpdateResponseWorkerBinding
- type StructField
- type StructFieldParam
- 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 ListField ¶
type ListField struct {
Items SourceField `json:"items" api:"required"`
JSON listFieldJSON `json:"-"`
}
func (*ListField) UnmarshalJSON ¶
type ListFieldParam ¶
type ListFieldParam struct {
Items param.Field[SourceFieldUnionParam] `json:"items" api:"required"`
}
func (ListFieldParam) MarshalJSON ¶
func (r ListFieldParam) MarshalJSON() (data []byte, err error)
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 PipelineDeleteV1Params ¶
type PipelineDeleteV1Response ¶
type PipelineDeleteV1Response = interface{}
type PipelineDeleteV1ResponseEnvelope ¶
type PipelineDeleteV1ResponseEnvelope struct {
Result PipelineDeleteV1Response `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON pipelineDeleteV1ResponseEnvelopeJSON `json:"-"`
}
func (*PipelineDeleteV1ResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineDeleteV1ResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineGetParams ¶
type PipelineGetResponse
deprecated
type PipelineGetResponse struct {
// Specifies the pipeline identifier.
ID string `json:"id" api:"required"`
Destination PipelineGetResponseDestination `json:"destination" api:"required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint" api:"required"`
// Defines the name of the pipeline.
Name string `json:"name" api:"required"`
Source []PipelineGetResponseSource `json:"source" api:"required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version" api:"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" api:"required"`
Compression PipelineGetResponseDestinationCompression `json:"compression" api:"required"`
// Specifies the format of data to deliver.
Format PipelineGetResponseDestinationFormat `json:"format" api:"required"`
Path PipelineGetResponseDestinationPath `json:"path" api:"required"`
// Specifies the type of destination.
Type PipelineGetResponseDestinationType `json:"type" api:"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" api:"required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s" api:"required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows" api:"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" api:"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" api:"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" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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 PipelineGetV1Params ¶
type PipelineGetV1Response ¶
type PipelineGetV1Response struct {
// Indicates a unique identifier for this pipeline.
ID string `json:"id" api:"required"`
CreatedAt string `json:"created_at" api:"required"`
ModifiedAt string `json:"modified_at" api:"required"`
// Indicates the name of the Pipeline.
Name string `json:"name" api:"required"`
// Specifies SQL for the Pipeline processing flow.
Sql string `json:"sql" api:"required"`
// Indicates the current status of the Pipeline.
Status string `json:"status" api:"required"`
// List of streams and sinks used by this pipeline.
Tables []PipelineGetV1ResponseTable `json:"tables" api:"required"`
// Indicates the reason for the failure of the Pipeline.
FailureReason string `json:"failure_reason"`
JSON pipelineGetV1ResponseJSON `json:"-"`
}
func (*PipelineGetV1Response) UnmarshalJSON ¶
func (r *PipelineGetV1Response) UnmarshalJSON(data []byte) (err error)
type PipelineGetV1ResponseEnvelope ¶
type PipelineGetV1ResponseEnvelope struct {
Result PipelineGetV1Response `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON pipelineGetV1ResponseEnvelopeJSON `json:"-"`
}
func (*PipelineGetV1ResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineGetV1ResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineGetV1ResponseTable ¶
type PipelineGetV1ResponseTable struct {
// Unique identifier for the connection (stream or sink).
ID string `json:"id" api:"required"`
// Latest available version of the connection.
Latest int64 `json:"latest" api:"required"`
// Name of the connection.
Name string `json:"name" api:"required"`
// Type of the connection.
Type PipelineGetV1ResponseTablesType `json:"type" api:"required"`
// Current version of the connection used by this pipeline.
Version int64 `json:"version" api:"required"`
JSON pipelineGetV1ResponseTableJSON `json:"-"`
}
func (*PipelineGetV1ResponseTable) UnmarshalJSON ¶
func (r *PipelineGetV1ResponseTable) UnmarshalJSON(data []byte) (err error)
type PipelineGetV1ResponseTablesType ¶
type PipelineGetV1ResponseTablesType string
Type of the connection.
const ( PipelineGetV1ResponseTablesTypeStream PipelineGetV1ResponseTablesType = "stream" PipelineGetV1ResponseTablesTypeSink PipelineGetV1ResponseTablesType = "sink" )
func (PipelineGetV1ResponseTablesType) IsKnown ¶
func (r PipelineGetV1ResponseTablesType) IsKnown() bool
type PipelineListParams ¶
type PipelineListParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"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" api:"required"`
Results []PipelineListResponseResult `json:"results" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"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" api:"required"`
Destination PipelineListResponseResultsDestination `json:"destination" api:"required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint" api:"required"`
// Defines the name of the pipeline.
Name string `json:"name" api:"required"`
Source []PipelineListResponseResultsSource `json:"source" api:"required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version" api:"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" api:"required"`
// Indicates the current page number.
Page float64 `json:"page" api:"required"`
// Indicates the number of items per page.
PerPage float64 `json:"per_page" api:"required"`
// Indicates the total number of items.
TotalCount float64 `json:"total_count" api:"required"`
JSON pipelineListResponseResultInfoJSON `json:"-"`
}
func (*PipelineListResponseResultInfo) UnmarshalJSON ¶
func (r *PipelineListResponseResultInfo) UnmarshalJSON(data []byte) (err error)
type PipelineListResponseResultsDestination ¶
type PipelineListResponseResultsDestination struct {
Batch PipelineListResponseResultsDestinationBatch `json:"batch" api:"required"`
Compression PipelineListResponseResultsDestinationCompression `json:"compression" api:"required"`
// Specifies the format of data to deliver.
Format PipelineListResponseResultsDestinationFormat `json:"format" api:"required"`
Path PipelineListResponseResultsDestinationPath `json:"path" api:"required"`
// Specifies the type of destination.
Type PipelineListResponseResultsDestinationType `json:"type" api:"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" api:"required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s" api:"required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows" api:"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" api:"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" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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 PipelineListV1Params ¶
type PipelineListV1Params struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
Page param.Field[float64] `query:"page"`
PerPage param.Field[float64] `query:"per_page"`
}
func (PipelineListV1Params) URLQuery ¶
func (r PipelineListV1Params) URLQuery() (v url.Values)
URLQuery serializes PipelineListV1Params's query parameters as `url.Values`.
type PipelineListV1Response ¶
type PipelineListV1Response struct {
// Indicates a unique identifier for this pipeline.
ID string `json:"id" api:"required"`
CreatedAt string `json:"created_at" api:"required"`
ModifiedAt string `json:"modified_at" api:"required"`
// Indicates the name of the Pipeline.
Name string `json:"name" api:"required"`
// Specifies SQL for the Pipeline processing flow.
Sql string `json:"sql" api:"required"`
// Indicates the current status of the Pipeline.
Status string `json:"status" api:"required"`
JSON pipelineListV1ResponseJSON `json:"-"`
}
func (*PipelineListV1Response) UnmarshalJSON ¶
func (r *PipelineListV1Response) UnmarshalJSON(data []byte) (err error)
type PipelineNewParams ¶
type PipelineNewParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
Destination param.Field[PipelineNewParamsDestination] `json:"destination" api:"required"`
// Defines the name of the pipeline.
Name param.Field[string] `json:"name" api:"required"`
Source param.Field[[]PipelineNewParamsSourceUnion] `json:"source" api:"required"`
}
func (PipelineNewParams) MarshalJSON ¶
func (r PipelineNewParams) MarshalJSON() (data []byte, err error)
type PipelineNewParamsDestination ¶
type PipelineNewParamsDestination struct {
Batch param.Field[PipelineNewParamsDestinationBatch] `json:"batch" api:"required"`
Compression param.Field[PipelineNewParamsDestinationCompression] `json:"compression" api:"required"`
Credentials param.Field[PipelineNewParamsDestinationCredentials] `json:"credentials" api:"required"`
// Specifies the format of data to deliver.
Format param.Field[PipelineNewParamsDestinationFormat] `json:"format" api:"required"`
Path param.Field[PipelineNewParamsDestinationPath] `json:"path" api:"required"`
// Specifies the type of destination.
Type param.Field[PipelineNewParamsDestinationType] `json:"type" api:"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" api:"required"`
// Specifies the R2 Endpoint.
Endpoint param.Field[string] `json:"endpoint" api:"required"`
// Specifies the R2 Bucket Secret Access Key.
SecretAccessKey param.Field[string] `json:"secret_access_key" api:"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" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Destination PipelineNewResponseDestination `json:"destination" api:"required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint" api:"required"`
// Defines the name of the pipeline.
Name string `json:"name" api:"required"`
Source []PipelineNewResponseSource `json:"source" api:"required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version" api:"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" api:"required"`
Compression PipelineNewResponseDestinationCompression `json:"compression" api:"required"`
// Specifies the format of data to deliver.
Format PipelineNewResponseDestinationFormat `json:"format" api:"required"`
Path PipelineNewResponseDestinationPath `json:"path" api:"required"`
// Specifies the type of destination.
Type PipelineNewResponseDestinationType `json:"type" api:"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" api:"required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s" api:"required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows" api:"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" api:"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" api:"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" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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 PipelineNewV1Params ¶
type PipelineNewV1Params struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Specifies the name of the Pipeline.
Name param.Field[string] `json:"name" api:"required"`
// Specifies SQL for the Pipeline processing flow.
Sql param.Field[string] `json:"sql" api:"required"`
}
func (PipelineNewV1Params) MarshalJSON ¶
func (r PipelineNewV1Params) MarshalJSON() (data []byte, err error)
type PipelineNewV1Response ¶
type PipelineNewV1Response struct {
// Indicates a unique identifier for this pipeline.
ID string `json:"id" api:"required"`
CreatedAt string `json:"created_at" api:"required"`
ModifiedAt string `json:"modified_at" api:"required"`
// Indicates the name of the Pipeline.
Name string `json:"name" api:"required"`
// Specifies SQL for the Pipeline processing flow.
Sql string `json:"sql" api:"required"`
// Indicates the current status of the Pipeline.
Status string `json:"status" api:"required"`
JSON pipelineNewV1ResponseJSON `json:"-"`
}
func (*PipelineNewV1Response) UnmarshalJSON ¶
func (r *PipelineNewV1Response) UnmarshalJSON(data []byte) (err error)
type PipelineNewV1ResponseEnvelope ¶
type PipelineNewV1ResponseEnvelope struct {
Result PipelineNewV1Response `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON pipelineNewV1ResponseEnvelopeJSON `json:"-"`
}
func (*PipelineNewV1ResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineNewV1ResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineService ¶
type PipelineService struct {
Options []option.RequestOption
Sinks *SinkService
Streams *StreamService
}
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: Use delete_v1 instead. This endpoint will be removed in the future.
func (*PipelineService) DeleteV1 ¶
func (r *PipelineService) DeleteV1(ctx context.Context, pipelineID string, body PipelineDeleteV1Params, opts ...option.RequestOption) (res *PipelineDeleteV1Response, err error)
Delete Pipeline in Account.
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: Use get_v1 instead. This endpoint will be removed in the future.
func (*PipelineService) GetV1 ¶
func (r *PipelineService) GetV1(ctx context.Context, pipelineID string, query PipelineGetV1Params, opts ...option.RequestOption) (res *PipelineGetV1Response, err error)
Get Pipeline details.
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: Use list_v1 instead. This endpoint will be removed in the future.
func (*PipelineService) ListV1 ¶
func (r *PipelineService) ListV1(ctx context.Context, params PipelineListV1Params, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[PipelineListV1Response], err error)
List/Filter Pipelines in Account.
func (*PipelineService) ListV1AutoPaging ¶
func (r *PipelineService) ListV1AutoPaging(ctx context.Context, params PipelineListV1Params, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[PipelineListV1Response]
List/Filter Pipelines in Account.
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: Use create_v1 instead. This endpoint will be removed in the future.
func (*PipelineService) NewV1 ¶
func (r *PipelineService) NewV1(ctx context.Context, params PipelineNewV1Params, opts ...option.RequestOption) (res *PipelineNewV1Response, err error)
Create a new Pipeline.
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: The v1 API does not support updates. This endpoint will be removed in the future.
func (*PipelineService) ValidateSql ¶
func (r *PipelineService) ValidateSql(ctx context.Context, params PipelineValidateSqlParams, opts ...option.RequestOption) (res *PipelineValidateSqlResponse, err error)
Validates that the Pipelines SQL is correct.
type PipelineUpdateParams ¶
type PipelineUpdateParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
Destination param.Field[PipelineUpdateParamsDestination] `json:"destination" api:"required"`
// Defines the name of the pipeline.
Name param.Field[string] `json:"name" api:"required"`
Source param.Field[[]PipelineUpdateParamsSourceUnion] `json:"source" api:"required"`
}
func (PipelineUpdateParams) MarshalJSON ¶
func (r PipelineUpdateParams) MarshalJSON() (data []byte, err error)
type PipelineUpdateParamsDestination ¶
type PipelineUpdateParamsDestination struct {
Batch param.Field[PipelineUpdateParamsDestinationBatch] `json:"batch" api:"required"`
Compression param.Field[PipelineUpdateParamsDestinationCompression] `json:"compression" api:"required"`
// Specifies the format of data to deliver.
Format param.Field[PipelineUpdateParamsDestinationFormat] `json:"format" api:"required"`
Path param.Field[PipelineUpdateParamsDestinationPath] `json:"path" api:"required"`
// Specifies the type of destination.
Type param.Field[PipelineUpdateParamsDestinationType] `json:"type" api:"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" api:"required"`
// Specifies the R2 Endpoint.
Endpoint param.Field[string] `json:"endpoint" api:"required"`
// Specifies the R2 Bucket Secret Access Key.
SecretAccessKey param.Field[string] `json:"secret_access_key" api:"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" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Type param.Field[string] `json:"type" api:"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" api:"required"`
Destination PipelineUpdateResponseDestination `json:"destination" api:"required"`
// Indicates the endpoint URL to send traffic.
Endpoint string `json:"endpoint" api:"required"`
// Defines the name of the pipeline.
Name string `json:"name" api:"required"`
Source []PipelineUpdateResponseSource `json:"source" api:"required"`
// Indicates the version number of last saved configuration.
Version float64 `json:"version" api:"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" api:"required"`
Compression PipelineUpdateResponseDestinationCompression `json:"compression" api:"required"`
// Specifies the format of data to deliver.
Format PipelineUpdateResponseDestinationFormat `json:"format" api:"required"`
Path PipelineUpdateResponseDestinationPath `json:"path" api:"required"`
// Specifies the type of destination.
Type PipelineUpdateResponseDestinationType `json:"type" api:"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" api:"required"`
// Specifies duration to wait to aggregate batches files.
MaxDurationS float64 `json:"max_duration_s" api:"required"`
// Specifies rough maximum number of rows per file.
MaxRows int64 `json:"max_rows" api:"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" api:"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" api:"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" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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" api:"required"`
Type string `json:"type" api:"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 PipelineValidateSqlParams ¶
type PipelineValidateSqlParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Specifies SQL to validate.
Sql param.Field[string] `json:"sql" api:"required"`
}
func (PipelineValidateSqlParams) MarshalJSON ¶
func (r PipelineValidateSqlParams) MarshalJSON() (data []byte, err error)
type PipelineValidateSqlResponse ¶
type PipelineValidateSqlResponse struct {
// Indicates tables involved in the processing.
Tables map[string]PipelineValidateSqlResponseTable `json:"tables" api:"required"`
// Indicates the processing flow to implement the SQL.
Graph PipelineValidateSqlResponseGraph `json:"graph"`
JSON pipelineValidateSqlResponseJSON `json:"-"`
}
func (*PipelineValidateSqlResponse) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponse) UnmarshalJSON(data []byte) (err error)
type PipelineValidateSqlResponseEnvelope ¶
type PipelineValidateSqlResponseEnvelope struct {
Result PipelineValidateSqlResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON pipelineValidateSqlResponseEnvelopeJSON `json:"-"`
}
func (*PipelineValidateSqlResponseEnvelope) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type PipelineValidateSqlResponseGraph ¶
type PipelineValidateSqlResponseGraph struct {
Edges []PipelineValidateSqlResponseGraphEdge `json:"edges" api:"required"`
Nodes []PipelineValidateSqlResponseGraphNode `json:"nodes" api:"required"`
JSON pipelineValidateSqlResponseGraphJSON `json:"-"`
}
Indicates the processing flow to implement the SQL.
func (*PipelineValidateSqlResponseGraph) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponseGraph) UnmarshalJSON(data []byte) (err error)
type PipelineValidateSqlResponseGraphEdge ¶
type PipelineValidateSqlResponseGraphEdge struct {
DestID int64 `json:"dest_id" api:"required"`
EdgeType string `json:"edge_type" api:"required"`
KeyType string `json:"key_type" api:"required"`
SrcID int64 `json:"src_id" api:"required"`
ValueType string `json:"value_type" api:"required"`
JSON pipelineValidateSqlResponseGraphEdgeJSON `json:"-"`
}
func (*PipelineValidateSqlResponseGraphEdge) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponseGraphEdge) UnmarshalJSON(data []byte) (err error)
type PipelineValidateSqlResponseGraphNode ¶
type PipelineValidateSqlResponseGraphNode struct {
Description string `json:"description" api:"required"`
NodeID int64 `json:"node_id" api:"required"`
Operator string `json:"operator" api:"required"`
Parallelism int64 `json:"parallelism" api:"required"`
JSON pipelineValidateSqlResponseGraphNodeJSON `json:"-"`
}
func (*PipelineValidateSqlResponseGraphNode) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponseGraphNode) UnmarshalJSON(data []byte) (err error)
type PipelineValidateSqlResponseTable ¶
type PipelineValidateSqlResponseTable struct {
ID string `json:"id" api:"required"`
Name string `json:"name" api:"required"`
Type string `json:"type" api:"required"`
Version float64 `json:"version" api:"required"`
JSON pipelineValidateSqlResponseTableJSON `json:"-"`
}
func (*PipelineValidateSqlResponseTable) UnmarshalJSON ¶
func (r *PipelineValidateSqlResponseTable) UnmarshalJSON(data []byte) (err error)
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 SinkDeleteParams ¶
type SinkDeleteResponse ¶
type SinkDeleteResponse = interface{}
type SinkDeleteResponseEnvelope ¶
type SinkDeleteResponseEnvelope struct {
Result SinkDeleteResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON sinkDeleteResponseEnvelopeJSON `json:"-"`
}
func (*SinkDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SinkDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SinkGetParams ¶
type SinkGetResponse ¶
type SinkGetResponse struct {
// Indicates a unique identifier for this sink.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Defines the name of the Sink.
Name string `json:"name" api:"required"`
// Specifies the type of sink.
Type SinkGetResponseType `json:"type" api:"required"`
// Defines the configuration of the R2 Sink.
Config SinkGetResponseConfig `json:"config"`
// Defines the output data format of a sink.
Format SinkGetResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema SinkGetResponseSchema `json:"schema"`
JSON sinkGetResponseJSON `json:"-"`
}
func (*SinkGetResponse) UnmarshalJSON ¶
func (r *SinkGetResponse) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfig ¶
type SinkGetResponseConfig struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
// This field can have the runtime type of
// [SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming].
FileNaming interface{} `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Table namespace
Namespace string `json:"namespace"`
// This field can have the runtime type of
// [SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning].
Partitioning interface{} `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// This field can have the runtime type of
// [SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy],
// [SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy].
RollingPolicy interface{} `json:"rolling_policy"`
// Table name
TableName string `json:"table_name"`
JSON sinkGetResponseConfigJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the configuration of the R2 Sink.
func (SinkGetResponseConfig) AsUnion ¶
func (r SinkGetResponseConfig) AsUnion() SinkGetResponseConfigUnion
AsUnion returns a SinkGetResponseConfigUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkGetResponseConfigCloudflarePipelinesR2TablePublic, SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic.
func (*SinkGetResponseConfig) UnmarshalJSON ¶
func (r *SinkGetResponseConfig) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic ¶
type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic struct {
// Cloudflare Account ID
AccountID string `json:"account_id" api:"required" format:"uri"`
// The R2 Bucket that hosts this catalog
Bucket string `json:"bucket" api:"required"`
// Table name
TableName string `json:"table_name" api:"required"`
// Table namespace
Namespace string `json:"namespace"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy `json:"rolling_policy"`
JSON sinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicJSON `json:"-"`
}
R2 Data Catalog Sink public configuration.
func (*SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy ¶
type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2TablePublic ¶
type SinkGetResponseConfigCloudflarePipelinesR2TablePublic struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
// Controls filename prefix/suffix and strategy.
FileNaming SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Data-layout partitioning for sinks.
Partitioning SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy `json:"rolling_policy"`
JSON sinkGetResponseConfigCloudflarePipelinesR2TablePublicJSON `json:"-"`
}
R2 Sink public configuration.
func (*SinkGetResponseConfigCloudflarePipelinesR2TablePublic) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2TablePublic) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming ¶
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming struct {
// The prefix to use in file name. i.e prefix-<uuid>.parquet
Prefix string `json:"prefix"`
// Filename generation strategy.
Strategy SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy `json:"strategy"`
// This will overwrite the default file suffix. i.e .parquet, use with caution
Suffix string `json:"suffix"`
JSON sinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingJSON `json:"-"`
}
Controls filename prefix/suffix and strategy.
func (*SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNaming) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy ¶
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy string
Filename generation strategy.
const ( SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategySerial SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "serial" SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUID SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid" SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUIDV7 SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid_v7" SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUlid SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "ulid" )
func (SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy) IsKnown ¶
func (r SinkGetResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy) IsKnown() bool
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning ¶
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning struct {
// The pattern of the date string
TimePattern string `json:"time_pattern"`
JSON sinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioningJSON `json:"-"`
}
Data-layout partitioning for sinks.
func (*SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2TablePublicPartitioning) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy ¶
type SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy) UnmarshalJSON ¶
func (r *SinkGetResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseConfigUnion ¶
type SinkGetResponseConfigUnion interface {
// contains filtered or unexported methods
}
Defines the configuration of the R2 Sink.
Union satisfied by SinkGetResponseConfigCloudflarePipelinesR2TablePublic or SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTablePublic.
type SinkGetResponseEnvelope ¶
type SinkGetResponseEnvelope struct {
Result SinkGetResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON sinkGetResponseEnvelopeJSON `json:"-"`
}
func (*SinkGetResponseEnvelope) UnmarshalJSON ¶
func (r *SinkGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseFormat ¶
type SinkGetResponseFormat struct {
Type SinkGetResponseFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkGetResponseFormatCompression `json:"compression"`
DecimalEncoding SinkGetResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat SinkGetResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkGetResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the output data format of a sink.
func (SinkGetResponseFormat) AsUnion ¶
func (r SinkGetResponseFormat) AsUnion() SinkGetResponseFormatUnion
AsUnion returns a SinkGetResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat, SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat.
func (*SinkGetResponseFormat) UnmarshalJSON ¶
func (r *SinkGetResponseFormat) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat struct {
Type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression `json:"compression"`
DecimalEncoding SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding `json:"decimal_encoding"`
TimestampFormat SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkGetResponseFormatCloudflarePipelinesSinkJsonFormatJSON `json:"-"`
}
func (*SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" )
func (SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown() bool
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding string
const ( SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" )
func (SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown() bool
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat string
const ( SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix_millis" )
func (SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown() bool
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType string
const (
SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatTypeJson SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType = "json"
)
func (SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown() bool
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat struct {
Type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType `json:"type" api:"required"`
Compression SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON sinkGetResponseFormatCloudflarePipelinesSinkParquetFormatJSON `json:"-"`
}
func (*SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression string
const ( SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" )
func (SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown() bool
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType ¶ added in v7.10.0
type SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType string
const (
SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatTypeParquet SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType = "parquet"
)
func (SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown ¶ added in v7.10.0
func (r SinkGetResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown() bool
type SinkGetResponseFormatCompression ¶
type SinkGetResponseFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkGetResponseFormatCompressionUncompressed SinkGetResponseFormatCompression = "uncompressed" SinkGetResponseFormatCompressionGzip SinkGetResponseFormatCompression = "gzip" SinkGetResponseFormatCompressionSnappy SinkGetResponseFormatCompression = "snappy" SinkGetResponseFormatCompressionZstd SinkGetResponseFormatCompression = "zstd" SinkGetResponseFormatCompressionLz4 SinkGetResponseFormatCompression = "lz4" )
func (SinkGetResponseFormatCompression) IsKnown ¶
func (r SinkGetResponseFormatCompression) IsKnown() bool
type SinkGetResponseFormatDecimalEncoding ¶
type SinkGetResponseFormatDecimalEncoding string
const ( SinkGetResponseFormatDecimalEncodingNumber SinkGetResponseFormatDecimalEncoding = "number" SinkGetResponseFormatDecimalEncodingString SinkGetResponseFormatDecimalEncoding = "string" SinkGetResponseFormatDecimalEncodingBytes SinkGetResponseFormatDecimalEncoding = "bytes" )
func (SinkGetResponseFormatDecimalEncoding) IsKnown ¶
func (r SinkGetResponseFormatDecimalEncoding) IsKnown() bool
type SinkGetResponseFormatTimestampFormat ¶
type SinkGetResponseFormatTimestampFormat string
const ( SinkGetResponseFormatTimestampFormatRfc3339 SinkGetResponseFormatTimestampFormat = "rfc3339" SinkGetResponseFormatTimestampFormatUnixMillis SinkGetResponseFormatTimestampFormat = "unix_millis" )
func (SinkGetResponseFormatTimestampFormat) IsKnown ¶
func (r SinkGetResponseFormatTimestampFormat) IsKnown() bool
type SinkGetResponseFormatType ¶
type SinkGetResponseFormatType string
const ( SinkGetResponseFormatTypeJson SinkGetResponseFormatType = "json" SinkGetResponseFormatTypeParquet SinkGetResponseFormatType = "parquet" )
func (SinkGetResponseFormatType) IsKnown ¶
func (r SinkGetResponseFormatType) IsKnown() bool
type SinkGetResponseFormatUnion ¶
type SinkGetResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the output data format of a sink.
Union satisfied by SinkGetResponseFormatCloudflarePipelinesSinkJsonFormat or SinkGetResponseFormatCloudflarePipelinesSinkParquetFormat.
type SinkGetResponseSchema ¶
type SinkGetResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON sinkGetResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*SinkGetResponseSchema) UnmarshalJSON ¶
func (r *SinkGetResponseSchema) UnmarshalJSON(data []byte) (err error)
type SinkGetResponseType ¶
type SinkGetResponseType string
Specifies the type of sink.
const ( SinkGetResponseTypeR2 SinkGetResponseType = "r2" SinkGetResponseTypeR2DataCatalog SinkGetResponseType = "r2_data_catalog" SinkGetResponseTypeBasinCatalog SinkGetResponseType = "basin_catalog" )
func (SinkGetResponseType) IsKnown ¶
func (r SinkGetResponseType) IsKnown() bool
type SinkListParams ¶
type SinkListParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Filters sinks by name (case-insensitive substring).
Name param.Field[string] `query:"name"`
Page param.Field[float64] `query:"page"`
PerPage param.Field[float64] `query:"per_page"`
PipelineID param.Field[string] `query:"pipeline_id"`
}
func (SinkListParams) URLQuery ¶
func (r SinkListParams) URLQuery() (v url.Values)
URLQuery serializes SinkListParams's query parameters as `url.Values`.
type SinkListResponse ¶
type SinkListResponse struct {
// Indicates a unique identifier for this sink.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Defines the name of the Sink.
Name string `json:"name" api:"required"`
// Specifies the type of sink.
Type SinkListResponseType `json:"type" api:"required"`
// Defines the configuration of the R2 Sink.
Config SinkListResponseConfig `json:"config"`
// Defines the output data format of a sink.
Format SinkListResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema SinkListResponseSchema `json:"schema"`
JSON sinkListResponseJSON `json:"-"`
}
func (*SinkListResponse) UnmarshalJSON ¶
func (r *SinkListResponse) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfig ¶
type SinkListResponseConfig struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
// This field can have the runtime type of
// [SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming].
FileNaming interface{} `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Table namespace
Namespace string `json:"namespace"`
// This field can have the runtime type of
// [SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning].
Partitioning interface{} `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// This field can have the runtime type of
// [SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy],
// [SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy].
RollingPolicy interface{} `json:"rolling_policy"`
// Table name
TableName string `json:"table_name"`
JSON sinkListResponseConfigJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the configuration of the R2 Sink.
func (SinkListResponseConfig) AsUnion ¶
func (r SinkListResponseConfig) AsUnion() SinkListResponseConfigUnion
AsUnion returns a SinkListResponseConfigUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkListResponseConfigCloudflarePipelinesR2TablePublic, SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic.
func (*SinkListResponseConfig) UnmarshalJSON ¶
func (r *SinkListResponseConfig) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic ¶
type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic struct {
// Cloudflare Account ID
AccountID string `json:"account_id" api:"required" format:"uri"`
// The R2 Bucket that hosts this catalog
Bucket string `json:"bucket" api:"required"`
// Table name
TableName string `json:"table_name" api:"required"`
// Table namespace
Namespace string `json:"namespace"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy `json:"rolling_policy"`
JSON sinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicJSON `json:"-"`
}
R2 Data Catalog Sink public configuration.
func (*SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy ¶
type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublicRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2TablePublic ¶
type SinkListResponseConfigCloudflarePipelinesR2TablePublic struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
// Controls filename prefix/suffix and strategy.
FileNaming SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Data-layout partitioning for sinks.
Partitioning SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy `json:"rolling_policy"`
JSON sinkListResponseConfigCloudflarePipelinesR2TablePublicJSON `json:"-"`
}
R2 Sink public configuration.
func (*SinkListResponseConfigCloudflarePipelinesR2TablePublic) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2TablePublic) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming ¶
type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming struct {
// The prefix to use in file name. i.e prefix-<uuid>.parquet
Prefix string `json:"prefix"`
// Filename generation strategy.
Strategy SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy `json:"strategy"`
// This will overwrite the default file suffix. i.e .parquet, use with caution
Suffix string `json:"suffix"`
JSON sinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingJSON `json:"-"`
}
Controls filename prefix/suffix and strategy.
func (*SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNaming) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy ¶
type SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy string
Filename generation strategy.
const ( SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategySerial SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "serial" SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUID SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid" SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUUIDV7 SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "uuid_v7" SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategyUlid SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy = "ulid" )
func (SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy) IsKnown ¶
func (r SinkListResponseConfigCloudflarePipelinesR2TablePublicFileNamingStrategy) IsKnown() bool
type SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning ¶
type SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning struct {
// The pattern of the date string
TimePattern string `json:"time_pattern"`
JSON sinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioningJSON `json:"-"`
}
Data-layout partitioning for sinks.
func (*SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2TablePublicPartitioning) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy ¶
type SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy) UnmarshalJSON ¶
func (r *SinkListResponseConfigCloudflarePipelinesR2TablePublicRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkListResponseConfigUnion ¶
type SinkListResponseConfigUnion interface {
// contains filtered or unexported methods
}
Defines the configuration of the R2 Sink.
Union satisfied by SinkListResponseConfigCloudflarePipelinesR2TablePublic or SinkListResponseConfigCloudflarePipelinesR2DataCatalogTablePublic.
type SinkListResponseFormat ¶
type SinkListResponseFormat struct {
Type SinkListResponseFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkListResponseFormatCompression `json:"compression"`
DecimalEncoding SinkListResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat SinkListResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkListResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the output data format of a sink.
func (SinkListResponseFormat) AsUnion ¶
func (r SinkListResponseFormat) AsUnion() SinkListResponseFormatUnion
AsUnion returns a SinkListResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkListResponseFormatCloudflarePipelinesSinkJsonFormat, SinkListResponseFormatCloudflarePipelinesSinkParquetFormat.
func (*SinkListResponseFormat) UnmarshalJSON ¶
func (r *SinkListResponseFormat) UnmarshalJSON(data []byte) (err error)
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormat ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormat struct {
Type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression `json:"compression"`
DecimalEncoding SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding `json:"decimal_encoding"`
TimestampFormat SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkListResponseFormatCloudflarePipelinesSinkJsonFormatJSON `json:"-"`
}
func (*SinkListResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkListResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON(data []byte) (err error)
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" )
func (SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown() bool
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding string
const ( SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" )
func (SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown() bool
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat string
const ( SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix_millis" )
func (SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown() bool
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType string
const (
SinkListResponseFormatCloudflarePipelinesSinkJsonFormatTypeJson SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType = "json"
)
func (SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown() bool
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormat ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormat struct {
Type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType `json:"type" api:"required"`
Compression SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON sinkListResponseFormatCloudflarePipelinesSinkParquetFormatJSON `json:"-"`
}
func (*SinkListResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkListResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON(data []byte) (err error)
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression string
const ( SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" )
func (SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown() bool
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType ¶ added in v7.10.0
type SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType string
const (
SinkListResponseFormatCloudflarePipelinesSinkParquetFormatTypeParquet SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType = "parquet"
)
func (SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown ¶ added in v7.10.0
func (r SinkListResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown() bool
type SinkListResponseFormatCompression ¶
type SinkListResponseFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkListResponseFormatCompressionUncompressed SinkListResponseFormatCompression = "uncompressed" SinkListResponseFormatCompressionGzip SinkListResponseFormatCompression = "gzip" SinkListResponseFormatCompressionSnappy SinkListResponseFormatCompression = "snappy" SinkListResponseFormatCompressionZstd SinkListResponseFormatCompression = "zstd" SinkListResponseFormatCompressionLz4 SinkListResponseFormatCompression = "lz4" )
func (SinkListResponseFormatCompression) IsKnown ¶
func (r SinkListResponseFormatCompression) IsKnown() bool
type SinkListResponseFormatDecimalEncoding ¶
type SinkListResponseFormatDecimalEncoding string
const ( SinkListResponseFormatDecimalEncodingNumber SinkListResponseFormatDecimalEncoding = "number" SinkListResponseFormatDecimalEncodingString SinkListResponseFormatDecimalEncoding = "string" SinkListResponseFormatDecimalEncodingBytes SinkListResponseFormatDecimalEncoding = "bytes" )
func (SinkListResponseFormatDecimalEncoding) IsKnown ¶
func (r SinkListResponseFormatDecimalEncoding) IsKnown() bool
type SinkListResponseFormatTimestampFormat ¶
type SinkListResponseFormatTimestampFormat string
const ( SinkListResponseFormatTimestampFormatRfc3339 SinkListResponseFormatTimestampFormat = "rfc3339" SinkListResponseFormatTimestampFormatUnixMillis SinkListResponseFormatTimestampFormat = "unix_millis" )
func (SinkListResponseFormatTimestampFormat) IsKnown ¶
func (r SinkListResponseFormatTimestampFormat) IsKnown() bool
type SinkListResponseFormatType ¶
type SinkListResponseFormatType string
const ( SinkListResponseFormatTypeJson SinkListResponseFormatType = "json" SinkListResponseFormatTypeParquet SinkListResponseFormatType = "parquet" )
func (SinkListResponseFormatType) IsKnown ¶
func (r SinkListResponseFormatType) IsKnown() bool
type SinkListResponseFormatUnion ¶
type SinkListResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the output data format of a sink.
Union satisfied by SinkListResponseFormatCloudflarePipelinesSinkJsonFormat or SinkListResponseFormatCloudflarePipelinesSinkParquetFormat.
type SinkListResponseSchema ¶
type SinkListResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON sinkListResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*SinkListResponseSchema) UnmarshalJSON ¶
func (r *SinkListResponseSchema) UnmarshalJSON(data []byte) (err error)
type SinkListResponseType ¶
type SinkListResponseType string
Specifies the type of sink.
const ( SinkListResponseTypeR2 SinkListResponseType = "r2" SinkListResponseTypeR2DataCatalog SinkListResponseType = "r2_data_catalog" SinkListResponseTypeBasinCatalog SinkListResponseType = "basin_catalog" )
func (SinkListResponseType) IsKnown ¶
func (r SinkListResponseType) IsKnown() bool
type SinkNewParams ¶
type SinkNewParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Defines the name of the Sink.
Name param.Field[string] `json:"name" api:"required"`
// Specifies the type of sink.
Type param.Field[SinkNewParamsType] `json:"type" api:"required"`
// Defines the configuration of the R2 Sink.
Config param.Field[SinkNewParamsConfigUnion] `json:"config"`
// Defines the output data format of a sink.
Format param.Field[SinkNewParamsFormatUnion] `json:"format"`
// Defines the schema of the events in the data stream.
Schema param.Field[SinkNewParamsSchema] `json:"schema"`
}
func (SinkNewParams) MarshalJSON ¶
func (r SinkNewParams) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfig ¶
type SinkNewParamsConfig struct {
// Cloudflare Account ID for the bucket
AccountID param.Field[string] `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket param.Field[string] `json:"bucket" api:"required"`
// Authentication token
Token param.Field[string] `json:"token" format:"var-str"`
Credentials param.Field[interface{}] `json:"credentials"`
FileNaming param.Field[interface{}] `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction param.Field[string] `json:"jurisdiction"`
// Table namespace
Namespace param.Field[string] `json:"namespace"`
Partitioning param.Field[interface{}] `json:"partitioning"`
// Subpath within the bucket to write to
Path param.Field[string] `json:"path"`
RollingPolicy param.Field[interface{}] `json:"rolling_policy"`
// Table name
TableName param.Field[string] `json:"table_name"`
}
Defines the configuration of the R2 Sink.
func (SinkNewParamsConfig) MarshalJSON ¶
func (r SinkNewParamsConfig) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable ¶
type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable struct {
// Authentication token
Token param.Field[string] `json:"token" api:"required" format:"var-str"`
// Cloudflare Account ID
AccountID param.Field[string] `json:"account_id" api:"required" format:"uri"`
// The R2 Bucket that hosts this catalog
Bucket param.Field[string] `json:"bucket" api:"required"`
// Table name
TableName param.Field[string] `json:"table_name" api:"required"`
// Table namespace
Namespace param.Field[string] `json:"namespace"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy param.Field[SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy] `json:"rolling_policy"`
}
R2 Data Catalog Sink
func (SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy ¶
type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes param.Field[int64] `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds param.Field[int64] `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds param.Field[int64] `json:"interval_seconds"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2Table ¶
type SinkNewParamsConfigCloudflarePipelinesR2Table struct {
// Cloudflare Account ID for the bucket
AccountID param.Field[string] `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket param.Field[string] `json:"bucket" api:"required"`
Credentials param.Field[SinkNewParamsConfigCloudflarePipelinesR2TableCredentials] `json:"credentials" api:"required"`
// Controls filename prefix/suffix and strategy.
FileNaming param.Field[SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming] `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction param.Field[string] `json:"jurisdiction"`
// Data-layout partitioning for sinks.
Partitioning param.Field[SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning] `json:"partitioning"`
// Subpath within the bucket to write to
Path param.Field[string] `json:"path"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy param.Field[SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy] `json:"rolling_policy"`
}
func (SinkNewParamsConfigCloudflarePipelinesR2Table) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2Table) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2TableCredentials ¶
type SinkNewParamsConfigCloudflarePipelinesR2TableCredentials struct {
// Cloudflare Account ID for the bucket
AccessKeyID param.Field[string] `json:"access_key_id" api:"required" format:"var-str"`
// Cloudflare Account ID for the bucket
SecretAccessKey param.Field[string] `json:"secret_access_key" api:"required" format:"var-str"`
}
func (SinkNewParamsConfigCloudflarePipelinesR2TableCredentials) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2TableCredentials) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming ¶
type SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming struct {
// The prefix to use in file name. i.e prefix-<uuid>.parquet
Prefix param.Field[string] `json:"prefix"`
// Filename generation strategy.
Strategy param.Field[SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy] `json:"strategy"`
// This will overwrite the default file suffix. i.e .parquet, use with caution
Suffix param.Field[string] `json:"suffix"`
}
Controls filename prefix/suffix and strategy.
func (SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy ¶
type SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy string
Filename generation strategy.
const ( SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial" SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUID SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid" SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7" SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUlid SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid" )
func (SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown() bool
type SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning ¶
type SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning struct {
// The pattern of the date string
TimePattern param.Field[string] `json:"time_pattern"`
}
Data-layout partitioning for sinks.
func (SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy ¶
type SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes param.Field[int64] `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds param.Field[int64] `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds param.Field[int64] `json:"interval_seconds"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy) MarshalJSON ¶
func (r SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy) MarshalJSON() (data []byte, err error)
type SinkNewParamsConfigUnion ¶
type SinkNewParamsConfigUnion interface {
// contains filtered or unexported methods
}
Defines the configuration of the R2 Sink.
Satisfied by pipelines.SinkNewParamsConfigCloudflarePipelinesR2Table, pipelines.SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable, SinkNewParamsConfig.
type SinkNewParamsFormat ¶
type SinkNewParamsFormat struct {
Type param.Field[SinkNewParamsFormatType] `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression param.Field[SinkNewParamsFormatCompression] `json:"compression"`
DecimalEncoding param.Field[SinkNewParamsFormatDecimalEncoding] `json:"decimal_encoding"`
RowGroupBytes param.Field[int64] `json:"row_group_bytes"`
TimestampFormat param.Field[SinkNewParamsFormatTimestampFormat] `json:"timestamp_format"`
Unstructured param.Field[bool] `json:"unstructured"`
}
Defines the output data format of a sink.
func (SinkNewParamsFormat) MarshalJSON ¶
func (r SinkNewParamsFormat) MarshalJSON() (data []byte, err error)
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat struct {
Type param.Field[SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType] `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression param.Field[SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression] `json:"compression"`
DecimalEncoding param.Field[SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding] `json:"decimal_encoding"`
TimestampFormat param.Field[SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat] `json:"timestamp_format"`
Unstructured param.Field[bool] `json:"unstructured"`
}
func (SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat) MarshalJSON ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat) MarshalJSON() (data []byte, err error)
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" )
func (SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown() bool
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding string
const ( SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" )
func (SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown() bool
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat string
const ( SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix_millis" )
func (SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown() bool
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType string
const (
SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatTypeJson SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType = "json"
)
func (SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkJsonFormatType) IsKnown() bool
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat struct {
Type param.Field[SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType] `json:"type" api:"required"`
Compression param.Field[SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression] `json:"compression"`
RowGroupBytes param.Field[int64] `json:"row_group_bytes"`
}
func (SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat) MarshalJSON ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat) MarshalJSON() (data []byte, err error)
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression string
const ( SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" )
func (SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown() bool
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType ¶ added in v7.10.0
type SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType string
const (
SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatTypeParquet SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType = "parquet"
)
func (SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType) IsKnown ¶ added in v7.10.0
func (r SinkNewParamsFormatCloudflarePipelinesSinkParquetFormatType) IsKnown() bool
type SinkNewParamsFormatCompression ¶
type SinkNewParamsFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkNewParamsFormatCompressionUncompressed SinkNewParamsFormatCompression = "uncompressed" SinkNewParamsFormatCompressionGzip SinkNewParamsFormatCompression = "gzip" SinkNewParamsFormatCompressionSnappy SinkNewParamsFormatCompression = "snappy" SinkNewParamsFormatCompressionZstd SinkNewParamsFormatCompression = "zstd" SinkNewParamsFormatCompressionLz4 SinkNewParamsFormatCompression = "lz4" )
func (SinkNewParamsFormatCompression) IsKnown ¶
func (r SinkNewParamsFormatCompression) IsKnown() bool
type SinkNewParamsFormatDecimalEncoding ¶
type SinkNewParamsFormatDecimalEncoding string
const ( SinkNewParamsFormatDecimalEncodingNumber SinkNewParamsFormatDecimalEncoding = "number" SinkNewParamsFormatDecimalEncodingString SinkNewParamsFormatDecimalEncoding = "string" SinkNewParamsFormatDecimalEncodingBytes SinkNewParamsFormatDecimalEncoding = "bytes" )
func (SinkNewParamsFormatDecimalEncoding) IsKnown ¶
func (r SinkNewParamsFormatDecimalEncoding) IsKnown() bool
type SinkNewParamsFormatTimestampFormat ¶
type SinkNewParamsFormatTimestampFormat string
const ( SinkNewParamsFormatTimestampFormatRfc3339 SinkNewParamsFormatTimestampFormat = "rfc3339" SinkNewParamsFormatTimestampFormatUnixMillis SinkNewParamsFormatTimestampFormat = "unix_millis" )
func (SinkNewParamsFormatTimestampFormat) IsKnown ¶
func (r SinkNewParamsFormatTimestampFormat) IsKnown() bool
type SinkNewParamsFormatType ¶
type SinkNewParamsFormatType string
const ( SinkNewParamsFormatTypeJson SinkNewParamsFormatType = "json" SinkNewParamsFormatTypeParquet SinkNewParamsFormatType = "parquet" )
func (SinkNewParamsFormatType) IsKnown ¶
func (r SinkNewParamsFormatType) IsKnown() bool
type SinkNewParamsFormatUnion ¶
type SinkNewParamsFormatUnion interface {
// contains filtered or unexported methods
}
Defines the output data format of a sink.
Satisfied by pipelines.SinkNewParamsFormatCloudflarePipelinesSinkJsonFormat, pipelines.SinkNewParamsFormatCloudflarePipelinesSinkParquetFormat, SinkNewParamsFormat.
type SinkNewParamsSchema ¶
type SinkNewParamsSchema struct {
Fields param.Field[[]SourceFieldUnionParam] `json:"fields"`
Inferred param.Field[bool] `json:"inferred"`
}
Defines the schema of the events in the data stream.
func (SinkNewParamsSchema) MarshalJSON ¶
func (r SinkNewParamsSchema) MarshalJSON() (data []byte, err error)
type SinkNewParamsType ¶
type SinkNewParamsType string
Specifies the type of sink.
const ( SinkNewParamsTypeR2 SinkNewParamsType = "r2" SinkNewParamsTypeR2DataCatalog SinkNewParamsType = "r2_data_catalog" SinkNewParamsTypeBasinCatalog SinkNewParamsType = "basin_catalog" )
func (SinkNewParamsType) IsKnown ¶
func (r SinkNewParamsType) IsKnown() bool
type SinkNewResponse ¶
type SinkNewResponse struct {
// Indicates a unique identifier for this sink.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Defines the name of the Sink.
Name string `json:"name" api:"required"`
// Specifies the type of sink.
Type SinkNewResponseType `json:"type" api:"required"`
// R2 Data Catalog Sink
Config SinkNewResponseConfig `json:"config"`
// Defines the output data format of a sink.
Format SinkNewResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema SinkNewResponseSchema `json:"schema"`
JSON sinkNewResponseJSON `json:"-"`
}
func (*SinkNewResponse) UnmarshalJSON ¶
func (r *SinkNewResponse) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfig ¶
type SinkNewResponseConfig struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
// Authentication token
Token string `json:"token" format:"var-str"`
// This field can have the runtime type of
// [SinkNewResponseConfigCloudflarePipelinesR2TableCredentials].
Credentials interface{} `json:"credentials"`
// This field can have the runtime type of
// [SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming].
FileNaming interface{} `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Table namespace
Namespace string `json:"namespace"`
// This field can have the runtime type of
// [SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning].
Partitioning interface{} `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// This field can have the runtime type of
// [SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy],
// [SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy].
RollingPolicy interface{} `json:"rolling_policy"`
// Table name
TableName string `json:"table_name"`
JSON sinkNewResponseConfigJSON `json:"-"`
// contains filtered or unexported fields
}
R2 Data Catalog Sink
func (SinkNewResponseConfig) AsUnion ¶
func (r SinkNewResponseConfig) AsUnion() SinkNewResponseConfigUnion
AsUnion returns a SinkNewResponseConfigUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkNewResponseConfigCloudflarePipelinesR2Table, SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable.
func (*SinkNewResponseConfig) UnmarshalJSON ¶
func (r *SinkNewResponseConfig) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable ¶
type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable struct {
// Authentication token
Token string `json:"token" api:"required" format:"var-str"`
// Cloudflare Account ID
AccountID string `json:"account_id" api:"required" format:"uri"`
// The R2 Bucket that hosts this catalog
Bucket string `json:"bucket" api:"required"`
// Table name
TableName string `json:"table_name" api:"required"`
// Table namespace
Namespace string `json:"namespace"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy `json:"rolling_policy"`
JSON sinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableJSON `json:"-"`
}
R2 Data Catalog Sink
func (*SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy ¶
type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2Table ¶
type SinkNewResponseConfigCloudflarePipelinesR2Table struct {
// Cloudflare Account ID for the bucket
AccountID string `json:"account_id" api:"required"`
// R2 Bucket to write to
Bucket string `json:"bucket" api:"required"`
Credentials SinkNewResponseConfigCloudflarePipelinesR2TableCredentials `json:"credentials" api:"required"`
// Controls filename prefix/suffix and strategy.
FileNaming SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming `json:"file_naming"`
// Jurisdiction this bucket is hosted in
Jurisdiction string `json:"jurisdiction"`
// Data-layout partitioning for sinks.
Partitioning SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning `json:"partitioning"`
// Subpath within the bucket to write to
Path string `json:"path"`
// Rolling policy for file sinks (when & why to close a file and open a new one).
RollingPolicy SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy `json:"rolling_policy"`
JSON sinkNewResponseConfigCloudflarePipelinesR2TableJSON `json:"-"`
}
func (*SinkNewResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2TableCredentials ¶
type SinkNewResponseConfigCloudflarePipelinesR2TableCredentials struct {
// Cloudflare Account ID for the bucket
AccessKeyID string `json:"access_key_id" api:"required" format:"var-str"`
// Cloudflare Account ID for the bucket
SecretAccessKey string `json:"secret_access_key" api:"required" format:"var-str"`
JSON sinkNewResponseConfigCloudflarePipelinesR2TableCredentialsJSON `json:"-"`
}
func (*SinkNewResponseConfigCloudflarePipelinesR2TableCredentials) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2TableCredentials) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming ¶
type SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming struct {
// The prefix to use in file name. i.e prefix-<uuid>.parquet
Prefix string `json:"prefix"`
// Filename generation strategy.
Strategy SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy `json:"strategy"`
// This will overwrite the default file suffix. i.e .parquet, use with caution
Suffix string `json:"suffix"`
JSON sinkNewResponseConfigCloudflarePipelinesR2TableFileNamingJSON `json:"-"`
}
Controls filename prefix/suffix and strategy.
func (*SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy ¶
type SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy string
Filename generation strategy.
const ( SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial" SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUID SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid" SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7" SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUlid SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid" )
func (SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown ¶
func (r SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown() bool
type SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning ¶
type SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning struct {
// The pattern of the date string
TimePattern string `json:"time_pattern"`
JSON sinkNewResponseConfigCloudflarePipelinesR2TablePartitioningJSON `json:"-"`
}
Data-layout partitioning for sinks.
func (*SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy ¶
type SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy struct {
// Files will be rolled after reaching this number of bytes
FileSizeBytes int64 `json:"file_size_bytes"`
// Number of seconds of inactivity to wait before rolling over to a new file
InactivitySeconds int64 `json:"inactivity_seconds"`
// Number of seconds to wait before rolling over to a new file
IntervalSeconds int64 `json:"interval_seconds"`
JSON sinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicyJSON `json:"-"`
}
Rolling policy for file sinks (when & why to close a file and open a new one).
func (*SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy) UnmarshalJSON ¶
func (r *SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseConfigUnion ¶
type SinkNewResponseConfigUnion interface {
// contains filtered or unexported methods
}
R2 Data Catalog Sink
Union satisfied by SinkNewResponseConfigCloudflarePipelinesR2Table or SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable.
type SinkNewResponseEnvelope ¶
type SinkNewResponseEnvelope struct {
Result SinkNewResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON sinkNewResponseEnvelopeJSON `json:"-"`
}
func (*SinkNewResponseEnvelope) UnmarshalJSON ¶
func (r *SinkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseFormat ¶
type SinkNewResponseFormat struct {
Type SinkNewResponseFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkNewResponseFormatCompression `json:"compression"`
DecimalEncoding SinkNewResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat SinkNewResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkNewResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the output data format of a sink.
func (SinkNewResponseFormat) AsUnion ¶
func (r SinkNewResponseFormat) AsUnion() SinkNewResponseFormatUnion
AsUnion returns a SinkNewResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat, SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat.
func (*SinkNewResponseFormat) UnmarshalJSON ¶
func (r *SinkNewResponseFormat) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat struct {
Type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType `json:"type" api:"required"`
// Specifies the compression applied to JSON sink output.
Compression SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression `json:"compression"`
DecimalEncoding SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding `json:"decimal_encoding"`
TimestampFormat SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON sinkNewResponseFormatCloudflarePipelinesSinkJsonFormatJSON `json:"-"`
}
func (*SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompressionUncompressed SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "uncompressed" SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompressionGzip SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression = "gzip" )
func (SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatCompression) IsKnown() bool
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding string
const ( SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingNumber SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "number" SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingString SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "string" SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncodingBytes SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding = "bytes" )
func (SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatDecimalEncoding) IsKnown() bool
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat string
const ( SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatRfc3339 SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "rfc3339" SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormatUnixMillis SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat = "unix_millis" )
func (SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTimestampFormat) IsKnown() bool
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType string
const (
SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatTypeJson SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType = "json"
)
func (SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkJsonFormatType) IsKnown() bool
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat struct {
Type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType `json:"type" api:"required"`
Compression SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON sinkNewResponseFormatCloudflarePipelinesSinkParquetFormatJSON `json:"-"`
}
func (*SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON ¶ added in v7.10.0
func (r *SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression string
const ( SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionUncompressed SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "uncompressed" SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionSnappy SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "snappy" SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionGzip SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "gzip" SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionZstd SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "zstd" SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompressionLz4 SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression = "lz4" )
func (SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatCompression) IsKnown() bool
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType ¶ added in v7.10.0
type SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType string
const (
SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatTypeParquet SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType = "parquet"
)
func (SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown ¶ added in v7.10.0
func (r SinkNewResponseFormatCloudflarePipelinesSinkParquetFormatType) IsKnown() bool
type SinkNewResponseFormatCompression ¶
type SinkNewResponseFormatCompression string
Specifies the compression applied to JSON sink output.
const ( SinkNewResponseFormatCompressionUncompressed SinkNewResponseFormatCompression = "uncompressed" SinkNewResponseFormatCompressionGzip SinkNewResponseFormatCompression = "gzip" SinkNewResponseFormatCompressionSnappy SinkNewResponseFormatCompression = "snappy" SinkNewResponseFormatCompressionZstd SinkNewResponseFormatCompression = "zstd" SinkNewResponseFormatCompressionLz4 SinkNewResponseFormatCompression = "lz4" )
func (SinkNewResponseFormatCompression) IsKnown ¶
func (r SinkNewResponseFormatCompression) IsKnown() bool
type SinkNewResponseFormatDecimalEncoding ¶
type SinkNewResponseFormatDecimalEncoding string
const ( SinkNewResponseFormatDecimalEncodingNumber SinkNewResponseFormatDecimalEncoding = "number" SinkNewResponseFormatDecimalEncodingString SinkNewResponseFormatDecimalEncoding = "string" SinkNewResponseFormatDecimalEncodingBytes SinkNewResponseFormatDecimalEncoding = "bytes" )
func (SinkNewResponseFormatDecimalEncoding) IsKnown ¶
func (r SinkNewResponseFormatDecimalEncoding) IsKnown() bool
type SinkNewResponseFormatTimestampFormat ¶
type SinkNewResponseFormatTimestampFormat string
const ( SinkNewResponseFormatTimestampFormatRfc3339 SinkNewResponseFormatTimestampFormat = "rfc3339" SinkNewResponseFormatTimestampFormatUnixMillis SinkNewResponseFormatTimestampFormat = "unix_millis" )
func (SinkNewResponseFormatTimestampFormat) IsKnown ¶
func (r SinkNewResponseFormatTimestampFormat) IsKnown() bool
type SinkNewResponseFormatType ¶
type SinkNewResponseFormatType string
const ( SinkNewResponseFormatTypeJson SinkNewResponseFormatType = "json" SinkNewResponseFormatTypeParquet SinkNewResponseFormatType = "parquet" )
func (SinkNewResponseFormatType) IsKnown ¶
func (r SinkNewResponseFormatType) IsKnown() bool
type SinkNewResponseFormatUnion ¶
type SinkNewResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the output data format of a sink.
Union satisfied by SinkNewResponseFormatCloudflarePipelinesSinkJsonFormat or SinkNewResponseFormatCloudflarePipelinesSinkParquetFormat.
type SinkNewResponseSchema ¶
type SinkNewResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON sinkNewResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*SinkNewResponseSchema) UnmarshalJSON ¶
func (r *SinkNewResponseSchema) UnmarshalJSON(data []byte) (err error)
type SinkNewResponseType ¶
type SinkNewResponseType string
Specifies the type of sink.
const ( SinkNewResponseTypeR2 SinkNewResponseType = "r2" SinkNewResponseTypeR2DataCatalog SinkNewResponseType = "r2_data_catalog" SinkNewResponseTypeBasinCatalog SinkNewResponseType = "basin_catalog" )
func (SinkNewResponseType) IsKnown ¶
func (r SinkNewResponseType) IsKnown() bool
type SinkService ¶
type SinkService struct {
Options []option.RequestOption
}
SinkService 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 NewSinkService method instead.
func NewSinkService ¶
func NewSinkService(opts ...option.RequestOption) (r *SinkService)
NewSinkService 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 (*SinkService) Delete ¶
func (r *SinkService) Delete(ctx context.Context, sinkID string, body SinkDeleteParams, opts ...option.RequestOption) (res *SinkDeleteResponse, err error)
Delete Sink in Account.
func (*SinkService) Get ¶
func (r *SinkService) Get(ctx context.Context, sinkID string, query SinkGetParams, opts ...option.RequestOption) (res *SinkGetResponse, err error)
Get Sink Details.
func (*SinkService) List ¶
func (r *SinkService) List(ctx context.Context, params SinkListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[SinkListResponse], err error)
List/Filter Sinks in Account.
func (*SinkService) ListAutoPaging ¶
func (r *SinkService) ListAutoPaging(ctx context.Context, params SinkListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[SinkListResponse]
List/Filter Sinks in Account.
func (*SinkService) New ¶
func (r *SinkService) New(ctx context.Context, params SinkNewParams, opts ...option.RequestOption) (res *SinkNewResponse, err error)
Create a new Sink.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type SourceField ¶
type SourceField struct {
// This field can have the runtime type of [[]SourceField].
Fields interface{} `json:"fields"`
// This field can have the runtime type of [SourceField].
Items interface{} `json:"items"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name" api:"nullable"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
Type SourceFieldType `json:"type"`
Unit SourceFieldUnit `json:"unit"`
JSON sourceFieldJSON `json:"-"`
// contains filtered or unexported fields
}
func (SourceField) AsUnion ¶
func (r SourceField) AsUnion() SourceFieldUnion
AsUnion returns a SourceFieldUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are SourceFieldInt32, SourceFieldInt64, SourceFieldFloat32, SourceFieldFloat64, SourceFieldBool, SourceFieldString, SourceFieldBinary, SourceFieldTimestamp, SourceFieldJson, SourceFieldStruct, SourceFieldList.
func (*SourceField) UnmarshalJSON ¶
func (r *SourceField) UnmarshalJSON(data []byte) (err error)
type SourceFieldBinary ¶
type SourceFieldBinary struct {
Type SourceFieldBinaryType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldBinaryJSON `json:"-"`
}
func (*SourceFieldBinary) UnmarshalJSON ¶
func (r *SourceFieldBinary) UnmarshalJSON(data []byte) (err error)
type SourceFieldBinaryParam ¶
type SourceFieldBinaryParam struct {
Type param.Field[SourceFieldBinaryType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldBinaryParam) MarshalJSON ¶
func (r SourceFieldBinaryParam) MarshalJSON() (data []byte, err error)
type SourceFieldBinaryType ¶
type SourceFieldBinaryType string
const (
SourceFieldBinaryTypeBinary SourceFieldBinaryType = "binary"
)
func (SourceFieldBinaryType) IsKnown ¶
func (r SourceFieldBinaryType) IsKnown() bool
type SourceFieldBool ¶
type SourceFieldBool struct {
Type SourceFieldBoolType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldBoolJSON `json:"-"`
}
func (*SourceFieldBool) UnmarshalJSON ¶
func (r *SourceFieldBool) UnmarshalJSON(data []byte) (err error)
type SourceFieldBoolParam ¶
type SourceFieldBoolParam struct {
Type param.Field[SourceFieldBoolType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldBoolParam) MarshalJSON ¶
func (r SourceFieldBoolParam) MarshalJSON() (data []byte, err error)
type SourceFieldBoolType ¶
type SourceFieldBoolType string
const (
SourceFieldBoolTypeBool SourceFieldBoolType = "bool"
)
func (SourceFieldBoolType) IsKnown ¶
func (r SourceFieldBoolType) IsKnown() bool
type SourceFieldFloat32 ¶
type SourceFieldFloat32 struct {
Type SourceFieldFloat32Type `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldFloat32JSON `json:"-"`
}
func (*SourceFieldFloat32) UnmarshalJSON ¶
func (r *SourceFieldFloat32) UnmarshalJSON(data []byte) (err error)
type SourceFieldFloat32Param ¶
type SourceFieldFloat32Param struct {
Type param.Field[SourceFieldFloat32Type] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldFloat32Param) MarshalJSON ¶
func (r SourceFieldFloat32Param) MarshalJSON() (data []byte, err error)
type SourceFieldFloat32Type ¶
type SourceFieldFloat32Type string
const (
SourceFieldFloat32TypeFloat32 SourceFieldFloat32Type = "float32"
)
func (SourceFieldFloat32Type) IsKnown ¶
func (r SourceFieldFloat32Type) IsKnown() bool
type SourceFieldFloat64 ¶
type SourceFieldFloat64 struct {
Type SourceFieldFloat64Type `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldFloat64JSON `json:"-"`
}
func (*SourceFieldFloat64) UnmarshalJSON ¶
func (r *SourceFieldFloat64) UnmarshalJSON(data []byte) (err error)
type SourceFieldFloat64Param ¶
type SourceFieldFloat64Param struct {
Type param.Field[SourceFieldFloat64Type] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldFloat64Param) MarshalJSON ¶
func (r SourceFieldFloat64Param) MarshalJSON() (data []byte, err error)
type SourceFieldFloat64Type ¶
type SourceFieldFloat64Type string
const (
SourceFieldFloat64TypeFloat64 SourceFieldFloat64Type = "float64"
)
func (SourceFieldFloat64Type) IsKnown ¶
func (r SourceFieldFloat64Type) IsKnown() bool
type SourceFieldInt32 ¶
type SourceFieldInt32 struct {
Type SourceFieldInt32Type `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldInt32JSON `json:"-"`
}
func (*SourceFieldInt32) UnmarshalJSON ¶
func (r *SourceFieldInt32) UnmarshalJSON(data []byte) (err error)
type SourceFieldInt32Param ¶
type SourceFieldInt32Param struct {
Type param.Field[SourceFieldInt32Type] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldInt32Param) MarshalJSON ¶
func (r SourceFieldInt32Param) MarshalJSON() (data []byte, err error)
type SourceFieldInt32Type ¶
type SourceFieldInt32Type string
const (
SourceFieldInt32TypeInt32 SourceFieldInt32Type = "int32"
)
func (SourceFieldInt32Type) IsKnown ¶
func (r SourceFieldInt32Type) IsKnown() bool
type SourceFieldInt64 ¶
type SourceFieldInt64 struct {
Type SourceFieldInt64Type `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldInt64JSON `json:"-"`
}
func (*SourceFieldInt64) UnmarshalJSON ¶
func (r *SourceFieldInt64) UnmarshalJSON(data []byte) (err error)
type SourceFieldInt64Param ¶
type SourceFieldInt64Param struct {
Type param.Field[SourceFieldInt64Type] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldInt64Param) MarshalJSON ¶
func (r SourceFieldInt64Param) MarshalJSON() (data []byte, err error)
type SourceFieldInt64Type ¶
type SourceFieldInt64Type string
const (
SourceFieldInt64TypeInt64 SourceFieldInt64Type = "int64"
)
func (SourceFieldInt64Type) IsKnown ¶
func (r SourceFieldInt64Type) IsKnown() bool
type SourceFieldJson ¶
type SourceFieldJson struct {
Type SourceFieldJsonType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldJsonJSON `json:"-"`
}
func (*SourceFieldJson) UnmarshalJSON ¶
func (r *SourceFieldJson) UnmarshalJSON(data []byte) (err error)
type SourceFieldJsonParam ¶
type SourceFieldJsonParam struct {
Type param.Field[SourceFieldJsonType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldJsonParam) MarshalJSON ¶
func (r SourceFieldJsonParam) MarshalJSON() (data []byte, err error)
type SourceFieldJsonType ¶
type SourceFieldJsonType string
const (
SourceFieldJsonTypeJson SourceFieldJsonType = "json"
)
func (SourceFieldJsonType) IsKnown ¶
func (r SourceFieldJsonType) IsKnown() bool
type SourceFieldList ¶
type SourceFieldList struct {
Type SourceFieldListType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldListJSON `json:"-"`
ListField
}
func (*SourceFieldList) UnmarshalJSON ¶
func (r *SourceFieldList) UnmarshalJSON(data []byte) (err error)
type SourceFieldListParam ¶
type SourceFieldListParam struct {
Type param.Field[SourceFieldListType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
ListFieldParam
}
func (SourceFieldListParam) MarshalJSON ¶
func (r SourceFieldListParam) MarshalJSON() (data []byte, err error)
type SourceFieldListType ¶
type SourceFieldListType string
const (
SourceFieldListTypeList SourceFieldListType = "list"
)
func (SourceFieldListType) IsKnown ¶
func (r SourceFieldListType) IsKnown() bool
type SourceFieldParam ¶
type SourceFieldParam struct {
Fields param.Field[interface{}] `json:"fields"`
Items param.Field[*SourceFieldUnionParam] `json:"items"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
Type param.Field[SourceFieldType] `json:"type"`
Unit param.Field[SourceFieldUnit] `json:"unit"`
}
func (SourceFieldParam) MarshalJSON ¶
func (r SourceFieldParam) MarshalJSON() (data []byte, err error)
type SourceFieldString ¶
type SourceFieldString struct {
Type SourceFieldStringType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldStringJSON `json:"-"`
}
func (*SourceFieldString) UnmarshalJSON ¶
func (r *SourceFieldString) UnmarshalJSON(data []byte) (err error)
type SourceFieldStringParam ¶
type SourceFieldStringParam struct {
Type param.Field[SourceFieldStringType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
}
func (SourceFieldStringParam) MarshalJSON ¶
func (r SourceFieldStringParam) MarshalJSON() (data []byte, err error)
type SourceFieldStringType ¶
type SourceFieldStringType string
const (
SourceFieldStringTypeString SourceFieldStringType = "string"
)
func (SourceFieldStringType) IsKnown ¶
func (r SourceFieldStringType) IsKnown() bool
type SourceFieldStruct ¶
type SourceFieldStruct struct {
Type SourceFieldStructType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
JSON sourceFieldStructJSON `json:"-"`
StructField
}
func (*SourceFieldStruct) UnmarshalJSON ¶
func (r *SourceFieldStruct) UnmarshalJSON(data []byte) (err error)
type SourceFieldStructParam ¶
type SourceFieldStructParam struct {
Type param.Field[SourceFieldStructType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
StructFieldParam
}
func (SourceFieldStructParam) MarshalJSON ¶
func (r SourceFieldStructParam) MarshalJSON() (data []byte, err error)
type SourceFieldStructType ¶
type SourceFieldStructType string
const (
SourceFieldStructTypeStruct SourceFieldStructType = "struct"
)
func (SourceFieldStructType) IsKnown ¶
func (r SourceFieldStructType) IsKnown() bool
type SourceFieldTimestamp ¶
type SourceFieldTimestamp struct {
Type SourceFieldTimestampType `json:"type" api:"required"`
MetadataKey string `json:"metadata_key" api:"nullable"`
Name string `json:"name"`
Required bool `json:"required"`
SqlName string `json:"sql_name"`
Unit SourceFieldTimestampUnit `json:"unit"`
JSON sourceFieldTimestampJSON `json:"-"`
}
func (*SourceFieldTimestamp) UnmarshalJSON ¶
func (r *SourceFieldTimestamp) UnmarshalJSON(data []byte) (err error)
type SourceFieldTimestampParam ¶
type SourceFieldTimestampParam struct {
Type param.Field[SourceFieldTimestampType] `json:"type" api:"required"`
MetadataKey param.Field[string] `json:"metadata_key"`
Name param.Field[string] `json:"name"`
Required param.Field[bool] `json:"required"`
SqlName param.Field[string] `json:"sql_name"`
Unit param.Field[SourceFieldTimestampUnit] `json:"unit"`
}
func (SourceFieldTimestampParam) MarshalJSON ¶
func (r SourceFieldTimestampParam) MarshalJSON() (data []byte, err error)
type SourceFieldTimestampType ¶
type SourceFieldTimestampType string
const (
SourceFieldTimestampTypeTimestamp SourceFieldTimestampType = "timestamp"
)
func (SourceFieldTimestampType) IsKnown ¶
func (r SourceFieldTimestampType) IsKnown() bool
type SourceFieldTimestampUnit ¶
type SourceFieldTimestampUnit string
const ( SourceFieldTimestampUnitSecond SourceFieldTimestampUnit = "second" SourceFieldTimestampUnitMillisecond SourceFieldTimestampUnit = "millisecond" SourceFieldTimestampUnitMicrosecond SourceFieldTimestampUnit = "microsecond" SourceFieldTimestampUnitNanosecond SourceFieldTimestampUnit = "nanosecond" )
func (SourceFieldTimestampUnit) IsKnown ¶
func (r SourceFieldTimestampUnit) IsKnown() bool
type SourceFieldType ¶
type SourceFieldType string
const ( SourceFieldTypeInt32 SourceFieldType = "int32" SourceFieldTypeInt64 SourceFieldType = "int64" SourceFieldTypeFloat32 SourceFieldType = "float32" SourceFieldTypeFloat64 SourceFieldType = "float64" SourceFieldTypeBool SourceFieldType = "bool" SourceFieldTypeString SourceFieldType = "string" SourceFieldTypeBinary SourceFieldType = "binary" SourceFieldTypeTimestamp SourceFieldType = "timestamp" SourceFieldTypeJson SourceFieldType = "json" SourceFieldTypeStruct SourceFieldType = "struct" SourceFieldTypeList SourceFieldType = "list" )
func (SourceFieldType) IsKnown ¶
func (r SourceFieldType) IsKnown() bool
type SourceFieldUnion ¶
type SourceFieldUnion interface {
// contains filtered or unexported methods
}
Union satisfied by SourceFieldInt32, SourceFieldInt64, SourceFieldFloat32, SourceFieldFloat64, SourceFieldBool, SourceFieldString, SourceFieldBinary, SourceFieldTimestamp, SourceFieldJson, SourceFieldStruct or SourceFieldList.
type SourceFieldUnionParam ¶
type SourceFieldUnionParam interface {
// contains filtered or unexported methods
}
Satisfied by pipelines.SourceFieldInt32Param, pipelines.SourceFieldInt64Param, pipelines.SourceFieldFloat32Param, pipelines.SourceFieldFloat64Param, pipelines.SourceFieldBoolParam, pipelines.SourceFieldStringParam, pipelines.SourceFieldBinaryParam, pipelines.SourceFieldTimestampParam, pipelines.SourceFieldJsonParam, pipelines.SourceFieldStructParam, pipelines.SourceFieldListParam, SourceFieldParam.
type SourceFieldUnit ¶
type SourceFieldUnit string
const ( SourceFieldUnitSecond SourceFieldUnit = "second" SourceFieldUnitMillisecond SourceFieldUnit = "millisecond" SourceFieldUnitMicrosecond SourceFieldUnit = "microsecond" SourceFieldUnitNanosecond SourceFieldUnit = "nanosecond" )
func (SourceFieldUnit) IsKnown ¶
func (r SourceFieldUnit) IsKnown() bool
type StreamDeleteParams ¶
type StreamDeleteResponse ¶
type StreamDeleteResponse = interface{}
type StreamDeleteResponseEnvelope ¶
type StreamDeleteResponseEnvelope struct {
Result StreamDeleteResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON streamDeleteResponseEnvelopeJSON `json:"-"`
}
func (*StreamDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *StreamDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type StreamGetParams ¶
type StreamGetResponse ¶
type StreamGetResponse struct {
// Indicates a unique identifier for this stream.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
HTTP StreamGetResponseHTTP `json:"http" api:"required"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Indicates the name of the Stream.
Name string `json:"name" api:"required"`
// Indicates the current version of this stream.
Version int64 `json:"version" api:"required"`
WorkerBinding StreamGetResponseWorkerBinding `json:"worker_binding" api:"required"`
// Indicates the endpoint URL of this stream.
Endpoint string `json:"endpoint" format:"uri"`
// Defines the data format of the events.
Format StreamGetResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema StreamGetResponseSchema `json:"schema"`
JSON streamGetResponseJSON `json:"-"`
}
func (*StreamGetResponse) UnmarshalJSON ¶
func (r *StreamGetResponse) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseEnvelope ¶
type StreamGetResponseEnvelope struct {
Result StreamGetResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON streamGetResponseEnvelopeJSON `json:"-"`
}
func (*StreamGetResponseEnvelope) UnmarshalJSON ¶
func (r *StreamGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseFormat ¶
type StreamGetResponseFormat struct {
Type StreamGetResponseFormatType `json:"type" api:"required"`
Compression StreamGetResponseFormatCompression `json:"compression"`
DecimalEncoding StreamGetResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat StreamGetResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamGetResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the data format of the events.
func (StreamGetResponseFormat) AsUnion ¶
func (r StreamGetResponseFormat) AsUnion() StreamGetResponseFormatUnion
AsUnion returns a StreamGetResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are StreamGetResponseFormatJson, StreamGetResponseFormatParquet.
func (*StreamGetResponseFormat) UnmarshalJSON ¶
func (r *StreamGetResponseFormat) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseFormatCompression ¶
type StreamGetResponseFormatCompression string
const ( StreamGetResponseFormatCompressionUncompressed StreamGetResponseFormatCompression = "uncompressed" StreamGetResponseFormatCompressionSnappy StreamGetResponseFormatCompression = "snappy" StreamGetResponseFormatCompressionGzip StreamGetResponseFormatCompression = "gzip" StreamGetResponseFormatCompressionZstd StreamGetResponseFormatCompression = "zstd" StreamGetResponseFormatCompressionLz4 StreamGetResponseFormatCompression = "lz4" )
func (StreamGetResponseFormatCompression) IsKnown ¶
func (r StreamGetResponseFormatCompression) IsKnown() bool
type StreamGetResponseFormatDecimalEncoding ¶
type StreamGetResponseFormatDecimalEncoding string
const ( StreamGetResponseFormatDecimalEncodingNumber StreamGetResponseFormatDecimalEncoding = "number" StreamGetResponseFormatDecimalEncodingString StreamGetResponseFormatDecimalEncoding = "string" StreamGetResponseFormatDecimalEncodingBytes StreamGetResponseFormatDecimalEncoding = "bytes" )
func (StreamGetResponseFormatDecimalEncoding) IsKnown ¶
func (r StreamGetResponseFormatDecimalEncoding) IsKnown() bool
type StreamGetResponseFormatJson ¶
type StreamGetResponseFormatJson struct {
Type StreamGetResponseFormatJsonType `json:"type" api:"required"`
DecimalEncoding StreamGetResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
TimestampFormat StreamGetResponseFormatJsonTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamGetResponseFormatJsonJSON `json:"-"`
}
func (*StreamGetResponseFormatJson) UnmarshalJSON ¶
func (r *StreamGetResponseFormatJson) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseFormatJsonDecimalEncoding ¶
type StreamGetResponseFormatJsonDecimalEncoding string
const ( StreamGetResponseFormatJsonDecimalEncodingNumber StreamGetResponseFormatJsonDecimalEncoding = "number" StreamGetResponseFormatJsonDecimalEncodingString StreamGetResponseFormatJsonDecimalEncoding = "string" StreamGetResponseFormatJsonDecimalEncodingBytes StreamGetResponseFormatJsonDecimalEncoding = "bytes" )
func (StreamGetResponseFormatJsonDecimalEncoding) IsKnown ¶
func (r StreamGetResponseFormatJsonDecimalEncoding) IsKnown() bool
type StreamGetResponseFormatJsonTimestampFormat ¶
type StreamGetResponseFormatJsonTimestampFormat string
const ( StreamGetResponseFormatJsonTimestampFormatRfc3339 StreamGetResponseFormatJsonTimestampFormat = "rfc3339" StreamGetResponseFormatJsonTimestampFormatUnixMillis StreamGetResponseFormatJsonTimestampFormat = "unix_millis" )
func (StreamGetResponseFormatJsonTimestampFormat) IsKnown ¶
func (r StreamGetResponseFormatJsonTimestampFormat) IsKnown() bool
type StreamGetResponseFormatJsonType ¶
type StreamGetResponseFormatJsonType string
const (
StreamGetResponseFormatJsonTypeJson StreamGetResponseFormatJsonType = "json"
)
func (StreamGetResponseFormatJsonType) IsKnown ¶
func (r StreamGetResponseFormatJsonType) IsKnown() bool
type StreamGetResponseFormatParquet ¶
type StreamGetResponseFormatParquet struct {
Type StreamGetResponseFormatParquetType `json:"type" api:"required"`
Compression StreamGetResponseFormatParquetCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON streamGetResponseFormatParquetJSON `json:"-"`
}
func (*StreamGetResponseFormatParquet) UnmarshalJSON ¶
func (r *StreamGetResponseFormatParquet) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseFormatParquetCompression ¶
type StreamGetResponseFormatParquetCompression string
const ( StreamGetResponseFormatParquetCompressionUncompressed StreamGetResponseFormatParquetCompression = "uncompressed" StreamGetResponseFormatParquetCompressionSnappy StreamGetResponseFormatParquetCompression = "snappy" StreamGetResponseFormatParquetCompressionGzip StreamGetResponseFormatParquetCompression = "gzip" StreamGetResponseFormatParquetCompressionZstd StreamGetResponseFormatParquetCompression = "zstd" StreamGetResponseFormatParquetCompressionLz4 StreamGetResponseFormatParquetCompression = "lz4" )
func (StreamGetResponseFormatParquetCompression) IsKnown ¶
func (r StreamGetResponseFormatParquetCompression) IsKnown() bool
type StreamGetResponseFormatParquetType ¶
type StreamGetResponseFormatParquetType string
const (
StreamGetResponseFormatParquetTypeParquet StreamGetResponseFormatParquetType = "parquet"
)
func (StreamGetResponseFormatParquetType) IsKnown ¶
func (r StreamGetResponseFormatParquetType) IsKnown() bool
type StreamGetResponseFormatTimestampFormat ¶
type StreamGetResponseFormatTimestampFormat string
const ( StreamGetResponseFormatTimestampFormatRfc3339 StreamGetResponseFormatTimestampFormat = "rfc3339" StreamGetResponseFormatTimestampFormatUnixMillis StreamGetResponseFormatTimestampFormat = "unix_millis" )
func (StreamGetResponseFormatTimestampFormat) IsKnown ¶
func (r StreamGetResponseFormatTimestampFormat) IsKnown() bool
type StreamGetResponseFormatType ¶
type StreamGetResponseFormatType string
const ( StreamGetResponseFormatTypeJson StreamGetResponseFormatType = "json" StreamGetResponseFormatTypeParquet StreamGetResponseFormatType = "parquet" )
func (StreamGetResponseFormatType) IsKnown ¶
func (r StreamGetResponseFormatType) IsKnown() bool
type StreamGetResponseFormatUnion ¶
type StreamGetResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the data format of the events.
Union satisfied by StreamGetResponseFormatJson or StreamGetResponseFormatParquet.
type StreamGetResponseHTTP ¶
type StreamGetResponseHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication bool `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled bool `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS StreamGetResponseHTTPCORS `json:"cors"`
JSON streamGetResponseHTTPJSON `json:"-"`
}
func (*StreamGetResponseHTTP) UnmarshalJSON ¶
func (r *StreamGetResponseHTTP) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseHTTPCORS ¶
type StreamGetResponseHTTPCORS struct {
Origins []string `json:"origins"`
JSON streamGetResponseHttpcorsJSON `json:"-"`
}
Specifies the CORS options for the HTTP endpoint.
func (*StreamGetResponseHTTPCORS) UnmarshalJSON ¶
func (r *StreamGetResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseSchema ¶
type StreamGetResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON streamGetResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*StreamGetResponseSchema) UnmarshalJSON ¶
func (r *StreamGetResponseSchema) UnmarshalJSON(data []byte) (err error)
type StreamGetResponseWorkerBinding ¶
type StreamGetResponseWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled bool `json:"enabled" api:"required"`
JSON streamGetResponseWorkerBindingJSON `json:"-"`
}
func (*StreamGetResponseWorkerBinding) UnmarshalJSON ¶
func (r *StreamGetResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)
type StreamListParams ¶
type StreamListParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Filters streams by name (case-insensitive substring).
Name param.Field[string] `query:"name"`
Page param.Field[float64] `query:"page"`
PerPage param.Field[float64] `query:"per_page"`
// Specifies the public ID of the pipeline.
PipelineID param.Field[string] `query:"pipeline_id"`
}
func (StreamListParams) URLQuery ¶
func (r StreamListParams) URLQuery() (v url.Values)
URLQuery serializes StreamListParams's query parameters as `url.Values`.
type StreamListResponse ¶
type StreamListResponse struct {
// Indicates a unique identifier for this stream.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
HTTP StreamListResponseHTTP `json:"http" api:"required"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Indicates the name of the Stream.
Name string `json:"name" api:"required"`
// Indicates the current version of this stream.
Version int64 `json:"version" api:"required"`
WorkerBinding StreamListResponseWorkerBinding `json:"worker_binding" api:"required"`
// Indicates the endpoint URL of this stream.
Endpoint string `json:"endpoint" format:"uri"`
// Defines the data format of the events.
Format StreamListResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema StreamListResponseSchema `json:"schema"`
JSON streamListResponseJSON `json:"-"`
}
func (*StreamListResponse) UnmarshalJSON ¶
func (r *StreamListResponse) UnmarshalJSON(data []byte) (err error)
type StreamListResponseFormat ¶
type StreamListResponseFormat struct {
Type StreamListResponseFormatType `json:"type" api:"required"`
Compression StreamListResponseFormatCompression `json:"compression"`
DecimalEncoding StreamListResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat StreamListResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamListResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the data format of the events.
func (StreamListResponseFormat) AsUnion ¶
func (r StreamListResponseFormat) AsUnion() StreamListResponseFormatUnion
AsUnion returns a StreamListResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are StreamListResponseFormatJson, StreamListResponseFormatParquet.
func (*StreamListResponseFormat) UnmarshalJSON ¶
func (r *StreamListResponseFormat) UnmarshalJSON(data []byte) (err error)
type StreamListResponseFormatCompression ¶
type StreamListResponseFormatCompression string
const ( StreamListResponseFormatCompressionUncompressed StreamListResponseFormatCompression = "uncompressed" StreamListResponseFormatCompressionSnappy StreamListResponseFormatCompression = "snappy" StreamListResponseFormatCompressionGzip StreamListResponseFormatCompression = "gzip" StreamListResponseFormatCompressionZstd StreamListResponseFormatCompression = "zstd" StreamListResponseFormatCompressionLz4 StreamListResponseFormatCompression = "lz4" )
func (StreamListResponseFormatCompression) IsKnown ¶
func (r StreamListResponseFormatCompression) IsKnown() bool
type StreamListResponseFormatDecimalEncoding ¶
type StreamListResponseFormatDecimalEncoding string
const ( StreamListResponseFormatDecimalEncodingNumber StreamListResponseFormatDecimalEncoding = "number" StreamListResponseFormatDecimalEncodingString StreamListResponseFormatDecimalEncoding = "string" StreamListResponseFormatDecimalEncodingBytes StreamListResponseFormatDecimalEncoding = "bytes" )
func (StreamListResponseFormatDecimalEncoding) IsKnown ¶
func (r StreamListResponseFormatDecimalEncoding) IsKnown() bool
type StreamListResponseFormatJson ¶
type StreamListResponseFormatJson struct {
Type StreamListResponseFormatJsonType `json:"type" api:"required"`
DecimalEncoding StreamListResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
TimestampFormat StreamListResponseFormatJsonTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamListResponseFormatJsonJSON `json:"-"`
}
func (*StreamListResponseFormatJson) UnmarshalJSON ¶
func (r *StreamListResponseFormatJson) UnmarshalJSON(data []byte) (err error)
type StreamListResponseFormatJsonDecimalEncoding ¶
type StreamListResponseFormatJsonDecimalEncoding string
const ( StreamListResponseFormatJsonDecimalEncodingNumber StreamListResponseFormatJsonDecimalEncoding = "number" StreamListResponseFormatJsonDecimalEncodingString StreamListResponseFormatJsonDecimalEncoding = "string" StreamListResponseFormatJsonDecimalEncodingBytes StreamListResponseFormatJsonDecimalEncoding = "bytes" )
func (StreamListResponseFormatJsonDecimalEncoding) IsKnown ¶
func (r StreamListResponseFormatJsonDecimalEncoding) IsKnown() bool
type StreamListResponseFormatJsonTimestampFormat ¶
type StreamListResponseFormatJsonTimestampFormat string
const ( StreamListResponseFormatJsonTimestampFormatRfc3339 StreamListResponseFormatJsonTimestampFormat = "rfc3339" StreamListResponseFormatJsonTimestampFormatUnixMillis StreamListResponseFormatJsonTimestampFormat = "unix_millis" )
func (StreamListResponseFormatJsonTimestampFormat) IsKnown ¶
func (r StreamListResponseFormatJsonTimestampFormat) IsKnown() bool
type StreamListResponseFormatJsonType ¶
type StreamListResponseFormatJsonType string
const (
StreamListResponseFormatJsonTypeJson StreamListResponseFormatJsonType = "json"
)
func (StreamListResponseFormatJsonType) IsKnown ¶
func (r StreamListResponseFormatJsonType) IsKnown() bool
type StreamListResponseFormatParquet ¶
type StreamListResponseFormatParquet struct {
Type StreamListResponseFormatParquetType `json:"type" api:"required"`
Compression StreamListResponseFormatParquetCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON streamListResponseFormatParquetJSON `json:"-"`
}
func (*StreamListResponseFormatParquet) UnmarshalJSON ¶
func (r *StreamListResponseFormatParquet) UnmarshalJSON(data []byte) (err error)
type StreamListResponseFormatParquetCompression ¶
type StreamListResponseFormatParquetCompression string
const ( StreamListResponseFormatParquetCompressionUncompressed StreamListResponseFormatParquetCompression = "uncompressed" StreamListResponseFormatParquetCompressionSnappy StreamListResponseFormatParquetCompression = "snappy" StreamListResponseFormatParquetCompressionGzip StreamListResponseFormatParquetCompression = "gzip" StreamListResponseFormatParquetCompressionZstd StreamListResponseFormatParquetCompression = "zstd" StreamListResponseFormatParquetCompressionLz4 StreamListResponseFormatParquetCompression = "lz4" )
func (StreamListResponseFormatParquetCompression) IsKnown ¶
func (r StreamListResponseFormatParquetCompression) IsKnown() bool
type StreamListResponseFormatParquetType ¶
type StreamListResponseFormatParquetType string
const (
StreamListResponseFormatParquetTypeParquet StreamListResponseFormatParquetType = "parquet"
)
func (StreamListResponseFormatParquetType) IsKnown ¶
func (r StreamListResponseFormatParquetType) IsKnown() bool
type StreamListResponseFormatTimestampFormat ¶
type StreamListResponseFormatTimestampFormat string
const ( StreamListResponseFormatTimestampFormatRfc3339 StreamListResponseFormatTimestampFormat = "rfc3339" StreamListResponseFormatTimestampFormatUnixMillis StreamListResponseFormatTimestampFormat = "unix_millis" )
func (StreamListResponseFormatTimestampFormat) IsKnown ¶
func (r StreamListResponseFormatTimestampFormat) IsKnown() bool
type StreamListResponseFormatType ¶
type StreamListResponseFormatType string
const ( StreamListResponseFormatTypeJson StreamListResponseFormatType = "json" StreamListResponseFormatTypeParquet StreamListResponseFormatType = "parquet" )
func (StreamListResponseFormatType) IsKnown ¶
func (r StreamListResponseFormatType) IsKnown() bool
type StreamListResponseFormatUnion ¶
type StreamListResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the data format of the events.
Union satisfied by StreamListResponseFormatJson or StreamListResponseFormatParquet.
type StreamListResponseHTTP ¶
type StreamListResponseHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication bool `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled bool `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS StreamListResponseHTTPCORS `json:"cors"`
JSON streamListResponseHTTPJSON `json:"-"`
}
func (*StreamListResponseHTTP) UnmarshalJSON ¶
func (r *StreamListResponseHTTP) UnmarshalJSON(data []byte) (err error)
type StreamListResponseHTTPCORS ¶
type StreamListResponseHTTPCORS struct {
Origins []string `json:"origins"`
JSON streamListResponseHttpcorsJSON `json:"-"`
}
Specifies the CORS options for the HTTP endpoint.
func (*StreamListResponseHTTPCORS) UnmarshalJSON ¶
func (r *StreamListResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)
type StreamListResponseSchema ¶
type StreamListResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON streamListResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*StreamListResponseSchema) UnmarshalJSON ¶
func (r *StreamListResponseSchema) UnmarshalJSON(data []byte) (err error)
type StreamListResponseWorkerBinding ¶
type StreamListResponseWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled bool `json:"enabled" api:"required"`
JSON streamListResponseWorkerBindingJSON `json:"-"`
}
func (*StreamListResponseWorkerBinding) UnmarshalJSON ¶
func (r *StreamListResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)
type StreamNewParams ¶
type StreamNewParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Specifies the name of the Stream.
Name param.Field[string] `json:"name" api:"required"`
// Defines the data format of the events.
Format param.Field[StreamNewParamsFormatUnion] `json:"format"`
HTTP param.Field[StreamNewParamsHTTP] `json:"http"`
// Defines the schema of the events in the data stream.
Schema param.Field[StreamNewParamsSchema] `json:"schema"`
WorkerBinding param.Field[StreamNewParamsWorkerBinding] `json:"worker_binding"`
}
func (StreamNewParams) MarshalJSON ¶
func (r StreamNewParams) MarshalJSON() (data []byte, err error)
type StreamNewParamsFormat ¶
type StreamNewParamsFormat struct {
Type param.Field[StreamNewParamsFormatType] `json:"type" api:"required"`
Compression param.Field[StreamNewParamsFormatCompression] `json:"compression"`
DecimalEncoding param.Field[StreamNewParamsFormatDecimalEncoding] `json:"decimal_encoding"`
RowGroupBytes param.Field[int64] `json:"row_group_bytes"`
TimestampFormat param.Field[StreamNewParamsFormatTimestampFormat] `json:"timestamp_format"`
Unstructured param.Field[bool] `json:"unstructured"`
}
Defines the data format of the events.
func (StreamNewParamsFormat) MarshalJSON ¶
func (r StreamNewParamsFormat) MarshalJSON() (data []byte, err error)
type StreamNewParamsFormatCompression ¶
type StreamNewParamsFormatCompression string
const ( StreamNewParamsFormatCompressionUncompressed StreamNewParamsFormatCompression = "uncompressed" StreamNewParamsFormatCompressionSnappy StreamNewParamsFormatCompression = "snappy" StreamNewParamsFormatCompressionGzip StreamNewParamsFormatCompression = "gzip" StreamNewParamsFormatCompressionZstd StreamNewParamsFormatCompression = "zstd" StreamNewParamsFormatCompressionLz4 StreamNewParamsFormatCompression = "lz4" )
func (StreamNewParamsFormatCompression) IsKnown ¶
func (r StreamNewParamsFormatCompression) IsKnown() bool
type StreamNewParamsFormatDecimalEncoding ¶
type StreamNewParamsFormatDecimalEncoding string
const ( StreamNewParamsFormatDecimalEncodingNumber StreamNewParamsFormatDecimalEncoding = "number" StreamNewParamsFormatDecimalEncodingString StreamNewParamsFormatDecimalEncoding = "string" StreamNewParamsFormatDecimalEncodingBytes StreamNewParamsFormatDecimalEncoding = "bytes" )
func (StreamNewParamsFormatDecimalEncoding) IsKnown ¶
func (r StreamNewParamsFormatDecimalEncoding) IsKnown() bool
type StreamNewParamsFormatJson ¶
type StreamNewParamsFormatJson struct {
Type param.Field[StreamNewParamsFormatJsonType] `json:"type" api:"required"`
DecimalEncoding param.Field[StreamNewParamsFormatJsonDecimalEncoding] `json:"decimal_encoding"`
TimestampFormat param.Field[StreamNewParamsFormatJsonTimestampFormat] `json:"timestamp_format"`
Unstructured param.Field[bool] `json:"unstructured"`
}
func (StreamNewParamsFormatJson) MarshalJSON ¶
func (r StreamNewParamsFormatJson) MarshalJSON() (data []byte, err error)
type StreamNewParamsFormatJsonDecimalEncoding ¶
type StreamNewParamsFormatJsonDecimalEncoding string
const ( StreamNewParamsFormatJsonDecimalEncodingNumber StreamNewParamsFormatJsonDecimalEncoding = "number" StreamNewParamsFormatJsonDecimalEncodingString StreamNewParamsFormatJsonDecimalEncoding = "string" StreamNewParamsFormatJsonDecimalEncodingBytes StreamNewParamsFormatJsonDecimalEncoding = "bytes" )
func (StreamNewParamsFormatJsonDecimalEncoding) IsKnown ¶
func (r StreamNewParamsFormatJsonDecimalEncoding) IsKnown() bool
type StreamNewParamsFormatJsonTimestampFormat ¶
type StreamNewParamsFormatJsonTimestampFormat string
const ( StreamNewParamsFormatJsonTimestampFormatRfc3339 StreamNewParamsFormatJsonTimestampFormat = "rfc3339" StreamNewParamsFormatJsonTimestampFormatUnixMillis StreamNewParamsFormatJsonTimestampFormat = "unix_millis" )
func (StreamNewParamsFormatJsonTimestampFormat) IsKnown ¶
func (r StreamNewParamsFormatJsonTimestampFormat) IsKnown() bool
type StreamNewParamsFormatJsonType ¶
type StreamNewParamsFormatJsonType string
const (
StreamNewParamsFormatJsonTypeJson StreamNewParamsFormatJsonType = "json"
)
func (StreamNewParamsFormatJsonType) IsKnown ¶
func (r StreamNewParamsFormatJsonType) IsKnown() bool
type StreamNewParamsFormatParquet ¶
type StreamNewParamsFormatParquet struct {
Type param.Field[StreamNewParamsFormatParquetType] `json:"type" api:"required"`
Compression param.Field[StreamNewParamsFormatParquetCompression] `json:"compression"`
RowGroupBytes param.Field[int64] `json:"row_group_bytes"`
}
func (StreamNewParamsFormatParquet) MarshalJSON ¶
func (r StreamNewParamsFormatParquet) MarshalJSON() (data []byte, err error)
type StreamNewParamsFormatParquetCompression ¶
type StreamNewParamsFormatParquetCompression string
const ( StreamNewParamsFormatParquetCompressionUncompressed StreamNewParamsFormatParquetCompression = "uncompressed" StreamNewParamsFormatParquetCompressionSnappy StreamNewParamsFormatParquetCompression = "snappy" StreamNewParamsFormatParquetCompressionGzip StreamNewParamsFormatParquetCompression = "gzip" StreamNewParamsFormatParquetCompressionZstd StreamNewParamsFormatParquetCompression = "zstd" StreamNewParamsFormatParquetCompressionLz4 StreamNewParamsFormatParquetCompression = "lz4" )
func (StreamNewParamsFormatParquetCompression) IsKnown ¶
func (r StreamNewParamsFormatParquetCompression) IsKnown() bool
type StreamNewParamsFormatParquetType ¶
type StreamNewParamsFormatParquetType string
const (
StreamNewParamsFormatParquetTypeParquet StreamNewParamsFormatParquetType = "parquet"
)
func (StreamNewParamsFormatParquetType) IsKnown ¶
func (r StreamNewParamsFormatParquetType) IsKnown() bool
type StreamNewParamsFormatTimestampFormat ¶
type StreamNewParamsFormatTimestampFormat string
const ( StreamNewParamsFormatTimestampFormatRfc3339 StreamNewParamsFormatTimestampFormat = "rfc3339" StreamNewParamsFormatTimestampFormatUnixMillis StreamNewParamsFormatTimestampFormat = "unix_millis" )
func (StreamNewParamsFormatTimestampFormat) IsKnown ¶
func (r StreamNewParamsFormatTimestampFormat) IsKnown() bool
type StreamNewParamsFormatType ¶
type StreamNewParamsFormatType string
const ( StreamNewParamsFormatTypeJson StreamNewParamsFormatType = "json" StreamNewParamsFormatTypeParquet StreamNewParamsFormatType = "parquet" )
func (StreamNewParamsFormatType) IsKnown ¶
func (r StreamNewParamsFormatType) IsKnown() bool
type StreamNewParamsFormatUnion ¶
type StreamNewParamsFormatUnion interface {
// contains filtered or unexported methods
}
Defines the data format of the events.
Satisfied by pipelines.StreamNewParamsFormatJson, pipelines.StreamNewParamsFormatParquet, StreamNewParamsFormat.
type StreamNewParamsHTTP ¶
type StreamNewParamsHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication param.Field[bool] `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled param.Field[bool] `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS param.Field[StreamNewParamsHTTPCORS] `json:"cors"`
}
func (StreamNewParamsHTTP) MarshalJSON ¶
func (r StreamNewParamsHTTP) MarshalJSON() (data []byte, err error)
type StreamNewParamsHTTPCORS ¶
Specifies the CORS options for the HTTP endpoint.
func (StreamNewParamsHTTPCORS) MarshalJSON ¶
func (r StreamNewParamsHTTPCORS) MarshalJSON() (data []byte, err error)
type StreamNewParamsSchema ¶
type StreamNewParamsSchema struct {
Fields param.Field[[]SourceFieldUnionParam] `json:"fields"`
Inferred param.Field[bool] `json:"inferred"`
}
Defines the schema of the events in the data stream.
func (StreamNewParamsSchema) MarshalJSON ¶
func (r StreamNewParamsSchema) MarshalJSON() (data []byte, err error)
type StreamNewParamsWorkerBinding ¶
type StreamNewParamsWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled param.Field[bool] `json:"enabled" api:"required"`
}
func (StreamNewParamsWorkerBinding) MarshalJSON ¶
func (r StreamNewParamsWorkerBinding) MarshalJSON() (data []byte, err error)
type StreamNewResponse ¶
type StreamNewResponse struct {
// Indicates a unique identifier for this stream.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
HTTP StreamNewResponseHTTP `json:"http" api:"required"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Indicates the name of the Stream.
Name string `json:"name" api:"required"`
// Indicates the current version of this stream.
Version int64 `json:"version" api:"required"`
WorkerBinding StreamNewResponseWorkerBinding `json:"worker_binding" api:"required"`
// Indicates the endpoint URL of this stream.
Endpoint string `json:"endpoint" format:"uri"`
// Defines the data format of the events.
Format StreamNewResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema StreamNewResponseSchema `json:"schema"`
JSON streamNewResponseJSON `json:"-"`
}
func (*StreamNewResponse) UnmarshalJSON ¶
func (r *StreamNewResponse) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseEnvelope ¶
type StreamNewResponseEnvelope struct {
Result StreamNewResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON streamNewResponseEnvelopeJSON `json:"-"`
}
func (*StreamNewResponseEnvelope) UnmarshalJSON ¶
func (r *StreamNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseFormat ¶
type StreamNewResponseFormat struct {
Type StreamNewResponseFormatType `json:"type" api:"required"`
Compression StreamNewResponseFormatCompression `json:"compression"`
DecimalEncoding StreamNewResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat StreamNewResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamNewResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the data format of the events.
func (StreamNewResponseFormat) AsUnion ¶
func (r StreamNewResponseFormat) AsUnion() StreamNewResponseFormatUnion
AsUnion returns a StreamNewResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are StreamNewResponseFormatJson, StreamNewResponseFormatParquet.
func (*StreamNewResponseFormat) UnmarshalJSON ¶
func (r *StreamNewResponseFormat) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseFormatCompression ¶
type StreamNewResponseFormatCompression string
const ( StreamNewResponseFormatCompressionUncompressed StreamNewResponseFormatCompression = "uncompressed" StreamNewResponseFormatCompressionSnappy StreamNewResponseFormatCompression = "snappy" StreamNewResponseFormatCompressionGzip StreamNewResponseFormatCompression = "gzip" StreamNewResponseFormatCompressionZstd StreamNewResponseFormatCompression = "zstd" StreamNewResponseFormatCompressionLz4 StreamNewResponseFormatCompression = "lz4" )
func (StreamNewResponseFormatCompression) IsKnown ¶
func (r StreamNewResponseFormatCompression) IsKnown() bool
type StreamNewResponseFormatDecimalEncoding ¶
type StreamNewResponseFormatDecimalEncoding string
const ( StreamNewResponseFormatDecimalEncodingNumber StreamNewResponseFormatDecimalEncoding = "number" StreamNewResponseFormatDecimalEncodingString StreamNewResponseFormatDecimalEncoding = "string" StreamNewResponseFormatDecimalEncodingBytes StreamNewResponseFormatDecimalEncoding = "bytes" )
func (StreamNewResponseFormatDecimalEncoding) IsKnown ¶
func (r StreamNewResponseFormatDecimalEncoding) IsKnown() bool
type StreamNewResponseFormatJson ¶
type StreamNewResponseFormatJson struct {
Type StreamNewResponseFormatJsonType `json:"type" api:"required"`
DecimalEncoding StreamNewResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
TimestampFormat StreamNewResponseFormatJsonTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamNewResponseFormatJsonJSON `json:"-"`
}
func (*StreamNewResponseFormatJson) UnmarshalJSON ¶
func (r *StreamNewResponseFormatJson) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseFormatJsonDecimalEncoding ¶
type StreamNewResponseFormatJsonDecimalEncoding string
const ( StreamNewResponseFormatJsonDecimalEncodingNumber StreamNewResponseFormatJsonDecimalEncoding = "number" StreamNewResponseFormatJsonDecimalEncodingString StreamNewResponseFormatJsonDecimalEncoding = "string" StreamNewResponseFormatJsonDecimalEncodingBytes StreamNewResponseFormatJsonDecimalEncoding = "bytes" )
func (StreamNewResponseFormatJsonDecimalEncoding) IsKnown ¶
func (r StreamNewResponseFormatJsonDecimalEncoding) IsKnown() bool
type StreamNewResponseFormatJsonTimestampFormat ¶
type StreamNewResponseFormatJsonTimestampFormat string
const ( StreamNewResponseFormatJsonTimestampFormatRfc3339 StreamNewResponseFormatJsonTimestampFormat = "rfc3339" StreamNewResponseFormatJsonTimestampFormatUnixMillis StreamNewResponseFormatJsonTimestampFormat = "unix_millis" )
func (StreamNewResponseFormatJsonTimestampFormat) IsKnown ¶
func (r StreamNewResponseFormatJsonTimestampFormat) IsKnown() bool
type StreamNewResponseFormatJsonType ¶
type StreamNewResponseFormatJsonType string
const (
StreamNewResponseFormatJsonTypeJson StreamNewResponseFormatJsonType = "json"
)
func (StreamNewResponseFormatJsonType) IsKnown ¶
func (r StreamNewResponseFormatJsonType) IsKnown() bool
type StreamNewResponseFormatParquet ¶
type StreamNewResponseFormatParquet struct {
Type StreamNewResponseFormatParquetType `json:"type" api:"required"`
Compression StreamNewResponseFormatParquetCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON streamNewResponseFormatParquetJSON `json:"-"`
}
func (*StreamNewResponseFormatParquet) UnmarshalJSON ¶
func (r *StreamNewResponseFormatParquet) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseFormatParquetCompression ¶
type StreamNewResponseFormatParquetCompression string
const ( StreamNewResponseFormatParquetCompressionUncompressed StreamNewResponseFormatParquetCompression = "uncompressed" StreamNewResponseFormatParquetCompressionSnappy StreamNewResponseFormatParquetCompression = "snappy" StreamNewResponseFormatParquetCompressionGzip StreamNewResponseFormatParquetCompression = "gzip" StreamNewResponseFormatParquetCompressionZstd StreamNewResponseFormatParquetCompression = "zstd" StreamNewResponseFormatParquetCompressionLz4 StreamNewResponseFormatParquetCompression = "lz4" )
func (StreamNewResponseFormatParquetCompression) IsKnown ¶
func (r StreamNewResponseFormatParquetCompression) IsKnown() bool
type StreamNewResponseFormatParquetType ¶
type StreamNewResponseFormatParquetType string
const (
StreamNewResponseFormatParquetTypeParquet StreamNewResponseFormatParquetType = "parquet"
)
func (StreamNewResponseFormatParquetType) IsKnown ¶
func (r StreamNewResponseFormatParquetType) IsKnown() bool
type StreamNewResponseFormatTimestampFormat ¶
type StreamNewResponseFormatTimestampFormat string
const ( StreamNewResponseFormatTimestampFormatRfc3339 StreamNewResponseFormatTimestampFormat = "rfc3339" StreamNewResponseFormatTimestampFormatUnixMillis StreamNewResponseFormatTimestampFormat = "unix_millis" )
func (StreamNewResponseFormatTimestampFormat) IsKnown ¶
func (r StreamNewResponseFormatTimestampFormat) IsKnown() bool
type StreamNewResponseFormatType ¶
type StreamNewResponseFormatType string
const ( StreamNewResponseFormatTypeJson StreamNewResponseFormatType = "json" StreamNewResponseFormatTypeParquet StreamNewResponseFormatType = "parquet" )
func (StreamNewResponseFormatType) IsKnown ¶
func (r StreamNewResponseFormatType) IsKnown() bool
type StreamNewResponseFormatUnion ¶
type StreamNewResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the data format of the events.
Union satisfied by StreamNewResponseFormatJson or StreamNewResponseFormatParquet.
type StreamNewResponseHTTP ¶
type StreamNewResponseHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication bool `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled bool `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS StreamNewResponseHTTPCORS `json:"cors"`
JSON streamNewResponseHTTPJSON `json:"-"`
}
func (*StreamNewResponseHTTP) UnmarshalJSON ¶
func (r *StreamNewResponseHTTP) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseHTTPCORS ¶
type StreamNewResponseHTTPCORS struct {
Origins []string `json:"origins"`
JSON streamNewResponseHttpcorsJSON `json:"-"`
}
Specifies the CORS options for the HTTP endpoint.
func (*StreamNewResponseHTTPCORS) UnmarshalJSON ¶
func (r *StreamNewResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseSchema ¶
type StreamNewResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON streamNewResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*StreamNewResponseSchema) UnmarshalJSON ¶
func (r *StreamNewResponseSchema) UnmarshalJSON(data []byte) (err error)
type StreamNewResponseWorkerBinding ¶
type StreamNewResponseWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled bool `json:"enabled" api:"required"`
JSON streamNewResponseWorkerBindingJSON `json:"-"`
}
func (*StreamNewResponseWorkerBinding) UnmarshalJSON ¶
func (r *StreamNewResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)
type StreamService ¶
type StreamService struct {
Options []option.RequestOption
}
StreamService 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 NewStreamService method instead.
func NewStreamService ¶
func NewStreamService(opts ...option.RequestOption) (r *StreamService)
NewStreamService 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 (*StreamService) Delete ¶
func (r *StreamService) Delete(ctx context.Context, streamID string, body StreamDeleteParams, opts ...option.RequestOption) (res *StreamDeleteResponse, err error)
Delete Stream in Account.
func (*StreamService) Get ¶
func (r *StreamService) Get(ctx context.Context, streamID string, query StreamGetParams, opts ...option.RequestOption) (res *StreamGetResponse, err error)
Get Stream Details.
func (*StreamService) List ¶
func (r *StreamService) List(ctx context.Context, params StreamListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[StreamListResponse], err error)
List/Filter Streams in Account.
func (*StreamService) ListAutoPaging ¶
func (r *StreamService) ListAutoPaging(ctx context.Context, params StreamListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[StreamListResponse]
List/Filter Streams in Account.
func (*StreamService) New ¶
func (r *StreamService) New(ctx context.Context, params StreamNewParams, opts ...option.RequestOption) (res *StreamNewResponse, err error)
Create a new Stream.
func (*StreamService) Update ¶
func (r *StreamService) Update(ctx context.Context, streamID string, params StreamUpdateParams, opts ...option.RequestOption) (res *StreamUpdateResponse, err error)
Update a Stream.
type StreamUpdateParams ¶
type StreamUpdateParams struct {
// Specifies the public ID of the account.
AccountID param.Field[string] `path:"account_id" api:"required"`
HTTP param.Field[StreamUpdateParamsHTTP] `json:"http"`
WorkerBinding param.Field[StreamUpdateParamsWorkerBinding] `json:"worker_binding"`
}
func (StreamUpdateParams) MarshalJSON ¶
func (r StreamUpdateParams) MarshalJSON() (data []byte, err error)
type StreamUpdateParamsHTTP ¶
type StreamUpdateParamsHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication param.Field[bool] `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled param.Field[bool] `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS param.Field[StreamUpdateParamsHTTPCORS] `json:"cors"`
}
func (StreamUpdateParamsHTTP) MarshalJSON ¶
func (r StreamUpdateParamsHTTP) MarshalJSON() (data []byte, err error)
type StreamUpdateParamsHTTPCORS ¶
Specifies the CORS options for the HTTP endpoint.
func (StreamUpdateParamsHTTPCORS) MarshalJSON ¶
func (r StreamUpdateParamsHTTPCORS) MarshalJSON() (data []byte, err error)
type StreamUpdateParamsWorkerBinding ¶
type StreamUpdateParamsWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled param.Field[bool] `json:"enabled" api:"required"`
}
func (StreamUpdateParamsWorkerBinding) MarshalJSON ¶
func (r StreamUpdateParamsWorkerBinding) MarshalJSON() (data []byte, err error)
type StreamUpdateResponse ¶
type StreamUpdateResponse struct {
// Indicates a unique identifier for this stream.
ID string `json:"id" api:"required"`
CreatedAt time.Time `json:"created_at" api:"required" format:"date-time"`
HTTP StreamUpdateResponseHTTP `json:"http" api:"required"`
ModifiedAt time.Time `json:"modified_at" api:"required" format:"date-time"`
// Indicates the name of the Stream.
Name string `json:"name" api:"required"`
// Indicates the current version of this stream.
Version int64 `json:"version" api:"required"`
WorkerBinding StreamUpdateResponseWorkerBinding `json:"worker_binding" api:"required"`
// Indicates the endpoint URL of this stream.
Endpoint string `json:"endpoint" format:"uri"`
// Defines the data format of the events.
Format StreamUpdateResponseFormat `json:"format"`
// Defines the schema of the events in the data stream.
Schema StreamUpdateResponseSchema `json:"schema"`
JSON streamUpdateResponseJSON `json:"-"`
}
func (*StreamUpdateResponse) UnmarshalJSON ¶
func (r *StreamUpdateResponse) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseEnvelope ¶
type StreamUpdateResponseEnvelope struct {
Result StreamUpdateResponse `json:"result" api:"required"`
// Indicates whether the API call was successful.
Success bool `json:"success" api:"required"`
JSON streamUpdateResponseEnvelopeJSON `json:"-"`
}
func (*StreamUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *StreamUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseFormat ¶
type StreamUpdateResponseFormat struct {
Type StreamUpdateResponseFormatType `json:"type" api:"required"`
Compression StreamUpdateResponseFormatCompression `json:"compression"`
DecimalEncoding StreamUpdateResponseFormatDecimalEncoding `json:"decimal_encoding"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
TimestampFormat StreamUpdateResponseFormatTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamUpdateResponseFormatJSON `json:"-"`
// contains filtered or unexported fields
}
Defines the data format of the events.
func (StreamUpdateResponseFormat) AsUnion ¶
func (r StreamUpdateResponseFormat) AsUnion() StreamUpdateResponseFormatUnion
AsUnion returns a StreamUpdateResponseFormatUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are StreamUpdateResponseFormatJson, StreamUpdateResponseFormatParquet.
func (*StreamUpdateResponseFormat) UnmarshalJSON ¶
func (r *StreamUpdateResponseFormat) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseFormatCompression ¶
type StreamUpdateResponseFormatCompression string
const ( StreamUpdateResponseFormatCompressionUncompressed StreamUpdateResponseFormatCompression = "uncompressed" StreamUpdateResponseFormatCompressionSnappy StreamUpdateResponseFormatCompression = "snappy" StreamUpdateResponseFormatCompressionGzip StreamUpdateResponseFormatCompression = "gzip" StreamUpdateResponseFormatCompressionZstd StreamUpdateResponseFormatCompression = "zstd" StreamUpdateResponseFormatCompressionLz4 StreamUpdateResponseFormatCompression = "lz4" )
func (StreamUpdateResponseFormatCompression) IsKnown ¶
func (r StreamUpdateResponseFormatCompression) IsKnown() bool
type StreamUpdateResponseFormatDecimalEncoding ¶
type StreamUpdateResponseFormatDecimalEncoding string
const ( StreamUpdateResponseFormatDecimalEncodingNumber StreamUpdateResponseFormatDecimalEncoding = "number" StreamUpdateResponseFormatDecimalEncodingString StreamUpdateResponseFormatDecimalEncoding = "string" StreamUpdateResponseFormatDecimalEncodingBytes StreamUpdateResponseFormatDecimalEncoding = "bytes" )
func (StreamUpdateResponseFormatDecimalEncoding) IsKnown ¶
func (r StreamUpdateResponseFormatDecimalEncoding) IsKnown() bool
type StreamUpdateResponseFormatJson ¶
type StreamUpdateResponseFormatJson struct {
Type StreamUpdateResponseFormatJsonType `json:"type" api:"required"`
DecimalEncoding StreamUpdateResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
TimestampFormat StreamUpdateResponseFormatJsonTimestampFormat `json:"timestamp_format"`
Unstructured bool `json:"unstructured"`
JSON streamUpdateResponseFormatJsonJSON `json:"-"`
}
func (*StreamUpdateResponseFormatJson) UnmarshalJSON ¶
func (r *StreamUpdateResponseFormatJson) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseFormatJsonDecimalEncoding ¶
type StreamUpdateResponseFormatJsonDecimalEncoding string
const ( StreamUpdateResponseFormatJsonDecimalEncodingNumber StreamUpdateResponseFormatJsonDecimalEncoding = "number" StreamUpdateResponseFormatJsonDecimalEncodingString StreamUpdateResponseFormatJsonDecimalEncoding = "string" StreamUpdateResponseFormatJsonDecimalEncodingBytes StreamUpdateResponseFormatJsonDecimalEncoding = "bytes" )
func (StreamUpdateResponseFormatJsonDecimalEncoding) IsKnown ¶
func (r StreamUpdateResponseFormatJsonDecimalEncoding) IsKnown() bool
type StreamUpdateResponseFormatJsonTimestampFormat ¶
type StreamUpdateResponseFormatJsonTimestampFormat string
const ( StreamUpdateResponseFormatJsonTimestampFormatRfc3339 StreamUpdateResponseFormatJsonTimestampFormat = "rfc3339" StreamUpdateResponseFormatJsonTimestampFormatUnixMillis StreamUpdateResponseFormatJsonTimestampFormat = "unix_millis" )
func (StreamUpdateResponseFormatJsonTimestampFormat) IsKnown ¶
func (r StreamUpdateResponseFormatJsonTimestampFormat) IsKnown() bool
type StreamUpdateResponseFormatJsonType ¶
type StreamUpdateResponseFormatJsonType string
const (
StreamUpdateResponseFormatJsonTypeJson StreamUpdateResponseFormatJsonType = "json"
)
func (StreamUpdateResponseFormatJsonType) IsKnown ¶
func (r StreamUpdateResponseFormatJsonType) IsKnown() bool
type StreamUpdateResponseFormatParquet ¶
type StreamUpdateResponseFormatParquet struct {
Type StreamUpdateResponseFormatParquetType `json:"type" api:"required"`
Compression StreamUpdateResponseFormatParquetCompression `json:"compression"`
RowGroupBytes int64 `json:"row_group_bytes" api:"nullable"`
JSON streamUpdateResponseFormatParquetJSON `json:"-"`
}
func (*StreamUpdateResponseFormatParquet) UnmarshalJSON ¶
func (r *StreamUpdateResponseFormatParquet) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseFormatParquetCompression ¶
type StreamUpdateResponseFormatParquetCompression string
const ( StreamUpdateResponseFormatParquetCompressionUncompressed StreamUpdateResponseFormatParquetCompression = "uncompressed" StreamUpdateResponseFormatParquetCompressionSnappy StreamUpdateResponseFormatParquetCompression = "snappy" StreamUpdateResponseFormatParquetCompressionGzip StreamUpdateResponseFormatParquetCompression = "gzip" StreamUpdateResponseFormatParquetCompressionZstd StreamUpdateResponseFormatParquetCompression = "zstd" StreamUpdateResponseFormatParquetCompressionLz4 StreamUpdateResponseFormatParquetCompression = "lz4" )
func (StreamUpdateResponseFormatParquetCompression) IsKnown ¶
func (r StreamUpdateResponseFormatParquetCompression) IsKnown() bool
type StreamUpdateResponseFormatParquetType ¶
type StreamUpdateResponseFormatParquetType string
const (
StreamUpdateResponseFormatParquetTypeParquet StreamUpdateResponseFormatParquetType = "parquet"
)
func (StreamUpdateResponseFormatParquetType) IsKnown ¶
func (r StreamUpdateResponseFormatParquetType) IsKnown() bool
type StreamUpdateResponseFormatTimestampFormat ¶
type StreamUpdateResponseFormatTimestampFormat string
const ( StreamUpdateResponseFormatTimestampFormatRfc3339 StreamUpdateResponseFormatTimestampFormat = "rfc3339" StreamUpdateResponseFormatTimestampFormatUnixMillis StreamUpdateResponseFormatTimestampFormat = "unix_millis" )
func (StreamUpdateResponseFormatTimestampFormat) IsKnown ¶
func (r StreamUpdateResponseFormatTimestampFormat) IsKnown() bool
type StreamUpdateResponseFormatType ¶
type StreamUpdateResponseFormatType string
const ( StreamUpdateResponseFormatTypeJson StreamUpdateResponseFormatType = "json" StreamUpdateResponseFormatTypeParquet StreamUpdateResponseFormatType = "parquet" )
func (StreamUpdateResponseFormatType) IsKnown ¶
func (r StreamUpdateResponseFormatType) IsKnown() bool
type StreamUpdateResponseFormatUnion ¶
type StreamUpdateResponseFormatUnion interface {
// contains filtered or unexported methods
}
Defines the data format of the events.
Union satisfied by StreamUpdateResponseFormatJson or StreamUpdateResponseFormatParquet.
type StreamUpdateResponseHTTP ¶
type StreamUpdateResponseHTTP struct {
// Indicates that authentication is required for the HTTP endpoint.
Authentication bool `json:"authentication" api:"required"`
// Indicates that the HTTP endpoint is enabled.
Enabled bool `json:"enabled" api:"required"`
// Specifies the CORS options for the HTTP endpoint.
CORS StreamUpdateResponseHTTPCORS `json:"cors"`
JSON streamUpdateResponseHTTPJSON `json:"-"`
}
func (*StreamUpdateResponseHTTP) UnmarshalJSON ¶
func (r *StreamUpdateResponseHTTP) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseHTTPCORS ¶
type StreamUpdateResponseHTTPCORS struct {
Origins []string `json:"origins"`
JSON streamUpdateResponseHttpcorsJSON `json:"-"`
}
Specifies the CORS options for the HTTP endpoint.
func (*StreamUpdateResponseHTTPCORS) UnmarshalJSON ¶
func (r *StreamUpdateResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseSchema ¶ added in v7.10.0
type StreamUpdateResponseSchema struct {
Fields []SourceField `json:"fields"`
Inferred bool `json:"inferred" api:"nullable"`
JSON streamUpdateResponseSchemaJSON `json:"-"`
}
Defines the schema of the events in the data stream.
func (*StreamUpdateResponseSchema) UnmarshalJSON ¶ added in v7.10.0
func (r *StreamUpdateResponseSchema) UnmarshalJSON(data []byte) (err error)
type StreamUpdateResponseWorkerBinding ¶
type StreamUpdateResponseWorkerBinding struct {
// Indicates that the worker binding is enabled.
Enabled bool `json:"enabled" api:"required"`
JSON streamUpdateResponseWorkerBindingJSON `json:"-"`
}
func (*StreamUpdateResponseWorkerBinding) UnmarshalJSON ¶
func (r *StreamUpdateResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)
type StructField ¶
type StructField struct {
Fields []SourceField `json:"fields" api:"required"`
Name string `json:"name" api:"nullable"`
JSON structFieldJSON `json:"-"`
}
func (*StructField) UnmarshalJSON ¶
func (r *StructField) UnmarshalJSON(data []byte) (err error)
type StructFieldParam ¶
type StructFieldParam struct {
Fields param.Field[[]SourceFieldUnionParam] `json:"fields" api:"required"`
Name param.Field[string] `json:"name"`
}
func (StructFieldParam) MarshalJSON ¶
func (r StructFieldParam) MarshalJSON() (data []byte, err error)
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.