pipelines

package
v6.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 20, 2025 License: Apache-2.0 Imports: 17 Imported by: 1

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

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 Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

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 Permission

type Permission = shared.Permission

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 PipelineDeleteParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PipelineDeleteV1Params added in v6.3.0

type PipelineDeleteV1Params struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PipelineGetParams

type PipelineGetParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PipelineGetResponse deprecated

type PipelineGetResponse struct {
	// Specifies the pipeline identifier.
	ID          string                         `json:"id,required"`
	Destination PipelineGetResponseDestination `json:"destination,required"`
	// Indicates the endpoint URL to send traffic.
	Endpoint string `json:"endpoint,required"`
	// Defines the name of the pipeline.
	Name   string                      `json:"name,required"`
	Source []PipelineGetResponseSource `json:"source,required"`
	// Indicates the version number of last saved configuration.
	Version float64                 `json:"version,required"`
	JSON    pipelineGetResponseJSON `json:"-"`
}

[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.

Deprecated: deprecated

func (*PipelineGetResponse) UnmarshalJSON

func (r *PipelineGetResponse) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseDestination

type PipelineGetResponseDestination struct {
	Batch       PipelineGetResponseDestinationBatch       `json:"batch,required"`
	Compression PipelineGetResponseDestinationCompression `json:"compression,required"`
	// Specifies the format of data to deliver.
	Format PipelineGetResponseDestinationFormat `json:"format,required"`
	Path   PipelineGetResponseDestinationPath   `json:"path,required"`
	// Specifies the type of destination.
	Type PipelineGetResponseDestinationType `json:"type,required"`
	JSON pipelineGetResponseDestinationJSON `json:"-"`
}

func (*PipelineGetResponseDestination) UnmarshalJSON

func (r *PipelineGetResponseDestination) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseDestinationBatch

type PipelineGetResponseDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes int64 `json:"max_bytes,required"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS float64 `json:"max_duration_s,required"`
	// Specifies rough maximum number of rows per file.
	MaxRows int64                                   `json:"max_rows,required"`
	JSON    pipelineGetResponseDestinationBatchJSON `json:"-"`
}

func (*PipelineGetResponseDestinationBatch) UnmarshalJSON

func (r *PipelineGetResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseDestinationCompression

type PipelineGetResponseDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type PipelineGetResponseDestinationCompressionType `json:"type,required"`
	JSON pipelineGetResponseDestinationCompressionJSON `json:"-"`
}

func (*PipelineGetResponseDestinationCompression) UnmarshalJSON

func (r *PipelineGetResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseDestinationCompressionType

type PipelineGetResponseDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineGetResponseDestinationCompressionTypeNone    PipelineGetResponseDestinationCompressionType = "none"
	PipelineGetResponseDestinationCompressionTypeGzip    PipelineGetResponseDestinationCompressionType = "gzip"
	PipelineGetResponseDestinationCompressionTypeDeflate PipelineGetResponseDestinationCompressionType = "deflate"
)

func (PipelineGetResponseDestinationCompressionType) IsKnown

type PipelineGetResponseDestinationFormat

type PipelineGetResponseDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineGetResponseDestinationFormatJson PipelineGetResponseDestinationFormat = "json"
)

func (PipelineGetResponseDestinationFormat) IsKnown

type PipelineGetResponseDestinationPath

type PipelineGetResponseDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket string `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename string `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath string `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix string                                 `json:"prefix"`
	JSON   pipelineGetResponseDestinationPathJSON `json:"-"`
}

func (*PipelineGetResponseDestinationPath) UnmarshalJSON

func (r *PipelineGetResponseDestinationPath) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseDestinationType

type PipelineGetResponseDestinationType string

Specifies the type of destination.

const (
	PipelineGetResponseDestinationTypeR2 PipelineGetResponseDestinationType = "r2"
)

func (PipelineGetResponseDestinationType) IsKnown

type PipelineGetResponseEnvelope

type PipelineGetResponseEnvelope struct {
	// [DEPRECATED] Describes the configuration of a pipeline. Use the new
	// streams/sinks/pipelines API instead.
	//
	// Deprecated: deprecated
	Result PipelineGetResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                            `json:"success,required"`
	JSON    pipelineGetResponseEnvelopeJSON `json:"-"`
}

func (*PipelineGetResponseEnvelope) UnmarshalJSON

func (r *PipelineGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseSource

type PipelineGetResponseSource struct {
	// Specifies the format of source data.
	Format PipelineGetResponseSourceFormat `json:"format,required"`
	Type   string                          `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool `json:"authentication"`
	// This field can have the runtime type of
	// [PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
	CORS interface{}                   `json:"cors"`
	JSON pipelineGetResponseSourceJSON `json:"-"`
	// contains filtered or unexported fields
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineGetResponseSource) AsUnion

AsUnion returns a PipelineGetResponseSourceUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.

func (*PipelineGetResponseSource) UnmarshalJSON

func (r *PipelineGetResponseSource) UnmarshalJSON(data []byte) (err error)

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
	Type   string                                                                          `json:"type,required"`
	JSON   pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON   `json:"-"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
	Type   string                                                                       `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool                                                                       `json:"authentication"`
	CORS           PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
	JSON           pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins []string                                                                       `json:"origins"`
	JSON    pipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}

func (*PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineGetResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineGetResponseSourceFormat

type PipelineGetResponseSourceFormat string

Specifies the format of source data.

const (
	PipelineGetResponseSourceFormatJson PipelineGetResponseSourceFormat = "json"
)

func (PipelineGetResponseSourceFormat) IsKnown

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 added in v6.3.0

type PipelineGetV1Params struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type PipelineGetV1Response added in v6.3.0

type PipelineGetV1Response struct {
	// Indicates a unique identifier for this pipeline.
	ID         string `json:"id,required"`
	CreatedAt  string `json:"created_at,required"`
	ModifiedAt string `json:"modified_at,required"`
	// Indicates the name of the Pipeline.
	Name string `json:"name,required"`
	// Specifies SQL for the Pipeline processing flow.
	Sql string `json:"sql,required"`
	// Indicates the current status of the Pipeline.
	Status string `json:"status,required"`
	// List of streams and sinks used by this pipeline.
	Tables []PipelineGetV1ResponseTable `json:"tables,required"`
	JSON   pipelineGetV1ResponseJSON    `json:"-"`
}

func (*PipelineGetV1Response) UnmarshalJSON added in v6.3.0

func (r *PipelineGetV1Response) UnmarshalJSON(data []byte) (err error)

type PipelineGetV1ResponseEnvelope added in v6.3.0

type PipelineGetV1ResponseEnvelope struct {
	Result PipelineGetV1Response `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                              `json:"success,required"`
	JSON    pipelineGetV1ResponseEnvelopeJSON `json:"-"`
}

func (*PipelineGetV1ResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *PipelineGetV1ResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type PipelineGetV1ResponseTable added in v6.3.0

type PipelineGetV1ResponseTable struct {
	// Unique identifier for the connection (stream or sink).
	ID string `json:"id,required"`
	// Latest available version of the connection.
	Latest int64 `json:"latest,required"`
	// Name of the connection.
	Name string `json:"name,required"`
	// Type of the connection.
	Type PipelineGetV1ResponseTablesType `json:"type,required"`
	// Current version of the connection used by this pipeline.
	Version int64                          `json:"version,required"`
	JSON    pipelineGetV1ResponseTableJSON `json:"-"`
}

func (*PipelineGetV1ResponseTable) UnmarshalJSON added in v6.3.0

func (r *PipelineGetV1ResponseTable) UnmarshalJSON(data []byte) (err error)

type PipelineGetV1ResponseTablesType added in v6.3.0

type PipelineGetV1ResponseTablesType string

Type of the connection.

const (
	PipelineGetV1ResponseTablesTypeStream PipelineGetV1ResponseTablesType = "stream"
	PipelineGetV1ResponseTablesTypeSink   PipelineGetV1ResponseTablesType = "sink"
)

func (PipelineGetV1ResponseTablesType) IsKnown added in v6.3.0

type PipelineListParams

type PipelineListParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specifies which page to retrieve.
	Page param.Field[string] `query:"page"`
	// Specifies the number of pipelines per page.
	PerPage param.Field[string] `query:"per_page"`
	// Specifies the prefix of pipeline name to search.
	Search param.Field[string] `query:"search"`
}

func (PipelineListParams) URLQuery

func (r PipelineListParams) URLQuery() (v url.Values)

URLQuery serializes PipelineListParams's query parameters as `url.Values`.

type PipelineListResponse

type PipelineListResponse struct {
	ResultInfo PipelineListResponseResultInfo `json:"result_info,required"`
	Results    []PipelineListResponseResult   `json:"results,required"`
	// Indicates whether the API call was successful.
	Success bool                     `json:"success,required"`
	JSON    pipelineListResponseJSON `json:"-"`
}

func (*PipelineListResponse) UnmarshalJSON

func (r *PipelineListResponse) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResult deprecated

type PipelineListResponseResult struct {
	// Specifies the pipeline identifier.
	ID          string                                 `json:"id,required"`
	Destination PipelineListResponseResultsDestination `json:"destination,required"`
	// Indicates the endpoint URL to send traffic.
	Endpoint string `json:"endpoint,required"`
	// Defines the name of the pipeline.
	Name   string                              `json:"name,required"`
	Source []PipelineListResponseResultsSource `json:"source,required"`
	// Indicates the version number of last saved configuration.
	Version float64                        `json:"version,required"`
	JSON    pipelineListResponseResultJSON `json:"-"`
}

[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.

Deprecated: deprecated

func (*PipelineListResponseResult) UnmarshalJSON

func (r *PipelineListResponseResult) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultInfo

type PipelineListResponseResultInfo struct {
	// Indicates the number of items on current page.
	Count float64 `json:"count,required"`
	// Indicates the current page number.
	Page float64 `json:"page,required"`
	// Indicates the number of items per page.
	PerPage float64 `json:"per_page,required"`
	// Indicates the total number of items.
	TotalCount float64                            `json:"total_count,required"`
	JSON       pipelineListResponseResultInfoJSON `json:"-"`
}

func (*PipelineListResponseResultInfo) UnmarshalJSON

func (r *PipelineListResponseResultInfo) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsDestination

type PipelineListResponseResultsDestination struct {
	Batch       PipelineListResponseResultsDestinationBatch       `json:"batch,required"`
	Compression PipelineListResponseResultsDestinationCompression `json:"compression,required"`
	// Specifies the format of data to deliver.
	Format PipelineListResponseResultsDestinationFormat `json:"format,required"`
	Path   PipelineListResponseResultsDestinationPath   `json:"path,required"`
	// Specifies the type of destination.
	Type PipelineListResponseResultsDestinationType `json:"type,required"`
	JSON pipelineListResponseResultsDestinationJSON `json:"-"`
}

func (*PipelineListResponseResultsDestination) UnmarshalJSON

func (r *PipelineListResponseResultsDestination) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsDestinationBatch

type PipelineListResponseResultsDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes int64 `json:"max_bytes,required"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS float64 `json:"max_duration_s,required"`
	// Specifies rough maximum number of rows per file.
	MaxRows int64                                           `json:"max_rows,required"`
	JSON    pipelineListResponseResultsDestinationBatchJSON `json:"-"`
}

func (*PipelineListResponseResultsDestinationBatch) UnmarshalJSON

func (r *PipelineListResponseResultsDestinationBatch) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsDestinationCompression

type PipelineListResponseResultsDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type PipelineListResponseResultsDestinationCompressionType `json:"type,required"`
	JSON pipelineListResponseResultsDestinationCompressionJSON `json:"-"`
}

func (*PipelineListResponseResultsDestinationCompression) UnmarshalJSON

func (r *PipelineListResponseResultsDestinationCompression) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsDestinationCompressionType

type PipelineListResponseResultsDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineListResponseResultsDestinationCompressionTypeNone    PipelineListResponseResultsDestinationCompressionType = "none"
	PipelineListResponseResultsDestinationCompressionTypeGzip    PipelineListResponseResultsDestinationCompressionType = "gzip"
	PipelineListResponseResultsDestinationCompressionTypeDeflate PipelineListResponseResultsDestinationCompressionType = "deflate"
)

func (PipelineListResponseResultsDestinationCompressionType) IsKnown

type PipelineListResponseResultsDestinationFormat

type PipelineListResponseResultsDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineListResponseResultsDestinationFormatJson PipelineListResponseResultsDestinationFormat = "json"
)

func (PipelineListResponseResultsDestinationFormat) IsKnown

type PipelineListResponseResultsDestinationPath

type PipelineListResponseResultsDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket string `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename string `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath string `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix string                                         `json:"prefix"`
	JSON   pipelineListResponseResultsDestinationPathJSON `json:"-"`
}

func (*PipelineListResponseResultsDestinationPath) UnmarshalJSON

func (r *PipelineListResponseResultsDestinationPath) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsDestinationType

type PipelineListResponseResultsDestinationType string

Specifies the type of destination.

const (
	PipelineListResponseResultsDestinationTypeR2 PipelineListResponseResultsDestinationType = "r2"
)

func (PipelineListResponseResultsDestinationType) IsKnown

type PipelineListResponseResultsSource

type PipelineListResponseResultsSource struct {
	// Specifies the format of source data.
	Format PipelineListResponseResultsSourceFormat `json:"format,required"`
	Type   string                                  `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool `json:"authentication"`
	// This field can have the runtime type of
	// [PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
	CORS interface{}                           `json:"cors"`
	JSON pipelineListResponseResultsSourceJSON `json:"-"`
	// contains filtered or unexported fields
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineListResponseResultsSource) AsUnion

AsUnion returns a PipelineListResponseResultsSourceUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource.

func (*PipelineListResponseResultsSource) UnmarshalJSON

func (r *PipelineListResponseResultsSource) UnmarshalJSON(data []byte) (err error)

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
	Type   string                                                                                  `json:"type,required"`
	JSON   pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON   `json:"-"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
	Type   string                                                                               `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool                                                                               `json:"authentication"`
	CORS           PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
	JSON           pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins []string                                                                               `json:"origins"`
	JSON    pipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}

func (*PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineListResponseResultsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineListResponseResultsSourceFormat

type PipelineListResponseResultsSourceFormat string

Specifies the format of source data.

const (
	PipelineListResponseResultsSourceFormatJson PipelineListResponseResultsSourceFormat = "json"
)

func (PipelineListResponseResultsSourceFormat) IsKnown

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 added in v6.3.0

type PipelineListV1Params struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string]  `path:"account_id,required"`
	Page      param.Field[float64] `query:"page"`
	PerPage   param.Field[float64] `query:"per_page"`
}

func (PipelineListV1Params) URLQuery added in v6.3.0

func (r PipelineListV1Params) URLQuery() (v url.Values)

URLQuery serializes PipelineListV1Params's query parameters as `url.Values`.

type PipelineListV1Response added in v6.3.0

type PipelineListV1Response struct {
	// Indicates a unique identifier for this pipeline.
	ID         string `json:"id,required"`
	CreatedAt  string `json:"created_at,required"`
	ModifiedAt string `json:"modified_at,required"`
	// Indicates the name of the Pipeline.
	Name string `json:"name,required"`
	// Specifies SQL for the Pipeline processing flow.
	Sql string `json:"sql,required"`
	// Indicates the current status of the Pipeline.
	Status string                     `json:"status,required"`
	JSON   pipelineListV1ResponseJSON `json:"-"`
}

func (*PipelineListV1Response) UnmarshalJSON added in v6.3.0

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,required"`
	Destination param.Field[PipelineNewParamsDestination] `json:"destination,required"`
	// Defines the name of the pipeline.
	Name   param.Field[string]                         `json:"name,required"`
	Source param.Field[[]PipelineNewParamsSourceUnion] `json:"source,required"`
}

func (PipelineNewParams) MarshalJSON

func (r PipelineNewParams) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestination

type PipelineNewParamsDestination struct {
	Batch       param.Field[PipelineNewParamsDestinationBatch]       `json:"batch,required"`
	Compression param.Field[PipelineNewParamsDestinationCompression] `json:"compression,required"`
	Credentials param.Field[PipelineNewParamsDestinationCredentials] `json:"credentials,required"`
	// Specifies the format of data to deliver.
	Format param.Field[PipelineNewParamsDestinationFormat] `json:"format,required"`
	Path   param.Field[PipelineNewParamsDestinationPath]   `json:"path,required"`
	// Specifies the type of destination.
	Type param.Field[PipelineNewParamsDestinationType] `json:"type,required"`
}

func (PipelineNewParamsDestination) MarshalJSON

func (r PipelineNewParamsDestination) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestinationBatch

type PipelineNewParamsDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes param.Field[int64] `json:"max_bytes"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS param.Field[float64] `json:"max_duration_s"`
	// Specifies rough maximum number of rows per file.
	MaxRows param.Field[int64] `json:"max_rows"`
}

func (PipelineNewParamsDestinationBatch) MarshalJSON

func (r PipelineNewParamsDestinationBatch) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestinationCompression

type PipelineNewParamsDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type param.Field[PipelineNewParamsDestinationCompressionType] `json:"type"`
}

func (PipelineNewParamsDestinationCompression) MarshalJSON

func (r PipelineNewParamsDestinationCompression) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestinationCompressionType

type PipelineNewParamsDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineNewParamsDestinationCompressionTypeNone    PipelineNewParamsDestinationCompressionType = "none"
	PipelineNewParamsDestinationCompressionTypeGzip    PipelineNewParamsDestinationCompressionType = "gzip"
	PipelineNewParamsDestinationCompressionTypeDeflate PipelineNewParamsDestinationCompressionType = "deflate"
)

func (PipelineNewParamsDestinationCompressionType) IsKnown

type PipelineNewParamsDestinationCredentials

type PipelineNewParamsDestinationCredentials struct {
	// Specifies the R2 Bucket Access Key Id.
	AccessKeyID param.Field[string] `json:"access_key_id,required"`
	// Specifies the R2 Endpoint.
	Endpoint param.Field[string] `json:"endpoint,required"`
	// Specifies the R2 Bucket Secret Access Key.
	SecretAccessKey param.Field[string] `json:"secret_access_key,required"`
}

func (PipelineNewParamsDestinationCredentials) MarshalJSON

func (r PipelineNewParamsDestinationCredentials) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestinationFormat

type PipelineNewParamsDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineNewParamsDestinationFormatJson PipelineNewParamsDestinationFormat = "json"
)

func (PipelineNewParamsDestinationFormat) IsKnown

type PipelineNewParamsDestinationPath

type PipelineNewParamsDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket param.Field[string] `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename param.Field[string] `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath param.Field[string] `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix param.Field[string] `json:"prefix"`
}

func (PipelineNewParamsDestinationPath) MarshalJSON

func (r PipelineNewParamsDestinationPath) MarshalJSON() (data []byte, err error)

type PipelineNewParamsDestinationType

type PipelineNewParamsDestinationType string

Specifies the type of destination.

const (
	PipelineNewParamsDestinationTypeR2 PipelineNewParamsDestinationType = "r2"
)

func (PipelineNewParamsDestinationType) IsKnown

type PipelineNewParamsSource

type PipelineNewParamsSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineNewParamsSourceFormat] `json:"format,required"`
	Type   param.Field[string]                        `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication param.Field[bool]        `json:"authentication"`
	CORS           param.Field[interface{}] `json:"cors"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineNewParamsSource) MarshalJSON

func (r PipelineNewParamsSource) MarshalJSON() (data []byte, err error)

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat] `json:"format,required"`
	Type   param.Field[string]                                                                        `json:"type,required"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat] `json:"format,required"`
	Type   param.Field[string]                                                                     `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication param.Field[bool]                                                                     `json:"authentication"`
	CORS           param.Field[PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] `json:"cors"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins param.Field[[]string] `json:"origins"`
}

func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineNewParamsSourceFormat

type PipelineNewParamsSourceFormat string

Specifies the format of source data.

const (
	PipelineNewParamsSourceFormatJson PipelineNewParamsSourceFormat = "json"
)

func (PipelineNewParamsSourceFormat) IsKnown

func (r PipelineNewParamsSourceFormat) IsKnown() bool

type PipelineNewParamsSourceUnion

type PipelineNewParamsSourceUnion interface {
	// contains filtered or unexported methods
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Satisfied by pipelines.PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, pipelines.PipelineNewParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource, PipelineNewParamsSource.

type PipelineNewResponse deprecated

type PipelineNewResponse struct {
	// Specifies the pipeline identifier.
	ID          string                         `json:"id,required"`
	Destination PipelineNewResponseDestination `json:"destination,required"`
	// Indicates the endpoint URL to send traffic.
	Endpoint string `json:"endpoint,required"`
	// Defines the name of the pipeline.
	Name   string                      `json:"name,required"`
	Source []PipelineNewResponseSource `json:"source,required"`
	// Indicates the version number of last saved configuration.
	Version float64                 `json:"version,required"`
	JSON    pipelineNewResponseJSON `json:"-"`
}

[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.

Deprecated: deprecated

func (*PipelineNewResponse) UnmarshalJSON

func (r *PipelineNewResponse) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseDestination

type PipelineNewResponseDestination struct {
	Batch       PipelineNewResponseDestinationBatch       `json:"batch,required"`
	Compression PipelineNewResponseDestinationCompression `json:"compression,required"`
	// Specifies the format of data to deliver.
	Format PipelineNewResponseDestinationFormat `json:"format,required"`
	Path   PipelineNewResponseDestinationPath   `json:"path,required"`
	// Specifies the type of destination.
	Type PipelineNewResponseDestinationType `json:"type,required"`
	JSON pipelineNewResponseDestinationJSON `json:"-"`
}

func (*PipelineNewResponseDestination) UnmarshalJSON

func (r *PipelineNewResponseDestination) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseDestinationBatch

type PipelineNewResponseDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes int64 `json:"max_bytes,required"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS float64 `json:"max_duration_s,required"`
	// Specifies rough maximum number of rows per file.
	MaxRows int64                                   `json:"max_rows,required"`
	JSON    pipelineNewResponseDestinationBatchJSON `json:"-"`
}

func (*PipelineNewResponseDestinationBatch) UnmarshalJSON

func (r *PipelineNewResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseDestinationCompression

type PipelineNewResponseDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type PipelineNewResponseDestinationCompressionType `json:"type,required"`
	JSON pipelineNewResponseDestinationCompressionJSON `json:"-"`
}

func (*PipelineNewResponseDestinationCompression) UnmarshalJSON

func (r *PipelineNewResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseDestinationCompressionType

type PipelineNewResponseDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineNewResponseDestinationCompressionTypeNone    PipelineNewResponseDestinationCompressionType = "none"
	PipelineNewResponseDestinationCompressionTypeGzip    PipelineNewResponseDestinationCompressionType = "gzip"
	PipelineNewResponseDestinationCompressionTypeDeflate PipelineNewResponseDestinationCompressionType = "deflate"
)

func (PipelineNewResponseDestinationCompressionType) IsKnown

type PipelineNewResponseDestinationFormat

type PipelineNewResponseDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineNewResponseDestinationFormatJson PipelineNewResponseDestinationFormat = "json"
)

func (PipelineNewResponseDestinationFormat) IsKnown

type PipelineNewResponseDestinationPath

type PipelineNewResponseDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket string `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename string `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath string `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix string                                 `json:"prefix"`
	JSON   pipelineNewResponseDestinationPathJSON `json:"-"`
}

func (*PipelineNewResponseDestinationPath) UnmarshalJSON

func (r *PipelineNewResponseDestinationPath) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseDestinationType

type PipelineNewResponseDestinationType string

Specifies the type of destination.

const (
	PipelineNewResponseDestinationTypeR2 PipelineNewResponseDestinationType = "r2"
)

func (PipelineNewResponseDestinationType) IsKnown

type PipelineNewResponseEnvelope

type PipelineNewResponseEnvelope struct {
	// [DEPRECATED] Describes the configuration of a pipeline. Use the new
	// streams/sinks/pipelines API instead.
	//
	// Deprecated: deprecated
	Result PipelineNewResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                            `json:"success,required"`
	JSON    pipelineNewResponseEnvelopeJSON `json:"-"`
}

func (*PipelineNewResponseEnvelope) UnmarshalJSON

func (r *PipelineNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseSource

type PipelineNewResponseSource struct {
	// Specifies the format of source data.
	Format PipelineNewResponseSourceFormat `json:"format,required"`
	Type   string                          `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool `json:"authentication"`
	// This field can have the runtime type of
	// [PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
	CORS interface{}                   `json:"cors"`
	JSON pipelineNewResponseSourceJSON `json:"-"`
	// contains filtered or unexported fields
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineNewResponseSource) AsUnion

AsUnion returns a PipelineNewResponseSourceUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.

func (*PipelineNewResponseSource) UnmarshalJSON

func (r *PipelineNewResponseSource) UnmarshalJSON(data []byte) (err error)

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
	Type   string                                                                          `json:"type,required"`
	JSON   pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON   `json:"-"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
	Type   string                                                                       `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool                                                                       `json:"authentication"`
	CORS           PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
	JSON           pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins []string                                                                       `json:"origins"`
	JSON    pipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}

func (*PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineNewResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineNewResponseSourceFormat

type PipelineNewResponseSourceFormat string

Specifies the format of source data.

const (
	PipelineNewResponseSourceFormatJson PipelineNewResponseSourceFormat = "json"
)

func (PipelineNewResponseSourceFormat) IsKnown

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 added in v6.3.0

type PipelineNewV1Params struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specifies the name of the Pipeline.
	Name param.Field[string] `json:"name,required"`
	// Specifies SQL for the Pipeline processing flow.
	Sql param.Field[string] `json:"sql,required"`
}

func (PipelineNewV1Params) MarshalJSON added in v6.3.0

func (r PipelineNewV1Params) MarshalJSON() (data []byte, err error)

type PipelineNewV1Response added in v6.3.0

type PipelineNewV1Response struct {
	// Indicates a unique identifier for this pipeline.
	ID         string `json:"id,required"`
	CreatedAt  string `json:"created_at,required"`
	ModifiedAt string `json:"modified_at,required"`
	// Indicates the name of the Pipeline.
	Name string `json:"name,required"`
	// Specifies SQL for the Pipeline processing flow.
	Sql string `json:"sql,required"`
	// Indicates the current status of the Pipeline.
	Status string                    `json:"status,required"`
	JSON   pipelineNewV1ResponseJSON `json:"-"`
}

func (*PipelineNewV1Response) UnmarshalJSON added in v6.3.0

func (r *PipelineNewV1Response) UnmarshalJSON(data []byte) (err error)

type PipelineNewV1ResponseEnvelope added in v6.3.0

type PipelineNewV1ResponseEnvelope struct {
	Result PipelineNewV1Response `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                              `json:"success,required"`
	JSON    pipelineNewV1ResponseEnvelopeJSON `json:"-"`
}

func (*PipelineNewV1ResponseEnvelope) UnmarshalJSON added in v6.3.0

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 added in v6.3.0

func (r *PipelineService) DeleteV1(ctx context.Context, pipelineID string, body PipelineDeleteV1Params, opts ...option.RequestOption) (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 added in v6.3.0

func (r *PipelineService) GetV1(ctx context.Context, pipelineID string, query PipelineGetV1Params, opts ...option.RequestOption) (res *PipelineGetV1Response, err error)

Get Pipelines Details.

func (*PipelineService) List deprecated

[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 added in v6.3.0

List/Filter Pipelines in Account.

func (*PipelineService) ListV1AutoPaging added in v6.3.0

List/Filter Pipelines in Account.

func (*PipelineService) New deprecated

[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 added in v6.3.0

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 added in v6.3.0

Validate Arroyo SQL.

type PipelineUpdateParams

type PipelineUpdateParams struct {
	// Specifies the public ID of the account.
	AccountID   param.Field[string]                          `path:"account_id,required"`
	Destination param.Field[PipelineUpdateParamsDestination] `json:"destination,required"`
	// Defines the name of the pipeline.
	Name   param.Field[string]                            `json:"name,required"`
	Source param.Field[[]PipelineUpdateParamsSourceUnion] `json:"source,required"`
}

func (PipelineUpdateParams) MarshalJSON

func (r PipelineUpdateParams) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestination

type PipelineUpdateParamsDestination struct {
	Batch       param.Field[PipelineUpdateParamsDestinationBatch]       `json:"batch,required"`
	Compression param.Field[PipelineUpdateParamsDestinationCompression] `json:"compression,required"`
	// Specifies the format of data to deliver.
	Format param.Field[PipelineUpdateParamsDestinationFormat] `json:"format,required"`
	Path   param.Field[PipelineUpdateParamsDestinationPath]   `json:"path,required"`
	// Specifies the type of destination.
	Type        param.Field[PipelineUpdateParamsDestinationType]        `json:"type,required"`
	Credentials param.Field[PipelineUpdateParamsDestinationCredentials] `json:"credentials"`
}

func (PipelineUpdateParamsDestination) MarshalJSON

func (r PipelineUpdateParamsDestination) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestinationBatch

type PipelineUpdateParamsDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes param.Field[int64] `json:"max_bytes"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS param.Field[float64] `json:"max_duration_s"`
	// Specifies rough maximum number of rows per file.
	MaxRows param.Field[int64] `json:"max_rows"`
}

func (PipelineUpdateParamsDestinationBatch) MarshalJSON

func (r PipelineUpdateParamsDestinationBatch) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestinationCompression

type PipelineUpdateParamsDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type param.Field[PipelineUpdateParamsDestinationCompressionType] `json:"type"`
}

func (PipelineUpdateParamsDestinationCompression) MarshalJSON

func (r PipelineUpdateParamsDestinationCompression) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestinationCompressionType

type PipelineUpdateParamsDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineUpdateParamsDestinationCompressionTypeNone    PipelineUpdateParamsDestinationCompressionType = "none"
	PipelineUpdateParamsDestinationCompressionTypeGzip    PipelineUpdateParamsDestinationCompressionType = "gzip"
	PipelineUpdateParamsDestinationCompressionTypeDeflate PipelineUpdateParamsDestinationCompressionType = "deflate"
)

func (PipelineUpdateParamsDestinationCompressionType) IsKnown

type PipelineUpdateParamsDestinationCredentials

type PipelineUpdateParamsDestinationCredentials struct {
	// Specifies the R2 Bucket Access Key Id.
	AccessKeyID param.Field[string] `json:"access_key_id,required"`
	// Specifies the R2 Endpoint.
	Endpoint param.Field[string] `json:"endpoint,required"`
	// Specifies the R2 Bucket Secret Access Key.
	SecretAccessKey param.Field[string] `json:"secret_access_key,required"`
}

func (PipelineUpdateParamsDestinationCredentials) MarshalJSON

func (r PipelineUpdateParamsDestinationCredentials) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestinationFormat

type PipelineUpdateParamsDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineUpdateParamsDestinationFormatJson PipelineUpdateParamsDestinationFormat = "json"
)

func (PipelineUpdateParamsDestinationFormat) IsKnown

type PipelineUpdateParamsDestinationPath

type PipelineUpdateParamsDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket param.Field[string] `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename param.Field[string] `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath param.Field[string] `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix param.Field[string] `json:"prefix"`
}

func (PipelineUpdateParamsDestinationPath) MarshalJSON

func (r PipelineUpdateParamsDestinationPath) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsDestinationType

type PipelineUpdateParamsDestinationType string

Specifies the type of destination.

const (
	PipelineUpdateParamsDestinationTypeR2 PipelineUpdateParamsDestinationType = "r2"
)

func (PipelineUpdateParamsDestinationType) IsKnown

type PipelineUpdateParamsSource

type PipelineUpdateParamsSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineUpdateParamsSourceFormat] `json:"format,required"`
	Type   param.Field[string]                           `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication param.Field[bool]        `json:"authentication"`
	CORS           param.Field[interface{}] `json:"cors"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineUpdateParamsSource) MarshalJSON

func (r PipelineUpdateParamsSource) MarshalJSON() (data []byte, err error)

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat] `json:"format,required"`
	Type   param.Field[string]                                                                           `json:"type,required"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource) MarshalJSON

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat] `json:"format,required"`
	Type   param.Field[string]                                                                        `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication param.Field[bool]                                                                        `json:"authentication"`
	CORS           param.Field[PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS] `json:"cors"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource) MarshalJSON

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins param.Field[[]string] `json:"origins"`
}

func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) MarshalJSON

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineUpdateParamsSourceFormat

type PipelineUpdateParamsSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateParamsSourceFormatJson PipelineUpdateParamsSourceFormat = "json"
)

func (PipelineUpdateParamsSourceFormat) IsKnown

type PipelineUpdateParamsSourceUnion

type PipelineUpdateParamsSourceUnion interface {
	// contains filtered or unexported methods
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Satisfied by pipelines.PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesHTTPSource, pipelines.PipelineUpdateParamsSourceCloudflarePipelinesWorkersPipelinesBindingSource, PipelineUpdateParamsSource.

type PipelineUpdateResponse deprecated

type PipelineUpdateResponse struct {
	// Specifies the pipeline identifier.
	ID          string                            `json:"id,required"`
	Destination PipelineUpdateResponseDestination `json:"destination,required"`
	// Indicates the endpoint URL to send traffic.
	Endpoint string `json:"endpoint,required"`
	// Defines the name of the pipeline.
	Name   string                         `json:"name,required"`
	Source []PipelineUpdateResponseSource `json:"source,required"`
	// Indicates the version number of last saved configuration.
	Version float64                    `json:"version,required"`
	JSON    pipelineUpdateResponseJSON `json:"-"`
}

[DEPRECATED] Describes the configuration of a pipeline. Use the new streams/sinks/pipelines API instead.

Deprecated: deprecated

func (*PipelineUpdateResponse) UnmarshalJSON

func (r *PipelineUpdateResponse) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseDestination

type PipelineUpdateResponseDestination struct {
	Batch       PipelineUpdateResponseDestinationBatch       `json:"batch,required"`
	Compression PipelineUpdateResponseDestinationCompression `json:"compression,required"`
	// Specifies the format of data to deliver.
	Format PipelineUpdateResponseDestinationFormat `json:"format,required"`
	Path   PipelineUpdateResponseDestinationPath   `json:"path,required"`
	// Specifies the type of destination.
	Type PipelineUpdateResponseDestinationType `json:"type,required"`
	JSON pipelineUpdateResponseDestinationJSON `json:"-"`
}

func (*PipelineUpdateResponseDestination) UnmarshalJSON

func (r *PipelineUpdateResponseDestination) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseDestinationBatch

type PipelineUpdateResponseDestinationBatch struct {
	// Specifies rough maximum size of files.
	MaxBytes int64 `json:"max_bytes,required"`
	// Specifies duration to wait to aggregate batches files.
	MaxDurationS float64 `json:"max_duration_s,required"`
	// Specifies rough maximum number of rows per file.
	MaxRows int64                                      `json:"max_rows,required"`
	JSON    pipelineUpdateResponseDestinationBatchJSON `json:"-"`
}

func (*PipelineUpdateResponseDestinationBatch) UnmarshalJSON

func (r *PipelineUpdateResponseDestinationBatch) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseDestinationCompression

type PipelineUpdateResponseDestinationCompression struct {
	// Specifies the desired compression algorithm and format.
	Type PipelineUpdateResponseDestinationCompressionType `json:"type,required"`
	JSON pipelineUpdateResponseDestinationCompressionJSON `json:"-"`
}

func (*PipelineUpdateResponseDestinationCompression) UnmarshalJSON

func (r *PipelineUpdateResponseDestinationCompression) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseDestinationCompressionType

type PipelineUpdateResponseDestinationCompressionType string

Specifies the desired compression algorithm and format.

const (
	PipelineUpdateResponseDestinationCompressionTypeNone    PipelineUpdateResponseDestinationCompressionType = "none"
	PipelineUpdateResponseDestinationCompressionTypeGzip    PipelineUpdateResponseDestinationCompressionType = "gzip"
	PipelineUpdateResponseDestinationCompressionTypeDeflate PipelineUpdateResponseDestinationCompressionType = "deflate"
)

func (PipelineUpdateResponseDestinationCompressionType) IsKnown

type PipelineUpdateResponseDestinationFormat

type PipelineUpdateResponseDestinationFormat string

Specifies the format of data to deliver.

const (
	PipelineUpdateResponseDestinationFormatJson PipelineUpdateResponseDestinationFormat = "json"
)

func (PipelineUpdateResponseDestinationFormat) IsKnown

type PipelineUpdateResponseDestinationPath

type PipelineUpdateResponseDestinationPath struct {
	// Specifies the R2 Bucket to store files.
	Bucket string `json:"bucket,required"`
	// Specifies the name pattern to for individual data files.
	Filename string `json:"filename"`
	// Specifies the name pattern for directory.
	Filepath string `json:"filepath"`
	// Specifies the base directory within the bucket.
	Prefix string                                    `json:"prefix"`
	JSON   pipelineUpdateResponseDestinationPathJSON `json:"-"`
}

func (*PipelineUpdateResponseDestinationPath) UnmarshalJSON

func (r *PipelineUpdateResponseDestinationPath) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseDestinationType

type PipelineUpdateResponseDestinationType string

Specifies the type of destination.

const (
	PipelineUpdateResponseDestinationTypeR2 PipelineUpdateResponseDestinationType = "r2"
)

func (PipelineUpdateResponseDestinationType) IsKnown

type PipelineUpdateResponseEnvelope

type PipelineUpdateResponseEnvelope struct {
	// [DEPRECATED] Describes the configuration of a pipeline. Use the new
	// streams/sinks/pipelines API instead.
	//
	// Deprecated: deprecated
	Result PipelineUpdateResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                               `json:"success,required"`
	JSON    pipelineUpdateResponseEnvelopeJSON `json:"-"`
}

func (*PipelineUpdateResponseEnvelope) UnmarshalJSON

func (r *PipelineUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseSource

type PipelineUpdateResponseSource struct {
	// Specifies the format of source data.
	Format PipelineUpdateResponseSourceFormat `json:"format,required"`
	Type   string                             `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool `json:"authentication"`
	// This field can have the runtime type of
	// [PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS].
	CORS interface{}                      `json:"cors"`
	JSON pipelineUpdateResponseSourceJSON `json:"-"`
	// contains filtered or unexported fields
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

func (PipelineUpdateResponseSource) AsUnion

AsUnion returns a PipelineUpdateResponseSourceUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource, PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource.

func (*PipelineUpdateResponseSource) UnmarshalJSON

func (r *PipelineUpdateResponseSource) UnmarshalJSON(data []byte) (err error)

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource deprecated

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource struct {
	// Specifies the format of source data.
	Format PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat `json:"format,required"`
	Type   string                                                                             `json:"type,required"`
	JSON   pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceJSON   `json:"-"`
}

[DEPRECATED] Worker binding source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSource) UnmarshalJSON

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormatJson PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat = "json"
)

func (PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesBindingSourceFormat) IsKnown

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource deprecated

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource struct {
	// Specifies the format of source data.
	Format PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat `json:"format,required"`
	Type   string                                                                          `json:"type,required"`
	// Specifies whether authentication is required to send to this pipeline via HTTP.
	Authentication bool                                                                          `json:"authentication"`
	CORS           PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS `json:"cors"`
	JSON           pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceJSON `json:"-"`
}

[DEPRECATED] HTTP source configuration. Use the new streams API instead.

Deprecated: deprecated

func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSource) UnmarshalJSON

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS struct {
	// Specifies allowed origins to allow Cross Origin HTTP Requests.
	Origins []string                                                                          `json:"origins"`
	JSON    pipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORSJSON `json:"-"`
}

func (*PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceCORS) UnmarshalJSON

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat

type PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormatJson PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat = "json"
)

func (PipelineUpdateResponseSourceCloudflarePipelinesWorkersPipelinesHTTPSourceFormat) IsKnown

type PipelineUpdateResponseSourceFormat

type PipelineUpdateResponseSourceFormat string

Specifies the format of source data.

const (
	PipelineUpdateResponseSourceFormatJson PipelineUpdateResponseSourceFormat = "json"
)

func (PipelineUpdateResponseSourceFormat) IsKnown

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 added in v6.3.0

type PipelineValidateSqlParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specifies SQL to validate.
	Sql param.Field[string] `json:"sql,required"`
}

func (PipelineValidateSqlParams) MarshalJSON added in v6.3.0

func (r PipelineValidateSqlParams) MarshalJSON() (data []byte, err error)

type PipelineValidateSqlResponse added in v6.3.0

type PipelineValidateSqlResponse struct {
	// Indicates tables involved in the processing.
	Tables map[string]PipelineValidateSqlResponseTable `json:"tables,required"`
	Graph  PipelineValidateSqlResponseGraph            `json:"graph"`
	JSON   pipelineValidateSqlResponseJSON             `json:"-"`
}

func (*PipelineValidateSqlResponse) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponse) UnmarshalJSON(data []byte) (err error)

type PipelineValidateSqlResponseEnvelope added in v6.3.0

type PipelineValidateSqlResponseEnvelope struct {
	Result PipelineValidateSqlResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                                    `json:"success,required"`
	JSON    pipelineValidateSqlResponseEnvelopeJSON `json:"-"`
}

func (*PipelineValidateSqlResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type PipelineValidateSqlResponseGraph added in v6.3.0

type PipelineValidateSqlResponseGraph struct {
	Edges []PipelineValidateSqlResponseGraphEdge `json:"edges,required"`
	Nodes []PipelineValidateSqlResponseGraphNode `json:"nodes,required"`
	JSON  pipelineValidateSqlResponseGraphJSON   `json:"-"`
}

func (*PipelineValidateSqlResponseGraph) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponseGraph) UnmarshalJSON(data []byte) (err error)

type PipelineValidateSqlResponseGraphEdge added in v6.3.0

type PipelineValidateSqlResponseGraphEdge struct {
	DestID    int64                                    `json:"dest_id,required"`
	EdgeType  string                                   `json:"edge_type,required"`
	KeyType   string                                   `json:"key_type,required"`
	SrcID     int64                                    `json:"src_id,required"`
	ValueType string                                   `json:"value_type,required"`
	JSON      pipelineValidateSqlResponseGraphEdgeJSON `json:"-"`
}

func (*PipelineValidateSqlResponseGraphEdge) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponseGraphEdge) UnmarshalJSON(data []byte) (err error)

type PipelineValidateSqlResponseGraphNode added in v6.3.0

type PipelineValidateSqlResponseGraphNode struct {
	Description string                                   `json:"description,required"`
	NodeID      int64                                    `json:"node_id,required"`
	Operator    string                                   `json:"operator,required"`
	Parallelism int64                                    `json:"parallelism,required"`
	JSON        pipelineValidateSqlResponseGraphNodeJSON `json:"-"`
}

func (*PipelineValidateSqlResponseGraphNode) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponseGraphNode) UnmarshalJSON(data []byte) (err error)

type PipelineValidateSqlResponseTable added in v6.3.0

type PipelineValidateSqlResponseTable struct {
	ID      string                               `json:"id,required"`
	Name    string                               `json:"name,required"`
	Type    string                               `json:"type,required"`
	Version float64                              `json:"version,required"`
	JSON    pipelineValidateSqlResponseTableJSON `json:"-"`
}

func (*PipelineValidateSqlResponseTable) UnmarshalJSON added in v6.3.0

func (r *PipelineValidateSqlResponseTable) UnmarshalJSON(data []byte) (err error)

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

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 added in v6.3.0

type SinkDeleteParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Delete sink forcefully, including deleting any dependent pipelines.
	Force param.Field[string] `query:"force"`
}

func (SinkDeleteParams) URLQuery added in v6.3.0

func (r SinkDeleteParams) URLQuery() (v url.Values)

URLQuery serializes SinkDeleteParams's query parameters as `url.Values`.

type SinkGetParams added in v6.3.0

type SinkGetParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SinkGetResponse added in v6.3.0

type SinkGetResponse struct {
	// Indicates a unique identifier for this sink.
	ID         string    `json:"id,required"`
	CreatedAt  time.Time `json:"created_at,required" format:"date-time"`
	ModifiedAt time.Time `json:"modified_at,required" format:"date-time"`
	// Defines the name of the Sink.
	Name string `json:"name,required"`
	// Specifies the type of sink.
	Type SinkGetResponseType `json:"type,required"`
	// Defines the configuration of the R2 Sink.
	Config SinkGetResponseConfig `json:"config"`
	Format SinkGetResponseFormat `json:"format"`
	Schema SinkGetResponseSchema `json:"schema"`
	JSON   sinkGetResponseJSON   `json:"-"`
}

func (*SinkGetResponse) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponse) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseConfig added in v6.3.0

type SinkGetResponseConfig struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket string `json:"bucket,required"`
	// Authentication token
	Token string `json:"token" format:"var-str"`
	// This field can have the runtime type of
	// [SinkGetResponseConfigCloudflarePipelinesR2TableCredentials].
	Credentials interface{} `json:"credentials"`
	// This field can have the runtime type of
	// [SinkGetResponseConfigCloudflarePipelinesR2TableFileNaming].
	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
	// [SinkGetResponseConfigCloudflarePipelinesR2TablePartitioning].
	Partitioning interface{} `json:"partitioning"`
	// Subpath within the bucket to write to
	Path string `json:"path"`
	// This field can have the runtime type of
	// [SinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicy],
	// [SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy].
	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 added in v6.3.0

AsUnion returns a SinkGetResponseConfigUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkGetResponseConfigCloudflarePipelinesR2Table, SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTable.

func (*SinkGetResponseConfig) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseConfig) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTable added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTable struct {
	// Authentication token
	Token string `json:"token,required" format:"var-str"`
	// Cloudflare Account ID
	AccountID string `json:"account_id,required" format:"uri"`
	// The R2 Bucket that hosts this catalog
	Bucket string `json:"bucket,required"`
	// Table name
	TableName string `json:"table_name,required"`
	// Table namespace
	Namespace string `json:"namespace"`
	// Rolling policy for file sinks (when & why to close a file and open a new one).
	RollingPolicy SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy `json:"rolling_policy"`
	JSON          sinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableJSON          `json:"-"`
}

R2 Data Catalog Sink

func (*SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTable) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy 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            sinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicyJSON `json:"-"`
}

Rolling policy for file sinks (when & why to close a file and open a new one).

func (*SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2Table added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2Table struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket      string                                                     `json:"bucket,required"`
	Credentials SinkGetResponseConfigCloudflarePipelinesR2TableCredentials `json:"credentials,required"`
	// Controls filename prefix/suffix and strategy.
	FileNaming SinkGetResponseConfigCloudflarePipelinesR2TableFileNaming `json:"file_naming"`
	// Jurisdiction this bucket is hosted in
	Jurisdiction string `json:"jurisdiction"`
	// Data-layout partitioning for sinks.
	Partitioning SinkGetResponseConfigCloudflarePipelinesR2TablePartitioning `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 SinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicy `json:"rolling_policy"`
	JSON          sinkGetResponseConfigCloudflarePipelinesR2TableJSON          `json:"-"`
}

func (*SinkGetResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseConfigCloudflarePipelinesR2TableCredentials added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableCredentials struct {
	// Cloudflare Account ID for the bucket
	AccessKeyID string `json:"access_key_id,required" format:"var-str"`
	// Cloudflare Account ID for the bucket
	SecretAccessKey string                                                         `json:"secret_access_key,required" format:"var-str"`
	JSON            sinkGetResponseConfigCloudflarePipelinesR2TableCredentialsJSON `json:"-"`
}

func (*SinkGetResponseConfigCloudflarePipelinesR2TableCredentials) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableFileNaming added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableFileNaming struct {
	// The prefix to use in file name. i.e prefix-<uuid>.parquet
	Prefix string `json:"prefix"`
	// Filename generation strategy.
	Strategy SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy `json:"strategy"`
	// This will overwrite the default file suffix. i.e .parquet, use with caution
	Suffix string                                                        `json:"suffix"`
	JSON   sinkGetResponseConfigCloudflarePipelinesR2TableFileNamingJSON `json:"-"`
}

Controls filename prefix/suffix and strategy.

func (*SinkGetResponseConfigCloudflarePipelinesR2TableFileNaming) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy string

Filename generation strategy.

const (
	SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial"
	SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUID   SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid"
	SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7"
	SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUlid   SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid"
)

func (SinkGetResponseConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TablePartitioning added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TablePartitioning struct {
	// The pattern of the date string
	TimePattern string                                                          `json:"time_pattern"`
	JSON        sinkGetResponseConfigCloudflarePipelinesR2TablePartitioningJSON `json:"-"`
}

Data-layout partitioning for sinks.

func (*SinkGetResponseConfigCloudflarePipelinesR2TablePartitioning) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicy added in v6.3.0

type SinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicy 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            sinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicyJSON `json:"-"`
}

Rolling policy for file sinks (when & why to close a file and open a new one).

func (*SinkGetResponseConfigCloudflarePipelinesR2TableRollingPolicy) UnmarshalJSON added in v6.3.0

type SinkGetResponseConfigUnion added in v6.3.0

type SinkGetResponseConfigUnion interface {
	// contains filtered or unexported methods
}

Defines the configuration of the R2 Sink.

Union satisfied by SinkGetResponseConfigCloudflarePipelinesR2Table or SinkGetResponseConfigCloudflarePipelinesR2DataCatalogTable.

type SinkGetResponseEnvelope added in v6.3.0

type SinkGetResponseEnvelope struct {
	Result SinkGetResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                        `json:"success,required"`
	JSON    sinkGetResponseEnvelopeJSON `json:"-"`
}

func (*SinkGetResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseFormat added in v6.3.0

type SinkGetResponseFormat struct {
	Type            SinkGetResponseFormatType            `json:"type,required"`
	Compression     SinkGetResponseFormatCompression     `json:"compression"`
	DecimalEncoding SinkGetResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                `json:"row_group_bytes,nullable"`
	TimestampFormat SinkGetResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                 `json:"unstructured"`
	JSON            sinkGetResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkGetResponseFormat) AsUnion added in v6.3.0

AsUnion returns a SinkGetResponseFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkGetResponseFormatJson, SinkGetResponseFormatParquet.

func (*SinkGetResponseFormat) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseFormat) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseFormatCompression added in v6.3.0

type SinkGetResponseFormatCompression string
const (
	SinkGetResponseFormatCompressionUncompressed SinkGetResponseFormatCompression = "uncompressed"
	SinkGetResponseFormatCompressionSnappy       SinkGetResponseFormatCompression = "snappy"
	SinkGetResponseFormatCompressionGzip         SinkGetResponseFormatCompression = "gzip"
	SinkGetResponseFormatCompressionZstd         SinkGetResponseFormatCompression = "zstd"
	SinkGetResponseFormatCompressionLz4          SinkGetResponseFormatCompression = "lz4"
)

func (SinkGetResponseFormatCompression) IsKnown added in v6.3.0

type SinkGetResponseFormatDecimalEncoding added in v6.3.0

type SinkGetResponseFormatDecimalEncoding string
const (
	SinkGetResponseFormatDecimalEncodingNumber SinkGetResponseFormatDecimalEncoding = "number"
	SinkGetResponseFormatDecimalEncodingString SinkGetResponseFormatDecimalEncoding = "string"
	SinkGetResponseFormatDecimalEncodingBytes  SinkGetResponseFormatDecimalEncoding = "bytes"
)

func (SinkGetResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkGetResponseFormatJson added in v6.3.0

type SinkGetResponseFormatJson struct {
	Type            SinkGetResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkGetResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkGetResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                     `json:"unstructured"`
	JSON            sinkGetResponseFormatJsonJSON            `json:"-"`
}

func (*SinkGetResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseFormatJsonDecimalEncoding added in v6.3.0

type SinkGetResponseFormatJsonDecimalEncoding string
const (
	SinkGetResponseFormatJsonDecimalEncodingNumber SinkGetResponseFormatJsonDecimalEncoding = "number"
	SinkGetResponseFormatJsonDecimalEncodingString SinkGetResponseFormatJsonDecimalEncoding = "string"
	SinkGetResponseFormatJsonDecimalEncodingBytes  SinkGetResponseFormatJsonDecimalEncoding = "bytes"
)

func (SinkGetResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkGetResponseFormatJsonTimestampFormat added in v6.3.0

type SinkGetResponseFormatJsonTimestampFormat string
const (
	SinkGetResponseFormatJsonTimestampFormatRfc3339    SinkGetResponseFormatJsonTimestampFormat = "rfc3339"
	SinkGetResponseFormatJsonTimestampFormatUnixMillis SinkGetResponseFormatJsonTimestampFormat = "unix_millis"
)

func (SinkGetResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkGetResponseFormatJsonType added in v6.3.0

type SinkGetResponseFormatJsonType string
const (
	SinkGetResponseFormatJsonTypeJson SinkGetResponseFormatJsonType = "json"
)

func (SinkGetResponseFormatJsonType) IsKnown added in v6.3.0

func (r SinkGetResponseFormatJsonType) IsKnown() bool

type SinkGetResponseFormatParquet added in v6.3.0

type SinkGetResponseFormatParquet struct {
	Type          SinkGetResponseFormatParquetType        `json:"type,required"`
	Compression   SinkGetResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                   `json:"row_group_bytes,nullable"`
	JSON          sinkGetResponseFormatParquetJSON        `json:"-"`
}

func (*SinkGetResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseFormatParquetCompression added in v6.3.0

type SinkGetResponseFormatParquetCompression string
const (
	SinkGetResponseFormatParquetCompressionUncompressed SinkGetResponseFormatParquetCompression = "uncompressed"
	SinkGetResponseFormatParquetCompressionSnappy       SinkGetResponseFormatParquetCompression = "snappy"
	SinkGetResponseFormatParquetCompressionGzip         SinkGetResponseFormatParquetCompression = "gzip"
	SinkGetResponseFormatParquetCompressionZstd         SinkGetResponseFormatParquetCompression = "zstd"
	SinkGetResponseFormatParquetCompressionLz4          SinkGetResponseFormatParquetCompression = "lz4"
)

func (SinkGetResponseFormatParquetCompression) IsKnown added in v6.3.0

type SinkGetResponseFormatParquetType added in v6.3.0

type SinkGetResponseFormatParquetType string
const (
	SinkGetResponseFormatParquetTypeParquet SinkGetResponseFormatParquetType = "parquet"
)

func (SinkGetResponseFormatParquetType) IsKnown added in v6.3.0

type SinkGetResponseFormatTimestampFormat added in v6.3.0

type SinkGetResponseFormatTimestampFormat string
const (
	SinkGetResponseFormatTimestampFormatRfc3339    SinkGetResponseFormatTimestampFormat = "rfc3339"
	SinkGetResponseFormatTimestampFormatUnixMillis SinkGetResponseFormatTimestampFormat = "unix_millis"
)

func (SinkGetResponseFormatTimestampFormat) IsKnown added in v6.3.0

type SinkGetResponseFormatType added in v6.3.0

type SinkGetResponseFormatType string
const (
	SinkGetResponseFormatTypeJson    SinkGetResponseFormatType = "json"
	SinkGetResponseFormatTypeParquet SinkGetResponseFormatType = "parquet"
)

func (SinkGetResponseFormatType) IsKnown added in v6.3.0

func (r SinkGetResponseFormatType) IsKnown() bool

type SinkGetResponseFormatUnion added in v6.3.0

type SinkGetResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkGetResponseFormatJson or SinkGetResponseFormatParquet.

type SinkGetResponseSchema added in v6.3.0

type SinkGetResponseSchema struct {
	Fields   []SinkGetResponseSchemaField `json:"fields"`
	Format   SinkGetResponseSchemaFormat  `json:"format"`
	Inferred bool                         `json:"inferred,nullable"`
	JSON     sinkGetResponseSchemaJSON    `json:"-"`
}

func (*SinkGetResponseSchema) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchema) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaField added in v6.3.0

type SinkGetResponseSchemaField struct {
	Type        SinkGetResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                          `json:"metadata_key,nullable"`
	Name        string                          `json:"name"`
	Required    bool                            `json:"required"`
	SqlName     string                          `json:"sql_name"`
	Unit        SinkGetResponseSchemaFieldsUnit `json:"unit"`
	JSON        sinkGetResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*SinkGetResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsBinary added in v6.3.0

type SinkGetResponseSchemaFieldsBinary struct {
	Type        SinkGetResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsBinaryType added in v6.3.0

type SinkGetResponseSchemaFieldsBinaryType string
const (
	SinkGetResponseSchemaFieldsBinaryTypeBinary SinkGetResponseSchemaFieldsBinaryType = "binary"
)

func (SinkGetResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsBool added in v6.3.0

type SinkGetResponseSchemaFieldsBool struct {
	Type        SinkGetResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                              `json:"metadata_key,nullable"`
	Name        string                              `json:"name"`
	Required    bool                                `json:"required"`
	SqlName     string                              `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsBoolType added in v6.3.0

type SinkGetResponseSchemaFieldsBoolType string
const (
	SinkGetResponseSchemaFieldsBoolTypeBool SinkGetResponseSchemaFieldsBoolType = "bool"
)

func (SinkGetResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsFloat32 added in v6.3.0

type SinkGetResponseSchemaFieldsFloat32 struct {
	Type        SinkGetResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsFloat32Type added in v6.3.0

type SinkGetResponseSchemaFieldsFloat32Type string
const (
	SinkGetResponseSchemaFieldsFloat32TypeFloat32 SinkGetResponseSchemaFieldsFloat32Type = "float32"
)

func (SinkGetResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsFloat64 added in v6.3.0

type SinkGetResponseSchemaFieldsFloat64 struct {
	Type        SinkGetResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsFloat64Type added in v6.3.0

type SinkGetResponseSchemaFieldsFloat64Type string
const (
	SinkGetResponseSchemaFieldsFloat64TypeFloat64 SinkGetResponseSchemaFieldsFloat64Type = "float64"
)

func (SinkGetResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsInt32 added in v6.3.0

type SinkGetResponseSchemaFieldsInt32 struct {
	Type        SinkGetResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsInt32Type added in v6.3.0

type SinkGetResponseSchemaFieldsInt32Type string
const (
	SinkGetResponseSchemaFieldsInt32TypeInt32 SinkGetResponseSchemaFieldsInt32Type = "int32"
)

func (SinkGetResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsInt64 added in v6.3.0

type SinkGetResponseSchemaFieldsInt64 struct {
	Type        SinkGetResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsInt64Type added in v6.3.0

type SinkGetResponseSchemaFieldsInt64Type string
const (
	SinkGetResponseSchemaFieldsInt64TypeInt64 SinkGetResponseSchemaFieldsInt64Type = "int64"
)

func (SinkGetResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsJson added in v6.3.0

type SinkGetResponseSchemaFieldsJson struct {
	Type        SinkGetResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                              `json:"metadata_key,nullable"`
	Name        string                              `json:"name"`
	Required    bool                                `json:"required"`
	SqlName     string                              `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsJsonType added in v6.3.0

type SinkGetResponseSchemaFieldsJsonType string
const (
	SinkGetResponseSchemaFieldsJsonTypeJson SinkGetResponseSchemaFieldsJsonType = "json"
)

func (SinkGetResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsList added in v6.3.0

type SinkGetResponseSchemaFieldsList struct {
	JSON sinkGetResponseSchemaFieldsListJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsString added in v6.3.0

type SinkGetResponseSchemaFieldsString struct {
	Type        SinkGetResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkGetResponseSchemaFieldsStringJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsStringType added in v6.3.0

type SinkGetResponseSchemaFieldsStringType string
const (
	SinkGetResponseSchemaFieldsStringTypeString SinkGetResponseSchemaFieldsStringType = "string"
)

func (SinkGetResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsStruct added in v6.3.0

type SinkGetResponseSchemaFieldsStruct struct {
	JSON sinkGetResponseSchemaFieldsStructJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsTimestamp added in v6.3.0

type SinkGetResponseSchemaFieldsTimestamp struct {
	Type        SinkGetResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	Unit        SinkGetResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        sinkGetResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*SinkGetResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFieldsTimestampType added in v6.3.0

type SinkGetResponseSchemaFieldsTimestampType string
const (
	SinkGetResponseSchemaFieldsTimestampTypeTimestamp SinkGetResponseSchemaFieldsTimestampType = "timestamp"
)

func (SinkGetResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsTimestampUnit added in v6.3.0

type SinkGetResponseSchemaFieldsTimestampUnit string
const (
	SinkGetResponseSchemaFieldsTimestampUnitSecond      SinkGetResponseSchemaFieldsTimestampUnit = "second"
	SinkGetResponseSchemaFieldsTimestampUnitMillisecond SinkGetResponseSchemaFieldsTimestampUnit = "millisecond"
	SinkGetResponseSchemaFieldsTimestampUnitMicrosecond SinkGetResponseSchemaFieldsTimestampUnit = "microsecond"
	SinkGetResponseSchemaFieldsTimestampUnitNanosecond  SinkGetResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (SinkGetResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsType added in v6.3.0

type SinkGetResponseSchemaFieldsType string
const (
	SinkGetResponseSchemaFieldsTypeInt32     SinkGetResponseSchemaFieldsType = "int32"
	SinkGetResponseSchemaFieldsTypeInt64     SinkGetResponseSchemaFieldsType = "int64"
	SinkGetResponseSchemaFieldsTypeFloat32   SinkGetResponseSchemaFieldsType = "float32"
	SinkGetResponseSchemaFieldsTypeFloat64   SinkGetResponseSchemaFieldsType = "float64"
	SinkGetResponseSchemaFieldsTypeBool      SinkGetResponseSchemaFieldsType = "bool"
	SinkGetResponseSchemaFieldsTypeString    SinkGetResponseSchemaFieldsType = "string"
	SinkGetResponseSchemaFieldsTypeBinary    SinkGetResponseSchemaFieldsType = "binary"
	SinkGetResponseSchemaFieldsTypeTimestamp SinkGetResponseSchemaFieldsType = "timestamp"
	SinkGetResponseSchemaFieldsTypeJson      SinkGetResponseSchemaFieldsType = "json"
	SinkGetResponseSchemaFieldsTypeStruct    SinkGetResponseSchemaFieldsType = "struct"
	SinkGetResponseSchemaFieldsTypeList      SinkGetResponseSchemaFieldsType = "list"
)

func (SinkGetResponseSchemaFieldsType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFieldsUnit added in v6.3.0

type SinkGetResponseSchemaFieldsUnit string
const (
	SinkGetResponseSchemaFieldsUnitSecond      SinkGetResponseSchemaFieldsUnit = "second"
	SinkGetResponseSchemaFieldsUnitMillisecond SinkGetResponseSchemaFieldsUnit = "millisecond"
	SinkGetResponseSchemaFieldsUnitMicrosecond SinkGetResponseSchemaFieldsUnit = "microsecond"
	SinkGetResponseSchemaFieldsUnitNanosecond  SinkGetResponseSchemaFieldsUnit = "nanosecond"
)

func (SinkGetResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormat added in v6.3.0

type SinkGetResponseSchemaFormat struct {
	Type            SinkGetResponseSchemaFormatType            `json:"type,required"`
	Compression     SinkGetResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding SinkGetResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                      `json:"row_group_bytes,nullable"`
	TimestampFormat SinkGetResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                       `json:"unstructured"`
	JSON            sinkGetResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkGetResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a SinkGetResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkGetResponseSchemaFormatJson, SinkGetResponseSchemaFormatParquet.

func (*SinkGetResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFormatCompression added in v6.3.0

type SinkGetResponseSchemaFormatCompression string
const (
	SinkGetResponseSchemaFormatCompressionUncompressed SinkGetResponseSchemaFormatCompression = "uncompressed"
	SinkGetResponseSchemaFormatCompressionSnappy       SinkGetResponseSchemaFormatCompression = "snappy"
	SinkGetResponseSchemaFormatCompressionGzip         SinkGetResponseSchemaFormatCompression = "gzip"
	SinkGetResponseSchemaFormatCompressionZstd         SinkGetResponseSchemaFormatCompression = "zstd"
	SinkGetResponseSchemaFormatCompressionLz4          SinkGetResponseSchemaFormatCompression = "lz4"
)

func (SinkGetResponseSchemaFormatCompression) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatDecimalEncoding added in v6.3.0

type SinkGetResponseSchemaFormatDecimalEncoding string
const (
	SinkGetResponseSchemaFormatDecimalEncodingNumber SinkGetResponseSchemaFormatDecimalEncoding = "number"
	SinkGetResponseSchemaFormatDecimalEncodingString SinkGetResponseSchemaFormatDecimalEncoding = "string"
	SinkGetResponseSchemaFormatDecimalEncodingBytes  SinkGetResponseSchemaFormatDecimalEncoding = "bytes"
)

func (SinkGetResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatJson added in v6.3.0

type SinkGetResponseSchemaFormatJson struct {
	Type            SinkGetResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkGetResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkGetResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                           `json:"unstructured"`
	JSON            sinkGetResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*SinkGetResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type SinkGetResponseSchemaFormatJsonDecimalEncoding string
const (
	SinkGetResponseSchemaFormatJsonDecimalEncodingNumber SinkGetResponseSchemaFormatJsonDecimalEncoding = "number"
	SinkGetResponseSchemaFormatJsonDecimalEncodingString SinkGetResponseSchemaFormatJsonDecimalEncoding = "string"
	SinkGetResponseSchemaFormatJsonDecimalEncodingBytes  SinkGetResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (SinkGetResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type SinkGetResponseSchemaFormatJsonTimestampFormat string
const (
	SinkGetResponseSchemaFormatJsonTimestampFormatRfc3339    SinkGetResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	SinkGetResponseSchemaFormatJsonTimestampFormatUnixMillis SinkGetResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (SinkGetResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatJsonType added in v6.3.0

type SinkGetResponseSchemaFormatJsonType string
const (
	SinkGetResponseSchemaFormatJsonTypeJson SinkGetResponseSchemaFormatJsonType = "json"
)

func (SinkGetResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatParquet added in v6.3.0

type SinkGetResponseSchemaFormatParquet struct {
	Type          SinkGetResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   SinkGetResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                         `json:"row_group_bytes,nullable"`
	JSON          sinkGetResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*SinkGetResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkGetResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkGetResponseSchemaFormatParquetCompression added in v6.3.0

type SinkGetResponseSchemaFormatParquetCompression string
const (
	SinkGetResponseSchemaFormatParquetCompressionUncompressed SinkGetResponseSchemaFormatParquetCompression = "uncompressed"
	SinkGetResponseSchemaFormatParquetCompressionSnappy       SinkGetResponseSchemaFormatParquetCompression = "snappy"
	SinkGetResponseSchemaFormatParquetCompressionGzip         SinkGetResponseSchemaFormatParquetCompression = "gzip"
	SinkGetResponseSchemaFormatParquetCompressionZstd         SinkGetResponseSchemaFormatParquetCompression = "zstd"
	SinkGetResponseSchemaFormatParquetCompressionLz4          SinkGetResponseSchemaFormatParquetCompression = "lz4"
)

func (SinkGetResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatParquetType added in v6.3.0

type SinkGetResponseSchemaFormatParquetType string
const (
	SinkGetResponseSchemaFormatParquetTypeParquet SinkGetResponseSchemaFormatParquetType = "parquet"
)

func (SinkGetResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatTimestampFormat added in v6.3.0

type SinkGetResponseSchemaFormatTimestampFormat string
const (
	SinkGetResponseSchemaFormatTimestampFormatRfc3339    SinkGetResponseSchemaFormatTimestampFormat = "rfc3339"
	SinkGetResponseSchemaFormatTimestampFormatUnixMillis SinkGetResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (SinkGetResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatType added in v6.3.0

type SinkGetResponseSchemaFormatType string
const (
	SinkGetResponseSchemaFormatTypeJson    SinkGetResponseSchemaFormatType = "json"
	SinkGetResponseSchemaFormatTypeParquet SinkGetResponseSchemaFormatType = "parquet"
)

func (SinkGetResponseSchemaFormatType) IsKnown added in v6.3.0

type SinkGetResponseSchemaFormatUnion added in v6.3.0

type SinkGetResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkGetResponseSchemaFormatJson or SinkGetResponseSchemaFormatParquet.

type SinkGetResponseType added in v6.3.0

type SinkGetResponseType string

Specifies the type of sink.

const (
	SinkGetResponseTypeR2            SinkGetResponseType = "r2"
	SinkGetResponseTypeR2DataCatalog SinkGetResponseType = "r2_data_catalog"
)

func (SinkGetResponseType) IsKnown added in v6.3.0

func (r SinkGetResponseType) IsKnown() bool

type SinkListParams added in v6.3.0

type SinkListParams struct {
	// Specifies the public ID of the account.
	AccountID  param.Field[string]  `path:"account_id,required"`
	Page       param.Field[float64] `query:"page"`
	PerPage    param.Field[float64] `query:"per_page"`
	PipelineID param.Field[string]  `query:"pipeline_id"`
}

func (SinkListParams) URLQuery added in v6.3.0

func (r SinkListParams) URLQuery() (v url.Values)

URLQuery serializes SinkListParams's query parameters as `url.Values`.

type SinkListResponse added in v6.3.0

type SinkListResponse struct {
	// Indicates a unique identifier for this sink.
	ID         string    `json:"id,required"`
	CreatedAt  time.Time `json:"created_at,required" format:"date-time"`
	ModifiedAt time.Time `json:"modified_at,required" format:"date-time"`
	// Defines the name of the Sink.
	Name string `json:"name,required"`
	// Specifies the type of sink.
	Type SinkListResponseType `json:"type,required"`
	// Defines the configuration of the R2 Sink.
	Config SinkListResponseConfig `json:"config"`
	Format SinkListResponseFormat `json:"format"`
	Schema SinkListResponseSchema `json:"schema"`
	JSON   sinkListResponseJSON   `json:"-"`
}

func (*SinkListResponse) UnmarshalJSON added in v6.3.0

func (r *SinkListResponse) UnmarshalJSON(data []byte) (err error)

type SinkListResponseConfig added in v6.3.0

type SinkListResponseConfig struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket string `json:"bucket,required"`
	// Authentication token
	Token string `json:"token" format:"var-str"`
	// This field can have the runtime type of
	// [SinkListResponseConfigCloudflarePipelinesR2TableCredentials].
	Credentials interface{} `json:"credentials"`
	// This field can have the runtime type of
	// [SinkListResponseConfigCloudflarePipelinesR2TableFileNaming].
	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
	// [SinkListResponseConfigCloudflarePipelinesR2TablePartitioning].
	Partitioning interface{} `json:"partitioning"`
	// Subpath within the bucket to write to
	Path string `json:"path"`
	// This field can have the runtime type of
	// [SinkListResponseConfigCloudflarePipelinesR2TableRollingPolicy],
	// [SinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy].
	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 added in v6.3.0

AsUnion returns a SinkListResponseConfigUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkListResponseConfigCloudflarePipelinesR2Table, SinkListResponseConfigCloudflarePipelinesR2DataCatalogTable.

func (*SinkListResponseConfig) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseConfig) UnmarshalJSON(data []byte) (err error)

type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTable added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTable struct {
	// Authentication token
	Token string `json:"token,required" format:"var-str"`
	// Cloudflare Account ID
	AccountID string `json:"account_id,required" format:"uri"`
	// The R2 Bucket that hosts this catalog
	Bucket string `json:"bucket,required"`
	// Table name
	TableName string `json:"table_name,required"`
	// Table namespace
	Namespace string `json:"namespace"`
	// Rolling policy for file sinks (when & why to close a file and open a new one).
	RollingPolicy SinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy `json:"rolling_policy"`
	JSON          sinkListResponseConfigCloudflarePipelinesR2DataCatalogTableJSON          `json:"-"`
}

R2 Data Catalog Sink

func (*SinkListResponseConfigCloudflarePipelinesR2DataCatalogTable) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy 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            sinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicyJSON `json:"-"`
}

Rolling policy for file sinks (when & why to close a file and open a new one).

func (*SinkListResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2Table added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2Table struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket      string                                                      `json:"bucket,required"`
	Credentials SinkListResponseConfigCloudflarePipelinesR2TableCredentials `json:"credentials,required"`
	// Controls filename prefix/suffix and strategy.
	FileNaming SinkListResponseConfigCloudflarePipelinesR2TableFileNaming `json:"file_naming"`
	// Jurisdiction this bucket is hosted in
	Jurisdiction string `json:"jurisdiction"`
	// Data-layout partitioning for sinks.
	Partitioning SinkListResponseConfigCloudflarePipelinesR2TablePartitioning `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 SinkListResponseConfigCloudflarePipelinesR2TableRollingPolicy `json:"rolling_policy"`
	JSON          sinkListResponseConfigCloudflarePipelinesR2TableJSON          `json:"-"`
}

func (*SinkListResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON(data []byte) (err error)

type SinkListResponseConfigCloudflarePipelinesR2TableCredentials added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableCredentials struct {
	// Cloudflare Account ID for the bucket
	AccessKeyID string `json:"access_key_id,required" format:"var-str"`
	// Cloudflare Account ID for the bucket
	SecretAccessKey string                                                          `json:"secret_access_key,required" format:"var-str"`
	JSON            sinkListResponseConfigCloudflarePipelinesR2TableCredentialsJSON `json:"-"`
}

func (*SinkListResponseConfigCloudflarePipelinesR2TableCredentials) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableFileNaming added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableFileNaming struct {
	// The prefix to use in file name. i.e prefix-<uuid>.parquet
	Prefix string `json:"prefix"`
	// Filename generation strategy.
	Strategy SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy `json:"strategy"`
	// This will overwrite the default file suffix. i.e .parquet, use with caution
	Suffix string                                                         `json:"suffix"`
	JSON   sinkListResponseConfigCloudflarePipelinesR2TableFileNamingJSON `json:"-"`
}

Controls filename prefix/suffix and strategy.

func (*SinkListResponseConfigCloudflarePipelinesR2TableFileNaming) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy string

Filename generation strategy.

const (
	SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial"
	SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUID   SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid"
	SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7"
	SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUlid   SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid"
)

func (SinkListResponseConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TablePartitioning added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TablePartitioning struct {
	// The pattern of the date string
	TimePattern string                                                           `json:"time_pattern"`
	JSON        sinkListResponseConfigCloudflarePipelinesR2TablePartitioningJSON `json:"-"`
}

Data-layout partitioning for sinks.

func (*SinkListResponseConfigCloudflarePipelinesR2TablePartitioning) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableRollingPolicy added in v6.3.0

type SinkListResponseConfigCloudflarePipelinesR2TableRollingPolicy 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            sinkListResponseConfigCloudflarePipelinesR2TableRollingPolicyJSON `json:"-"`
}

Rolling policy for file sinks (when & why to close a file and open a new one).

func (*SinkListResponseConfigCloudflarePipelinesR2TableRollingPolicy) UnmarshalJSON added in v6.3.0

type SinkListResponseConfigUnion added in v6.3.0

type SinkListResponseConfigUnion interface {
	// contains filtered or unexported methods
}

Defines the configuration of the R2 Sink.

Union satisfied by SinkListResponseConfigCloudflarePipelinesR2Table or SinkListResponseConfigCloudflarePipelinesR2DataCatalogTable.

type SinkListResponseFormat added in v6.3.0

type SinkListResponseFormat struct {
	Type            SinkListResponseFormatType            `json:"type,required"`
	Compression     SinkListResponseFormatCompression     `json:"compression"`
	DecimalEncoding SinkListResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                 `json:"row_group_bytes,nullable"`
	TimestampFormat SinkListResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                  `json:"unstructured"`
	JSON            sinkListResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkListResponseFormat) AsUnion added in v6.3.0

AsUnion returns a SinkListResponseFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkListResponseFormatJson, SinkListResponseFormatParquet.

func (*SinkListResponseFormat) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseFormat) UnmarshalJSON(data []byte) (err error)

type SinkListResponseFormatCompression added in v6.3.0

type SinkListResponseFormatCompression string
const (
	SinkListResponseFormatCompressionUncompressed SinkListResponseFormatCompression = "uncompressed"
	SinkListResponseFormatCompressionSnappy       SinkListResponseFormatCompression = "snappy"
	SinkListResponseFormatCompressionGzip         SinkListResponseFormatCompression = "gzip"
	SinkListResponseFormatCompressionZstd         SinkListResponseFormatCompression = "zstd"
	SinkListResponseFormatCompressionLz4          SinkListResponseFormatCompression = "lz4"
)

func (SinkListResponseFormatCompression) IsKnown added in v6.3.0

type SinkListResponseFormatDecimalEncoding added in v6.3.0

type SinkListResponseFormatDecimalEncoding string
const (
	SinkListResponseFormatDecimalEncodingNumber SinkListResponseFormatDecimalEncoding = "number"
	SinkListResponseFormatDecimalEncodingString SinkListResponseFormatDecimalEncoding = "string"
	SinkListResponseFormatDecimalEncodingBytes  SinkListResponseFormatDecimalEncoding = "bytes"
)

func (SinkListResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkListResponseFormatJson added in v6.3.0

type SinkListResponseFormatJson struct {
	Type            SinkListResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkListResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkListResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                      `json:"unstructured"`
	JSON            sinkListResponseFormatJsonJSON            `json:"-"`
}

func (*SinkListResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkListResponseFormatJsonDecimalEncoding added in v6.3.0

type SinkListResponseFormatJsonDecimalEncoding string
const (
	SinkListResponseFormatJsonDecimalEncodingNumber SinkListResponseFormatJsonDecimalEncoding = "number"
	SinkListResponseFormatJsonDecimalEncodingString SinkListResponseFormatJsonDecimalEncoding = "string"
	SinkListResponseFormatJsonDecimalEncodingBytes  SinkListResponseFormatJsonDecimalEncoding = "bytes"
)

func (SinkListResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkListResponseFormatJsonTimestampFormat added in v6.3.0

type SinkListResponseFormatJsonTimestampFormat string
const (
	SinkListResponseFormatJsonTimestampFormatRfc3339    SinkListResponseFormatJsonTimestampFormat = "rfc3339"
	SinkListResponseFormatJsonTimestampFormatUnixMillis SinkListResponseFormatJsonTimestampFormat = "unix_millis"
)

func (SinkListResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkListResponseFormatJsonType added in v6.3.0

type SinkListResponseFormatJsonType string
const (
	SinkListResponseFormatJsonTypeJson SinkListResponseFormatJsonType = "json"
)

func (SinkListResponseFormatJsonType) IsKnown added in v6.3.0

type SinkListResponseFormatParquet added in v6.3.0

type SinkListResponseFormatParquet struct {
	Type          SinkListResponseFormatParquetType        `json:"type,required"`
	Compression   SinkListResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                    `json:"row_group_bytes,nullable"`
	JSON          sinkListResponseFormatParquetJSON        `json:"-"`
}

func (*SinkListResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkListResponseFormatParquetCompression added in v6.3.0

type SinkListResponseFormatParquetCompression string
const (
	SinkListResponseFormatParquetCompressionUncompressed SinkListResponseFormatParquetCompression = "uncompressed"
	SinkListResponseFormatParquetCompressionSnappy       SinkListResponseFormatParquetCompression = "snappy"
	SinkListResponseFormatParquetCompressionGzip         SinkListResponseFormatParquetCompression = "gzip"
	SinkListResponseFormatParquetCompressionZstd         SinkListResponseFormatParquetCompression = "zstd"
	SinkListResponseFormatParquetCompressionLz4          SinkListResponseFormatParquetCompression = "lz4"
)

func (SinkListResponseFormatParquetCompression) IsKnown added in v6.3.0

type SinkListResponseFormatParquetType added in v6.3.0

type SinkListResponseFormatParquetType string
const (
	SinkListResponseFormatParquetTypeParquet SinkListResponseFormatParquetType = "parquet"
)

func (SinkListResponseFormatParquetType) IsKnown added in v6.3.0

type SinkListResponseFormatTimestampFormat added in v6.3.0

type SinkListResponseFormatTimestampFormat string
const (
	SinkListResponseFormatTimestampFormatRfc3339    SinkListResponseFormatTimestampFormat = "rfc3339"
	SinkListResponseFormatTimestampFormatUnixMillis SinkListResponseFormatTimestampFormat = "unix_millis"
)

func (SinkListResponseFormatTimestampFormat) IsKnown added in v6.3.0

type SinkListResponseFormatType added in v6.3.0

type SinkListResponseFormatType string
const (
	SinkListResponseFormatTypeJson    SinkListResponseFormatType = "json"
	SinkListResponseFormatTypeParquet SinkListResponseFormatType = "parquet"
)

func (SinkListResponseFormatType) IsKnown added in v6.3.0

func (r SinkListResponseFormatType) IsKnown() bool

type SinkListResponseFormatUnion added in v6.3.0

type SinkListResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkListResponseFormatJson or SinkListResponseFormatParquet.

type SinkListResponseSchema added in v6.3.0

type SinkListResponseSchema struct {
	Fields   []SinkListResponseSchemaField `json:"fields"`
	Format   SinkListResponseSchemaFormat  `json:"format"`
	Inferred bool                          `json:"inferred,nullable"`
	JSON     sinkListResponseSchemaJSON    `json:"-"`
}

func (*SinkListResponseSchema) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchema) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaField added in v6.3.0

type SinkListResponseSchemaField struct {
	Type        SinkListResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                           `json:"metadata_key,nullable"`
	Name        string                           `json:"name"`
	Required    bool                             `json:"required"`
	SqlName     string                           `json:"sql_name"`
	Unit        SinkListResponseSchemaFieldsUnit `json:"unit"`
	JSON        sinkListResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*SinkListResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsBinary added in v6.3.0

type SinkListResponseSchemaFieldsBinary struct {
	Type        SinkListResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsBinaryType added in v6.3.0

type SinkListResponseSchemaFieldsBinaryType string
const (
	SinkListResponseSchemaFieldsBinaryTypeBinary SinkListResponseSchemaFieldsBinaryType = "binary"
)

func (SinkListResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsBool added in v6.3.0

type SinkListResponseSchemaFieldsBool struct {
	Type        SinkListResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsBoolType added in v6.3.0

type SinkListResponseSchemaFieldsBoolType string
const (
	SinkListResponseSchemaFieldsBoolTypeBool SinkListResponseSchemaFieldsBoolType = "bool"
)

func (SinkListResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsFloat32 added in v6.3.0

type SinkListResponseSchemaFieldsFloat32 struct {
	Type        SinkListResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsFloat32Type added in v6.3.0

type SinkListResponseSchemaFieldsFloat32Type string
const (
	SinkListResponseSchemaFieldsFloat32TypeFloat32 SinkListResponseSchemaFieldsFloat32Type = "float32"
)

func (SinkListResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsFloat64 added in v6.3.0

type SinkListResponseSchemaFieldsFloat64 struct {
	Type        SinkListResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsFloat64Type added in v6.3.0

type SinkListResponseSchemaFieldsFloat64Type string
const (
	SinkListResponseSchemaFieldsFloat64TypeFloat64 SinkListResponseSchemaFieldsFloat64Type = "float64"
)

func (SinkListResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsInt32 added in v6.3.0

type SinkListResponseSchemaFieldsInt32 struct {
	Type        SinkListResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsInt32Type added in v6.3.0

type SinkListResponseSchemaFieldsInt32Type string
const (
	SinkListResponseSchemaFieldsInt32TypeInt32 SinkListResponseSchemaFieldsInt32Type = "int32"
)

func (SinkListResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsInt64 added in v6.3.0

type SinkListResponseSchemaFieldsInt64 struct {
	Type        SinkListResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsInt64Type added in v6.3.0

type SinkListResponseSchemaFieldsInt64Type string
const (
	SinkListResponseSchemaFieldsInt64TypeInt64 SinkListResponseSchemaFieldsInt64Type = "int64"
)

func (SinkListResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsJson added in v6.3.0

type SinkListResponseSchemaFieldsJson struct {
	Type        SinkListResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsJsonType added in v6.3.0

type SinkListResponseSchemaFieldsJsonType string
const (
	SinkListResponseSchemaFieldsJsonTypeJson SinkListResponseSchemaFieldsJsonType = "json"
)

func (SinkListResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsList added in v6.3.0

type SinkListResponseSchemaFieldsList struct {
	JSON sinkListResponseSchemaFieldsListJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsString added in v6.3.0

type SinkListResponseSchemaFieldsString struct {
	Type        SinkListResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkListResponseSchemaFieldsStringJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsStringType added in v6.3.0

type SinkListResponseSchemaFieldsStringType string
const (
	SinkListResponseSchemaFieldsStringTypeString SinkListResponseSchemaFieldsStringType = "string"
)

func (SinkListResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsStruct added in v6.3.0

type SinkListResponseSchemaFieldsStruct struct {
	JSON sinkListResponseSchemaFieldsStructJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsTimestamp added in v6.3.0

type SinkListResponseSchemaFieldsTimestamp struct {
	Type        SinkListResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                    `json:"metadata_key,nullable"`
	Name        string                                    `json:"name"`
	Required    bool                                      `json:"required"`
	SqlName     string                                    `json:"sql_name"`
	Unit        SinkListResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        sinkListResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*SinkListResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFieldsTimestampType added in v6.3.0

type SinkListResponseSchemaFieldsTimestampType string
const (
	SinkListResponseSchemaFieldsTimestampTypeTimestamp SinkListResponseSchemaFieldsTimestampType = "timestamp"
)

func (SinkListResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsTimestampUnit added in v6.3.0

type SinkListResponseSchemaFieldsTimestampUnit string
const (
	SinkListResponseSchemaFieldsTimestampUnitSecond      SinkListResponseSchemaFieldsTimestampUnit = "second"
	SinkListResponseSchemaFieldsTimestampUnitMillisecond SinkListResponseSchemaFieldsTimestampUnit = "millisecond"
	SinkListResponseSchemaFieldsTimestampUnitMicrosecond SinkListResponseSchemaFieldsTimestampUnit = "microsecond"
	SinkListResponseSchemaFieldsTimestampUnitNanosecond  SinkListResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (SinkListResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsType added in v6.3.0

type SinkListResponseSchemaFieldsType string
const (
	SinkListResponseSchemaFieldsTypeInt32     SinkListResponseSchemaFieldsType = "int32"
	SinkListResponseSchemaFieldsTypeInt64     SinkListResponseSchemaFieldsType = "int64"
	SinkListResponseSchemaFieldsTypeFloat32   SinkListResponseSchemaFieldsType = "float32"
	SinkListResponseSchemaFieldsTypeFloat64   SinkListResponseSchemaFieldsType = "float64"
	SinkListResponseSchemaFieldsTypeBool      SinkListResponseSchemaFieldsType = "bool"
	SinkListResponseSchemaFieldsTypeString    SinkListResponseSchemaFieldsType = "string"
	SinkListResponseSchemaFieldsTypeBinary    SinkListResponseSchemaFieldsType = "binary"
	SinkListResponseSchemaFieldsTypeTimestamp SinkListResponseSchemaFieldsType = "timestamp"
	SinkListResponseSchemaFieldsTypeJson      SinkListResponseSchemaFieldsType = "json"
	SinkListResponseSchemaFieldsTypeStruct    SinkListResponseSchemaFieldsType = "struct"
	SinkListResponseSchemaFieldsTypeList      SinkListResponseSchemaFieldsType = "list"
)

func (SinkListResponseSchemaFieldsType) IsKnown added in v6.3.0

type SinkListResponseSchemaFieldsUnit added in v6.3.0

type SinkListResponseSchemaFieldsUnit string
const (
	SinkListResponseSchemaFieldsUnitSecond      SinkListResponseSchemaFieldsUnit = "second"
	SinkListResponseSchemaFieldsUnitMillisecond SinkListResponseSchemaFieldsUnit = "millisecond"
	SinkListResponseSchemaFieldsUnitMicrosecond SinkListResponseSchemaFieldsUnit = "microsecond"
	SinkListResponseSchemaFieldsUnitNanosecond  SinkListResponseSchemaFieldsUnit = "nanosecond"
)

func (SinkListResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type SinkListResponseSchemaFormat added in v6.3.0

type SinkListResponseSchemaFormat struct {
	Type            SinkListResponseSchemaFormatType            `json:"type,required"`
	Compression     SinkListResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding SinkListResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                       `json:"row_group_bytes,nullable"`
	TimestampFormat SinkListResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                        `json:"unstructured"`
	JSON            sinkListResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkListResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a SinkListResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkListResponseSchemaFormatJson, SinkListResponseSchemaFormatParquet.

func (*SinkListResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFormatCompression added in v6.3.0

type SinkListResponseSchemaFormatCompression string
const (
	SinkListResponseSchemaFormatCompressionUncompressed SinkListResponseSchemaFormatCompression = "uncompressed"
	SinkListResponseSchemaFormatCompressionSnappy       SinkListResponseSchemaFormatCompression = "snappy"
	SinkListResponseSchemaFormatCompressionGzip         SinkListResponseSchemaFormatCompression = "gzip"
	SinkListResponseSchemaFormatCompressionZstd         SinkListResponseSchemaFormatCompression = "zstd"
	SinkListResponseSchemaFormatCompressionLz4          SinkListResponseSchemaFormatCompression = "lz4"
)

func (SinkListResponseSchemaFormatCompression) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatDecimalEncoding added in v6.3.0

type SinkListResponseSchemaFormatDecimalEncoding string
const (
	SinkListResponseSchemaFormatDecimalEncodingNumber SinkListResponseSchemaFormatDecimalEncoding = "number"
	SinkListResponseSchemaFormatDecimalEncodingString SinkListResponseSchemaFormatDecimalEncoding = "string"
	SinkListResponseSchemaFormatDecimalEncodingBytes  SinkListResponseSchemaFormatDecimalEncoding = "bytes"
)

func (SinkListResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatJson added in v6.3.0

type SinkListResponseSchemaFormatJson struct {
	Type            SinkListResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkListResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkListResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                            `json:"unstructured"`
	JSON            sinkListResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*SinkListResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type SinkListResponseSchemaFormatJsonDecimalEncoding string
const (
	SinkListResponseSchemaFormatJsonDecimalEncodingNumber SinkListResponseSchemaFormatJsonDecimalEncoding = "number"
	SinkListResponseSchemaFormatJsonDecimalEncodingString SinkListResponseSchemaFormatJsonDecimalEncoding = "string"
	SinkListResponseSchemaFormatJsonDecimalEncodingBytes  SinkListResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (SinkListResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type SinkListResponseSchemaFormatJsonTimestampFormat string
const (
	SinkListResponseSchemaFormatJsonTimestampFormatRfc3339    SinkListResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	SinkListResponseSchemaFormatJsonTimestampFormatUnixMillis SinkListResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (SinkListResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatJsonType added in v6.3.0

type SinkListResponseSchemaFormatJsonType string
const (
	SinkListResponseSchemaFormatJsonTypeJson SinkListResponseSchemaFormatJsonType = "json"
)

func (SinkListResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatParquet added in v6.3.0

type SinkListResponseSchemaFormatParquet struct {
	Type          SinkListResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   SinkListResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                          `json:"row_group_bytes,nullable"`
	JSON          sinkListResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*SinkListResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkListResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkListResponseSchemaFormatParquetCompression added in v6.3.0

type SinkListResponseSchemaFormatParquetCompression string
const (
	SinkListResponseSchemaFormatParquetCompressionUncompressed SinkListResponseSchemaFormatParquetCompression = "uncompressed"
	SinkListResponseSchemaFormatParquetCompressionSnappy       SinkListResponseSchemaFormatParquetCompression = "snappy"
	SinkListResponseSchemaFormatParquetCompressionGzip         SinkListResponseSchemaFormatParquetCompression = "gzip"
	SinkListResponseSchemaFormatParquetCompressionZstd         SinkListResponseSchemaFormatParquetCompression = "zstd"
	SinkListResponseSchemaFormatParquetCompressionLz4          SinkListResponseSchemaFormatParquetCompression = "lz4"
)

func (SinkListResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatParquetType added in v6.3.0

type SinkListResponseSchemaFormatParquetType string
const (
	SinkListResponseSchemaFormatParquetTypeParquet SinkListResponseSchemaFormatParquetType = "parquet"
)

func (SinkListResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatTimestampFormat added in v6.3.0

type SinkListResponseSchemaFormatTimestampFormat string
const (
	SinkListResponseSchemaFormatTimestampFormatRfc3339    SinkListResponseSchemaFormatTimestampFormat = "rfc3339"
	SinkListResponseSchemaFormatTimestampFormatUnixMillis SinkListResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (SinkListResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatType added in v6.3.0

type SinkListResponseSchemaFormatType string
const (
	SinkListResponseSchemaFormatTypeJson    SinkListResponseSchemaFormatType = "json"
	SinkListResponseSchemaFormatTypeParquet SinkListResponseSchemaFormatType = "parquet"
)

func (SinkListResponseSchemaFormatType) IsKnown added in v6.3.0

type SinkListResponseSchemaFormatUnion added in v6.3.0

type SinkListResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkListResponseSchemaFormatJson or SinkListResponseSchemaFormatParquet.

type SinkListResponseType added in v6.3.0

type SinkListResponseType string

Specifies the type of sink.

const (
	SinkListResponseTypeR2            SinkListResponseType = "r2"
	SinkListResponseTypeR2DataCatalog SinkListResponseType = "r2_data_catalog"
)

func (SinkListResponseType) IsKnown added in v6.3.0

func (r SinkListResponseType) IsKnown() bool

type SinkNewParams added in v6.3.0

type SinkNewParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Defines the name of the Sink.
	Name param.Field[string] `json:"name,required"`
	// Specifies the type of sink.
	Type param.Field[SinkNewParamsType] `json:"type,required"`
	// Defines the configuration of the R2 Sink.
	Config param.Field[SinkNewParamsConfigUnion] `json:"config"`
	Format param.Field[SinkNewParamsFormatUnion] `json:"format"`
	Schema param.Field[SinkNewParamsSchema]      `json:"schema"`
}

func (SinkNewParams) MarshalJSON added in v6.3.0

func (r SinkNewParams) MarshalJSON() (data []byte, err error)

type SinkNewParamsConfig added in v6.3.0

type SinkNewParamsConfig struct {
	// Cloudflare Account ID for the bucket
	AccountID param.Field[string] `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket param.Field[string] `json:"bucket,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 added in v6.3.0

func (r SinkNewParamsConfig) MarshalJSON() (data []byte, err error)

type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable struct {
	// Authentication token
	Token param.Field[string] `json:"token,required" format:"var-str"`
	// Cloudflare Account ID
	AccountID param.Field[string] `json:"account_id,required" format:"uri"`
	// The R2 Bucket that hosts this catalog
	Bucket param.Field[string] `json:"bucket,required"`
	// Table name
	TableName param.Field[string] `json:"table_name,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 added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy added in v6.3.0

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 added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2Table added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2Table struct {
	// Cloudflare Account ID for the bucket
	AccountID param.Field[string] `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket      param.Field[string]                                                   `json:"bucket,required"`
	Credentials param.Field[SinkNewParamsConfigCloudflarePipelinesR2TableCredentials] `json:"credentials,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 added in v6.3.0

func (r SinkNewParamsConfigCloudflarePipelinesR2Table) MarshalJSON() (data []byte, err error)

type SinkNewParamsConfigCloudflarePipelinesR2TableCredentials added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TableCredentials struct {
	// Cloudflare Account ID for the bucket
	AccessKeyID param.Field[string] `json:"access_key_id,required" format:"var-str"`
	// Cloudflare Account ID for the bucket
	SecretAccessKey param.Field[string] `json:"secret_access_key,required" format:"var-str"`
}

func (SinkNewParamsConfigCloudflarePipelinesR2TableCredentials) MarshalJSON added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TableFileNaming added in v6.3.0

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 added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy string

Filename generation strategy.

const (
	SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial"
	SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUID   SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid"
	SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7"
	SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategyUlid   SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid"
)

func (SinkNewParamsConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning struct {
	// The pattern of the date string
	TimePattern param.Field[string] `json:"time_pattern"`
}

Data-layout partitioning for sinks.

func (SinkNewParamsConfigCloudflarePipelinesR2TablePartitioning) MarshalJSON added in v6.3.0

type SinkNewParamsConfigCloudflarePipelinesR2TableRollingPolicy added in v6.3.0

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 added in v6.3.0

type SinkNewParamsConfigUnion added in v6.3.0

type SinkNewParamsConfigUnion interface {
	// contains filtered or unexported methods
}

Defines the configuration of the R2 Sink.

Satisfied by pipelines.SinkNewParamsConfigCloudflarePipelinesR2Table, pipelines.SinkNewParamsConfigCloudflarePipelinesR2DataCatalogTable, SinkNewParamsConfig.

type SinkNewParamsFormat added in v6.3.0

type SinkNewParamsFormat struct {
	Type            param.Field[SinkNewParamsFormatType]            `json:"type,required"`
	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"`
}

func (SinkNewParamsFormat) MarshalJSON added in v6.3.0

func (r SinkNewParamsFormat) MarshalJSON() (data []byte, err error)

type SinkNewParamsFormatCompression added in v6.3.0

type SinkNewParamsFormatCompression string
const (
	SinkNewParamsFormatCompressionUncompressed SinkNewParamsFormatCompression = "uncompressed"
	SinkNewParamsFormatCompressionSnappy       SinkNewParamsFormatCompression = "snappy"
	SinkNewParamsFormatCompressionGzip         SinkNewParamsFormatCompression = "gzip"
	SinkNewParamsFormatCompressionZstd         SinkNewParamsFormatCompression = "zstd"
	SinkNewParamsFormatCompressionLz4          SinkNewParamsFormatCompression = "lz4"
)

func (SinkNewParamsFormatCompression) IsKnown added in v6.3.0

type SinkNewParamsFormatDecimalEncoding added in v6.3.0

type SinkNewParamsFormatDecimalEncoding string
const (
	SinkNewParamsFormatDecimalEncodingNumber SinkNewParamsFormatDecimalEncoding = "number"
	SinkNewParamsFormatDecimalEncodingString SinkNewParamsFormatDecimalEncoding = "string"
	SinkNewParamsFormatDecimalEncodingBytes  SinkNewParamsFormatDecimalEncoding = "bytes"
)

func (SinkNewParamsFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkNewParamsFormatJson added in v6.3.0

type SinkNewParamsFormatJson struct {
	Type            param.Field[SinkNewParamsFormatJsonType]            `json:"type,required"`
	DecimalEncoding param.Field[SinkNewParamsFormatJsonDecimalEncoding] `json:"decimal_encoding"`
	TimestampFormat param.Field[SinkNewParamsFormatJsonTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                   `json:"unstructured"`
}

func (SinkNewParamsFormatJson) MarshalJSON added in v6.3.0

func (r SinkNewParamsFormatJson) MarshalJSON() (data []byte, err error)

type SinkNewParamsFormatJsonDecimalEncoding added in v6.3.0

type SinkNewParamsFormatJsonDecimalEncoding string
const (
	SinkNewParamsFormatJsonDecimalEncodingNumber SinkNewParamsFormatJsonDecimalEncoding = "number"
	SinkNewParamsFormatJsonDecimalEncodingString SinkNewParamsFormatJsonDecimalEncoding = "string"
	SinkNewParamsFormatJsonDecimalEncodingBytes  SinkNewParamsFormatJsonDecimalEncoding = "bytes"
)

func (SinkNewParamsFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkNewParamsFormatJsonTimestampFormat added in v6.3.0

type SinkNewParamsFormatJsonTimestampFormat string
const (
	SinkNewParamsFormatJsonTimestampFormatRfc3339    SinkNewParamsFormatJsonTimestampFormat = "rfc3339"
	SinkNewParamsFormatJsonTimestampFormatUnixMillis SinkNewParamsFormatJsonTimestampFormat = "unix_millis"
)

func (SinkNewParamsFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkNewParamsFormatJsonType added in v6.3.0

type SinkNewParamsFormatJsonType string
const (
	SinkNewParamsFormatJsonTypeJson SinkNewParamsFormatJsonType = "json"
)

func (SinkNewParamsFormatJsonType) IsKnown added in v6.3.0

func (r SinkNewParamsFormatJsonType) IsKnown() bool

type SinkNewParamsFormatParquet added in v6.3.0

type SinkNewParamsFormatParquet struct {
	Type          param.Field[SinkNewParamsFormatParquetType]        `json:"type,required"`
	Compression   param.Field[SinkNewParamsFormatParquetCompression] `json:"compression"`
	RowGroupBytes param.Field[int64]                                 `json:"row_group_bytes"`
}

func (SinkNewParamsFormatParquet) MarshalJSON added in v6.3.0

func (r SinkNewParamsFormatParquet) MarshalJSON() (data []byte, err error)

type SinkNewParamsFormatParquetCompression added in v6.3.0

type SinkNewParamsFormatParquetCompression string
const (
	SinkNewParamsFormatParquetCompressionUncompressed SinkNewParamsFormatParquetCompression = "uncompressed"
	SinkNewParamsFormatParquetCompressionSnappy       SinkNewParamsFormatParquetCompression = "snappy"
	SinkNewParamsFormatParquetCompressionGzip         SinkNewParamsFormatParquetCompression = "gzip"
	SinkNewParamsFormatParquetCompressionZstd         SinkNewParamsFormatParquetCompression = "zstd"
	SinkNewParamsFormatParquetCompressionLz4          SinkNewParamsFormatParquetCompression = "lz4"
)

func (SinkNewParamsFormatParquetCompression) IsKnown added in v6.3.0

type SinkNewParamsFormatParquetType added in v6.3.0

type SinkNewParamsFormatParquetType string
const (
	SinkNewParamsFormatParquetTypeParquet SinkNewParamsFormatParquetType = "parquet"
)

func (SinkNewParamsFormatParquetType) IsKnown added in v6.3.0

type SinkNewParamsFormatTimestampFormat added in v6.3.0

type SinkNewParamsFormatTimestampFormat string
const (
	SinkNewParamsFormatTimestampFormatRfc3339    SinkNewParamsFormatTimestampFormat = "rfc3339"
	SinkNewParamsFormatTimestampFormatUnixMillis SinkNewParamsFormatTimestampFormat = "unix_millis"
)

func (SinkNewParamsFormatTimestampFormat) IsKnown added in v6.3.0

type SinkNewParamsFormatType added in v6.3.0

type SinkNewParamsFormatType string
const (
	SinkNewParamsFormatTypeJson    SinkNewParamsFormatType = "json"
	SinkNewParamsFormatTypeParquet SinkNewParamsFormatType = "parquet"
)

func (SinkNewParamsFormatType) IsKnown added in v6.3.0

func (r SinkNewParamsFormatType) IsKnown() bool

type SinkNewParamsFormatUnion added in v6.3.0

type SinkNewParamsFormatUnion interface {
	// contains filtered or unexported methods
}

Satisfied by pipelines.SinkNewParamsFormatJson, pipelines.SinkNewParamsFormatParquet, SinkNewParamsFormat.

type SinkNewParamsSchema added in v6.3.0

type SinkNewParamsSchema struct {
	Fields   param.Field[[]SinkNewParamsSchemaFieldUnion] `json:"fields"`
	Format   param.Field[SinkNewParamsSchemaFormatUnion]  `json:"format"`
	Inferred param.Field[bool]                            `json:"inferred"`
}

func (SinkNewParamsSchema) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchema) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaField added in v6.3.0

type SinkNewParamsSchemaField struct {
	Type        param.Field[SinkNewParamsSchemaFieldsType] `json:"type,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[SinkNewParamsSchemaFieldsUnit] `json:"unit"`
}

func (SinkNewParamsSchemaField) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaField) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsBinary added in v6.3.0

type SinkNewParamsSchemaFieldsBinary struct {
	Type        param.Field[SinkNewParamsSchemaFieldsBinaryType] `json:"type,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 (SinkNewParamsSchemaFieldsBinary) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsBinary) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsBinaryType added in v6.3.0

type SinkNewParamsSchemaFieldsBinaryType string
const (
	SinkNewParamsSchemaFieldsBinaryTypeBinary SinkNewParamsSchemaFieldsBinaryType = "binary"
)

func (SinkNewParamsSchemaFieldsBinaryType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsBool added in v6.3.0

type SinkNewParamsSchemaFieldsBool struct {
	Type        param.Field[SinkNewParamsSchemaFieldsBoolType] `json:"type,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 (SinkNewParamsSchemaFieldsBool) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsBool) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsBoolType added in v6.3.0

type SinkNewParamsSchemaFieldsBoolType string
const (
	SinkNewParamsSchemaFieldsBoolTypeBool SinkNewParamsSchemaFieldsBoolType = "bool"
)

func (SinkNewParamsSchemaFieldsBoolType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsFloat32 added in v6.3.0

type SinkNewParamsSchemaFieldsFloat32 struct {
	Type        param.Field[SinkNewParamsSchemaFieldsFloat32Type] `json:"type,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 (SinkNewParamsSchemaFieldsFloat32) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsFloat32) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsFloat32Type added in v6.3.0

type SinkNewParamsSchemaFieldsFloat32Type string
const (
	SinkNewParamsSchemaFieldsFloat32TypeFloat32 SinkNewParamsSchemaFieldsFloat32Type = "float32"
)

func (SinkNewParamsSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsFloat64 added in v6.3.0

type SinkNewParamsSchemaFieldsFloat64 struct {
	Type        param.Field[SinkNewParamsSchemaFieldsFloat64Type] `json:"type,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 (SinkNewParamsSchemaFieldsFloat64) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsFloat64) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsFloat64Type added in v6.3.0

type SinkNewParamsSchemaFieldsFloat64Type string
const (
	SinkNewParamsSchemaFieldsFloat64TypeFloat64 SinkNewParamsSchemaFieldsFloat64Type = "float64"
)

func (SinkNewParamsSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsInt32 added in v6.3.0

type SinkNewParamsSchemaFieldsInt32 struct {
	Type        param.Field[SinkNewParamsSchemaFieldsInt32Type] `json:"type,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 (SinkNewParamsSchemaFieldsInt32) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsInt32) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsInt32Type added in v6.3.0

type SinkNewParamsSchemaFieldsInt32Type string
const (
	SinkNewParamsSchemaFieldsInt32TypeInt32 SinkNewParamsSchemaFieldsInt32Type = "int32"
)

func (SinkNewParamsSchemaFieldsInt32Type) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsInt64 added in v6.3.0

type SinkNewParamsSchemaFieldsInt64 struct {
	Type        param.Field[SinkNewParamsSchemaFieldsInt64Type] `json:"type,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 (SinkNewParamsSchemaFieldsInt64) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsInt64) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsInt64Type added in v6.3.0

type SinkNewParamsSchemaFieldsInt64Type string
const (
	SinkNewParamsSchemaFieldsInt64TypeInt64 SinkNewParamsSchemaFieldsInt64Type = "int64"
)

func (SinkNewParamsSchemaFieldsInt64Type) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsJson added in v6.3.0

type SinkNewParamsSchemaFieldsJson struct {
	Type        param.Field[SinkNewParamsSchemaFieldsJsonType] `json:"type,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 (SinkNewParamsSchemaFieldsJson) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsJson) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsJsonType added in v6.3.0

type SinkNewParamsSchemaFieldsJsonType string
const (
	SinkNewParamsSchemaFieldsJsonTypeJson SinkNewParamsSchemaFieldsJsonType = "json"
)

func (SinkNewParamsSchemaFieldsJsonType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsList added in v6.3.0

type SinkNewParamsSchemaFieldsList struct {
}

func (SinkNewParamsSchemaFieldsList) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsList) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsString added in v6.3.0

type SinkNewParamsSchemaFieldsString struct {
	Type        param.Field[SinkNewParamsSchemaFieldsStringType] `json:"type,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 (SinkNewParamsSchemaFieldsString) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsString) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsStringType added in v6.3.0

type SinkNewParamsSchemaFieldsStringType string
const (
	SinkNewParamsSchemaFieldsStringTypeString SinkNewParamsSchemaFieldsStringType = "string"
)

func (SinkNewParamsSchemaFieldsStringType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsStruct added in v6.3.0

type SinkNewParamsSchemaFieldsStruct struct {
}

func (SinkNewParamsSchemaFieldsStruct) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsStruct) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsTimestamp added in v6.3.0

type SinkNewParamsSchemaFieldsTimestamp struct {
	Type        param.Field[SinkNewParamsSchemaFieldsTimestampType] `json:"type,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[SinkNewParamsSchemaFieldsTimestampUnit] `json:"unit"`
}

func (SinkNewParamsSchemaFieldsTimestamp) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFieldsTimestamp) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFieldsTimestampType added in v6.3.0

type SinkNewParamsSchemaFieldsTimestampType string
const (
	SinkNewParamsSchemaFieldsTimestampTypeTimestamp SinkNewParamsSchemaFieldsTimestampType = "timestamp"
)

func (SinkNewParamsSchemaFieldsTimestampType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsTimestampUnit added in v6.3.0

type SinkNewParamsSchemaFieldsTimestampUnit string
const (
	SinkNewParamsSchemaFieldsTimestampUnitSecond      SinkNewParamsSchemaFieldsTimestampUnit = "second"
	SinkNewParamsSchemaFieldsTimestampUnitMillisecond SinkNewParamsSchemaFieldsTimestampUnit = "millisecond"
	SinkNewParamsSchemaFieldsTimestampUnitMicrosecond SinkNewParamsSchemaFieldsTimestampUnit = "microsecond"
	SinkNewParamsSchemaFieldsTimestampUnitNanosecond  SinkNewParamsSchemaFieldsTimestampUnit = "nanosecond"
)

func (SinkNewParamsSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type SinkNewParamsSchemaFieldsType added in v6.3.0

type SinkNewParamsSchemaFieldsType string
const (
	SinkNewParamsSchemaFieldsTypeInt32     SinkNewParamsSchemaFieldsType = "int32"
	SinkNewParamsSchemaFieldsTypeInt64     SinkNewParamsSchemaFieldsType = "int64"
	SinkNewParamsSchemaFieldsTypeFloat32   SinkNewParamsSchemaFieldsType = "float32"
	SinkNewParamsSchemaFieldsTypeFloat64   SinkNewParamsSchemaFieldsType = "float64"
	SinkNewParamsSchemaFieldsTypeBool      SinkNewParamsSchemaFieldsType = "bool"
	SinkNewParamsSchemaFieldsTypeString    SinkNewParamsSchemaFieldsType = "string"
	SinkNewParamsSchemaFieldsTypeBinary    SinkNewParamsSchemaFieldsType = "binary"
	SinkNewParamsSchemaFieldsTypeTimestamp SinkNewParamsSchemaFieldsType = "timestamp"
	SinkNewParamsSchemaFieldsTypeJson      SinkNewParamsSchemaFieldsType = "json"
	SinkNewParamsSchemaFieldsTypeStruct    SinkNewParamsSchemaFieldsType = "struct"
	SinkNewParamsSchemaFieldsTypeList      SinkNewParamsSchemaFieldsType = "list"
)

func (SinkNewParamsSchemaFieldsType) IsKnown added in v6.3.0

func (r SinkNewParamsSchemaFieldsType) IsKnown() bool

type SinkNewParamsSchemaFieldsUnit added in v6.3.0

type SinkNewParamsSchemaFieldsUnit string
const (
	SinkNewParamsSchemaFieldsUnitSecond      SinkNewParamsSchemaFieldsUnit = "second"
	SinkNewParamsSchemaFieldsUnitMillisecond SinkNewParamsSchemaFieldsUnit = "millisecond"
	SinkNewParamsSchemaFieldsUnitMicrosecond SinkNewParamsSchemaFieldsUnit = "microsecond"
	SinkNewParamsSchemaFieldsUnitNanosecond  SinkNewParamsSchemaFieldsUnit = "nanosecond"
)

func (SinkNewParamsSchemaFieldsUnit) IsKnown added in v6.3.0

func (r SinkNewParamsSchemaFieldsUnit) IsKnown() bool

type SinkNewParamsSchemaFormat added in v6.3.0

type SinkNewParamsSchemaFormat struct {
	Type            param.Field[SinkNewParamsSchemaFormatType]            `json:"type,required"`
	Compression     param.Field[SinkNewParamsSchemaFormatCompression]     `json:"compression"`
	DecimalEncoding param.Field[SinkNewParamsSchemaFormatDecimalEncoding] `json:"decimal_encoding"`
	RowGroupBytes   param.Field[int64]                                    `json:"row_group_bytes"`
	TimestampFormat param.Field[SinkNewParamsSchemaFormatTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                     `json:"unstructured"`
}

func (SinkNewParamsSchemaFormat) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFormat) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFormatCompression added in v6.3.0

type SinkNewParamsSchemaFormatCompression string
const (
	SinkNewParamsSchemaFormatCompressionUncompressed SinkNewParamsSchemaFormatCompression = "uncompressed"
	SinkNewParamsSchemaFormatCompressionSnappy       SinkNewParamsSchemaFormatCompression = "snappy"
	SinkNewParamsSchemaFormatCompressionGzip         SinkNewParamsSchemaFormatCompression = "gzip"
	SinkNewParamsSchemaFormatCompressionZstd         SinkNewParamsSchemaFormatCompression = "zstd"
	SinkNewParamsSchemaFormatCompressionLz4          SinkNewParamsSchemaFormatCompression = "lz4"
)

func (SinkNewParamsSchemaFormatCompression) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatDecimalEncoding added in v6.3.0

type SinkNewParamsSchemaFormatDecimalEncoding string
const (
	SinkNewParamsSchemaFormatDecimalEncodingNumber SinkNewParamsSchemaFormatDecimalEncoding = "number"
	SinkNewParamsSchemaFormatDecimalEncodingString SinkNewParamsSchemaFormatDecimalEncoding = "string"
	SinkNewParamsSchemaFormatDecimalEncodingBytes  SinkNewParamsSchemaFormatDecimalEncoding = "bytes"
)

func (SinkNewParamsSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatJson added in v6.3.0

type SinkNewParamsSchemaFormatJson struct {
	Type            param.Field[SinkNewParamsSchemaFormatJsonType]            `json:"type,required"`
	DecimalEncoding param.Field[SinkNewParamsSchemaFormatJsonDecimalEncoding] `json:"decimal_encoding"`
	TimestampFormat param.Field[SinkNewParamsSchemaFormatJsonTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                         `json:"unstructured"`
}

func (SinkNewParamsSchemaFormatJson) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFormatJson) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFormatJsonDecimalEncoding added in v6.3.0

type SinkNewParamsSchemaFormatJsonDecimalEncoding string
const (
	SinkNewParamsSchemaFormatJsonDecimalEncodingNumber SinkNewParamsSchemaFormatJsonDecimalEncoding = "number"
	SinkNewParamsSchemaFormatJsonDecimalEncodingString SinkNewParamsSchemaFormatJsonDecimalEncoding = "string"
	SinkNewParamsSchemaFormatJsonDecimalEncodingBytes  SinkNewParamsSchemaFormatJsonDecimalEncoding = "bytes"
)

func (SinkNewParamsSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatJsonTimestampFormat added in v6.3.0

type SinkNewParamsSchemaFormatJsonTimestampFormat string
const (
	SinkNewParamsSchemaFormatJsonTimestampFormatRfc3339    SinkNewParamsSchemaFormatJsonTimestampFormat = "rfc3339"
	SinkNewParamsSchemaFormatJsonTimestampFormatUnixMillis SinkNewParamsSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (SinkNewParamsSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatJsonType added in v6.3.0

type SinkNewParamsSchemaFormatJsonType string
const (
	SinkNewParamsSchemaFormatJsonTypeJson SinkNewParamsSchemaFormatJsonType = "json"
)

func (SinkNewParamsSchemaFormatJsonType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatParquet added in v6.3.0

type SinkNewParamsSchemaFormatParquet struct {
	Type          param.Field[SinkNewParamsSchemaFormatParquetType]        `json:"type,required"`
	Compression   param.Field[SinkNewParamsSchemaFormatParquetCompression] `json:"compression"`
	RowGroupBytes param.Field[int64]                                       `json:"row_group_bytes"`
}

func (SinkNewParamsSchemaFormatParquet) MarshalJSON added in v6.3.0

func (r SinkNewParamsSchemaFormatParquet) MarshalJSON() (data []byte, err error)

type SinkNewParamsSchemaFormatParquetCompression added in v6.3.0

type SinkNewParamsSchemaFormatParquetCompression string
const (
	SinkNewParamsSchemaFormatParquetCompressionUncompressed SinkNewParamsSchemaFormatParquetCompression = "uncompressed"
	SinkNewParamsSchemaFormatParquetCompressionSnappy       SinkNewParamsSchemaFormatParquetCompression = "snappy"
	SinkNewParamsSchemaFormatParquetCompressionGzip         SinkNewParamsSchemaFormatParquetCompression = "gzip"
	SinkNewParamsSchemaFormatParquetCompressionZstd         SinkNewParamsSchemaFormatParquetCompression = "zstd"
	SinkNewParamsSchemaFormatParquetCompressionLz4          SinkNewParamsSchemaFormatParquetCompression = "lz4"
)

func (SinkNewParamsSchemaFormatParquetCompression) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatParquetType added in v6.3.0

type SinkNewParamsSchemaFormatParquetType string
const (
	SinkNewParamsSchemaFormatParquetTypeParquet SinkNewParamsSchemaFormatParquetType = "parquet"
)

func (SinkNewParamsSchemaFormatParquetType) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatTimestampFormat added in v6.3.0

type SinkNewParamsSchemaFormatTimestampFormat string
const (
	SinkNewParamsSchemaFormatTimestampFormatRfc3339    SinkNewParamsSchemaFormatTimestampFormat = "rfc3339"
	SinkNewParamsSchemaFormatTimestampFormatUnixMillis SinkNewParamsSchemaFormatTimestampFormat = "unix_millis"
)

func (SinkNewParamsSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type SinkNewParamsSchemaFormatType added in v6.3.0

type SinkNewParamsSchemaFormatType string
const (
	SinkNewParamsSchemaFormatTypeJson    SinkNewParamsSchemaFormatType = "json"
	SinkNewParamsSchemaFormatTypeParquet SinkNewParamsSchemaFormatType = "parquet"
)

func (SinkNewParamsSchemaFormatType) IsKnown added in v6.3.0

func (r SinkNewParamsSchemaFormatType) IsKnown() bool

type SinkNewParamsSchemaFormatUnion added in v6.3.0

type SinkNewParamsSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Satisfied by pipelines.SinkNewParamsSchemaFormatJson, pipelines.SinkNewParamsSchemaFormatParquet, SinkNewParamsSchemaFormat.

type SinkNewParamsType added in v6.3.0

type SinkNewParamsType string

Specifies the type of sink.

const (
	SinkNewParamsTypeR2            SinkNewParamsType = "r2"
	SinkNewParamsTypeR2DataCatalog SinkNewParamsType = "r2_data_catalog"
)

func (SinkNewParamsType) IsKnown added in v6.3.0

func (r SinkNewParamsType) IsKnown() bool

type SinkNewResponse added in v6.3.0

type SinkNewResponse struct {
	// Indicates a unique identifier for this sink.
	ID         string    `json:"id,required"`
	CreatedAt  time.Time `json:"created_at,required" format:"date-time"`
	ModifiedAt time.Time `json:"modified_at,required" format:"date-time"`
	// Defines the name of the Sink.
	Name string `json:"name,required"`
	// Specifies the type of sink.
	Type SinkNewResponseType `json:"type,required"`
	// R2 Data Catalog Sink
	Config SinkNewResponseConfig `json:"config"`
	Format SinkNewResponseFormat `json:"format"`
	Schema SinkNewResponseSchema `json:"schema"`
	JSON   sinkNewResponseJSON   `json:"-"`
}

func (*SinkNewResponse) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponse) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseConfig added in v6.3.0

type SinkNewResponseConfig struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket string `json:"bucket,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 added in v6.3.0

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 added in v6.3.0

func (r *SinkNewResponseConfig) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable struct {
	// Authentication token
	Token string `json:"token,required" format:"var-str"`
	// Cloudflare Account ID
	AccountID string `json:"account_id,required" format:"uri"`
	// The R2 Bucket that hosts this catalog
	Bucket string `json:"bucket,required"`
	// Table name
	TableName string `json:"table_name,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 added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTableRollingPolicy added in v6.3.0

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 added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2Table added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2Table struct {
	// Cloudflare Account ID for the bucket
	AccountID string `json:"account_id,required"`
	// R2 Bucket to write to
	Bucket      string                                                     `json:"bucket,required"`
	Credentials SinkNewResponseConfigCloudflarePipelinesR2TableCredentials `json:"credentials,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 added in v6.3.0

func (r *SinkNewResponseConfigCloudflarePipelinesR2Table) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseConfigCloudflarePipelinesR2TableCredentials added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TableCredentials struct {
	// Cloudflare Account ID for the bucket
	AccessKeyID string `json:"access_key_id,required" format:"var-str"`
	// Cloudflare Account ID for the bucket
	SecretAccessKey string                                                         `json:"secret_access_key,required" format:"var-str"`
	JSON            sinkNewResponseConfigCloudflarePipelinesR2TableCredentialsJSON `json:"-"`
}

func (*SinkNewResponseConfigCloudflarePipelinesR2TableCredentials) UnmarshalJSON added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TableFileNaming added in v6.3.0

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 added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy string

Filename generation strategy.

const (
	SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategySerial SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "serial"
	SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUID   SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid"
	SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUUIDV7 SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "uuid_v7"
	SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategyUlid   SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy = "ulid"
)

func (SinkNewResponseConfigCloudflarePipelinesR2TableFileNamingStrategy) IsKnown added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TablePartitioning added in v6.3.0

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 added in v6.3.0

type SinkNewResponseConfigCloudflarePipelinesR2TableRollingPolicy added in v6.3.0

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 added in v6.3.0

type SinkNewResponseConfigUnion added in v6.3.0

type SinkNewResponseConfigUnion interface {
	// contains filtered or unexported methods
}

R2 Data Catalog Sink

Union satisfied by SinkNewResponseConfigCloudflarePipelinesR2Table or SinkNewResponseConfigCloudflarePipelinesR2DataCatalogTable.

type SinkNewResponseEnvelope added in v6.3.0

type SinkNewResponseEnvelope struct {
	Result SinkNewResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                        `json:"success,required"`
	JSON    sinkNewResponseEnvelopeJSON `json:"-"`
}

func (*SinkNewResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseFormat added in v6.3.0

type SinkNewResponseFormat struct {
	Type            SinkNewResponseFormatType            `json:"type,required"`
	Compression     SinkNewResponseFormatCompression     `json:"compression"`
	DecimalEncoding SinkNewResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                `json:"row_group_bytes,nullable"`
	TimestampFormat SinkNewResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                 `json:"unstructured"`
	JSON            sinkNewResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkNewResponseFormat) AsUnion added in v6.3.0

AsUnion returns a SinkNewResponseFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkNewResponseFormatJson, SinkNewResponseFormatParquet.

func (*SinkNewResponseFormat) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseFormat) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseFormatCompression added in v6.3.0

type SinkNewResponseFormatCompression string
const (
	SinkNewResponseFormatCompressionUncompressed SinkNewResponseFormatCompression = "uncompressed"
	SinkNewResponseFormatCompressionSnappy       SinkNewResponseFormatCompression = "snappy"
	SinkNewResponseFormatCompressionGzip         SinkNewResponseFormatCompression = "gzip"
	SinkNewResponseFormatCompressionZstd         SinkNewResponseFormatCompression = "zstd"
	SinkNewResponseFormatCompressionLz4          SinkNewResponseFormatCompression = "lz4"
)

func (SinkNewResponseFormatCompression) IsKnown added in v6.3.0

type SinkNewResponseFormatDecimalEncoding added in v6.3.0

type SinkNewResponseFormatDecimalEncoding string
const (
	SinkNewResponseFormatDecimalEncodingNumber SinkNewResponseFormatDecimalEncoding = "number"
	SinkNewResponseFormatDecimalEncodingString SinkNewResponseFormatDecimalEncoding = "string"
	SinkNewResponseFormatDecimalEncodingBytes  SinkNewResponseFormatDecimalEncoding = "bytes"
)

func (SinkNewResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkNewResponseFormatJson added in v6.3.0

type SinkNewResponseFormatJson struct {
	Type            SinkNewResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkNewResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkNewResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                     `json:"unstructured"`
	JSON            sinkNewResponseFormatJsonJSON            `json:"-"`
}

func (*SinkNewResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseFormatJsonDecimalEncoding added in v6.3.0

type SinkNewResponseFormatJsonDecimalEncoding string
const (
	SinkNewResponseFormatJsonDecimalEncodingNumber SinkNewResponseFormatJsonDecimalEncoding = "number"
	SinkNewResponseFormatJsonDecimalEncodingString SinkNewResponseFormatJsonDecimalEncoding = "string"
	SinkNewResponseFormatJsonDecimalEncodingBytes  SinkNewResponseFormatJsonDecimalEncoding = "bytes"
)

func (SinkNewResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkNewResponseFormatJsonTimestampFormat added in v6.3.0

type SinkNewResponseFormatJsonTimestampFormat string
const (
	SinkNewResponseFormatJsonTimestampFormatRfc3339    SinkNewResponseFormatJsonTimestampFormat = "rfc3339"
	SinkNewResponseFormatJsonTimestampFormatUnixMillis SinkNewResponseFormatJsonTimestampFormat = "unix_millis"
)

func (SinkNewResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkNewResponseFormatJsonType added in v6.3.0

type SinkNewResponseFormatJsonType string
const (
	SinkNewResponseFormatJsonTypeJson SinkNewResponseFormatJsonType = "json"
)

func (SinkNewResponseFormatJsonType) IsKnown added in v6.3.0

func (r SinkNewResponseFormatJsonType) IsKnown() bool

type SinkNewResponseFormatParquet added in v6.3.0

type SinkNewResponseFormatParquet struct {
	Type          SinkNewResponseFormatParquetType        `json:"type,required"`
	Compression   SinkNewResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                   `json:"row_group_bytes,nullable"`
	JSON          sinkNewResponseFormatParquetJSON        `json:"-"`
}

func (*SinkNewResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseFormatParquetCompression added in v6.3.0

type SinkNewResponseFormatParquetCompression string
const (
	SinkNewResponseFormatParquetCompressionUncompressed SinkNewResponseFormatParquetCompression = "uncompressed"
	SinkNewResponseFormatParquetCompressionSnappy       SinkNewResponseFormatParquetCompression = "snappy"
	SinkNewResponseFormatParquetCompressionGzip         SinkNewResponseFormatParquetCompression = "gzip"
	SinkNewResponseFormatParquetCompressionZstd         SinkNewResponseFormatParquetCompression = "zstd"
	SinkNewResponseFormatParquetCompressionLz4          SinkNewResponseFormatParquetCompression = "lz4"
)

func (SinkNewResponseFormatParquetCompression) IsKnown added in v6.3.0

type SinkNewResponseFormatParquetType added in v6.3.0

type SinkNewResponseFormatParquetType string
const (
	SinkNewResponseFormatParquetTypeParquet SinkNewResponseFormatParquetType = "parquet"
)

func (SinkNewResponseFormatParquetType) IsKnown added in v6.3.0

type SinkNewResponseFormatTimestampFormat added in v6.3.0

type SinkNewResponseFormatTimestampFormat string
const (
	SinkNewResponseFormatTimestampFormatRfc3339    SinkNewResponseFormatTimestampFormat = "rfc3339"
	SinkNewResponseFormatTimestampFormatUnixMillis SinkNewResponseFormatTimestampFormat = "unix_millis"
)

func (SinkNewResponseFormatTimestampFormat) IsKnown added in v6.3.0

type SinkNewResponseFormatType added in v6.3.0

type SinkNewResponseFormatType string
const (
	SinkNewResponseFormatTypeJson    SinkNewResponseFormatType = "json"
	SinkNewResponseFormatTypeParquet SinkNewResponseFormatType = "parquet"
)

func (SinkNewResponseFormatType) IsKnown added in v6.3.0

func (r SinkNewResponseFormatType) IsKnown() bool

type SinkNewResponseFormatUnion added in v6.3.0

type SinkNewResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkNewResponseFormatJson or SinkNewResponseFormatParquet.

type SinkNewResponseSchema added in v6.3.0

type SinkNewResponseSchema struct {
	Fields   []SinkNewResponseSchemaField `json:"fields"`
	Format   SinkNewResponseSchemaFormat  `json:"format"`
	Inferred bool                         `json:"inferred,nullable"`
	JSON     sinkNewResponseSchemaJSON    `json:"-"`
}

func (*SinkNewResponseSchema) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchema) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaField added in v6.3.0

type SinkNewResponseSchemaField struct {
	Type        SinkNewResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                          `json:"metadata_key,nullable"`
	Name        string                          `json:"name"`
	Required    bool                            `json:"required"`
	SqlName     string                          `json:"sql_name"`
	Unit        SinkNewResponseSchemaFieldsUnit `json:"unit"`
	JSON        sinkNewResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*SinkNewResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsBinary added in v6.3.0

type SinkNewResponseSchemaFieldsBinary struct {
	Type        SinkNewResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsBinaryType added in v6.3.0

type SinkNewResponseSchemaFieldsBinaryType string
const (
	SinkNewResponseSchemaFieldsBinaryTypeBinary SinkNewResponseSchemaFieldsBinaryType = "binary"
)

func (SinkNewResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsBool added in v6.3.0

type SinkNewResponseSchemaFieldsBool struct {
	Type        SinkNewResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                              `json:"metadata_key,nullable"`
	Name        string                              `json:"name"`
	Required    bool                                `json:"required"`
	SqlName     string                              `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsBoolType added in v6.3.0

type SinkNewResponseSchemaFieldsBoolType string
const (
	SinkNewResponseSchemaFieldsBoolTypeBool SinkNewResponseSchemaFieldsBoolType = "bool"
)

func (SinkNewResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsFloat32 added in v6.3.0

type SinkNewResponseSchemaFieldsFloat32 struct {
	Type        SinkNewResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsFloat32Type added in v6.3.0

type SinkNewResponseSchemaFieldsFloat32Type string
const (
	SinkNewResponseSchemaFieldsFloat32TypeFloat32 SinkNewResponseSchemaFieldsFloat32Type = "float32"
)

func (SinkNewResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsFloat64 added in v6.3.0

type SinkNewResponseSchemaFieldsFloat64 struct {
	Type        SinkNewResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsFloat64Type added in v6.3.0

type SinkNewResponseSchemaFieldsFloat64Type string
const (
	SinkNewResponseSchemaFieldsFloat64TypeFloat64 SinkNewResponseSchemaFieldsFloat64Type = "float64"
)

func (SinkNewResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsInt32 added in v6.3.0

type SinkNewResponseSchemaFieldsInt32 struct {
	Type        SinkNewResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsInt32Type added in v6.3.0

type SinkNewResponseSchemaFieldsInt32Type string
const (
	SinkNewResponseSchemaFieldsInt32TypeInt32 SinkNewResponseSchemaFieldsInt32Type = "int32"
)

func (SinkNewResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsInt64 added in v6.3.0

type SinkNewResponseSchemaFieldsInt64 struct {
	Type        SinkNewResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                               `json:"metadata_key,nullable"`
	Name        string                               `json:"name"`
	Required    bool                                 `json:"required"`
	SqlName     string                               `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsInt64Type added in v6.3.0

type SinkNewResponseSchemaFieldsInt64Type string
const (
	SinkNewResponseSchemaFieldsInt64TypeInt64 SinkNewResponseSchemaFieldsInt64Type = "int64"
)

func (SinkNewResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsJson added in v6.3.0

type SinkNewResponseSchemaFieldsJson struct {
	Type        SinkNewResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                              `json:"metadata_key,nullable"`
	Name        string                              `json:"name"`
	Required    bool                                `json:"required"`
	SqlName     string                              `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsJsonType added in v6.3.0

type SinkNewResponseSchemaFieldsJsonType string
const (
	SinkNewResponseSchemaFieldsJsonTypeJson SinkNewResponseSchemaFieldsJsonType = "json"
)

func (SinkNewResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsList added in v6.3.0

type SinkNewResponseSchemaFieldsList struct {
	JSON sinkNewResponseSchemaFieldsListJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsString added in v6.3.0

type SinkNewResponseSchemaFieldsString struct {
	Type        SinkNewResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        sinkNewResponseSchemaFieldsStringJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsStringType added in v6.3.0

type SinkNewResponseSchemaFieldsStringType string
const (
	SinkNewResponseSchemaFieldsStringTypeString SinkNewResponseSchemaFieldsStringType = "string"
)

func (SinkNewResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsStruct added in v6.3.0

type SinkNewResponseSchemaFieldsStruct struct {
	JSON sinkNewResponseSchemaFieldsStructJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsTimestamp added in v6.3.0

type SinkNewResponseSchemaFieldsTimestamp struct {
	Type        SinkNewResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	Unit        SinkNewResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        sinkNewResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*SinkNewResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFieldsTimestampType added in v6.3.0

type SinkNewResponseSchemaFieldsTimestampType string
const (
	SinkNewResponseSchemaFieldsTimestampTypeTimestamp SinkNewResponseSchemaFieldsTimestampType = "timestamp"
)

func (SinkNewResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsTimestampUnit added in v6.3.0

type SinkNewResponseSchemaFieldsTimestampUnit string
const (
	SinkNewResponseSchemaFieldsTimestampUnitSecond      SinkNewResponseSchemaFieldsTimestampUnit = "second"
	SinkNewResponseSchemaFieldsTimestampUnitMillisecond SinkNewResponseSchemaFieldsTimestampUnit = "millisecond"
	SinkNewResponseSchemaFieldsTimestampUnitMicrosecond SinkNewResponseSchemaFieldsTimestampUnit = "microsecond"
	SinkNewResponseSchemaFieldsTimestampUnitNanosecond  SinkNewResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (SinkNewResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsType added in v6.3.0

type SinkNewResponseSchemaFieldsType string
const (
	SinkNewResponseSchemaFieldsTypeInt32     SinkNewResponseSchemaFieldsType = "int32"
	SinkNewResponseSchemaFieldsTypeInt64     SinkNewResponseSchemaFieldsType = "int64"
	SinkNewResponseSchemaFieldsTypeFloat32   SinkNewResponseSchemaFieldsType = "float32"
	SinkNewResponseSchemaFieldsTypeFloat64   SinkNewResponseSchemaFieldsType = "float64"
	SinkNewResponseSchemaFieldsTypeBool      SinkNewResponseSchemaFieldsType = "bool"
	SinkNewResponseSchemaFieldsTypeString    SinkNewResponseSchemaFieldsType = "string"
	SinkNewResponseSchemaFieldsTypeBinary    SinkNewResponseSchemaFieldsType = "binary"
	SinkNewResponseSchemaFieldsTypeTimestamp SinkNewResponseSchemaFieldsType = "timestamp"
	SinkNewResponseSchemaFieldsTypeJson      SinkNewResponseSchemaFieldsType = "json"
	SinkNewResponseSchemaFieldsTypeStruct    SinkNewResponseSchemaFieldsType = "struct"
	SinkNewResponseSchemaFieldsTypeList      SinkNewResponseSchemaFieldsType = "list"
)

func (SinkNewResponseSchemaFieldsType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFieldsUnit added in v6.3.0

type SinkNewResponseSchemaFieldsUnit string
const (
	SinkNewResponseSchemaFieldsUnitSecond      SinkNewResponseSchemaFieldsUnit = "second"
	SinkNewResponseSchemaFieldsUnitMillisecond SinkNewResponseSchemaFieldsUnit = "millisecond"
	SinkNewResponseSchemaFieldsUnitMicrosecond SinkNewResponseSchemaFieldsUnit = "microsecond"
	SinkNewResponseSchemaFieldsUnitNanosecond  SinkNewResponseSchemaFieldsUnit = "nanosecond"
)

func (SinkNewResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormat added in v6.3.0

type SinkNewResponseSchemaFormat struct {
	Type            SinkNewResponseSchemaFormatType            `json:"type,required"`
	Compression     SinkNewResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding SinkNewResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                      `json:"row_group_bytes,nullable"`
	TimestampFormat SinkNewResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                       `json:"unstructured"`
	JSON            sinkNewResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (SinkNewResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a SinkNewResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are SinkNewResponseSchemaFormatJson, SinkNewResponseSchemaFormatParquet.

func (*SinkNewResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFormatCompression added in v6.3.0

type SinkNewResponseSchemaFormatCompression string
const (
	SinkNewResponseSchemaFormatCompressionUncompressed SinkNewResponseSchemaFormatCompression = "uncompressed"
	SinkNewResponseSchemaFormatCompressionSnappy       SinkNewResponseSchemaFormatCompression = "snappy"
	SinkNewResponseSchemaFormatCompressionGzip         SinkNewResponseSchemaFormatCompression = "gzip"
	SinkNewResponseSchemaFormatCompressionZstd         SinkNewResponseSchemaFormatCompression = "zstd"
	SinkNewResponseSchemaFormatCompressionLz4          SinkNewResponseSchemaFormatCompression = "lz4"
)

func (SinkNewResponseSchemaFormatCompression) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatDecimalEncoding added in v6.3.0

type SinkNewResponseSchemaFormatDecimalEncoding string
const (
	SinkNewResponseSchemaFormatDecimalEncodingNumber SinkNewResponseSchemaFormatDecimalEncoding = "number"
	SinkNewResponseSchemaFormatDecimalEncodingString SinkNewResponseSchemaFormatDecimalEncoding = "string"
	SinkNewResponseSchemaFormatDecimalEncodingBytes  SinkNewResponseSchemaFormatDecimalEncoding = "bytes"
)

func (SinkNewResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatJson added in v6.3.0

type SinkNewResponseSchemaFormatJson struct {
	Type            SinkNewResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding SinkNewResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat SinkNewResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                           `json:"unstructured"`
	JSON            sinkNewResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*SinkNewResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type SinkNewResponseSchemaFormatJsonDecimalEncoding string
const (
	SinkNewResponseSchemaFormatJsonDecimalEncodingNumber SinkNewResponseSchemaFormatJsonDecimalEncoding = "number"
	SinkNewResponseSchemaFormatJsonDecimalEncodingString SinkNewResponseSchemaFormatJsonDecimalEncoding = "string"
	SinkNewResponseSchemaFormatJsonDecimalEncodingBytes  SinkNewResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (SinkNewResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type SinkNewResponseSchemaFormatJsonTimestampFormat string
const (
	SinkNewResponseSchemaFormatJsonTimestampFormatRfc3339    SinkNewResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	SinkNewResponseSchemaFormatJsonTimestampFormatUnixMillis SinkNewResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (SinkNewResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatJsonType added in v6.3.0

type SinkNewResponseSchemaFormatJsonType string
const (
	SinkNewResponseSchemaFormatJsonTypeJson SinkNewResponseSchemaFormatJsonType = "json"
)

func (SinkNewResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatParquet added in v6.3.0

type SinkNewResponseSchemaFormatParquet struct {
	Type          SinkNewResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   SinkNewResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                         `json:"row_group_bytes,nullable"`
	JSON          sinkNewResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*SinkNewResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *SinkNewResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type SinkNewResponseSchemaFormatParquetCompression added in v6.3.0

type SinkNewResponseSchemaFormatParquetCompression string
const (
	SinkNewResponseSchemaFormatParquetCompressionUncompressed SinkNewResponseSchemaFormatParquetCompression = "uncompressed"
	SinkNewResponseSchemaFormatParquetCompressionSnappy       SinkNewResponseSchemaFormatParquetCompression = "snappy"
	SinkNewResponseSchemaFormatParquetCompressionGzip         SinkNewResponseSchemaFormatParquetCompression = "gzip"
	SinkNewResponseSchemaFormatParquetCompressionZstd         SinkNewResponseSchemaFormatParquetCompression = "zstd"
	SinkNewResponseSchemaFormatParquetCompressionLz4          SinkNewResponseSchemaFormatParquetCompression = "lz4"
)

func (SinkNewResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatParquetType added in v6.3.0

type SinkNewResponseSchemaFormatParquetType string
const (
	SinkNewResponseSchemaFormatParquetTypeParquet SinkNewResponseSchemaFormatParquetType = "parquet"
)

func (SinkNewResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatTimestampFormat added in v6.3.0

type SinkNewResponseSchemaFormatTimestampFormat string
const (
	SinkNewResponseSchemaFormatTimestampFormatRfc3339    SinkNewResponseSchemaFormatTimestampFormat = "rfc3339"
	SinkNewResponseSchemaFormatTimestampFormatUnixMillis SinkNewResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (SinkNewResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatType added in v6.3.0

type SinkNewResponseSchemaFormatType string
const (
	SinkNewResponseSchemaFormatTypeJson    SinkNewResponseSchemaFormatType = "json"
	SinkNewResponseSchemaFormatTypeParquet SinkNewResponseSchemaFormatType = "parquet"
)

func (SinkNewResponseSchemaFormatType) IsKnown added in v6.3.0

type SinkNewResponseSchemaFormatUnion added in v6.3.0

type SinkNewResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by SinkNewResponseSchemaFormatJson or SinkNewResponseSchemaFormatParquet.

type SinkNewResponseType added in v6.3.0

type SinkNewResponseType string

Specifies the type of sink.

const (
	SinkNewResponseTypeR2            SinkNewResponseType = "r2"
	SinkNewResponseTypeR2DataCatalog SinkNewResponseType = "r2_data_catalog"
)

func (SinkNewResponseType) IsKnown added in v6.3.0

func (r SinkNewResponseType) IsKnown() bool

type SinkService added in v6.3.0

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 added in v6.3.0

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 added in v6.3.0

func (r *SinkService) Delete(ctx context.Context, sinkID string, params SinkDeleteParams, opts ...option.RequestOption) (err error)

Delete Pipeline in Account.

func (*SinkService) Get added in v6.3.0

func (r *SinkService) Get(ctx context.Context, sinkID string, query SinkGetParams, opts ...option.RequestOption) (res *SinkGetResponse, err error)

Get Sink Details.

func (*SinkService) List added in v6.3.0

List/Filter Sinks in Account.

func (*SinkService) ListAutoPaging added in v6.3.0

List/Filter Sinks in Account.

func (*SinkService) New added in v6.3.0

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 StreamDeleteParams added in v6.3.0

type StreamDeleteParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Delete stream forcefully, including deleting any dependent pipelines.
	Force param.Field[string] `query:"force"`
}

func (StreamDeleteParams) URLQuery added in v6.3.0

func (r StreamDeleteParams) URLQuery() (v url.Values)

URLQuery serializes StreamDeleteParams's query parameters as `url.Values`.

type StreamGetParams added in v6.3.0

type StreamGetParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type StreamGetResponse added in v6.3.0

type StreamGetResponse struct {
	// Indicates a unique identifier for this stream.
	ID         string                `json:"id,required"`
	CreatedAt  time.Time             `json:"created_at,required" format:"date-time"`
	HTTP       StreamGetResponseHTTP `json:"http,required"`
	ModifiedAt time.Time             `json:"modified_at,required" format:"date-time"`
	// Indicates the name of the Stream.
	Name string `json:"name,required"`
	// Indicates the current version of this stream.
	Version       int64                          `json:"version,required"`
	WorkerBinding StreamGetResponseWorkerBinding `json:"worker_binding,required"`
	// Indicates the endpoint URL of this stream.
	Endpoint string                  `json:"endpoint" format:"uri"`
	Format   StreamGetResponseFormat `json:"format"`
	Schema   StreamGetResponseSchema `json:"schema"`
	JSON     streamGetResponseJSON   `json:"-"`
}

func (*StreamGetResponse) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponse) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseEnvelope added in v6.3.0

type StreamGetResponseEnvelope struct {
	Result StreamGetResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                          `json:"success,required"`
	JSON    streamGetResponseEnvelopeJSON `json:"-"`
}

func (*StreamGetResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseFormat added in v6.3.0

type StreamGetResponseFormat struct {
	Type            StreamGetResponseFormatType            `json:"type,required"`
	Compression     StreamGetResponseFormatCompression     `json:"compression"`
	DecimalEncoding StreamGetResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                  `json:"row_group_bytes,nullable"`
	TimestampFormat StreamGetResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                   `json:"unstructured"`
	JSON            streamGetResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamGetResponseFormat) AsUnion added in v6.3.0

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 added in v6.3.0

func (r *StreamGetResponseFormat) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseFormatCompression added in v6.3.0

type StreamGetResponseFormatCompression string
const (
	StreamGetResponseFormatCompressionUncompressed StreamGetResponseFormatCompression = "uncompressed"
	StreamGetResponseFormatCompressionSnappy       StreamGetResponseFormatCompression = "snappy"
	StreamGetResponseFormatCompressionGzip         StreamGetResponseFormatCompression = "gzip"
	StreamGetResponseFormatCompressionZstd         StreamGetResponseFormatCompression = "zstd"
	StreamGetResponseFormatCompressionLz4          StreamGetResponseFormatCompression = "lz4"
)

func (StreamGetResponseFormatCompression) IsKnown added in v6.3.0

type StreamGetResponseFormatDecimalEncoding added in v6.3.0

type StreamGetResponseFormatDecimalEncoding string
const (
	StreamGetResponseFormatDecimalEncodingNumber StreamGetResponseFormatDecimalEncoding = "number"
	StreamGetResponseFormatDecimalEncodingString StreamGetResponseFormatDecimalEncoding = "string"
	StreamGetResponseFormatDecimalEncodingBytes  StreamGetResponseFormatDecimalEncoding = "bytes"
)

func (StreamGetResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamGetResponseFormatJson added in v6.3.0

type StreamGetResponseFormatJson struct {
	Type            StreamGetResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamGetResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamGetResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                       `json:"unstructured"`
	JSON            streamGetResponseFormatJsonJSON            `json:"-"`
}

func (*StreamGetResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseFormatJsonDecimalEncoding added in v6.3.0

type StreamGetResponseFormatJsonDecimalEncoding string
const (
	StreamGetResponseFormatJsonDecimalEncodingNumber StreamGetResponseFormatJsonDecimalEncoding = "number"
	StreamGetResponseFormatJsonDecimalEncodingString StreamGetResponseFormatJsonDecimalEncoding = "string"
	StreamGetResponseFormatJsonDecimalEncodingBytes  StreamGetResponseFormatJsonDecimalEncoding = "bytes"
)

func (StreamGetResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamGetResponseFormatJsonTimestampFormat added in v6.3.0

type StreamGetResponseFormatJsonTimestampFormat string
const (
	StreamGetResponseFormatJsonTimestampFormatRfc3339    StreamGetResponseFormatJsonTimestampFormat = "rfc3339"
	StreamGetResponseFormatJsonTimestampFormatUnixMillis StreamGetResponseFormatJsonTimestampFormat = "unix_millis"
)

func (StreamGetResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamGetResponseFormatJsonType added in v6.3.0

type StreamGetResponseFormatJsonType string
const (
	StreamGetResponseFormatJsonTypeJson StreamGetResponseFormatJsonType = "json"
)

func (StreamGetResponseFormatJsonType) IsKnown added in v6.3.0

type StreamGetResponseFormatParquet added in v6.3.0

type StreamGetResponseFormatParquet struct {
	Type          StreamGetResponseFormatParquetType        `json:"type,required"`
	Compression   StreamGetResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                     `json:"row_group_bytes,nullable"`
	JSON          streamGetResponseFormatParquetJSON        `json:"-"`
}

func (*StreamGetResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseFormatParquetCompression added in v6.3.0

type StreamGetResponseFormatParquetCompression string
const (
	StreamGetResponseFormatParquetCompressionUncompressed StreamGetResponseFormatParquetCompression = "uncompressed"
	StreamGetResponseFormatParquetCompressionSnappy       StreamGetResponseFormatParquetCompression = "snappy"
	StreamGetResponseFormatParquetCompressionGzip         StreamGetResponseFormatParquetCompression = "gzip"
	StreamGetResponseFormatParquetCompressionZstd         StreamGetResponseFormatParquetCompression = "zstd"
	StreamGetResponseFormatParquetCompressionLz4          StreamGetResponseFormatParquetCompression = "lz4"
)

func (StreamGetResponseFormatParquetCompression) IsKnown added in v6.3.0

type StreamGetResponseFormatParquetType added in v6.3.0

type StreamGetResponseFormatParquetType string
const (
	StreamGetResponseFormatParquetTypeParquet StreamGetResponseFormatParquetType = "parquet"
)

func (StreamGetResponseFormatParquetType) IsKnown added in v6.3.0

type StreamGetResponseFormatTimestampFormat added in v6.3.0

type StreamGetResponseFormatTimestampFormat string
const (
	StreamGetResponseFormatTimestampFormatRfc3339    StreamGetResponseFormatTimestampFormat = "rfc3339"
	StreamGetResponseFormatTimestampFormatUnixMillis StreamGetResponseFormatTimestampFormat = "unix_millis"
)

func (StreamGetResponseFormatTimestampFormat) IsKnown added in v6.3.0

type StreamGetResponseFormatType added in v6.3.0

type StreamGetResponseFormatType string
const (
	StreamGetResponseFormatTypeJson    StreamGetResponseFormatType = "json"
	StreamGetResponseFormatTypeParquet StreamGetResponseFormatType = "parquet"
)

func (StreamGetResponseFormatType) IsKnown added in v6.3.0

func (r StreamGetResponseFormatType) IsKnown() bool

type StreamGetResponseFormatUnion added in v6.3.0

type StreamGetResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamGetResponseFormatJson or StreamGetResponseFormatParquet.

type StreamGetResponseHTTP added in v6.3.0

type StreamGetResponseHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication bool `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled bool `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS StreamGetResponseHTTPCORS `json:"cors"`
	JSON streamGetResponseHTTPJSON `json:"-"`
}

func (*StreamGetResponseHTTP) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseHTTP) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseHTTPCORS added in v6.3.0

type StreamGetResponseHTTPCORS struct {
	Origins []string                      `json:"origins"`
	JSON    streamGetResponseHttpcorsJSON `json:"-"`
}

Specifies the CORS options for the HTTP endpoint.

func (*StreamGetResponseHTTPCORS) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchema added in v6.3.0

type StreamGetResponseSchema struct {
	Fields   []StreamGetResponseSchemaField `json:"fields"`
	Format   StreamGetResponseSchemaFormat  `json:"format"`
	Inferred bool                           `json:"inferred,nullable"`
	JSON     streamGetResponseSchemaJSON    `json:"-"`
}

func (*StreamGetResponseSchema) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchema) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaField added in v6.3.0

type StreamGetResponseSchemaField struct {
	Type        StreamGetResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                            `json:"metadata_key,nullable"`
	Name        string                            `json:"name"`
	Required    bool                              `json:"required"`
	SqlName     string                            `json:"sql_name"`
	Unit        StreamGetResponseSchemaFieldsUnit `json:"unit"`
	JSON        streamGetResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*StreamGetResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsBinary added in v6.3.0

type StreamGetResponseSchemaFieldsBinary struct {
	Type        StreamGetResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsBinaryType added in v6.3.0

type StreamGetResponseSchemaFieldsBinaryType string
const (
	StreamGetResponseSchemaFieldsBinaryTypeBinary StreamGetResponseSchemaFieldsBinaryType = "binary"
)

func (StreamGetResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsBool added in v6.3.0

type StreamGetResponseSchemaFieldsBool struct {
	Type        StreamGetResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsBoolType added in v6.3.0

type StreamGetResponseSchemaFieldsBoolType string
const (
	StreamGetResponseSchemaFieldsBoolTypeBool StreamGetResponseSchemaFieldsBoolType = "bool"
)

func (StreamGetResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsFloat32 added in v6.3.0

type StreamGetResponseSchemaFieldsFloat32 struct {
	Type        StreamGetResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsFloat32Type added in v6.3.0

type StreamGetResponseSchemaFieldsFloat32Type string
const (
	StreamGetResponseSchemaFieldsFloat32TypeFloat32 StreamGetResponseSchemaFieldsFloat32Type = "float32"
)

func (StreamGetResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsFloat64 added in v6.3.0

type StreamGetResponseSchemaFieldsFloat64 struct {
	Type        StreamGetResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsFloat64Type added in v6.3.0

type StreamGetResponseSchemaFieldsFloat64Type string
const (
	StreamGetResponseSchemaFieldsFloat64TypeFloat64 StreamGetResponseSchemaFieldsFloat64Type = "float64"
)

func (StreamGetResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsInt32 added in v6.3.0

type StreamGetResponseSchemaFieldsInt32 struct {
	Type        StreamGetResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsInt32Type added in v6.3.0

type StreamGetResponseSchemaFieldsInt32Type string
const (
	StreamGetResponseSchemaFieldsInt32TypeInt32 StreamGetResponseSchemaFieldsInt32Type = "int32"
)

func (StreamGetResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsInt64 added in v6.3.0

type StreamGetResponseSchemaFieldsInt64 struct {
	Type        StreamGetResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsInt64Type added in v6.3.0

type StreamGetResponseSchemaFieldsInt64Type string
const (
	StreamGetResponseSchemaFieldsInt64TypeInt64 StreamGetResponseSchemaFieldsInt64Type = "int64"
)

func (StreamGetResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsJson added in v6.3.0

type StreamGetResponseSchemaFieldsJson struct {
	Type        StreamGetResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsJsonType added in v6.3.0

type StreamGetResponseSchemaFieldsJsonType string
const (
	StreamGetResponseSchemaFieldsJsonTypeJson StreamGetResponseSchemaFieldsJsonType = "json"
)

func (StreamGetResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsList added in v6.3.0

type StreamGetResponseSchemaFieldsList struct {
	JSON streamGetResponseSchemaFieldsListJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsString added in v6.3.0

type StreamGetResponseSchemaFieldsString struct {
	Type        StreamGetResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamGetResponseSchemaFieldsStringJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsStringType added in v6.3.0

type StreamGetResponseSchemaFieldsStringType string
const (
	StreamGetResponseSchemaFieldsStringTypeString StreamGetResponseSchemaFieldsStringType = "string"
)

func (StreamGetResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsStruct added in v6.3.0

type StreamGetResponseSchemaFieldsStruct struct {
	JSON streamGetResponseSchemaFieldsStructJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsTimestamp added in v6.3.0

type StreamGetResponseSchemaFieldsTimestamp struct {
	Type        StreamGetResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                     `json:"metadata_key,nullable"`
	Name        string                                     `json:"name"`
	Required    bool                                       `json:"required"`
	SqlName     string                                     `json:"sql_name"`
	Unit        StreamGetResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        streamGetResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*StreamGetResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFieldsTimestampType added in v6.3.0

type StreamGetResponseSchemaFieldsTimestampType string
const (
	StreamGetResponseSchemaFieldsTimestampTypeTimestamp StreamGetResponseSchemaFieldsTimestampType = "timestamp"
)

func (StreamGetResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsTimestampUnit added in v6.3.0

type StreamGetResponseSchemaFieldsTimestampUnit string
const (
	StreamGetResponseSchemaFieldsTimestampUnitSecond      StreamGetResponseSchemaFieldsTimestampUnit = "second"
	StreamGetResponseSchemaFieldsTimestampUnitMillisecond StreamGetResponseSchemaFieldsTimestampUnit = "millisecond"
	StreamGetResponseSchemaFieldsTimestampUnitMicrosecond StreamGetResponseSchemaFieldsTimestampUnit = "microsecond"
	StreamGetResponseSchemaFieldsTimestampUnitNanosecond  StreamGetResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (StreamGetResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsType added in v6.3.0

type StreamGetResponseSchemaFieldsType string
const (
	StreamGetResponseSchemaFieldsTypeInt32     StreamGetResponseSchemaFieldsType = "int32"
	StreamGetResponseSchemaFieldsTypeInt64     StreamGetResponseSchemaFieldsType = "int64"
	StreamGetResponseSchemaFieldsTypeFloat32   StreamGetResponseSchemaFieldsType = "float32"
	StreamGetResponseSchemaFieldsTypeFloat64   StreamGetResponseSchemaFieldsType = "float64"
	StreamGetResponseSchemaFieldsTypeBool      StreamGetResponseSchemaFieldsType = "bool"
	StreamGetResponseSchemaFieldsTypeString    StreamGetResponseSchemaFieldsType = "string"
	StreamGetResponseSchemaFieldsTypeBinary    StreamGetResponseSchemaFieldsType = "binary"
	StreamGetResponseSchemaFieldsTypeTimestamp StreamGetResponseSchemaFieldsType = "timestamp"
	StreamGetResponseSchemaFieldsTypeJson      StreamGetResponseSchemaFieldsType = "json"
	StreamGetResponseSchemaFieldsTypeStruct    StreamGetResponseSchemaFieldsType = "struct"
	StreamGetResponseSchemaFieldsTypeList      StreamGetResponseSchemaFieldsType = "list"
)

func (StreamGetResponseSchemaFieldsType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFieldsUnit added in v6.3.0

type StreamGetResponseSchemaFieldsUnit string
const (
	StreamGetResponseSchemaFieldsUnitSecond      StreamGetResponseSchemaFieldsUnit = "second"
	StreamGetResponseSchemaFieldsUnitMillisecond StreamGetResponseSchemaFieldsUnit = "millisecond"
	StreamGetResponseSchemaFieldsUnitMicrosecond StreamGetResponseSchemaFieldsUnit = "microsecond"
	StreamGetResponseSchemaFieldsUnitNanosecond  StreamGetResponseSchemaFieldsUnit = "nanosecond"
)

func (StreamGetResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormat added in v6.3.0

type StreamGetResponseSchemaFormat struct {
	Type            StreamGetResponseSchemaFormatType            `json:"type,required"`
	Compression     StreamGetResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding StreamGetResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                        `json:"row_group_bytes,nullable"`
	TimestampFormat StreamGetResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                         `json:"unstructured"`
	JSON            streamGetResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamGetResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a StreamGetResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StreamGetResponseSchemaFormatJson, StreamGetResponseSchemaFormatParquet.

func (*StreamGetResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFormatCompression added in v6.3.0

type StreamGetResponseSchemaFormatCompression string
const (
	StreamGetResponseSchemaFormatCompressionUncompressed StreamGetResponseSchemaFormatCompression = "uncompressed"
	StreamGetResponseSchemaFormatCompressionSnappy       StreamGetResponseSchemaFormatCompression = "snappy"
	StreamGetResponseSchemaFormatCompressionGzip         StreamGetResponseSchemaFormatCompression = "gzip"
	StreamGetResponseSchemaFormatCompressionZstd         StreamGetResponseSchemaFormatCompression = "zstd"
	StreamGetResponseSchemaFormatCompressionLz4          StreamGetResponseSchemaFormatCompression = "lz4"
)

func (StreamGetResponseSchemaFormatCompression) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatDecimalEncoding added in v6.3.0

type StreamGetResponseSchemaFormatDecimalEncoding string
const (
	StreamGetResponseSchemaFormatDecimalEncodingNumber StreamGetResponseSchemaFormatDecimalEncoding = "number"
	StreamGetResponseSchemaFormatDecimalEncodingString StreamGetResponseSchemaFormatDecimalEncoding = "string"
	StreamGetResponseSchemaFormatDecimalEncodingBytes  StreamGetResponseSchemaFormatDecimalEncoding = "bytes"
)

func (StreamGetResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatJson added in v6.3.0

type StreamGetResponseSchemaFormatJson struct {
	Type            StreamGetResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamGetResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamGetResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                             `json:"unstructured"`
	JSON            streamGetResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*StreamGetResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type StreamGetResponseSchemaFormatJsonDecimalEncoding string
const (
	StreamGetResponseSchemaFormatJsonDecimalEncodingNumber StreamGetResponseSchemaFormatJsonDecimalEncoding = "number"
	StreamGetResponseSchemaFormatJsonDecimalEncodingString StreamGetResponseSchemaFormatJsonDecimalEncoding = "string"
	StreamGetResponseSchemaFormatJsonDecimalEncodingBytes  StreamGetResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (StreamGetResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type StreamGetResponseSchemaFormatJsonTimestampFormat string
const (
	StreamGetResponseSchemaFormatJsonTimestampFormatRfc3339    StreamGetResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	StreamGetResponseSchemaFormatJsonTimestampFormatUnixMillis StreamGetResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (StreamGetResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatJsonType added in v6.3.0

type StreamGetResponseSchemaFormatJsonType string
const (
	StreamGetResponseSchemaFormatJsonTypeJson StreamGetResponseSchemaFormatJsonType = "json"
)

func (StreamGetResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatParquet added in v6.3.0

type StreamGetResponseSchemaFormatParquet struct {
	Type          StreamGetResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   StreamGetResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                           `json:"row_group_bytes,nullable"`
	JSON          streamGetResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*StreamGetResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamGetResponseSchemaFormatParquetCompression added in v6.3.0

type StreamGetResponseSchemaFormatParquetCompression string
const (
	StreamGetResponseSchemaFormatParquetCompressionUncompressed StreamGetResponseSchemaFormatParquetCompression = "uncompressed"
	StreamGetResponseSchemaFormatParquetCompressionSnappy       StreamGetResponseSchemaFormatParquetCompression = "snappy"
	StreamGetResponseSchemaFormatParquetCompressionGzip         StreamGetResponseSchemaFormatParquetCompression = "gzip"
	StreamGetResponseSchemaFormatParquetCompressionZstd         StreamGetResponseSchemaFormatParquetCompression = "zstd"
	StreamGetResponseSchemaFormatParquetCompressionLz4          StreamGetResponseSchemaFormatParquetCompression = "lz4"
)

func (StreamGetResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatParquetType added in v6.3.0

type StreamGetResponseSchemaFormatParquetType string
const (
	StreamGetResponseSchemaFormatParquetTypeParquet StreamGetResponseSchemaFormatParquetType = "parquet"
)

func (StreamGetResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatTimestampFormat added in v6.3.0

type StreamGetResponseSchemaFormatTimestampFormat string
const (
	StreamGetResponseSchemaFormatTimestampFormatRfc3339    StreamGetResponseSchemaFormatTimestampFormat = "rfc3339"
	StreamGetResponseSchemaFormatTimestampFormatUnixMillis StreamGetResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (StreamGetResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatType added in v6.3.0

type StreamGetResponseSchemaFormatType string
const (
	StreamGetResponseSchemaFormatTypeJson    StreamGetResponseSchemaFormatType = "json"
	StreamGetResponseSchemaFormatTypeParquet StreamGetResponseSchemaFormatType = "parquet"
)

func (StreamGetResponseSchemaFormatType) IsKnown added in v6.3.0

type StreamGetResponseSchemaFormatUnion added in v6.3.0

type StreamGetResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamGetResponseSchemaFormatJson or StreamGetResponseSchemaFormatParquet.

type StreamGetResponseWorkerBinding added in v6.3.0

type StreamGetResponseWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled bool                               `json:"enabled,required"`
	JSON    streamGetResponseWorkerBindingJSON `json:"-"`
}

func (*StreamGetResponseWorkerBinding) UnmarshalJSON added in v6.3.0

func (r *StreamGetResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)

type StreamListParams added in v6.3.0

type StreamListParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string]  `path:"account_id,required"`
	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 added in v6.3.0

func (r StreamListParams) URLQuery() (v url.Values)

URLQuery serializes StreamListParams's query parameters as `url.Values`.

type StreamListResponse added in v6.3.0

type StreamListResponse struct {
	// Indicates a unique identifier for this stream.
	ID         string                 `json:"id,required"`
	CreatedAt  time.Time              `json:"created_at,required" format:"date-time"`
	HTTP       StreamListResponseHTTP `json:"http,required"`
	ModifiedAt time.Time              `json:"modified_at,required" format:"date-time"`
	// Indicates the name of the Stream.
	Name string `json:"name,required"`
	// Indicates the current version of this stream.
	Version       int64                           `json:"version,required"`
	WorkerBinding StreamListResponseWorkerBinding `json:"worker_binding,required"`
	// Indicates the endpoint URL of this stream.
	Endpoint string                   `json:"endpoint" format:"uri"`
	Format   StreamListResponseFormat `json:"format"`
	Schema   StreamListResponseSchema `json:"schema"`
	JSON     streamListResponseJSON   `json:"-"`
}

func (*StreamListResponse) UnmarshalJSON added in v6.3.0

func (r *StreamListResponse) UnmarshalJSON(data []byte) (err error)

type StreamListResponseFormat added in v6.3.0

type StreamListResponseFormat struct {
	Type            StreamListResponseFormatType            `json:"type,required"`
	Compression     StreamListResponseFormatCompression     `json:"compression"`
	DecimalEncoding StreamListResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                   `json:"row_group_bytes,nullable"`
	TimestampFormat StreamListResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                    `json:"unstructured"`
	JSON            streamListResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamListResponseFormat) AsUnion added in v6.3.0

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 added in v6.3.0

func (r *StreamListResponseFormat) UnmarshalJSON(data []byte) (err error)

type StreamListResponseFormatCompression added in v6.3.0

type StreamListResponseFormatCompression string
const (
	StreamListResponseFormatCompressionUncompressed StreamListResponseFormatCompression = "uncompressed"
	StreamListResponseFormatCompressionSnappy       StreamListResponseFormatCompression = "snappy"
	StreamListResponseFormatCompressionGzip         StreamListResponseFormatCompression = "gzip"
	StreamListResponseFormatCompressionZstd         StreamListResponseFormatCompression = "zstd"
	StreamListResponseFormatCompressionLz4          StreamListResponseFormatCompression = "lz4"
)

func (StreamListResponseFormatCompression) IsKnown added in v6.3.0

type StreamListResponseFormatDecimalEncoding added in v6.3.0

type StreamListResponseFormatDecimalEncoding string
const (
	StreamListResponseFormatDecimalEncodingNumber StreamListResponseFormatDecimalEncoding = "number"
	StreamListResponseFormatDecimalEncodingString StreamListResponseFormatDecimalEncoding = "string"
	StreamListResponseFormatDecimalEncodingBytes  StreamListResponseFormatDecimalEncoding = "bytes"
)

func (StreamListResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamListResponseFormatJson added in v6.3.0

type StreamListResponseFormatJson struct {
	Type            StreamListResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamListResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamListResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                        `json:"unstructured"`
	JSON            streamListResponseFormatJsonJSON            `json:"-"`
}

func (*StreamListResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamListResponseFormatJsonDecimalEncoding added in v6.3.0

type StreamListResponseFormatJsonDecimalEncoding string
const (
	StreamListResponseFormatJsonDecimalEncodingNumber StreamListResponseFormatJsonDecimalEncoding = "number"
	StreamListResponseFormatJsonDecimalEncodingString StreamListResponseFormatJsonDecimalEncoding = "string"
	StreamListResponseFormatJsonDecimalEncodingBytes  StreamListResponseFormatJsonDecimalEncoding = "bytes"
)

func (StreamListResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamListResponseFormatJsonTimestampFormat added in v6.3.0

type StreamListResponseFormatJsonTimestampFormat string
const (
	StreamListResponseFormatJsonTimestampFormatRfc3339    StreamListResponseFormatJsonTimestampFormat = "rfc3339"
	StreamListResponseFormatJsonTimestampFormatUnixMillis StreamListResponseFormatJsonTimestampFormat = "unix_millis"
)

func (StreamListResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamListResponseFormatJsonType added in v6.3.0

type StreamListResponseFormatJsonType string
const (
	StreamListResponseFormatJsonTypeJson StreamListResponseFormatJsonType = "json"
)

func (StreamListResponseFormatJsonType) IsKnown added in v6.3.0

type StreamListResponseFormatParquet added in v6.3.0

type StreamListResponseFormatParquet struct {
	Type          StreamListResponseFormatParquetType        `json:"type,required"`
	Compression   StreamListResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                      `json:"row_group_bytes,nullable"`
	JSON          streamListResponseFormatParquetJSON        `json:"-"`
}

func (*StreamListResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamListResponseFormatParquetCompression added in v6.3.0

type StreamListResponseFormatParquetCompression string
const (
	StreamListResponseFormatParquetCompressionUncompressed StreamListResponseFormatParquetCompression = "uncompressed"
	StreamListResponseFormatParquetCompressionSnappy       StreamListResponseFormatParquetCompression = "snappy"
	StreamListResponseFormatParquetCompressionGzip         StreamListResponseFormatParquetCompression = "gzip"
	StreamListResponseFormatParquetCompressionZstd         StreamListResponseFormatParquetCompression = "zstd"
	StreamListResponseFormatParquetCompressionLz4          StreamListResponseFormatParquetCompression = "lz4"
)

func (StreamListResponseFormatParquetCompression) IsKnown added in v6.3.0

type StreamListResponseFormatParquetType added in v6.3.0

type StreamListResponseFormatParquetType string
const (
	StreamListResponseFormatParquetTypeParquet StreamListResponseFormatParquetType = "parquet"
)

func (StreamListResponseFormatParquetType) IsKnown added in v6.3.0

type StreamListResponseFormatTimestampFormat added in v6.3.0

type StreamListResponseFormatTimestampFormat string
const (
	StreamListResponseFormatTimestampFormatRfc3339    StreamListResponseFormatTimestampFormat = "rfc3339"
	StreamListResponseFormatTimestampFormatUnixMillis StreamListResponseFormatTimestampFormat = "unix_millis"
)

func (StreamListResponseFormatTimestampFormat) IsKnown added in v6.3.0

type StreamListResponseFormatType added in v6.3.0

type StreamListResponseFormatType string
const (
	StreamListResponseFormatTypeJson    StreamListResponseFormatType = "json"
	StreamListResponseFormatTypeParquet StreamListResponseFormatType = "parquet"
)

func (StreamListResponseFormatType) IsKnown added in v6.3.0

func (r StreamListResponseFormatType) IsKnown() bool

type StreamListResponseFormatUnion added in v6.3.0

type StreamListResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamListResponseFormatJson or StreamListResponseFormatParquet.

type StreamListResponseHTTP added in v6.3.0

type StreamListResponseHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication bool `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled bool `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS StreamListResponseHTTPCORS `json:"cors"`
	JSON streamListResponseHTTPJSON `json:"-"`
}

func (*StreamListResponseHTTP) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseHTTP) UnmarshalJSON(data []byte) (err error)

type StreamListResponseHTTPCORS added in v6.3.0

type StreamListResponseHTTPCORS struct {
	Origins []string                       `json:"origins"`
	JSON    streamListResponseHttpcorsJSON `json:"-"`
}

Specifies the CORS options for the HTTP endpoint.

func (*StreamListResponseHTTPCORS) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchema added in v6.3.0

type StreamListResponseSchema struct {
	Fields   []StreamListResponseSchemaField `json:"fields"`
	Format   StreamListResponseSchemaFormat  `json:"format"`
	Inferred bool                            `json:"inferred,nullable"`
	JSON     streamListResponseSchemaJSON    `json:"-"`
}

func (*StreamListResponseSchema) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchema) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaField added in v6.3.0

type StreamListResponseSchemaField struct {
	Type        StreamListResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                             `json:"metadata_key,nullable"`
	Name        string                             `json:"name"`
	Required    bool                               `json:"required"`
	SqlName     string                             `json:"sql_name"`
	Unit        StreamListResponseSchemaFieldsUnit `json:"unit"`
	JSON        streamListResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*StreamListResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsBinary added in v6.3.0

type StreamListResponseSchemaFieldsBinary struct {
	Type        StreamListResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsBinaryType added in v6.3.0

type StreamListResponseSchemaFieldsBinaryType string
const (
	StreamListResponseSchemaFieldsBinaryTypeBinary StreamListResponseSchemaFieldsBinaryType = "binary"
)

func (StreamListResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsBool added in v6.3.0

type StreamListResponseSchemaFieldsBool struct {
	Type        StreamListResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsBoolType added in v6.3.0

type StreamListResponseSchemaFieldsBoolType string
const (
	StreamListResponseSchemaFieldsBoolTypeBool StreamListResponseSchemaFieldsBoolType = "bool"
)

func (StreamListResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsFloat32 added in v6.3.0

type StreamListResponseSchemaFieldsFloat32 struct {
	Type        StreamListResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                    `json:"metadata_key,nullable"`
	Name        string                                    `json:"name"`
	Required    bool                                      `json:"required"`
	SqlName     string                                    `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsFloat32Type added in v6.3.0

type StreamListResponseSchemaFieldsFloat32Type string
const (
	StreamListResponseSchemaFieldsFloat32TypeFloat32 StreamListResponseSchemaFieldsFloat32Type = "float32"
)

func (StreamListResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsFloat64 added in v6.3.0

type StreamListResponseSchemaFieldsFloat64 struct {
	Type        StreamListResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                    `json:"metadata_key,nullable"`
	Name        string                                    `json:"name"`
	Required    bool                                      `json:"required"`
	SqlName     string                                    `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsFloat64Type added in v6.3.0

type StreamListResponseSchemaFieldsFloat64Type string
const (
	StreamListResponseSchemaFieldsFloat64TypeFloat64 StreamListResponseSchemaFieldsFloat64Type = "float64"
)

func (StreamListResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsInt32 added in v6.3.0

type StreamListResponseSchemaFieldsInt32 struct {
	Type        StreamListResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsInt32Type added in v6.3.0

type StreamListResponseSchemaFieldsInt32Type string
const (
	StreamListResponseSchemaFieldsInt32TypeInt32 StreamListResponseSchemaFieldsInt32Type = "int32"
)

func (StreamListResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsInt64 added in v6.3.0

type StreamListResponseSchemaFieldsInt64 struct {
	Type        StreamListResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsInt64Type added in v6.3.0

type StreamListResponseSchemaFieldsInt64Type string
const (
	StreamListResponseSchemaFieldsInt64TypeInt64 StreamListResponseSchemaFieldsInt64Type = "int64"
)

func (StreamListResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsJson added in v6.3.0

type StreamListResponseSchemaFieldsJson struct {
	Type        StreamListResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsJsonType added in v6.3.0

type StreamListResponseSchemaFieldsJsonType string
const (
	StreamListResponseSchemaFieldsJsonTypeJson StreamListResponseSchemaFieldsJsonType = "json"
)

func (StreamListResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsList added in v6.3.0

type StreamListResponseSchemaFieldsList struct {
	JSON streamListResponseSchemaFieldsListJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsString added in v6.3.0

type StreamListResponseSchemaFieldsString struct {
	Type        StreamListResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamListResponseSchemaFieldsStringJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsStringType added in v6.3.0

type StreamListResponseSchemaFieldsStringType string
const (
	StreamListResponseSchemaFieldsStringTypeString StreamListResponseSchemaFieldsStringType = "string"
)

func (StreamListResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsStruct added in v6.3.0

type StreamListResponseSchemaFieldsStruct struct {
	JSON streamListResponseSchemaFieldsStructJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsTimestamp added in v6.3.0

type StreamListResponseSchemaFieldsTimestamp struct {
	Type        StreamListResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                      `json:"metadata_key,nullable"`
	Name        string                                      `json:"name"`
	Required    bool                                        `json:"required"`
	SqlName     string                                      `json:"sql_name"`
	Unit        StreamListResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        streamListResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*StreamListResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFieldsTimestampType added in v6.3.0

type StreamListResponseSchemaFieldsTimestampType string
const (
	StreamListResponseSchemaFieldsTimestampTypeTimestamp StreamListResponseSchemaFieldsTimestampType = "timestamp"
)

func (StreamListResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsTimestampUnit added in v6.3.0

type StreamListResponseSchemaFieldsTimestampUnit string
const (
	StreamListResponseSchemaFieldsTimestampUnitSecond      StreamListResponseSchemaFieldsTimestampUnit = "second"
	StreamListResponseSchemaFieldsTimestampUnitMillisecond StreamListResponseSchemaFieldsTimestampUnit = "millisecond"
	StreamListResponseSchemaFieldsTimestampUnitMicrosecond StreamListResponseSchemaFieldsTimestampUnit = "microsecond"
	StreamListResponseSchemaFieldsTimestampUnitNanosecond  StreamListResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (StreamListResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsType added in v6.3.0

type StreamListResponseSchemaFieldsType string
const (
	StreamListResponseSchemaFieldsTypeInt32     StreamListResponseSchemaFieldsType = "int32"
	StreamListResponseSchemaFieldsTypeInt64     StreamListResponseSchemaFieldsType = "int64"
	StreamListResponseSchemaFieldsTypeFloat32   StreamListResponseSchemaFieldsType = "float32"
	StreamListResponseSchemaFieldsTypeFloat64   StreamListResponseSchemaFieldsType = "float64"
	StreamListResponseSchemaFieldsTypeBool      StreamListResponseSchemaFieldsType = "bool"
	StreamListResponseSchemaFieldsTypeString    StreamListResponseSchemaFieldsType = "string"
	StreamListResponseSchemaFieldsTypeBinary    StreamListResponseSchemaFieldsType = "binary"
	StreamListResponseSchemaFieldsTypeTimestamp StreamListResponseSchemaFieldsType = "timestamp"
	StreamListResponseSchemaFieldsTypeJson      StreamListResponseSchemaFieldsType = "json"
	StreamListResponseSchemaFieldsTypeStruct    StreamListResponseSchemaFieldsType = "struct"
	StreamListResponseSchemaFieldsTypeList      StreamListResponseSchemaFieldsType = "list"
)

func (StreamListResponseSchemaFieldsType) IsKnown added in v6.3.0

type StreamListResponseSchemaFieldsUnit added in v6.3.0

type StreamListResponseSchemaFieldsUnit string
const (
	StreamListResponseSchemaFieldsUnitSecond      StreamListResponseSchemaFieldsUnit = "second"
	StreamListResponseSchemaFieldsUnitMillisecond StreamListResponseSchemaFieldsUnit = "millisecond"
	StreamListResponseSchemaFieldsUnitMicrosecond StreamListResponseSchemaFieldsUnit = "microsecond"
	StreamListResponseSchemaFieldsUnitNanosecond  StreamListResponseSchemaFieldsUnit = "nanosecond"
)

func (StreamListResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type StreamListResponseSchemaFormat added in v6.3.0

type StreamListResponseSchemaFormat struct {
	Type            StreamListResponseSchemaFormatType            `json:"type,required"`
	Compression     StreamListResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding StreamListResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                         `json:"row_group_bytes,nullable"`
	TimestampFormat StreamListResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                          `json:"unstructured"`
	JSON            streamListResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamListResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a StreamListResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StreamListResponseSchemaFormatJson, StreamListResponseSchemaFormatParquet.

func (*StreamListResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFormatCompression added in v6.3.0

type StreamListResponseSchemaFormatCompression string
const (
	StreamListResponseSchemaFormatCompressionUncompressed StreamListResponseSchemaFormatCompression = "uncompressed"
	StreamListResponseSchemaFormatCompressionSnappy       StreamListResponseSchemaFormatCompression = "snappy"
	StreamListResponseSchemaFormatCompressionGzip         StreamListResponseSchemaFormatCompression = "gzip"
	StreamListResponseSchemaFormatCompressionZstd         StreamListResponseSchemaFormatCompression = "zstd"
	StreamListResponseSchemaFormatCompressionLz4          StreamListResponseSchemaFormatCompression = "lz4"
)

func (StreamListResponseSchemaFormatCompression) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatDecimalEncoding added in v6.3.0

type StreamListResponseSchemaFormatDecimalEncoding string
const (
	StreamListResponseSchemaFormatDecimalEncodingNumber StreamListResponseSchemaFormatDecimalEncoding = "number"
	StreamListResponseSchemaFormatDecimalEncodingString StreamListResponseSchemaFormatDecimalEncoding = "string"
	StreamListResponseSchemaFormatDecimalEncodingBytes  StreamListResponseSchemaFormatDecimalEncoding = "bytes"
)

func (StreamListResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatJson added in v6.3.0

type StreamListResponseSchemaFormatJson struct {
	Type            StreamListResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamListResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamListResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                              `json:"unstructured"`
	JSON            streamListResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*StreamListResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type StreamListResponseSchemaFormatJsonDecimalEncoding string
const (
	StreamListResponseSchemaFormatJsonDecimalEncodingNumber StreamListResponseSchemaFormatJsonDecimalEncoding = "number"
	StreamListResponseSchemaFormatJsonDecimalEncodingString StreamListResponseSchemaFormatJsonDecimalEncoding = "string"
	StreamListResponseSchemaFormatJsonDecimalEncodingBytes  StreamListResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (StreamListResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type StreamListResponseSchemaFormatJsonTimestampFormat string
const (
	StreamListResponseSchemaFormatJsonTimestampFormatRfc3339    StreamListResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	StreamListResponseSchemaFormatJsonTimestampFormatUnixMillis StreamListResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (StreamListResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatJsonType added in v6.3.0

type StreamListResponseSchemaFormatJsonType string
const (
	StreamListResponseSchemaFormatJsonTypeJson StreamListResponseSchemaFormatJsonType = "json"
)

func (StreamListResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatParquet added in v6.3.0

type StreamListResponseSchemaFormatParquet struct {
	Type          StreamListResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   StreamListResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                            `json:"row_group_bytes,nullable"`
	JSON          streamListResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*StreamListResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamListResponseSchemaFormatParquetCompression added in v6.3.0

type StreamListResponseSchemaFormatParquetCompression string
const (
	StreamListResponseSchemaFormatParquetCompressionUncompressed StreamListResponseSchemaFormatParquetCompression = "uncompressed"
	StreamListResponseSchemaFormatParquetCompressionSnappy       StreamListResponseSchemaFormatParquetCompression = "snappy"
	StreamListResponseSchemaFormatParquetCompressionGzip         StreamListResponseSchemaFormatParquetCompression = "gzip"
	StreamListResponseSchemaFormatParquetCompressionZstd         StreamListResponseSchemaFormatParquetCompression = "zstd"
	StreamListResponseSchemaFormatParquetCompressionLz4          StreamListResponseSchemaFormatParquetCompression = "lz4"
)

func (StreamListResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatParquetType added in v6.3.0

type StreamListResponseSchemaFormatParquetType string
const (
	StreamListResponseSchemaFormatParquetTypeParquet StreamListResponseSchemaFormatParquetType = "parquet"
)

func (StreamListResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatTimestampFormat added in v6.3.0

type StreamListResponseSchemaFormatTimestampFormat string
const (
	StreamListResponseSchemaFormatTimestampFormatRfc3339    StreamListResponseSchemaFormatTimestampFormat = "rfc3339"
	StreamListResponseSchemaFormatTimestampFormatUnixMillis StreamListResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (StreamListResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatType added in v6.3.0

type StreamListResponseSchemaFormatType string
const (
	StreamListResponseSchemaFormatTypeJson    StreamListResponseSchemaFormatType = "json"
	StreamListResponseSchemaFormatTypeParquet StreamListResponseSchemaFormatType = "parquet"
)

func (StreamListResponseSchemaFormatType) IsKnown added in v6.3.0

type StreamListResponseSchemaFormatUnion added in v6.3.0

type StreamListResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamListResponseSchemaFormatJson or StreamListResponseSchemaFormatParquet.

type StreamListResponseWorkerBinding added in v6.3.0

type StreamListResponseWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled bool                                `json:"enabled,required"`
	JSON    streamListResponseWorkerBindingJSON `json:"-"`
}

func (*StreamListResponseWorkerBinding) UnmarshalJSON added in v6.3.0

func (r *StreamListResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)

type StreamNewParams added in v6.3.0

type StreamNewParams struct {
	// Specifies the public ID of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Specifies the name of the Stream.
	Name          param.Field[string]                       `json:"name,required"`
	Format        param.Field[StreamNewParamsFormatUnion]   `json:"format"`
	HTTP          param.Field[StreamNewParamsHTTP]          `json:"http"`
	Schema        param.Field[StreamNewParamsSchema]        `json:"schema"`
	WorkerBinding param.Field[StreamNewParamsWorkerBinding] `json:"worker_binding"`
}

func (StreamNewParams) MarshalJSON added in v6.3.0

func (r StreamNewParams) MarshalJSON() (data []byte, err error)

type StreamNewParamsFormat added in v6.3.0

type StreamNewParamsFormat struct {
	Type            param.Field[StreamNewParamsFormatType]            `json:"type,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"`
}

func (StreamNewParamsFormat) MarshalJSON added in v6.3.0

func (r StreamNewParamsFormat) MarshalJSON() (data []byte, err error)

type StreamNewParamsFormatCompression added in v6.3.0

type StreamNewParamsFormatCompression string
const (
	StreamNewParamsFormatCompressionUncompressed StreamNewParamsFormatCompression = "uncompressed"
	StreamNewParamsFormatCompressionSnappy       StreamNewParamsFormatCompression = "snappy"
	StreamNewParamsFormatCompressionGzip         StreamNewParamsFormatCompression = "gzip"
	StreamNewParamsFormatCompressionZstd         StreamNewParamsFormatCompression = "zstd"
	StreamNewParamsFormatCompressionLz4          StreamNewParamsFormatCompression = "lz4"
)

func (StreamNewParamsFormatCompression) IsKnown added in v6.3.0

type StreamNewParamsFormatDecimalEncoding added in v6.3.0

type StreamNewParamsFormatDecimalEncoding string
const (
	StreamNewParamsFormatDecimalEncodingNumber StreamNewParamsFormatDecimalEncoding = "number"
	StreamNewParamsFormatDecimalEncodingString StreamNewParamsFormatDecimalEncoding = "string"
	StreamNewParamsFormatDecimalEncodingBytes  StreamNewParamsFormatDecimalEncoding = "bytes"
)

func (StreamNewParamsFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamNewParamsFormatJson added in v6.3.0

type StreamNewParamsFormatJson struct {
	Type            param.Field[StreamNewParamsFormatJsonType]            `json:"type,required"`
	DecimalEncoding param.Field[StreamNewParamsFormatJsonDecimalEncoding] `json:"decimal_encoding"`
	TimestampFormat param.Field[StreamNewParamsFormatJsonTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                     `json:"unstructured"`
}

func (StreamNewParamsFormatJson) MarshalJSON added in v6.3.0

func (r StreamNewParamsFormatJson) MarshalJSON() (data []byte, err error)

type StreamNewParamsFormatJsonDecimalEncoding added in v6.3.0

type StreamNewParamsFormatJsonDecimalEncoding string
const (
	StreamNewParamsFormatJsonDecimalEncodingNumber StreamNewParamsFormatJsonDecimalEncoding = "number"
	StreamNewParamsFormatJsonDecimalEncodingString StreamNewParamsFormatJsonDecimalEncoding = "string"
	StreamNewParamsFormatJsonDecimalEncodingBytes  StreamNewParamsFormatJsonDecimalEncoding = "bytes"
)

func (StreamNewParamsFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamNewParamsFormatJsonTimestampFormat added in v6.3.0

type StreamNewParamsFormatJsonTimestampFormat string
const (
	StreamNewParamsFormatJsonTimestampFormatRfc3339    StreamNewParamsFormatJsonTimestampFormat = "rfc3339"
	StreamNewParamsFormatJsonTimestampFormatUnixMillis StreamNewParamsFormatJsonTimestampFormat = "unix_millis"
)

func (StreamNewParamsFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamNewParamsFormatJsonType added in v6.3.0

type StreamNewParamsFormatJsonType string
const (
	StreamNewParamsFormatJsonTypeJson StreamNewParamsFormatJsonType = "json"
)

func (StreamNewParamsFormatJsonType) IsKnown added in v6.3.0

func (r StreamNewParamsFormatJsonType) IsKnown() bool

type StreamNewParamsFormatParquet added in v6.3.0

type StreamNewParamsFormatParquet struct {
	Type          param.Field[StreamNewParamsFormatParquetType]        `json:"type,required"`
	Compression   param.Field[StreamNewParamsFormatParquetCompression] `json:"compression"`
	RowGroupBytes param.Field[int64]                                   `json:"row_group_bytes"`
}

func (StreamNewParamsFormatParquet) MarshalJSON added in v6.3.0

func (r StreamNewParamsFormatParquet) MarshalJSON() (data []byte, err error)

type StreamNewParamsFormatParquetCompression added in v6.3.0

type StreamNewParamsFormatParquetCompression string
const (
	StreamNewParamsFormatParquetCompressionUncompressed StreamNewParamsFormatParquetCompression = "uncompressed"
	StreamNewParamsFormatParquetCompressionSnappy       StreamNewParamsFormatParquetCompression = "snappy"
	StreamNewParamsFormatParquetCompressionGzip         StreamNewParamsFormatParquetCompression = "gzip"
	StreamNewParamsFormatParquetCompressionZstd         StreamNewParamsFormatParquetCompression = "zstd"
	StreamNewParamsFormatParquetCompressionLz4          StreamNewParamsFormatParquetCompression = "lz4"
)

func (StreamNewParamsFormatParquetCompression) IsKnown added in v6.3.0

type StreamNewParamsFormatParquetType added in v6.3.0

type StreamNewParamsFormatParquetType string
const (
	StreamNewParamsFormatParquetTypeParquet StreamNewParamsFormatParquetType = "parquet"
)

func (StreamNewParamsFormatParquetType) IsKnown added in v6.3.0

type StreamNewParamsFormatTimestampFormat added in v6.3.0

type StreamNewParamsFormatTimestampFormat string
const (
	StreamNewParamsFormatTimestampFormatRfc3339    StreamNewParamsFormatTimestampFormat = "rfc3339"
	StreamNewParamsFormatTimestampFormatUnixMillis StreamNewParamsFormatTimestampFormat = "unix_millis"
)

func (StreamNewParamsFormatTimestampFormat) IsKnown added in v6.3.0

type StreamNewParamsFormatType added in v6.3.0

type StreamNewParamsFormatType string
const (
	StreamNewParamsFormatTypeJson    StreamNewParamsFormatType = "json"
	StreamNewParamsFormatTypeParquet StreamNewParamsFormatType = "parquet"
)

func (StreamNewParamsFormatType) IsKnown added in v6.3.0

func (r StreamNewParamsFormatType) IsKnown() bool

type StreamNewParamsFormatUnion added in v6.3.0

type StreamNewParamsFormatUnion interface {
	// contains filtered or unexported methods
}

Satisfied by pipelines.StreamNewParamsFormatJson, pipelines.StreamNewParamsFormatParquet, StreamNewParamsFormat.

type StreamNewParamsHTTP added in v6.3.0

type StreamNewParamsHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication param.Field[bool] `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS param.Field[StreamNewParamsHTTPCORS] `json:"cors"`
}

func (StreamNewParamsHTTP) MarshalJSON added in v6.3.0

func (r StreamNewParamsHTTP) MarshalJSON() (data []byte, err error)

type StreamNewParamsHTTPCORS added in v6.3.0

type StreamNewParamsHTTPCORS struct {
	Origins param.Field[[]string] `json:"origins"`
}

Specifies the CORS options for the HTTP endpoint.

func (StreamNewParamsHTTPCORS) MarshalJSON added in v6.3.0

func (r StreamNewParamsHTTPCORS) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchema added in v6.3.0

type StreamNewParamsSchema struct {
	Fields   param.Field[[]StreamNewParamsSchemaFieldUnion] `json:"fields"`
	Format   param.Field[StreamNewParamsSchemaFormatUnion]  `json:"format"`
	Inferred param.Field[bool]                              `json:"inferred"`
}

func (StreamNewParamsSchema) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchema) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaField added in v6.3.0

type StreamNewParamsSchemaField struct {
	Type        param.Field[StreamNewParamsSchemaFieldsType] `json:"type,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[StreamNewParamsSchemaFieldsUnit] `json:"unit"`
}

func (StreamNewParamsSchemaField) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaField) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsBinary added in v6.3.0

type StreamNewParamsSchemaFieldsBinary struct {
	Type        param.Field[StreamNewParamsSchemaFieldsBinaryType] `json:"type,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 (StreamNewParamsSchemaFieldsBinary) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsBinary) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsBinaryType added in v6.3.0

type StreamNewParamsSchemaFieldsBinaryType string
const (
	StreamNewParamsSchemaFieldsBinaryTypeBinary StreamNewParamsSchemaFieldsBinaryType = "binary"
)

func (StreamNewParamsSchemaFieldsBinaryType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsBool added in v6.3.0

type StreamNewParamsSchemaFieldsBool struct {
	Type        param.Field[StreamNewParamsSchemaFieldsBoolType] `json:"type,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 (StreamNewParamsSchemaFieldsBool) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsBool) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsBoolType added in v6.3.0

type StreamNewParamsSchemaFieldsBoolType string
const (
	StreamNewParamsSchemaFieldsBoolTypeBool StreamNewParamsSchemaFieldsBoolType = "bool"
)

func (StreamNewParamsSchemaFieldsBoolType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsFloat32 added in v6.3.0

type StreamNewParamsSchemaFieldsFloat32 struct {
	Type        param.Field[StreamNewParamsSchemaFieldsFloat32Type] `json:"type,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 (StreamNewParamsSchemaFieldsFloat32) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsFloat32) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsFloat32Type added in v6.3.0

type StreamNewParamsSchemaFieldsFloat32Type string
const (
	StreamNewParamsSchemaFieldsFloat32TypeFloat32 StreamNewParamsSchemaFieldsFloat32Type = "float32"
)

func (StreamNewParamsSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsFloat64 added in v6.3.0

type StreamNewParamsSchemaFieldsFloat64 struct {
	Type        param.Field[StreamNewParamsSchemaFieldsFloat64Type] `json:"type,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 (StreamNewParamsSchemaFieldsFloat64) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsFloat64) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsFloat64Type added in v6.3.0

type StreamNewParamsSchemaFieldsFloat64Type string
const (
	StreamNewParamsSchemaFieldsFloat64TypeFloat64 StreamNewParamsSchemaFieldsFloat64Type = "float64"
)

func (StreamNewParamsSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsInt32 added in v6.3.0

type StreamNewParamsSchemaFieldsInt32 struct {
	Type        param.Field[StreamNewParamsSchemaFieldsInt32Type] `json:"type,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 (StreamNewParamsSchemaFieldsInt32) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsInt32) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsInt32Type added in v6.3.0

type StreamNewParamsSchemaFieldsInt32Type string
const (
	StreamNewParamsSchemaFieldsInt32TypeInt32 StreamNewParamsSchemaFieldsInt32Type = "int32"
)

func (StreamNewParamsSchemaFieldsInt32Type) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsInt64 added in v6.3.0

type StreamNewParamsSchemaFieldsInt64 struct {
	Type        param.Field[StreamNewParamsSchemaFieldsInt64Type] `json:"type,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 (StreamNewParamsSchemaFieldsInt64) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsInt64) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsInt64Type added in v6.3.0

type StreamNewParamsSchemaFieldsInt64Type string
const (
	StreamNewParamsSchemaFieldsInt64TypeInt64 StreamNewParamsSchemaFieldsInt64Type = "int64"
)

func (StreamNewParamsSchemaFieldsInt64Type) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsJson added in v6.3.0

type StreamNewParamsSchemaFieldsJson struct {
	Type        param.Field[StreamNewParamsSchemaFieldsJsonType] `json:"type,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 (StreamNewParamsSchemaFieldsJson) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsJson) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsJsonType added in v6.3.0

type StreamNewParamsSchemaFieldsJsonType string
const (
	StreamNewParamsSchemaFieldsJsonTypeJson StreamNewParamsSchemaFieldsJsonType = "json"
)

func (StreamNewParamsSchemaFieldsJsonType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsList added in v6.3.0

type StreamNewParamsSchemaFieldsList struct {
}

func (StreamNewParamsSchemaFieldsList) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsList) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsString added in v6.3.0

type StreamNewParamsSchemaFieldsString struct {
	Type        param.Field[StreamNewParamsSchemaFieldsStringType] `json:"type,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 (StreamNewParamsSchemaFieldsString) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsString) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsStringType added in v6.3.0

type StreamNewParamsSchemaFieldsStringType string
const (
	StreamNewParamsSchemaFieldsStringTypeString StreamNewParamsSchemaFieldsStringType = "string"
)

func (StreamNewParamsSchemaFieldsStringType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsStruct added in v6.3.0

type StreamNewParamsSchemaFieldsStruct struct {
}

func (StreamNewParamsSchemaFieldsStruct) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsStruct) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsTimestamp added in v6.3.0

type StreamNewParamsSchemaFieldsTimestamp struct {
	Type        param.Field[StreamNewParamsSchemaFieldsTimestampType] `json:"type,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[StreamNewParamsSchemaFieldsTimestampUnit] `json:"unit"`
}

func (StreamNewParamsSchemaFieldsTimestamp) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFieldsTimestamp) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFieldsTimestampType added in v6.3.0

type StreamNewParamsSchemaFieldsTimestampType string
const (
	StreamNewParamsSchemaFieldsTimestampTypeTimestamp StreamNewParamsSchemaFieldsTimestampType = "timestamp"
)

func (StreamNewParamsSchemaFieldsTimestampType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsTimestampUnit added in v6.3.0

type StreamNewParamsSchemaFieldsTimestampUnit string
const (
	StreamNewParamsSchemaFieldsTimestampUnitSecond      StreamNewParamsSchemaFieldsTimestampUnit = "second"
	StreamNewParamsSchemaFieldsTimestampUnitMillisecond StreamNewParamsSchemaFieldsTimestampUnit = "millisecond"
	StreamNewParamsSchemaFieldsTimestampUnitMicrosecond StreamNewParamsSchemaFieldsTimestampUnit = "microsecond"
	StreamNewParamsSchemaFieldsTimestampUnitNanosecond  StreamNewParamsSchemaFieldsTimestampUnit = "nanosecond"
)

func (StreamNewParamsSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsType added in v6.3.0

type StreamNewParamsSchemaFieldsType string
const (
	StreamNewParamsSchemaFieldsTypeInt32     StreamNewParamsSchemaFieldsType = "int32"
	StreamNewParamsSchemaFieldsTypeInt64     StreamNewParamsSchemaFieldsType = "int64"
	StreamNewParamsSchemaFieldsTypeFloat32   StreamNewParamsSchemaFieldsType = "float32"
	StreamNewParamsSchemaFieldsTypeFloat64   StreamNewParamsSchemaFieldsType = "float64"
	StreamNewParamsSchemaFieldsTypeBool      StreamNewParamsSchemaFieldsType = "bool"
	StreamNewParamsSchemaFieldsTypeString    StreamNewParamsSchemaFieldsType = "string"
	StreamNewParamsSchemaFieldsTypeBinary    StreamNewParamsSchemaFieldsType = "binary"
	StreamNewParamsSchemaFieldsTypeTimestamp StreamNewParamsSchemaFieldsType = "timestamp"
	StreamNewParamsSchemaFieldsTypeJson      StreamNewParamsSchemaFieldsType = "json"
	StreamNewParamsSchemaFieldsTypeStruct    StreamNewParamsSchemaFieldsType = "struct"
	StreamNewParamsSchemaFieldsTypeList      StreamNewParamsSchemaFieldsType = "list"
)

func (StreamNewParamsSchemaFieldsType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFieldsUnit added in v6.3.0

type StreamNewParamsSchemaFieldsUnit string
const (
	StreamNewParamsSchemaFieldsUnitSecond      StreamNewParamsSchemaFieldsUnit = "second"
	StreamNewParamsSchemaFieldsUnitMillisecond StreamNewParamsSchemaFieldsUnit = "millisecond"
	StreamNewParamsSchemaFieldsUnitMicrosecond StreamNewParamsSchemaFieldsUnit = "microsecond"
	StreamNewParamsSchemaFieldsUnitNanosecond  StreamNewParamsSchemaFieldsUnit = "nanosecond"
)

func (StreamNewParamsSchemaFieldsUnit) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormat added in v6.3.0

type StreamNewParamsSchemaFormat struct {
	Type            param.Field[StreamNewParamsSchemaFormatType]            `json:"type,required"`
	Compression     param.Field[StreamNewParamsSchemaFormatCompression]     `json:"compression"`
	DecimalEncoding param.Field[StreamNewParamsSchemaFormatDecimalEncoding] `json:"decimal_encoding"`
	RowGroupBytes   param.Field[int64]                                      `json:"row_group_bytes"`
	TimestampFormat param.Field[StreamNewParamsSchemaFormatTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                       `json:"unstructured"`
}

func (StreamNewParamsSchemaFormat) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFormat) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFormatCompression added in v6.3.0

type StreamNewParamsSchemaFormatCompression string
const (
	StreamNewParamsSchemaFormatCompressionUncompressed StreamNewParamsSchemaFormatCompression = "uncompressed"
	StreamNewParamsSchemaFormatCompressionSnappy       StreamNewParamsSchemaFormatCompression = "snappy"
	StreamNewParamsSchemaFormatCompressionGzip         StreamNewParamsSchemaFormatCompression = "gzip"
	StreamNewParamsSchemaFormatCompressionZstd         StreamNewParamsSchemaFormatCompression = "zstd"
	StreamNewParamsSchemaFormatCompressionLz4          StreamNewParamsSchemaFormatCompression = "lz4"
)

func (StreamNewParamsSchemaFormatCompression) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatDecimalEncoding added in v6.3.0

type StreamNewParamsSchemaFormatDecimalEncoding string
const (
	StreamNewParamsSchemaFormatDecimalEncodingNumber StreamNewParamsSchemaFormatDecimalEncoding = "number"
	StreamNewParamsSchemaFormatDecimalEncodingString StreamNewParamsSchemaFormatDecimalEncoding = "string"
	StreamNewParamsSchemaFormatDecimalEncodingBytes  StreamNewParamsSchemaFormatDecimalEncoding = "bytes"
)

func (StreamNewParamsSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatJson added in v6.3.0

type StreamNewParamsSchemaFormatJson struct {
	Type            param.Field[StreamNewParamsSchemaFormatJsonType]            `json:"type,required"`
	DecimalEncoding param.Field[StreamNewParamsSchemaFormatJsonDecimalEncoding] `json:"decimal_encoding"`
	TimestampFormat param.Field[StreamNewParamsSchemaFormatJsonTimestampFormat] `json:"timestamp_format"`
	Unstructured    param.Field[bool]                                           `json:"unstructured"`
}

func (StreamNewParamsSchemaFormatJson) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFormatJson) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFormatJsonDecimalEncoding added in v6.3.0

type StreamNewParamsSchemaFormatJsonDecimalEncoding string
const (
	StreamNewParamsSchemaFormatJsonDecimalEncodingNumber StreamNewParamsSchemaFormatJsonDecimalEncoding = "number"
	StreamNewParamsSchemaFormatJsonDecimalEncodingString StreamNewParamsSchemaFormatJsonDecimalEncoding = "string"
	StreamNewParamsSchemaFormatJsonDecimalEncodingBytes  StreamNewParamsSchemaFormatJsonDecimalEncoding = "bytes"
)

func (StreamNewParamsSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatJsonTimestampFormat added in v6.3.0

type StreamNewParamsSchemaFormatJsonTimestampFormat string
const (
	StreamNewParamsSchemaFormatJsonTimestampFormatRfc3339    StreamNewParamsSchemaFormatJsonTimestampFormat = "rfc3339"
	StreamNewParamsSchemaFormatJsonTimestampFormatUnixMillis StreamNewParamsSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (StreamNewParamsSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatJsonType added in v6.3.0

type StreamNewParamsSchemaFormatJsonType string
const (
	StreamNewParamsSchemaFormatJsonTypeJson StreamNewParamsSchemaFormatJsonType = "json"
)

func (StreamNewParamsSchemaFormatJsonType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatParquet added in v6.3.0

type StreamNewParamsSchemaFormatParquet struct {
	Type          param.Field[StreamNewParamsSchemaFormatParquetType]        `json:"type,required"`
	Compression   param.Field[StreamNewParamsSchemaFormatParquetCompression] `json:"compression"`
	RowGroupBytes param.Field[int64]                                         `json:"row_group_bytes"`
}

func (StreamNewParamsSchemaFormatParquet) MarshalJSON added in v6.3.0

func (r StreamNewParamsSchemaFormatParquet) MarshalJSON() (data []byte, err error)

type StreamNewParamsSchemaFormatParquetCompression added in v6.3.0

type StreamNewParamsSchemaFormatParquetCompression string
const (
	StreamNewParamsSchemaFormatParquetCompressionUncompressed StreamNewParamsSchemaFormatParquetCompression = "uncompressed"
	StreamNewParamsSchemaFormatParquetCompressionSnappy       StreamNewParamsSchemaFormatParquetCompression = "snappy"
	StreamNewParamsSchemaFormatParquetCompressionGzip         StreamNewParamsSchemaFormatParquetCompression = "gzip"
	StreamNewParamsSchemaFormatParquetCompressionZstd         StreamNewParamsSchemaFormatParquetCompression = "zstd"
	StreamNewParamsSchemaFormatParquetCompressionLz4          StreamNewParamsSchemaFormatParquetCompression = "lz4"
)

func (StreamNewParamsSchemaFormatParquetCompression) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatParquetType added in v6.3.0

type StreamNewParamsSchemaFormatParquetType string
const (
	StreamNewParamsSchemaFormatParquetTypeParquet StreamNewParamsSchemaFormatParquetType = "parquet"
)

func (StreamNewParamsSchemaFormatParquetType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatTimestampFormat added in v6.3.0

type StreamNewParamsSchemaFormatTimestampFormat string
const (
	StreamNewParamsSchemaFormatTimestampFormatRfc3339    StreamNewParamsSchemaFormatTimestampFormat = "rfc3339"
	StreamNewParamsSchemaFormatTimestampFormatUnixMillis StreamNewParamsSchemaFormatTimestampFormat = "unix_millis"
)

func (StreamNewParamsSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatType added in v6.3.0

type StreamNewParamsSchemaFormatType string
const (
	StreamNewParamsSchemaFormatTypeJson    StreamNewParamsSchemaFormatType = "json"
	StreamNewParamsSchemaFormatTypeParquet StreamNewParamsSchemaFormatType = "parquet"
)

func (StreamNewParamsSchemaFormatType) IsKnown added in v6.3.0

type StreamNewParamsSchemaFormatUnion added in v6.3.0

type StreamNewParamsSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Satisfied by pipelines.StreamNewParamsSchemaFormatJson, pipelines.StreamNewParamsSchemaFormatParquet, StreamNewParamsSchemaFormat.

type StreamNewParamsWorkerBinding added in v6.3.0

type StreamNewParamsWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (StreamNewParamsWorkerBinding) MarshalJSON added in v6.3.0

func (r StreamNewParamsWorkerBinding) MarshalJSON() (data []byte, err error)

type StreamNewResponse added in v6.3.0

type StreamNewResponse struct {
	// Indicates a unique identifier for this stream.
	ID         string                `json:"id,required"`
	CreatedAt  time.Time             `json:"created_at,required" format:"date-time"`
	HTTP       StreamNewResponseHTTP `json:"http,required"`
	ModifiedAt time.Time             `json:"modified_at,required" format:"date-time"`
	// Indicates the name of the Stream.
	Name string `json:"name,required"`
	// Indicates the current version of this stream.
	Version       int64                          `json:"version,required"`
	WorkerBinding StreamNewResponseWorkerBinding `json:"worker_binding,required"`
	// Indicates the endpoint URL of this stream.
	Endpoint string                  `json:"endpoint" format:"uri"`
	Format   StreamNewResponseFormat `json:"format"`
	Schema   StreamNewResponseSchema `json:"schema"`
	JSON     streamNewResponseJSON   `json:"-"`
}

func (*StreamNewResponse) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponse) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseEnvelope added in v6.3.0

type StreamNewResponseEnvelope struct {
	Result StreamNewResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                          `json:"success,required"`
	JSON    streamNewResponseEnvelopeJSON `json:"-"`
}

func (*StreamNewResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseFormat added in v6.3.0

type StreamNewResponseFormat struct {
	Type            StreamNewResponseFormatType            `json:"type,required"`
	Compression     StreamNewResponseFormatCompression     `json:"compression"`
	DecimalEncoding StreamNewResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                  `json:"row_group_bytes,nullable"`
	TimestampFormat StreamNewResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                   `json:"unstructured"`
	JSON            streamNewResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamNewResponseFormat) AsUnion added in v6.3.0

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 added in v6.3.0

func (r *StreamNewResponseFormat) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseFormatCompression added in v6.3.0

type StreamNewResponseFormatCompression string
const (
	StreamNewResponseFormatCompressionUncompressed StreamNewResponseFormatCompression = "uncompressed"
	StreamNewResponseFormatCompressionSnappy       StreamNewResponseFormatCompression = "snappy"
	StreamNewResponseFormatCompressionGzip         StreamNewResponseFormatCompression = "gzip"
	StreamNewResponseFormatCompressionZstd         StreamNewResponseFormatCompression = "zstd"
	StreamNewResponseFormatCompressionLz4          StreamNewResponseFormatCompression = "lz4"
)

func (StreamNewResponseFormatCompression) IsKnown added in v6.3.0

type StreamNewResponseFormatDecimalEncoding added in v6.3.0

type StreamNewResponseFormatDecimalEncoding string
const (
	StreamNewResponseFormatDecimalEncodingNumber StreamNewResponseFormatDecimalEncoding = "number"
	StreamNewResponseFormatDecimalEncodingString StreamNewResponseFormatDecimalEncoding = "string"
	StreamNewResponseFormatDecimalEncodingBytes  StreamNewResponseFormatDecimalEncoding = "bytes"
)

func (StreamNewResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamNewResponseFormatJson added in v6.3.0

type StreamNewResponseFormatJson struct {
	Type            StreamNewResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamNewResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamNewResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                       `json:"unstructured"`
	JSON            streamNewResponseFormatJsonJSON            `json:"-"`
}

func (*StreamNewResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseFormatJsonDecimalEncoding added in v6.3.0

type StreamNewResponseFormatJsonDecimalEncoding string
const (
	StreamNewResponseFormatJsonDecimalEncodingNumber StreamNewResponseFormatJsonDecimalEncoding = "number"
	StreamNewResponseFormatJsonDecimalEncodingString StreamNewResponseFormatJsonDecimalEncoding = "string"
	StreamNewResponseFormatJsonDecimalEncodingBytes  StreamNewResponseFormatJsonDecimalEncoding = "bytes"
)

func (StreamNewResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamNewResponseFormatJsonTimestampFormat added in v6.3.0

type StreamNewResponseFormatJsonTimestampFormat string
const (
	StreamNewResponseFormatJsonTimestampFormatRfc3339    StreamNewResponseFormatJsonTimestampFormat = "rfc3339"
	StreamNewResponseFormatJsonTimestampFormatUnixMillis StreamNewResponseFormatJsonTimestampFormat = "unix_millis"
)

func (StreamNewResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamNewResponseFormatJsonType added in v6.3.0

type StreamNewResponseFormatJsonType string
const (
	StreamNewResponseFormatJsonTypeJson StreamNewResponseFormatJsonType = "json"
)

func (StreamNewResponseFormatJsonType) IsKnown added in v6.3.0

type StreamNewResponseFormatParquet added in v6.3.0

type StreamNewResponseFormatParquet struct {
	Type          StreamNewResponseFormatParquetType        `json:"type,required"`
	Compression   StreamNewResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                     `json:"row_group_bytes,nullable"`
	JSON          streamNewResponseFormatParquetJSON        `json:"-"`
}

func (*StreamNewResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseFormatParquetCompression added in v6.3.0

type StreamNewResponseFormatParquetCompression string
const (
	StreamNewResponseFormatParquetCompressionUncompressed StreamNewResponseFormatParquetCompression = "uncompressed"
	StreamNewResponseFormatParquetCompressionSnappy       StreamNewResponseFormatParquetCompression = "snappy"
	StreamNewResponseFormatParquetCompressionGzip         StreamNewResponseFormatParquetCompression = "gzip"
	StreamNewResponseFormatParquetCompressionZstd         StreamNewResponseFormatParquetCompression = "zstd"
	StreamNewResponseFormatParquetCompressionLz4          StreamNewResponseFormatParquetCompression = "lz4"
)

func (StreamNewResponseFormatParquetCompression) IsKnown added in v6.3.0

type StreamNewResponseFormatParquetType added in v6.3.0

type StreamNewResponseFormatParquetType string
const (
	StreamNewResponseFormatParquetTypeParquet StreamNewResponseFormatParquetType = "parquet"
)

func (StreamNewResponseFormatParquetType) IsKnown added in v6.3.0

type StreamNewResponseFormatTimestampFormat added in v6.3.0

type StreamNewResponseFormatTimestampFormat string
const (
	StreamNewResponseFormatTimestampFormatRfc3339    StreamNewResponseFormatTimestampFormat = "rfc3339"
	StreamNewResponseFormatTimestampFormatUnixMillis StreamNewResponseFormatTimestampFormat = "unix_millis"
)

func (StreamNewResponseFormatTimestampFormat) IsKnown added in v6.3.0

type StreamNewResponseFormatType added in v6.3.0

type StreamNewResponseFormatType string
const (
	StreamNewResponseFormatTypeJson    StreamNewResponseFormatType = "json"
	StreamNewResponseFormatTypeParquet StreamNewResponseFormatType = "parquet"
)

func (StreamNewResponseFormatType) IsKnown added in v6.3.0

func (r StreamNewResponseFormatType) IsKnown() bool

type StreamNewResponseFormatUnion added in v6.3.0

type StreamNewResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamNewResponseFormatJson or StreamNewResponseFormatParquet.

type StreamNewResponseHTTP added in v6.3.0

type StreamNewResponseHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication bool `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled bool `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS StreamNewResponseHTTPCORS `json:"cors"`
	JSON streamNewResponseHTTPJSON `json:"-"`
}

func (*StreamNewResponseHTTP) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseHTTP) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseHTTPCORS added in v6.3.0

type StreamNewResponseHTTPCORS struct {
	Origins []string                      `json:"origins"`
	JSON    streamNewResponseHttpcorsJSON `json:"-"`
}

Specifies the CORS options for the HTTP endpoint.

func (*StreamNewResponseHTTPCORS) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchema added in v6.3.0

type StreamNewResponseSchema struct {
	Fields   []StreamNewResponseSchemaField `json:"fields"`
	Format   StreamNewResponseSchemaFormat  `json:"format"`
	Inferred bool                           `json:"inferred,nullable"`
	JSON     streamNewResponseSchemaJSON    `json:"-"`
}

func (*StreamNewResponseSchema) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchema) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaField added in v6.3.0

type StreamNewResponseSchemaField struct {
	Type        StreamNewResponseSchemaFieldsType `json:"type,required"`
	MetadataKey string                            `json:"metadata_key,nullable"`
	Name        string                            `json:"name"`
	Required    bool                              `json:"required"`
	SqlName     string                            `json:"sql_name"`
	Unit        StreamNewResponseSchemaFieldsUnit `json:"unit"`
	JSON        streamNewResponseSchemaFieldJSON  `json:"-"`
	// contains filtered or unexported fields
}

func (*StreamNewResponseSchemaField) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaField) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsBinary added in v6.3.0

type StreamNewResponseSchemaFieldsBinary struct {
	Type        StreamNewResponseSchemaFieldsBinaryType `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsBinaryJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsBinary) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsBinary) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsBinaryType added in v6.3.0

type StreamNewResponseSchemaFieldsBinaryType string
const (
	StreamNewResponseSchemaFieldsBinaryTypeBinary StreamNewResponseSchemaFieldsBinaryType = "binary"
)

func (StreamNewResponseSchemaFieldsBinaryType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsBool added in v6.3.0

type StreamNewResponseSchemaFieldsBool struct {
	Type        StreamNewResponseSchemaFieldsBoolType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsBoolJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsBool) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsBool) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsBoolType added in v6.3.0

type StreamNewResponseSchemaFieldsBoolType string
const (
	StreamNewResponseSchemaFieldsBoolTypeBool StreamNewResponseSchemaFieldsBoolType = "bool"
)

func (StreamNewResponseSchemaFieldsBoolType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsFloat32 added in v6.3.0

type StreamNewResponseSchemaFieldsFloat32 struct {
	Type        StreamNewResponseSchemaFieldsFloat32Type `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsFloat32JSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsFloat32) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsFloat32) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsFloat32Type added in v6.3.0

type StreamNewResponseSchemaFieldsFloat32Type string
const (
	StreamNewResponseSchemaFieldsFloat32TypeFloat32 StreamNewResponseSchemaFieldsFloat32Type = "float32"
)

func (StreamNewResponseSchemaFieldsFloat32Type) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsFloat64 added in v6.3.0

type StreamNewResponseSchemaFieldsFloat64 struct {
	Type        StreamNewResponseSchemaFieldsFloat64Type `json:"type,required"`
	MetadataKey string                                   `json:"metadata_key,nullable"`
	Name        string                                   `json:"name"`
	Required    bool                                     `json:"required"`
	SqlName     string                                   `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsFloat64JSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsFloat64) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsFloat64) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsFloat64Type added in v6.3.0

type StreamNewResponseSchemaFieldsFloat64Type string
const (
	StreamNewResponseSchemaFieldsFloat64TypeFloat64 StreamNewResponseSchemaFieldsFloat64Type = "float64"
)

func (StreamNewResponseSchemaFieldsFloat64Type) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsInt32 added in v6.3.0

type StreamNewResponseSchemaFieldsInt32 struct {
	Type        StreamNewResponseSchemaFieldsInt32Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsInt32JSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsInt32) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsInt32) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsInt32Type added in v6.3.0

type StreamNewResponseSchemaFieldsInt32Type string
const (
	StreamNewResponseSchemaFieldsInt32TypeInt32 StreamNewResponseSchemaFieldsInt32Type = "int32"
)

func (StreamNewResponseSchemaFieldsInt32Type) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsInt64 added in v6.3.0

type StreamNewResponseSchemaFieldsInt64 struct {
	Type        StreamNewResponseSchemaFieldsInt64Type `json:"type,required"`
	MetadataKey string                                 `json:"metadata_key,nullable"`
	Name        string                                 `json:"name"`
	Required    bool                                   `json:"required"`
	SqlName     string                                 `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsInt64JSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsInt64) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsInt64) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsInt64Type added in v6.3.0

type StreamNewResponseSchemaFieldsInt64Type string
const (
	StreamNewResponseSchemaFieldsInt64TypeInt64 StreamNewResponseSchemaFieldsInt64Type = "int64"
)

func (StreamNewResponseSchemaFieldsInt64Type) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsJson added in v6.3.0

type StreamNewResponseSchemaFieldsJson struct {
	Type        StreamNewResponseSchemaFieldsJsonType `json:"type,required"`
	MetadataKey string                                `json:"metadata_key,nullable"`
	Name        string                                `json:"name"`
	Required    bool                                  `json:"required"`
	SqlName     string                                `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsJsonJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsJson) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsJson) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsJsonType added in v6.3.0

type StreamNewResponseSchemaFieldsJsonType string
const (
	StreamNewResponseSchemaFieldsJsonTypeJson StreamNewResponseSchemaFieldsJsonType = "json"
)

func (StreamNewResponseSchemaFieldsJsonType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsList added in v6.3.0

type StreamNewResponseSchemaFieldsList struct {
	JSON streamNewResponseSchemaFieldsListJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsList) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsList) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsString added in v6.3.0

type StreamNewResponseSchemaFieldsString struct {
	Type        StreamNewResponseSchemaFieldsStringType `json:"type,required"`
	MetadataKey string                                  `json:"metadata_key,nullable"`
	Name        string                                  `json:"name"`
	Required    bool                                    `json:"required"`
	SqlName     string                                  `json:"sql_name"`
	JSON        streamNewResponseSchemaFieldsStringJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsString) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsString) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsStringType added in v6.3.0

type StreamNewResponseSchemaFieldsStringType string
const (
	StreamNewResponseSchemaFieldsStringTypeString StreamNewResponseSchemaFieldsStringType = "string"
)

func (StreamNewResponseSchemaFieldsStringType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsStruct added in v6.3.0

type StreamNewResponseSchemaFieldsStruct struct {
	JSON streamNewResponseSchemaFieldsStructJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsStruct) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsStruct) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsTimestamp added in v6.3.0

type StreamNewResponseSchemaFieldsTimestamp struct {
	Type        StreamNewResponseSchemaFieldsTimestampType `json:"type,required"`
	MetadataKey string                                     `json:"metadata_key,nullable"`
	Name        string                                     `json:"name"`
	Required    bool                                       `json:"required"`
	SqlName     string                                     `json:"sql_name"`
	Unit        StreamNewResponseSchemaFieldsTimestampUnit `json:"unit"`
	JSON        streamNewResponseSchemaFieldsTimestampJSON `json:"-"`
}

func (*StreamNewResponseSchemaFieldsTimestamp) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFieldsTimestamp) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFieldsTimestampType added in v6.3.0

type StreamNewResponseSchemaFieldsTimestampType string
const (
	StreamNewResponseSchemaFieldsTimestampTypeTimestamp StreamNewResponseSchemaFieldsTimestampType = "timestamp"
)

func (StreamNewResponseSchemaFieldsTimestampType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsTimestampUnit added in v6.3.0

type StreamNewResponseSchemaFieldsTimestampUnit string
const (
	StreamNewResponseSchemaFieldsTimestampUnitSecond      StreamNewResponseSchemaFieldsTimestampUnit = "second"
	StreamNewResponseSchemaFieldsTimestampUnitMillisecond StreamNewResponseSchemaFieldsTimestampUnit = "millisecond"
	StreamNewResponseSchemaFieldsTimestampUnitMicrosecond StreamNewResponseSchemaFieldsTimestampUnit = "microsecond"
	StreamNewResponseSchemaFieldsTimestampUnitNanosecond  StreamNewResponseSchemaFieldsTimestampUnit = "nanosecond"
)

func (StreamNewResponseSchemaFieldsTimestampUnit) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsType added in v6.3.0

type StreamNewResponseSchemaFieldsType string
const (
	StreamNewResponseSchemaFieldsTypeInt32     StreamNewResponseSchemaFieldsType = "int32"
	StreamNewResponseSchemaFieldsTypeInt64     StreamNewResponseSchemaFieldsType = "int64"
	StreamNewResponseSchemaFieldsTypeFloat32   StreamNewResponseSchemaFieldsType = "float32"
	StreamNewResponseSchemaFieldsTypeFloat64   StreamNewResponseSchemaFieldsType = "float64"
	StreamNewResponseSchemaFieldsTypeBool      StreamNewResponseSchemaFieldsType = "bool"
	StreamNewResponseSchemaFieldsTypeString    StreamNewResponseSchemaFieldsType = "string"
	StreamNewResponseSchemaFieldsTypeBinary    StreamNewResponseSchemaFieldsType = "binary"
	StreamNewResponseSchemaFieldsTypeTimestamp StreamNewResponseSchemaFieldsType = "timestamp"
	StreamNewResponseSchemaFieldsTypeJson      StreamNewResponseSchemaFieldsType = "json"
	StreamNewResponseSchemaFieldsTypeStruct    StreamNewResponseSchemaFieldsType = "struct"
	StreamNewResponseSchemaFieldsTypeList      StreamNewResponseSchemaFieldsType = "list"
)

func (StreamNewResponseSchemaFieldsType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFieldsUnit added in v6.3.0

type StreamNewResponseSchemaFieldsUnit string
const (
	StreamNewResponseSchemaFieldsUnitSecond      StreamNewResponseSchemaFieldsUnit = "second"
	StreamNewResponseSchemaFieldsUnitMillisecond StreamNewResponseSchemaFieldsUnit = "millisecond"
	StreamNewResponseSchemaFieldsUnitMicrosecond StreamNewResponseSchemaFieldsUnit = "microsecond"
	StreamNewResponseSchemaFieldsUnitNanosecond  StreamNewResponseSchemaFieldsUnit = "nanosecond"
)

func (StreamNewResponseSchemaFieldsUnit) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormat added in v6.3.0

type StreamNewResponseSchemaFormat struct {
	Type            StreamNewResponseSchemaFormatType            `json:"type,required"`
	Compression     StreamNewResponseSchemaFormatCompression     `json:"compression"`
	DecimalEncoding StreamNewResponseSchemaFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                        `json:"row_group_bytes,nullable"`
	TimestampFormat StreamNewResponseSchemaFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                         `json:"unstructured"`
	JSON            streamNewResponseSchemaFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamNewResponseSchemaFormat) AsUnion added in v6.3.0

AsUnion returns a StreamNewResponseSchemaFormatUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are StreamNewResponseSchemaFormatJson, StreamNewResponseSchemaFormatParquet.

func (*StreamNewResponseSchemaFormat) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFormat) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFormatCompression added in v6.3.0

type StreamNewResponseSchemaFormatCompression string
const (
	StreamNewResponseSchemaFormatCompressionUncompressed StreamNewResponseSchemaFormatCompression = "uncompressed"
	StreamNewResponseSchemaFormatCompressionSnappy       StreamNewResponseSchemaFormatCompression = "snappy"
	StreamNewResponseSchemaFormatCompressionGzip         StreamNewResponseSchemaFormatCompression = "gzip"
	StreamNewResponseSchemaFormatCompressionZstd         StreamNewResponseSchemaFormatCompression = "zstd"
	StreamNewResponseSchemaFormatCompressionLz4          StreamNewResponseSchemaFormatCompression = "lz4"
)

func (StreamNewResponseSchemaFormatCompression) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatDecimalEncoding added in v6.3.0

type StreamNewResponseSchemaFormatDecimalEncoding string
const (
	StreamNewResponseSchemaFormatDecimalEncodingNumber StreamNewResponseSchemaFormatDecimalEncoding = "number"
	StreamNewResponseSchemaFormatDecimalEncodingString StreamNewResponseSchemaFormatDecimalEncoding = "string"
	StreamNewResponseSchemaFormatDecimalEncodingBytes  StreamNewResponseSchemaFormatDecimalEncoding = "bytes"
)

func (StreamNewResponseSchemaFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatJson added in v6.3.0

type StreamNewResponseSchemaFormatJson struct {
	Type            StreamNewResponseSchemaFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamNewResponseSchemaFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamNewResponseSchemaFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                             `json:"unstructured"`
	JSON            streamNewResponseSchemaFormatJsonJSON            `json:"-"`
}

func (*StreamNewResponseSchemaFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFormatJsonDecimalEncoding added in v6.3.0

type StreamNewResponseSchemaFormatJsonDecimalEncoding string
const (
	StreamNewResponseSchemaFormatJsonDecimalEncodingNumber StreamNewResponseSchemaFormatJsonDecimalEncoding = "number"
	StreamNewResponseSchemaFormatJsonDecimalEncodingString StreamNewResponseSchemaFormatJsonDecimalEncoding = "string"
	StreamNewResponseSchemaFormatJsonDecimalEncodingBytes  StreamNewResponseSchemaFormatJsonDecimalEncoding = "bytes"
)

func (StreamNewResponseSchemaFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatJsonTimestampFormat added in v6.3.0

type StreamNewResponseSchemaFormatJsonTimestampFormat string
const (
	StreamNewResponseSchemaFormatJsonTimestampFormatRfc3339    StreamNewResponseSchemaFormatJsonTimestampFormat = "rfc3339"
	StreamNewResponseSchemaFormatJsonTimestampFormatUnixMillis StreamNewResponseSchemaFormatJsonTimestampFormat = "unix_millis"
)

func (StreamNewResponseSchemaFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatJsonType added in v6.3.0

type StreamNewResponseSchemaFormatJsonType string
const (
	StreamNewResponseSchemaFormatJsonTypeJson StreamNewResponseSchemaFormatJsonType = "json"
)

func (StreamNewResponseSchemaFormatJsonType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatParquet added in v6.3.0

type StreamNewResponseSchemaFormatParquet struct {
	Type          StreamNewResponseSchemaFormatParquetType        `json:"type,required"`
	Compression   StreamNewResponseSchemaFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                           `json:"row_group_bytes,nullable"`
	JSON          streamNewResponseSchemaFormatParquetJSON        `json:"-"`
}

func (*StreamNewResponseSchemaFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseSchemaFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamNewResponseSchemaFormatParquetCompression added in v6.3.0

type StreamNewResponseSchemaFormatParquetCompression string
const (
	StreamNewResponseSchemaFormatParquetCompressionUncompressed StreamNewResponseSchemaFormatParquetCompression = "uncompressed"
	StreamNewResponseSchemaFormatParquetCompressionSnappy       StreamNewResponseSchemaFormatParquetCompression = "snappy"
	StreamNewResponseSchemaFormatParquetCompressionGzip         StreamNewResponseSchemaFormatParquetCompression = "gzip"
	StreamNewResponseSchemaFormatParquetCompressionZstd         StreamNewResponseSchemaFormatParquetCompression = "zstd"
	StreamNewResponseSchemaFormatParquetCompressionLz4          StreamNewResponseSchemaFormatParquetCompression = "lz4"
)

func (StreamNewResponseSchemaFormatParquetCompression) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatParquetType added in v6.3.0

type StreamNewResponseSchemaFormatParquetType string
const (
	StreamNewResponseSchemaFormatParquetTypeParquet StreamNewResponseSchemaFormatParquetType = "parquet"
)

func (StreamNewResponseSchemaFormatParquetType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatTimestampFormat added in v6.3.0

type StreamNewResponseSchemaFormatTimestampFormat string
const (
	StreamNewResponseSchemaFormatTimestampFormatRfc3339    StreamNewResponseSchemaFormatTimestampFormat = "rfc3339"
	StreamNewResponseSchemaFormatTimestampFormatUnixMillis StreamNewResponseSchemaFormatTimestampFormat = "unix_millis"
)

func (StreamNewResponseSchemaFormatTimestampFormat) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatType added in v6.3.0

type StreamNewResponseSchemaFormatType string
const (
	StreamNewResponseSchemaFormatTypeJson    StreamNewResponseSchemaFormatType = "json"
	StreamNewResponseSchemaFormatTypeParquet StreamNewResponseSchemaFormatType = "parquet"
)

func (StreamNewResponseSchemaFormatType) IsKnown added in v6.3.0

type StreamNewResponseSchemaFormatUnion added in v6.3.0

type StreamNewResponseSchemaFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamNewResponseSchemaFormatJson or StreamNewResponseSchemaFormatParquet.

type StreamNewResponseWorkerBinding added in v6.3.0

type StreamNewResponseWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled bool                               `json:"enabled,required"`
	JSON    streamNewResponseWorkerBindingJSON `json:"-"`
}

func (*StreamNewResponseWorkerBinding) UnmarshalJSON added in v6.3.0

func (r *StreamNewResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)

type StreamService added in v6.3.0

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 added in v6.3.0

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 added in v6.3.0

func (r *StreamService) Delete(ctx context.Context, streamID string, params StreamDeleteParams, opts ...option.RequestOption) (err error)

Delete Stream in Account.

func (*StreamService) Get added in v6.3.0

func (r *StreamService) Get(ctx context.Context, streamID string, query StreamGetParams, opts ...option.RequestOption) (res *StreamGetResponse, err error)

Get Stream Details.

func (*StreamService) List added in v6.3.0

List/Filter Streams in Account.

func (*StreamService) ListAutoPaging added in v6.3.0

List/Filter Streams in Account.

func (*StreamService) New added in v6.3.0

func (r *StreamService) New(ctx context.Context, params StreamNewParams, opts ...option.RequestOption) (res *StreamNewResponse, err error)

Create a new Stream.

func (*StreamService) Update added in v6.3.0

func (r *StreamService) Update(ctx context.Context, streamID string, params StreamUpdateParams, opts ...option.RequestOption) (res *StreamUpdateResponse, err error)

Update a Stream.

type StreamUpdateParams added in v6.3.0

type StreamUpdateParams struct {
	// Specifies the public ID of the account.
	AccountID     param.Field[string]                          `path:"account_id,required"`
	HTTP          param.Field[StreamUpdateParamsHTTP]          `json:"http"`
	WorkerBinding param.Field[StreamUpdateParamsWorkerBinding] `json:"worker_binding"`
}

func (StreamUpdateParams) MarshalJSON added in v6.3.0

func (r StreamUpdateParams) MarshalJSON() (data []byte, err error)

type StreamUpdateParamsHTTP added in v6.3.0

type StreamUpdateParamsHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication param.Field[bool] `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS param.Field[StreamUpdateParamsHTTPCORS] `json:"cors"`
}

func (StreamUpdateParamsHTTP) MarshalJSON added in v6.3.0

func (r StreamUpdateParamsHTTP) MarshalJSON() (data []byte, err error)

type StreamUpdateParamsHTTPCORS added in v6.3.0

type StreamUpdateParamsHTTPCORS struct {
	Origins param.Field[[]string] `json:"origins"`
}

Specifies the CORS options for the HTTP endpoint.

func (StreamUpdateParamsHTTPCORS) MarshalJSON added in v6.3.0

func (r StreamUpdateParamsHTTPCORS) MarshalJSON() (data []byte, err error)

type StreamUpdateParamsWorkerBinding added in v6.3.0

type StreamUpdateParamsWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled param.Field[bool] `json:"enabled,required"`
}

func (StreamUpdateParamsWorkerBinding) MarshalJSON added in v6.3.0

func (r StreamUpdateParamsWorkerBinding) MarshalJSON() (data []byte, err error)

type StreamUpdateResponse added in v6.3.0

type StreamUpdateResponse struct {
	// Indicates a unique identifier for this stream.
	ID         string                   `json:"id,required"`
	CreatedAt  time.Time                `json:"created_at,required" format:"date-time"`
	HTTP       StreamUpdateResponseHTTP `json:"http,required"`
	ModifiedAt time.Time                `json:"modified_at,required" format:"date-time"`
	// Indicates the name of the Stream.
	Name string `json:"name,required"`
	// Indicates the current version of this stream.
	Version       int64                             `json:"version,required"`
	WorkerBinding StreamUpdateResponseWorkerBinding `json:"worker_binding,required"`
	// Indicates the endpoint URL of this stream.
	Endpoint string                     `json:"endpoint" format:"uri"`
	Format   StreamUpdateResponseFormat `json:"format"`
	JSON     streamUpdateResponseJSON   `json:"-"`
}

func (*StreamUpdateResponse) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponse) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseEnvelope added in v6.3.0

type StreamUpdateResponseEnvelope struct {
	Result StreamUpdateResponse `json:"result,required"`
	// Indicates whether the API call was successful.
	Success bool                             `json:"success,required"`
	JSON    streamUpdateResponseEnvelopeJSON `json:"-"`
}

func (*StreamUpdateResponseEnvelope) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseFormat added in v6.3.0

type StreamUpdateResponseFormat struct {
	Type            StreamUpdateResponseFormatType            `json:"type,required"`
	Compression     StreamUpdateResponseFormatCompression     `json:"compression"`
	DecimalEncoding StreamUpdateResponseFormatDecimalEncoding `json:"decimal_encoding"`
	RowGroupBytes   int64                                     `json:"row_group_bytes,nullable"`
	TimestampFormat StreamUpdateResponseFormatTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                      `json:"unstructured"`
	JSON            streamUpdateResponseFormatJSON            `json:"-"`
	// contains filtered or unexported fields
}

func (StreamUpdateResponseFormat) AsUnion added in v6.3.0

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 added in v6.3.0

func (r *StreamUpdateResponseFormat) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseFormatCompression added in v6.3.0

type StreamUpdateResponseFormatCompression string
const (
	StreamUpdateResponseFormatCompressionUncompressed StreamUpdateResponseFormatCompression = "uncompressed"
	StreamUpdateResponseFormatCompressionSnappy       StreamUpdateResponseFormatCompression = "snappy"
	StreamUpdateResponseFormatCompressionGzip         StreamUpdateResponseFormatCompression = "gzip"
	StreamUpdateResponseFormatCompressionZstd         StreamUpdateResponseFormatCompression = "zstd"
	StreamUpdateResponseFormatCompressionLz4          StreamUpdateResponseFormatCompression = "lz4"
)

func (StreamUpdateResponseFormatCompression) IsKnown added in v6.3.0

type StreamUpdateResponseFormatDecimalEncoding added in v6.3.0

type StreamUpdateResponseFormatDecimalEncoding string
const (
	StreamUpdateResponseFormatDecimalEncodingNumber StreamUpdateResponseFormatDecimalEncoding = "number"
	StreamUpdateResponseFormatDecimalEncodingString StreamUpdateResponseFormatDecimalEncoding = "string"
	StreamUpdateResponseFormatDecimalEncodingBytes  StreamUpdateResponseFormatDecimalEncoding = "bytes"
)

func (StreamUpdateResponseFormatDecimalEncoding) IsKnown added in v6.3.0

type StreamUpdateResponseFormatJson added in v6.3.0

type StreamUpdateResponseFormatJson struct {
	Type            StreamUpdateResponseFormatJsonType            `json:"type,required"`
	DecimalEncoding StreamUpdateResponseFormatJsonDecimalEncoding `json:"decimal_encoding"`
	TimestampFormat StreamUpdateResponseFormatJsonTimestampFormat `json:"timestamp_format"`
	Unstructured    bool                                          `json:"unstructured"`
	JSON            streamUpdateResponseFormatJsonJSON            `json:"-"`
}

func (*StreamUpdateResponseFormatJson) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseFormatJson) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseFormatJsonDecimalEncoding added in v6.3.0

type StreamUpdateResponseFormatJsonDecimalEncoding string
const (
	StreamUpdateResponseFormatJsonDecimalEncodingNumber StreamUpdateResponseFormatJsonDecimalEncoding = "number"
	StreamUpdateResponseFormatJsonDecimalEncodingString StreamUpdateResponseFormatJsonDecimalEncoding = "string"
	StreamUpdateResponseFormatJsonDecimalEncodingBytes  StreamUpdateResponseFormatJsonDecimalEncoding = "bytes"
)

func (StreamUpdateResponseFormatJsonDecimalEncoding) IsKnown added in v6.3.0

type StreamUpdateResponseFormatJsonTimestampFormat added in v6.3.0

type StreamUpdateResponseFormatJsonTimestampFormat string
const (
	StreamUpdateResponseFormatJsonTimestampFormatRfc3339    StreamUpdateResponseFormatJsonTimestampFormat = "rfc3339"
	StreamUpdateResponseFormatJsonTimestampFormatUnixMillis StreamUpdateResponseFormatJsonTimestampFormat = "unix_millis"
)

func (StreamUpdateResponseFormatJsonTimestampFormat) IsKnown added in v6.3.0

type StreamUpdateResponseFormatJsonType added in v6.3.0

type StreamUpdateResponseFormatJsonType string
const (
	StreamUpdateResponseFormatJsonTypeJson StreamUpdateResponseFormatJsonType = "json"
)

func (StreamUpdateResponseFormatJsonType) IsKnown added in v6.3.0

type StreamUpdateResponseFormatParquet added in v6.3.0

type StreamUpdateResponseFormatParquet struct {
	Type          StreamUpdateResponseFormatParquetType        `json:"type,required"`
	Compression   StreamUpdateResponseFormatParquetCompression `json:"compression"`
	RowGroupBytes int64                                        `json:"row_group_bytes,nullable"`
	JSON          streamUpdateResponseFormatParquetJSON        `json:"-"`
}

func (*StreamUpdateResponseFormatParquet) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseFormatParquet) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseFormatParquetCompression added in v6.3.0

type StreamUpdateResponseFormatParquetCompression string
const (
	StreamUpdateResponseFormatParquetCompressionUncompressed StreamUpdateResponseFormatParquetCompression = "uncompressed"
	StreamUpdateResponseFormatParquetCompressionSnappy       StreamUpdateResponseFormatParquetCompression = "snappy"
	StreamUpdateResponseFormatParquetCompressionGzip         StreamUpdateResponseFormatParquetCompression = "gzip"
	StreamUpdateResponseFormatParquetCompressionZstd         StreamUpdateResponseFormatParquetCompression = "zstd"
	StreamUpdateResponseFormatParquetCompressionLz4          StreamUpdateResponseFormatParquetCompression = "lz4"
)

func (StreamUpdateResponseFormatParquetCompression) IsKnown added in v6.3.0

type StreamUpdateResponseFormatParquetType added in v6.3.0

type StreamUpdateResponseFormatParquetType string
const (
	StreamUpdateResponseFormatParquetTypeParquet StreamUpdateResponseFormatParquetType = "parquet"
)

func (StreamUpdateResponseFormatParquetType) IsKnown added in v6.3.0

type StreamUpdateResponseFormatTimestampFormat added in v6.3.0

type StreamUpdateResponseFormatTimestampFormat string
const (
	StreamUpdateResponseFormatTimestampFormatRfc3339    StreamUpdateResponseFormatTimestampFormat = "rfc3339"
	StreamUpdateResponseFormatTimestampFormatUnixMillis StreamUpdateResponseFormatTimestampFormat = "unix_millis"
)

func (StreamUpdateResponseFormatTimestampFormat) IsKnown added in v6.3.0

type StreamUpdateResponseFormatType added in v6.3.0

type StreamUpdateResponseFormatType string
const (
	StreamUpdateResponseFormatTypeJson    StreamUpdateResponseFormatType = "json"
	StreamUpdateResponseFormatTypeParquet StreamUpdateResponseFormatType = "parquet"
)

func (StreamUpdateResponseFormatType) IsKnown added in v6.3.0

type StreamUpdateResponseFormatUnion added in v6.3.0

type StreamUpdateResponseFormatUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by StreamUpdateResponseFormatJson or StreamUpdateResponseFormatParquet.

type StreamUpdateResponseHTTP added in v6.3.0

type StreamUpdateResponseHTTP struct {
	// Indicates that authentication is required for the HTTP endpoint.
	Authentication bool `json:"authentication,required"`
	// Indicates that the HTTP endpoint is enabled.
	Enabled bool `json:"enabled,required"`
	// Specifies the CORS options for the HTTP endpoint.
	CORS StreamUpdateResponseHTTPCORS `json:"cors"`
	JSON streamUpdateResponseHTTPJSON `json:"-"`
}

func (*StreamUpdateResponseHTTP) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseHTTP) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseHTTPCORS added in v6.3.0

type StreamUpdateResponseHTTPCORS struct {
	Origins []string                         `json:"origins"`
	JSON    streamUpdateResponseHttpcorsJSON `json:"-"`
}

Specifies the CORS options for the HTTP endpoint.

func (*StreamUpdateResponseHTTPCORS) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseHTTPCORS) UnmarshalJSON(data []byte) (err error)

type StreamUpdateResponseWorkerBinding added in v6.3.0

type StreamUpdateResponseWorkerBinding struct {
	// Indicates that the worker binding is enabled.
	Enabled bool                                  `json:"enabled,required"`
	JSON    streamUpdateResponseWorkerBindingJSON `json:"-"`
}

func (*StreamUpdateResponseWorkerBinding) UnmarshalJSON added in v6.3.0

func (r *StreamUpdateResponseWorkerBinding) UnmarshalJSON(data []byte) (err error)

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

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 TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL