workers

package
v4.4.0 Latest Latest
Warning

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

Go to latest
Published: May 16, 2025 License: Apache-2.0 Imports: 19 Imported by: 3

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 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 AccountSettingGetParams

type AccountSettingGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type AccountSettingGetResponse

type AccountSettingGetResponse struct {
	DefaultUsageModel string                        `json:"default_usage_model"`
	GreenCompute      bool                          `json:"green_compute"`
	JSON              accountSettingGetResponseJSON `json:"-"`
}

func (*AccountSettingGetResponse) UnmarshalJSON

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

type AccountSettingGetResponseEnvelope

type AccountSettingGetResponseEnvelope struct {
	Errors   []AccountSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccountSettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountSettingGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success AccountSettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    accountSettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*AccountSettingGetResponseEnvelope) UnmarshalJSON

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

type AccountSettingGetResponseEnvelopeErrors added in v4.3.0

type AccountSettingGetResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           AccountSettingGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             accountSettingGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AccountSettingGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type AccountSettingGetResponseEnvelopeErrorsSource added in v4.3.0

type AccountSettingGetResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    accountSettingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AccountSettingGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type AccountSettingGetResponseEnvelopeMessages added in v4.3.0

type AccountSettingGetResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           AccountSettingGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             accountSettingGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AccountSettingGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type AccountSettingGetResponseEnvelopeMessagesSource added in v4.3.0

type AccountSettingGetResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    accountSettingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AccountSettingGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type AccountSettingGetResponseEnvelopeSuccess

type AccountSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AccountSettingGetResponseEnvelopeSuccessTrue AccountSettingGetResponseEnvelopeSuccess = true
)

func (AccountSettingGetResponseEnvelopeSuccess) IsKnown

type AccountSettingService

type AccountSettingService struct {
	Options []option.RequestOption
}

AccountSettingService 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 NewAccountSettingService method instead.

func NewAccountSettingService

func NewAccountSettingService(opts ...option.RequestOption) (r *AccountSettingService)

NewAccountSettingService 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 (*AccountSettingService) Get

Fetches Worker account settings for an account.

func (*AccountSettingService) Update

Creates Worker account settings for an account.

type AccountSettingUpdateParams

type AccountSettingUpdateParams struct {
	// Identifier.
	AccountID         param.Field[string] `path:"account_id,required"`
	DefaultUsageModel param.Field[string] `json:"default_usage_model"`
	GreenCompute      param.Field[bool]   `json:"green_compute"`
}

func (AccountSettingUpdateParams) MarshalJSON

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

type AccountSettingUpdateResponse

type AccountSettingUpdateResponse struct {
	DefaultUsageModel string                           `json:"default_usage_model"`
	GreenCompute      bool                             `json:"green_compute"`
	JSON              accountSettingUpdateResponseJSON `json:"-"`
}

func (*AccountSettingUpdateResponse) UnmarshalJSON

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

type AccountSettingUpdateResponseEnvelope

type AccountSettingUpdateResponseEnvelope struct {
	Errors   []AccountSettingUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AccountSettingUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   AccountSettingUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success AccountSettingUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    accountSettingUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*AccountSettingUpdateResponseEnvelope) UnmarshalJSON

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

type AccountSettingUpdateResponseEnvelopeErrors added in v4.3.0

type AccountSettingUpdateResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           AccountSettingUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             accountSettingUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AccountSettingUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type AccountSettingUpdateResponseEnvelopeErrorsSource added in v4.3.0

type AccountSettingUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    accountSettingUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AccountSettingUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type AccountSettingUpdateResponseEnvelopeMessages added in v4.3.0

type AccountSettingUpdateResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           AccountSettingUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             accountSettingUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AccountSettingUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type AccountSettingUpdateResponseEnvelopeMessagesSource added in v4.3.0

type AccountSettingUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    accountSettingUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AccountSettingUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type AccountSettingUpdateResponseEnvelopeSuccess

type AccountSettingUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AccountSettingUpdateResponseEnvelopeSuccessTrue AccountSettingUpdateResponseEnvelopeSuccess = true
)

func (AccountSettingUpdateResponseEnvelopeSuccess) IsKnown

type AssetService

type AssetService struct {
	Options []option.RequestOption
	Upload  *AssetUploadService
}

AssetService 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 NewAssetService method instead.

func NewAssetService

func NewAssetService(opts ...option.RequestOption) (r *AssetService)

NewAssetService 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.

type AssetUploadNewParams

type AssetUploadNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Whether the file contents are base64-encoded. Must be `true`.
	Base64 param.Field[AssetUploadNewParamsBase64] `query:"base64,required"`
	Body   map[string]string                       `json:"body,required"`
}

func (AssetUploadNewParams) MarshalMultipart

func (r AssetUploadNewParams) MarshalMultipart() (data []byte, contentType string, err error)

func (AssetUploadNewParams) URLQuery

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

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

type AssetUploadNewParamsBase64

type AssetUploadNewParamsBase64 bool

Whether the file contents are base64-encoded. Must be `true`.

const (
	AssetUploadNewParamsBase64True AssetUploadNewParamsBase64 = true
)

func (AssetUploadNewParamsBase64) IsKnown

func (r AssetUploadNewParamsBase64) IsKnown() bool

type AssetUploadNewResponse

type AssetUploadNewResponse struct {
	// A "completion" JWT which can be redeemed when creating a Worker version.
	JWT  string                     `json:"jwt"`
	JSON assetUploadNewResponseJSON `json:"-"`
}

func (*AssetUploadNewResponse) UnmarshalJSON

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

type AssetUploadNewResponseEnvelope

type AssetUploadNewResponseEnvelope struct {
	Errors   []AssetUploadNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []AssetUploadNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success AssetUploadNewResponseEnvelopeSuccess `json:"success,required"`
	Result  AssetUploadNewResponse                `json:"result"`
	JSON    assetUploadNewResponseEnvelopeJSON    `json:"-"`
}

func (*AssetUploadNewResponseEnvelope) UnmarshalJSON

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

type AssetUploadNewResponseEnvelopeErrors added in v4.3.0

type AssetUploadNewResponseEnvelopeErrors struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           AssetUploadNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             assetUploadNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*AssetUploadNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type AssetUploadNewResponseEnvelopeErrorsSource added in v4.3.0

type AssetUploadNewResponseEnvelopeErrorsSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    assetUploadNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*AssetUploadNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type AssetUploadNewResponseEnvelopeMessages added in v4.3.0

type AssetUploadNewResponseEnvelopeMessages struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           AssetUploadNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             assetUploadNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*AssetUploadNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type AssetUploadNewResponseEnvelopeMessagesSource added in v4.3.0

type AssetUploadNewResponseEnvelopeMessagesSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    assetUploadNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*AssetUploadNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type AssetUploadNewResponseEnvelopeSuccess

type AssetUploadNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	AssetUploadNewResponseEnvelopeSuccessTrue AssetUploadNewResponseEnvelopeSuccess = true
)

func (AssetUploadNewResponseEnvelopeSuccess) IsKnown

type AssetUploadService

type AssetUploadService struct {
	Options []option.RequestOption
}

AssetUploadService 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 NewAssetUploadService method instead.

func NewAssetUploadService

func NewAssetUploadService(opts ...option.RequestOption) (r *AssetUploadService)

NewAssetUploadService 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 (*AssetUploadService) New

Upload assets ahead of creating a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.

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 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 ConsumerScript

type ConsumerScript struct {
	// Name of Worker that is to be the consumer.
	Service string `json:"service,required"`
	// Optional environment if the Worker utilizes one.
	Environment string `json:"environment"`
	// Optional dispatch namespace the script belongs to.
	Namespace string             `json:"namespace"`
	JSON      consumerScriptJSON `json:"-"`
}

A reference to a script that will consume logs from the attached Worker.

func (*ConsumerScript) UnmarshalJSON

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

type ConsumerScriptParam

type ConsumerScriptParam struct {
	// Name of Worker that is to be the consumer.
	Service param.Field[string] `json:"service,required"`
	// Optional environment if the Worker utilizes one.
	Environment param.Field[string] `json:"environment"`
	// Optional dispatch namespace the script belongs to.
	Namespace param.Field[string] `json:"namespace"`
}

A reference to a script that will consume logs from the attached Worker.

func (ConsumerScriptParam) MarshalJSON

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

type Deployment

type Deployment struct {
	// Human-readable message about the deployment. Truncated to 100 bytes.
	WorkersMessage string         `json:"workers/message"`
	JSON           deploymentJSON `json:"-"`
}

func (*Deployment) UnmarshalJSON

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

type DeploymentParam

type DeploymentParam struct {
	// Human-readable message about the deployment. Truncated to 100 bytes.
	WorkersMessage param.Field[string] `json:"workers/message"`
}

func (DeploymentParam) MarshalJSON

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

type Domain

type Domain struct {
	// Identifer of the Worker Domain.
	ID string `json:"id"`
	// Worker environment associated with the zone and hostname.
	Environment string `json:"environment"`
	// Hostname of the Worker Domain.
	Hostname string `json:"hostname"`
	// Worker service associated with the zone and hostname.
	Service string `json:"service"`
	// Identifier of the zone.
	ZoneID string `json:"zone_id"`
	// Name of the zone.
	ZoneName string     `json:"zone_name"`
	JSON     domainJSON `json:"-"`
}

func (*Domain) UnmarshalJSON

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

type DomainDeleteParams

type DomainDeleteParams struct {
	// Identifer of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type DomainGetParams

type DomainGetParams struct {
	// Identifer of the account.
	AccountID param.Field[string] `path:"account_id,required"`
}

type DomainGetResponseEnvelope

type DomainGetResponseEnvelope struct {
	Errors   []DomainGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DomainGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DomainGetResponseEnvelopeSuccess `json:"success,required"`
	Result  Domain                           `json:"result"`
	JSON    domainGetResponseEnvelopeJSON    `json:"-"`
}

func (*DomainGetResponseEnvelope) UnmarshalJSON

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

type DomainGetResponseEnvelopeErrors added in v4.3.0

type DomainGetResponseEnvelopeErrors struct {
	Code             int64                                 `json:"code,required"`
	Message          string                                `json:"message,required"`
	DocumentationURL string                                `json:"documentation_url"`
	Source           DomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             domainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DomainGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type DomainGetResponseEnvelopeErrorsSource added in v4.3.0

type DomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                    `json:"pointer"`
	JSON    domainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DomainGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type DomainGetResponseEnvelopeMessages added in v4.3.0

type DomainGetResponseEnvelopeMessages struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           DomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             domainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DomainGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type DomainGetResponseEnvelopeMessagesSource added in v4.3.0

type DomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    domainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DomainGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type DomainGetResponseEnvelopeSuccess

type DomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DomainGetResponseEnvelopeSuccessTrue DomainGetResponseEnvelopeSuccess = true
)

func (DomainGetResponseEnvelopeSuccess) IsKnown

type DomainListParams

type DomainListParams struct {
	// Identifer of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Worker environment associated with the zone and hostname.
	Environment param.Field[string] `query:"environment"`
	// Hostname of the Worker Domain.
	Hostname param.Field[string] `query:"hostname"`
	// Worker service associated with the zone and hostname.
	Service param.Field[string] `query:"service"`
	// Identifier of the zone.
	ZoneID param.Field[string] `query:"zone_id"`
	// Name of the zone.
	ZoneName param.Field[string] `query:"zone_name"`
}

func (DomainListParams) URLQuery

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

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

type DomainService

type DomainService struct {
	Options []option.RequestOption
}

DomainService 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 NewDomainService method instead.

func NewDomainService

func NewDomainService(opts ...option.RequestOption) (r *DomainService)

NewDomainService 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 (*DomainService) Delete

func (r *DomainService) Delete(ctx context.Context, domainID string, body DomainDeleteParams, opts ...option.RequestOption) (err error)

Detaches a Worker from a zone and hostname.

func (*DomainService) Get

func (r *DomainService) Get(ctx context.Context, domainID string, query DomainGetParams, opts ...option.RequestOption) (res *Domain, err error)

Gets a Worker domain.

func (*DomainService) List

Lists all Worker Domains for an account.

func (*DomainService) ListAutoPaging

Lists all Worker Domains for an account.

func (*DomainService) Update

func (r *DomainService) Update(ctx context.Context, params DomainUpdateParams, opts ...option.RequestOption) (res *Domain, err error)

Attaches a Worker to a zone and hostname.

type DomainUpdateParams

type DomainUpdateParams struct {
	// Identifer of the account.
	AccountID param.Field[string] `path:"account_id,required"`
	// Worker environment associated with the zone and hostname.
	Environment param.Field[string] `json:"environment,required"`
	// Hostname of the Worker Domain.
	Hostname param.Field[string] `json:"hostname,required"`
	// Worker service associated with the zone and hostname.
	Service param.Field[string] `json:"service,required"`
	// Identifier of the zone.
	ZoneID param.Field[string] `json:"zone_id,required"`
}

func (DomainUpdateParams) MarshalJSON

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

type DomainUpdateResponseEnvelope

type DomainUpdateResponseEnvelope struct {
	Errors   []DomainUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DomainUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DomainUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  Domain                              `json:"result"`
	JSON    domainUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DomainUpdateResponseEnvelope) UnmarshalJSON

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

type DomainUpdateResponseEnvelopeErrors added in v4.3.0

type DomainUpdateResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           DomainUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             domainUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DomainUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type DomainUpdateResponseEnvelopeErrorsSource added in v4.3.0

type DomainUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    domainUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DomainUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type DomainUpdateResponseEnvelopeMessages added in v4.3.0

type DomainUpdateResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           DomainUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             domainUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DomainUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type DomainUpdateResponseEnvelopeMessagesSource added in v4.3.0

type DomainUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    domainUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DomainUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type DomainUpdateResponseEnvelopeSuccess

type DomainUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DomainUpdateResponseEnvelopeSuccessTrue DomainUpdateResponseEnvelopeSuccess = true
)

func (DomainUpdateResponseEnvelopeSuccess) IsKnown

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource added in v4.2.0

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 MigrationStep

type MigrationStep struct {
	// A list of classes to delete Durable Object namespaces from.
	DeletedClasses []string `json:"deleted_classes"`
	// A list of classes to create Durable Object namespaces from.
	NewClasses []string `json:"new_classes"`
	// A list of classes to create Durable Object namespaces with SQLite from.
	NewSqliteClasses []string `json:"new_sqlite_classes"`
	// A list of classes with Durable Object namespaces that were renamed.
	RenamedClasses []MigrationStepRenamedClass `json:"renamed_classes"`
	// A list of transfers for Durable Object namespaces from a different Worker and
	// class to a class defined in this Worker.
	TransferredClasses []MigrationStepTransferredClass `json:"transferred_classes"`
	JSON               migrationStepJSON               `json:"-"`
}

func (*MigrationStep) UnmarshalJSON

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

type MigrationStepParam

type MigrationStepParam struct {
	// A list of classes to delete Durable Object namespaces from.
	DeletedClasses param.Field[[]string] `json:"deleted_classes"`
	// A list of classes to create Durable Object namespaces from.
	NewClasses param.Field[[]string] `json:"new_classes"`
	// A list of classes to create Durable Object namespaces with SQLite from.
	NewSqliteClasses param.Field[[]string] `json:"new_sqlite_classes"`
	// A list of classes with Durable Object namespaces that were renamed.
	RenamedClasses param.Field[[]MigrationStepRenamedClassParam] `json:"renamed_classes"`
	// A list of transfers for Durable Object namespaces from a different Worker and
	// class to a class defined in this Worker.
	TransferredClasses param.Field[[]MigrationStepTransferredClassParam] `json:"transferred_classes"`
}

func (MigrationStepParam) MarshalJSON

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

type MigrationStepRenamedClass

type MigrationStepRenamedClass struct {
	From string                        `json:"from"`
	To   string                        `json:"to"`
	JSON migrationStepRenamedClassJSON `json:"-"`
}

func (*MigrationStepRenamedClass) UnmarshalJSON

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

type MigrationStepRenamedClassParam

type MigrationStepRenamedClassParam struct {
	From param.Field[string] `json:"from"`
	To   param.Field[string] `json:"to"`
}

func (MigrationStepRenamedClassParam) MarshalJSON

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

type MigrationStepTransferredClass

type MigrationStepTransferredClass struct {
	From       string                            `json:"from"`
	FromScript string                            `json:"from_script"`
	To         string                            `json:"to"`
	JSON       migrationStepTransferredClassJSON `json:"-"`
}

func (*MigrationStepTransferredClass) UnmarshalJSON

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

type MigrationStepTransferredClassParam

type MigrationStepTransferredClassParam struct {
	From       param.Field[string] `json:"from"`
	FromScript param.Field[string] `json:"from_script"`
	To         param.Field[string] `json:"to"`
}

func (MigrationStepTransferredClassParam) MarshalJSON

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

type ObservabilityService added in v4.3.0

type ObservabilityService struct {
	Options   []option.RequestOption
	Telemetry *ObservabilityTelemetryService
}

ObservabilityService 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 NewObservabilityService method instead.

func NewObservabilityService added in v4.3.0

func NewObservabilityService(opts ...option.RequestOption) (r *ObservabilityService)

NewObservabilityService 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.

type ObservabilityTelemetryKeysParams added in v4.3.0

type ObservabilityTelemetryKeysParams struct {
	AccountID param.Field[string]                                   `path:"account_id,required"`
	Datasets  param.Field[[]string]                                 `json:"datasets"`
	Filters   param.Field[[]ObservabilityTelemetryKeysParamsFilter] `json:"filters"`
	// Search for a specific substring in the keys.
	KeyNeedle param.Field[ObservabilityTelemetryKeysParamsKeyNeedle] `json:"keyNeedle"`
	Limit     param.Field[float64]                                   `json:"limit"`
	// Search for a specific substring in the event.
	Needle    param.Field[ObservabilityTelemetryKeysParamsNeedle]    `json:"needle"`
	Timeframe param.Field[ObservabilityTelemetryKeysParamsTimeframe] `json:"timeframe"`
}

func (ObservabilityTelemetryKeysParams) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysParamsFilter added in v4.3.0

type ObservabilityTelemetryKeysParamsFilter struct {
	Key       param.Field[string]                                            `json:"key,required"`
	Operation param.Field[ObservabilityTelemetryKeysParamsFiltersOperation]  `json:"operation,required"`
	Type      param.Field[ObservabilityTelemetryKeysParamsFiltersType]       `json:"type,required"`
	Value     param.Field[ObservabilityTelemetryKeysParamsFiltersValueUnion] `json:"value"`
}

func (ObservabilityTelemetryKeysParamsFilter) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysParamsFiltersOperation added in v4.3.0

type ObservabilityTelemetryKeysParamsFiltersOperation string
const (
	ObservabilityTelemetryKeysParamsFiltersOperationIncludes            ObservabilityTelemetryKeysParamsFiltersOperation = "includes"
	ObservabilityTelemetryKeysParamsFiltersOperationNotIncludes         ObservabilityTelemetryKeysParamsFiltersOperation = "not_includes"
	ObservabilityTelemetryKeysParamsFiltersOperationStartsWith          ObservabilityTelemetryKeysParamsFiltersOperation = "starts_with"
	ObservabilityTelemetryKeysParamsFiltersOperationRegex               ObservabilityTelemetryKeysParamsFiltersOperation = "regex"
	ObservabilityTelemetryKeysParamsFiltersOperationExists              ObservabilityTelemetryKeysParamsFiltersOperation = "exists"
	ObservabilityTelemetryKeysParamsFiltersOperationIsNull              ObservabilityTelemetryKeysParamsFiltersOperation = "is_null"
	ObservabilityTelemetryKeysParamsFiltersOperationIn                  ObservabilityTelemetryKeysParamsFiltersOperation = "in"
	ObservabilityTelemetryKeysParamsFiltersOperationNotIn               ObservabilityTelemetryKeysParamsFiltersOperation = "not_in"
	ObservabilityTelemetryKeysParamsFiltersOperationEq                  ObservabilityTelemetryKeysParamsFiltersOperation = "eq"
	ObservabilityTelemetryKeysParamsFiltersOperationNeq                 ObservabilityTelemetryKeysParamsFiltersOperation = "neq"
	ObservabilityTelemetryKeysParamsFiltersOperationGt                  ObservabilityTelemetryKeysParamsFiltersOperation = "gt"
	ObservabilityTelemetryKeysParamsFiltersOperationGte                 ObservabilityTelemetryKeysParamsFiltersOperation = "gte"
	ObservabilityTelemetryKeysParamsFiltersOperationLt                  ObservabilityTelemetryKeysParamsFiltersOperation = "lt"
	ObservabilityTelemetryKeysParamsFiltersOperationLte                 ObservabilityTelemetryKeysParamsFiltersOperation = "lte"
	ObservabilityTelemetryKeysParamsFiltersOperationEquals              ObservabilityTelemetryKeysParamsFiltersOperation = "="
	ObservabilityTelemetryKeysParamsFiltersOperationNotEquals           ObservabilityTelemetryKeysParamsFiltersOperation = "!="
	ObservabilityTelemetryKeysParamsFiltersOperationGreater             ObservabilityTelemetryKeysParamsFiltersOperation = ">"
	ObservabilityTelemetryKeysParamsFiltersOperationGreaterOrEquals     ObservabilityTelemetryKeysParamsFiltersOperation = ">="
	ObservabilityTelemetryKeysParamsFiltersOperationLess                ObservabilityTelemetryKeysParamsFiltersOperation = "<"
	ObservabilityTelemetryKeysParamsFiltersOperationLessOrEquals        ObservabilityTelemetryKeysParamsFiltersOperation = "<="
	ObservabilityTelemetryKeysParamsFiltersOperationIncludesUppercase   ObservabilityTelemetryKeysParamsFiltersOperation = "INCLUDES"
	ObservabilityTelemetryKeysParamsFiltersOperationDoesNotInclude      ObservabilityTelemetryKeysParamsFiltersOperation = "DOES_NOT_INCLUDE"
	ObservabilityTelemetryKeysParamsFiltersOperationMatchRegex          ObservabilityTelemetryKeysParamsFiltersOperation = "MATCH_REGEX"
	ObservabilityTelemetryKeysParamsFiltersOperationExistsUppercase     ObservabilityTelemetryKeysParamsFiltersOperation = "EXISTS"
	ObservabilityTelemetryKeysParamsFiltersOperationDoesNotExist        ObservabilityTelemetryKeysParamsFiltersOperation = "DOES_NOT_EXIST"
	ObservabilityTelemetryKeysParamsFiltersOperationInUppercase         ObservabilityTelemetryKeysParamsFiltersOperation = "IN"
	ObservabilityTelemetryKeysParamsFiltersOperationNotInUppercase      ObservabilityTelemetryKeysParamsFiltersOperation = "NOT_IN"
	ObservabilityTelemetryKeysParamsFiltersOperationStartsWithUppercase ObservabilityTelemetryKeysParamsFiltersOperation = "STARTS_WITH"
)

func (ObservabilityTelemetryKeysParamsFiltersOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryKeysParamsFiltersType added in v4.3.0

type ObservabilityTelemetryKeysParamsFiltersType string
const (
	ObservabilityTelemetryKeysParamsFiltersTypeString  ObservabilityTelemetryKeysParamsFiltersType = "string"
	ObservabilityTelemetryKeysParamsFiltersTypeNumber  ObservabilityTelemetryKeysParamsFiltersType = "number"
	ObservabilityTelemetryKeysParamsFiltersTypeBoolean ObservabilityTelemetryKeysParamsFiltersType = "boolean"
)

func (ObservabilityTelemetryKeysParamsFiltersType) IsKnown added in v4.3.0

type ObservabilityTelemetryKeysParamsFiltersValueUnion added in v4.3.0

type ObservabilityTelemetryKeysParamsFiltersValueUnion interface {
	ImplementsObservabilityTelemetryKeysParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryKeysParamsKeyNeedle added in v4.3.0

type ObservabilityTelemetryKeysParamsKeyNeedle struct {
	Value     param.Field[ObservabilityTelemetryKeysParamsKeyNeedleValueUnion] `json:"value,required"`
	IsRegex   param.Field[bool]                                                `json:"isRegex"`
	MatchCase param.Field[bool]                                                `json:"matchCase"`
}

Search for a specific substring in the keys.

func (ObservabilityTelemetryKeysParamsKeyNeedle) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysParamsKeyNeedleValueUnion added in v4.3.0

type ObservabilityTelemetryKeysParamsKeyNeedleValueUnion interface {
	ImplementsObservabilityTelemetryKeysParamsKeyNeedleValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryKeysParamsNeedle added in v4.3.0

type ObservabilityTelemetryKeysParamsNeedle struct {
	Value     param.Field[ObservabilityTelemetryKeysParamsNeedleValueUnion] `json:"value,required"`
	IsRegex   param.Field[bool]                                             `json:"isRegex"`
	MatchCase param.Field[bool]                                             `json:"matchCase"`
}

Search for a specific substring in the event.

func (ObservabilityTelemetryKeysParamsNeedle) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysParamsNeedleValueUnion added in v4.3.0

type ObservabilityTelemetryKeysParamsNeedleValueUnion interface {
	ImplementsObservabilityTelemetryKeysParamsNeedleValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryKeysParamsTimeframe added in v4.3.0

type ObservabilityTelemetryKeysParamsTimeframe struct {
	From param.Field[float64] `json:"from,required"`
	To   param.Field[float64] `json:"to,required"`
}

func (ObservabilityTelemetryKeysParamsTimeframe) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysResponse added in v4.3.0

type ObservabilityTelemetryKeysResponse struct {
	Key        string                                 `json:"key,required"`
	LastSeenAt float64                                `json:"lastSeenAt,required"`
	Type       ObservabilityTelemetryKeysResponseType `json:"type,required"`
	JSON       observabilityTelemetryKeysResponseJSON `json:"-"`
}

func (*ObservabilityTelemetryKeysResponse) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryKeysResponseType added in v4.3.0

type ObservabilityTelemetryKeysResponseType string
const (
	ObservabilityTelemetryKeysResponseTypeString  ObservabilityTelemetryKeysResponseType = "string"
	ObservabilityTelemetryKeysResponseTypeBoolean ObservabilityTelemetryKeysResponseType = "boolean"
	ObservabilityTelemetryKeysResponseTypeNumber  ObservabilityTelemetryKeysResponseType = "number"
)

func (ObservabilityTelemetryKeysResponseType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParams added in v4.3.0

type ObservabilityTelemetryQueryParams struct {
	AccountID       param.Field[string]                                       `path:"account_id,required"`
	QueryID         param.Field[string]                                       `json:"queryId,required"`
	Timeframe       param.Field[ObservabilityTelemetryQueryParamsTimeframe]   `json:"timeframe,required"`
	Chart           param.Field[bool]                                         `json:"chart"`
	Compare         param.Field[bool]                                         `json:"compare"`
	Dry             param.Field[bool]                                         `json:"dry"`
	Granularity     param.Field[float64]                                      `json:"granularity"`
	IgnoreSeries    param.Field[bool]                                         `json:"ignoreSeries"`
	Limit           param.Field[float64]                                      `json:"limit"`
	Offset          param.Field[string]                                       `json:"offset"`
	OffsetBy        param.Field[float64]                                      `json:"offsetBy"`
	OffsetDirection param.Field[string]                                       `json:"offsetDirection"`
	Parameters      param.Field[ObservabilityTelemetryQueryParamsParameters]  `json:"parameters"`
	PatternType     param.Field[ObservabilityTelemetryQueryParamsPatternType] `json:"patternType"`
	View            param.Field[ObservabilityTelemetryQueryParamsView]        `json:"view"`
}

func (ObservabilityTelemetryQueryParams) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParameters added in v4.3.0

type ObservabilityTelemetryQueryParamsParameters struct {
	// Create Calculations to compute as part of the query.
	Calculations param.Field[[]ObservabilityTelemetryQueryParamsParametersCalculation] `json:"calculations"`
	// Set the Datasets to query. Leave it empty to query all the datasets.
	Datasets param.Field[[]string] `json:"datasets"`
	// Set a Flag to describe how to combine the filters on the query.
	FilterCombination param.Field[ObservabilityTelemetryQueryParamsParametersFilterCombination] `json:"filterCombination"`
	// Configure the Filters to apply to the query.
	Filters param.Field[[]ObservabilityTelemetryQueryParamsParametersFilter] `json:"filters"`
	// Define how to group the results of the query.
	GroupBys param.Field[[]ObservabilityTelemetryQueryParamsParametersGroupBy] `json:"groupBys"`
	// Configure the Having clauses that filter on calculations in the query result.
	Havings param.Field[[]ObservabilityTelemetryQueryParamsParametersHaving] `json:"havings"`
	// Set a limit on the number of results / records returned by the query
	Limit param.Field[int64] `json:"limit"`
	// Define an expression to search using full-text search.
	Needle param.Field[ObservabilityTelemetryQueryParamsParametersNeedle] `json:"needle"`
	// Configure the order of the results returned by the query.
	OrderBy param.Field[ObservabilityTelemetryQueryParamsParametersOrderBy] `json:"orderBy"`
}

func (ObservabilityTelemetryQueryParamsParameters) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersCalculation added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersCalculation struct {
	Operator param.Field[ObservabilityTelemetryQueryParamsParametersCalculationsOperator] `json:"operator,required"`
	Alias    param.Field[string]                                                          `json:"alias"`
	Key      param.Field[string]                                                          `json:"key"`
	KeyType  param.Field[ObservabilityTelemetryQueryParamsParametersCalculationsKeyType]  `json:"keyType"`
}

func (ObservabilityTelemetryQueryParamsParametersCalculation) MarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersCalculationsKeyType added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersCalculationsKeyType string
const (
	ObservabilityTelemetryQueryParamsParametersCalculationsKeyTypeString  ObservabilityTelemetryQueryParamsParametersCalculationsKeyType = "string"
	ObservabilityTelemetryQueryParamsParametersCalculationsKeyTypeNumber  ObservabilityTelemetryQueryParamsParametersCalculationsKeyType = "number"
	ObservabilityTelemetryQueryParamsParametersCalculationsKeyTypeBoolean ObservabilityTelemetryQueryParamsParametersCalculationsKeyType = "boolean"
)

func (ObservabilityTelemetryQueryParamsParametersCalculationsKeyType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersCalculationsOperator added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersCalculationsOperator string
const (
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorUniq              ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "uniq"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorCount             ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "count"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMax               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "max"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMin               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "min"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorSum               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "sum"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorAvg               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "avg"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMedian            ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "median"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP001              ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p001"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP01               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p01"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP05               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p05"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP10               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p10"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP25               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p25"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP75               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p75"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP90               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p90"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP95               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p95"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP99               ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p99"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP999              ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "p999"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorStddev            ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "stddev"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorVariance          ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "variance"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorCountDistinct     ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "COUNT_DISTINCT"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorCountUppercase    ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "COUNT"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMaxUppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "MAX"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMinUppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "MIN"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorSumUppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "SUM"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorAvgUppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "AVG"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorMedianUppercase   ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "MEDIAN"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP001Uppercase     ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P001"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP01Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P01"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP05Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P05"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP10Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P10"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP25Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P25"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP75Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P75"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP90Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P90"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP95Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P95"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP99Uppercase      ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P99"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorP999Uppercase     ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "P999"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorStddevUppercase   ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "STDDEV"
	ObservabilityTelemetryQueryParamsParametersCalculationsOperatorVarianceUppercase ObservabilityTelemetryQueryParamsParametersCalculationsOperator = "VARIANCE"
)

func (ObservabilityTelemetryQueryParamsParametersCalculationsOperator) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFilter added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFilter struct {
	Key       param.Field[string]                                                       `json:"key,required"`
	Operation param.Field[ObservabilityTelemetryQueryParamsParametersFiltersOperation]  `json:"operation,required"`
	Type      param.Field[ObservabilityTelemetryQueryParamsParametersFiltersType]       `json:"type,required"`
	Value     param.Field[ObservabilityTelemetryQueryParamsParametersFiltersValueUnion] `json:"value"`
}

func (ObservabilityTelemetryQueryParamsParametersFilter) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersFilterCombination added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFilterCombination string

Set a Flag to describe how to combine the filters on the query.

const (
	ObservabilityTelemetryQueryParamsParametersFilterCombinationAnd          ObservabilityTelemetryQueryParamsParametersFilterCombination = "and"
	ObservabilityTelemetryQueryParamsParametersFilterCombinationOr           ObservabilityTelemetryQueryParamsParametersFilterCombination = "or"
	ObservabilityTelemetryQueryParamsParametersFilterCombinationAndUppercase ObservabilityTelemetryQueryParamsParametersFilterCombination = "AND"
	ObservabilityTelemetryQueryParamsParametersFilterCombinationOrUppercase  ObservabilityTelemetryQueryParamsParametersFilterCombination = "OR"
)

func (ObservabilityTelemetryQueryParamsParametersFilterCombination) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersOperation added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersOperation string
const (
	ObservabilityTelemetryQueryParamsParametersFiltersOperationIncludes            ObservabilityTelemetryQueryParamsParametersFiltersOperation = "includes"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationNotIncludes         ObservabilityTelemetryQueryParamsParametersFiltersOperation = "not_includes"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationStartsWith          ObservabilityTelemetryQueryParamsParametersFiltersOperation = "starts_with"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationRegex               ObservabilityTelemetryQueryParamsParametersFiltersOperation = "regex"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationExists              ObservabilityTelemetryQueryParamsParametersFiltersOperation = "exists"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationIsNull              ObservabilityTelemetryQueryParamsParametersFiltersOperation = "is_null"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationIn                  ObservabilityTelemetryQueryParamsParametersFiltersOperation = "in"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationNotIn               ObservabilityTelemetryQueryParamsParametersFiltersOperation = "not_in"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationEq                  ObservabilityTelemetryQueryParamsParametersFiltersOperation = "eq"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationNeq                 ObservabilityTelemetryQueryParamsParametersFiltersOperation = "neq"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationGt                  ObservabilityTelemetryQueryParamsParametersFiltersOperation = "gt"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationGte                 ObservabilityTelemetryQueryParamsParametersFiltersOperation = "gte"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationLt                  ObservabilityTelemetryQueryParamsParametersFiltersOperation = "lt"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationLte                 ObservabilityTelemetryQueryParamsParametersFiltersOperation = "lte"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationEquals              ObservabilityTelemetryQueryParamsParametersFiltersOperation = "="
	ObservabilityTelemetryQueryParamsParametersFiltersOperationNotEquals           ObservabilityTelemetryQueryParamsParametersFiltersOperation = "!="
	ObservabilityTelemetryQueryParamsParametersFiltersOperationGreater             ObservabilityTelemetryQueryParamsParametersFiltersOperation = ">"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationGreaterOrEquals     ObservabilityTelemetryQueryParamsParametersFiltersOperation = ">="
	ObservabilityTelemetryQueryParamsParametersFiltersOperationLess                ObservabilityTelemetryQueryParamsParametersFiltersOperation = "<"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationLessOrEquals        ObservabilityTelemetryQueryParamsParametersFiltersOperation = "<="
	ObservabilityTelemetryQueryParamsParametersFiltersOperationIncludesUppercase   ObservabilityTelemetryQueryParamsParametersFiltersOperation = "INCLUDES"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationDoesNotInclude      ObservabilityTelemetryQueryParamsParametersFiltersOperation = "DOES_NOT_INCLUDE"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationMatchRegex          ObservabilityTelemetryQueryParamsParametersFiltersOperation = "MATCH_REGEX"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationExistsUppercase     ObservabilityTelemetryQueryParamsParametersFiltersOperation = "EXISTS"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationDoesNotExist        ObservabilityTelemetryQueryParamsParametersFiltersOperation = "DOES_NOT_EXIST"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationInUppercase         ObservabilityTelemetryQueryParamsParametersFiltersOperation = "IN"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationNotInUppercase      ObservabilityTelemetryQueryParamsParametersFiltersOperation = "NOT_IN"
	ObservabilityTelemetryQueryParamsParametersFiltersOperationStartsWithUppercase ObservabilityTelemetryQueryParamsParametersFiltersOperation = "STARTS_WITH"
)

func (ObservabilityTelemetryQueryParamsParametersFiltersOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersType added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersType string
const (
	ObservabilityTelemetryQueryParamsParametersFiltersTypeString  ObservabilityTelemetryQueryParamsParametersFiltersType = "string"
	ObservabilityTelemetryQueryParamsParametersFiltersTypeNumber  ObservabilityTelemetryQueryParamsParametersFiltersType = "number"
	ObservabilityTelemetryQueryParamsParametersFiltersTypeBoolean ObservabilityTelemetryQueryParamsParametersFiltersType = "boolean"
)

func (ObservabilityTelemetryQueryParamsParametersFiltersType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersValueUnion added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersFiltersValueUnion interface {
	ImplementsObservabilityTelemetryQueryParamsParametersFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryQueryParamsParametersGroupBy added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersGroupBy struct {
	Type  param.Field[ObservabilityTelemetryQueryParamsParametersGroupBysType] `json:"type,required"`
	Value param.Field[string]                                                  `json:"value,required"`
}

func (ObservabilityTelemetryQueryParamsParametersGroupBy) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersGroupBysType added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersGroupBysType string
const (
	ObservabilityTelemetryQueryParamsParametersGroupBysTypeString  ObservabilityTelemetryQueryParamsParametersGroupBysType = "string"
	ObservabilityTelemetryQueryParamsParametersGroupBysTypeNumber  ObservabilityTelemetryQueryParamsParametersGroupBysType = "number"
	ObservabilityTelemetryQueryParamsParametersGroupBysTypeBoolean ObservabilityTelemetryQueryParamsParametersGroupBysType = "boolean"
)

func (ObservabilityTelemetryQueryParamsParametersGroupBysType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersHaving added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersHaving struct {
	Key       param.Field[string]                                                      `json:"key,required"`
	Operation param.Field[ObservabilityTelemetryQueryParamsParametersHavingsOperation] `json:"operation,required"`
	Value     param.Field[float64]                                                     `json:"value,required"`
}

func (ObservabilityTelemetryQueryParamsParametersHaving) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersHavingsOperation added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersHavingsOperation string
const (
	ObservabilityTelemetryQueryParamsParametersHavingsOperationEq  ObservabilityTelemetryQueryParamsParametersHavingsOperation = "eq"
	ObservabilityTelemetryQueryParamsParametersHavingsOperationNeq ObservabilityTelemetryQueryParamsParametersHavingsOperation = "neq"
	ObservabilityTelemetryQueryParamsParametersHavingsOperationGt  ObservabilityTelemetryQueryParamsParametersHavingsOperation = "gt"
	ObservabilityTelemetryQueryParamsParametersHavingsOperationGte ObservabilityTelemetryQueryParamsParametersHavingsOperation = "gte"
	ObservabilityTelemetryQueryParamsParametersHavingsOperationLt  ObservabilityTelemetryQueryParamsParametersHavingsOperation = "lt"
	ObservabilityTelemetryQueryParamsParametersHavingsOperationLte ObservabilityTelemetryQueryParamsParametersHavingsOperation = "lte"
)

func (ObservabilityTelemetryQueryParamsParametersHavingsOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersNeedle added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersNeedle struct {
	Value     param.Field[ObservabilityTelemetryQueryParamsParametersNeedleValueUnion] `json:"value,required"`
	IsRegex   param.Field[bool]                                                        `json:"isRegex"`
	MatchCase param.Field[bool]                                                        `json:"matchCase"`
}

Define an expression to search using full-text search.

func (ObservabilityTelemetryQueryParamsParametersNeedle) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersNeedleValueUnion added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersNeedleValueUnion interface {
	ImplementsObservabilityTelemetryQueryParamsParametersNeedleValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryQueryParamsParametersOrderBy added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersOrderBy struct {
	// Configure which Calculation to order the results by.
	Value param.Field[string] `json:"value,required"`
	// Set the order of the results
	Order param.Field[ObservabilityTelemetryQueryParamsParametersOrderByOrder] `json:"order"`
}

Configure the order of the results returned by the query.

func (ObservabilityTelemetryQueryParamsParametersOrderBy) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsParametersOrderByOrder added in v4.3.0

type ObservabilityTelemetryQueryParamsParametersOrderByOrder string

Set the order of the results

const (
	ObservabilityTelemetryQueryParamsParametersOrderByOrderAsc  ObservabilityTelemetryQueryParamsParametersOrderByOrder = "asc"
	ObservabilityTelemetryQueryParamsParametersOrderByOrderDesc ObservabilityTelemetryQueryParamsParametersOrderByOrder = "desc"
)

func (ObservabilityTelemetryQueryParamsParametersOrderByOrder) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsPatternType added in v4.3.0

type ObservabilityTelemetryQueryParamsPatternType string
const (
	ObservabilityTelemetryQueryParamsPatternTypeMessage ObservabilityTelemetryQueryParamsPatternType = "message"
	ObservabilityTelemetryQueryParamsPatternTypeError   ObservabilityTelemetryQueryParamsPatternType = "error"
)

func (ObservabilityTelemetryQueryParamsPatternType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryParamsTimeframe added in v4.3.0

type ObservabilityTelemetryQueryParamsTimeframe struct {
	From param.Field[float64] `json:"from,required"`
	To   param.Field[float64] `json:"to,required"`
}

func (ObservabilityTelemetryQueryParamsTimeframe) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryParamsView added in v4.3.0

type ObservabilityTelemetryQueryParamsView string
const (
	ObservabilityTelemetryQueryParamsViewTraces       ObservabilityTelemetryQueryParamsView = "traces"
	ObservabilityTelemetryQueryParamsViewEvents       ObservabilityTelemetryQueryParamsView = "events"
	ObservabilityTelemetryQueryParamsViewCalculations ObservabilityTelemetryQueryParamsView = "calculations"
	ObservabilityTelemetryQueryParamsViewInvocations  ObservabilityTelemetryQueryParamsView = "invocations"
	ObservabilityTelemetryQueryParamsViewRequests     ObservabilityTelemetryQueryParamsView = "requests"
	ObservabilityTelemetryQueryParamsViewPatterns     ObservabilityTelemetryQueryParamsView = "patterns"
)

func (ObservabilityTelemetryQueryParamsView) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponse added in v4.3.0

type ObservabilityTelemetryQueryResponse struct {
	// A Workers Observability Query Object
	Run ObservabilityTelemetryQueryResponseRun `json:"run,required"`
	// The statistics object contains information about query performance from the
	// database, it does not include any network latency
	Statistics   ObservabilityTelemetryQueryResponseStatistics              `json:"statistics,required"`
	Calculations []ObservabilityTelemetryQueryResponseCalculation           `json:"calculations"`
	Compare      []ObservabilityTelemetryQueryResponseCompare               `json:"compare"`
	Events       ObservabilityTelemetryQueryResponseEvents                  `json:"events"`
	Invocations  map[string][]ObservabilityTelemetryQueryResponseInvocation `json:"invocations"`
	Patterns     []ObservabilityTelemetryQueryResponsePattern               `json:"patterns"`
	JSON         observabilityTelemetryQueryResponseJSON                    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponse) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCalculation added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculation struct {
	Aggregates  []ObservabilityTelemetryQueryResponseCalculationsAggregate `json:"aggregates,required"`
	Calculation string                                                     `json:"calculation,required"`
	Series      []ObservabilityTelemetryQueryResponseCalculationsSery      `json:"series,required"`
	Alias       string                                                     `json:"alias"`
	JSON        observabilityTelemetryQueryResponseCalculationJSON         `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculation) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCalculationsAggregate added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsAggregate struct {
	Count          float64                                                          `json:"count,required"`
	Interval       float64                                                          `json:"interval,required"`
	SampleInterval float64                                                          `json:"sampleInterval,required"`
	Value          float64                                                          `json:"value,required"`
	Groups         []ObservabilityTelemetryQueryResponseCalculationsAggregatesGroup `json:"groups"`
	JSON           observabilityTelemetryQueryResponseCalculationsAggregateJSON     `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculationsAggregate) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsAggregatesGroup added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsAggregatesGroup struct {
	Key   string                                                                    `json:"key,required"`
	Value ObservabilityTelemetryQueryResponseCalculationsAggregatesGroupsValueUnion `json:"value,required"`
	JSON  observabilityTelemetryQueryResponseCalculationsAggregatesGroupJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculationsAggregatesGroup) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsAggregatesGroupsValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsAggregatesGroupsValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseCalculationsAggregatesGroupsValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseCalculationsSeriesData added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSeriesData struct {
	Count          float64                                                          `json:"count,required"`
	FirstSeen      string                                                           `json:"firstSeen,required"`
	Interval       float64                                                          `json:"interval,required"`
	LastSeen       string                                                           `json:"lastSeen,required"`
	SampleInterval float64                                                          `json:"sampleInterval,required"`
	Value          float64                                                          `json:"value,required"`
	Groups         []ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroup `json:"groups"`
	JSON           observabilityTelemetryQueryResponseCalculationsSeriesDataJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculationsSeriesData) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroup added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroup struct {
	Key   string                                                                    `json:"key,required"`
	Value ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroupsValueUnion `json:"value,required"`
	JSON  observabilityTelemetryQueryResponseCalculationsSeriesDataGroupJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroup) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroupsValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSeriesDataGroupsValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseCalculationsSeriesDataGroupsValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseCalculationsSery added in v4.3.0

type ObservabilityTelemetryQueryResponseCalculationsSery struct {
	Data []ObservabilityTelemetryQueryResponseCalculationsSeriesData `json:"data,required"`
	Time string                                                      `json:"time,required"`
	JSON observabilityTelemetryQueryResponseCalculationsSeryJSON     `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCalculationsSery) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCompare added in v4.3.0

type ObservabilityTelemetryQueryResponseCompare struct {
	Aggregates  []ObservabilityTelemetryQueryResponseCompareAggregate `json:"aggregates,required"`
	Calculation string                                                `json:"calculation,required"`
	Series      []ObservabilityTelemetryQueryResponseCompareSery      `json:"series,required"`
	Alias       string                                                `json:"alias"`
	JSON        observabilityTelemetryQueryResponseCompareJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompare) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCompareAggregate added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareAggregate struct {
	Count          float64                                                     `json:"count,required"`
	Interval       float64                                                     `json:"interval,required"`
	SampleInterval float64                                                     `json:"sampleInterval,required"`
	Value          float64                                                     `json:"value,required"`
	Groups         []ObservabilityTelemetryQueryResponseCompareAggregatesGroup `json:"groups"`
	JSON           observabilityTelemetryQueryResponseCompareAggregateJSON     `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompareAggregate) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCompareAggregatesGroup added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareAggregatesGroup struct {
	Key   string                                                               `json:"key,required"`
	Value ObservabilityTelemetryQueryResponseCompareAggregatesGroupsValueUnion `json:"value,required"`
	JSON  observabilityTelemetryQueryResponseCompareAggregatesGroupJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompareAggregatesGroup) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareAggregatesGroupsValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareAggregatesGroupsValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseCompareAggregatesGroupsValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseCompareSeriesData added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareSeriesData struct {
	Count          float64                                                     `json:"count,required"`
	FirstSeen      string                                                      `json:"firstSeen,required"`
	Interval       float64                                                     `json:"interval,required"`
	LastSeen       string                                                      `json:"lastSeen,required"`
	SampleInterval float64                                                     `json:"sampleInterval,required"`
	Value          float64                                                     `json:"value,required"`
	Groups         []ObservabilityTelemetryQueryResponseCompareSeriesDataGroup `json:"groups"`
	JSON           observabilityTelemetryQueryResponseCompareSeriesDataJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompareSeriesData) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseCompareSeriesDataGroup added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareSeriesDataGroup struct {
	Key   string                                                               `json:"key,required"`
	Value ObservabilityTelemetryQueryResponseCompareSeriesDataGroupsValueUnion `json:"value,required"`
	JSON  observabilityTelemetryQueryResponseCompareSeriesDataGroupJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompareSeriesDataGroup) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareSeriesDataGroupsValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareSeriesDataGroupsValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseCompareSeriesDataGroupsValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseCompareSery added in v4.3.0

type ObservabilityTelemetryQueryResponseCompareSery struct {
	Data []ObservabilityTelemetryQueryResponseCompareSeriesData `json:"data,required"`
	Time string                                                 `json:"time,required"`
	JSON observabilityTelemetryQueryResponseCompareSeryJSON     `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseCompareSery) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEnvelope added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelope struct {
	Errors   []ObservabilityTelemetryQueryResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ObservabilityTelemetryQueryResponseEnvelopeMessages `json:"messages,required"`
	Result   ObservabilityTelemetryQueryResponse                   `json:"result,required"`
	Success  ObservabilityTelemetryQueryResponseEnvelopeSuccess    `json:"success,required"`
	JSON     observabilityTelemetryQueryResponseEnvelopeJSON       `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEnvelopeErrors added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelopeErrors struct {
	Message string                                                `json:"message,required"`
	JSON    observabilityTelemetryQueryResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEnvelopeMessages added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelopeMessages struct {
	Message ObservabilityTelemetryQueryResponseEnvelopeMessagesMessage `json:"message,required"`
	JSON    observabilityTelemetryQueryResponseEnvelopeMessagesJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEnvelopeMessagesMessage added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelopeMessagesMessage string
const (
	ObservabilityTelemetryQueryResponseEnvelopeMessagesMessageSuccessfulRequest ObservabilityTelemetryQueryResponseEnvelopeMessagesMessage = "Successful request"
)

func (ObservabilityTelemetryQueryResponseEnvelopeMessagesMessage) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelopeSuccess added in v4.3.0

type ObservabilityTelemetryQueryResponseEnvelopeSuccess bool
const (
	ObservabilityTelemetryQueryResponseEnvelopeSuccessTrue ObservabilityTelemetryQueryResponseEnvelopeSuccess = true
)

func (ObservabilityTelemetryQueryResponseEnvelopeSuccess) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEvents added in v4.3.0

type ObservabilityTelemetryQueryResponseEvents struct {
	Count  float64                                          `json:"count"`
	Events []ObservabilityTelemetryQueryResponseEventsEvent `json:"events"`
	Fields []ObservabilityTelemetryQueryResponseEventsField `json:"fields"`
	Series []ObservabilityTelemetryQueryResponseEventsSery  `json:"series"`
	JSON   observabilityTelemetryQueryResponseEventsJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEvents) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEventsEvent added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEvent struct {
	Metadata  ObservabilityTelemetryQueryResponseEventsEventsMetadata `json:"$metadata,required"`
	Dataset   string                                                  `json:"dataset,required"`
	Source    interface{}                                             `json:"source,required"`
	Timestamp int64                                                   `json:"timestamp,required"`
	// Cloudflare Workers event information enriches your logs so you can easily
	// identify and debug issues.
	Workers ObservabilityTelemetryQueryResponseEventsEventsWorkers `json:"$workers"`
	JSON    observabilityTelemetryQueryResponseEventsEventJSON     `json:"-"`
}

The data structure of a telemetry event

func (*ObservabilityTelemetryQueryResponseEventsEvent) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEventsEventsMetadata added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsMetadata struct {
	ID              string                                                      `json:"id,required"`
	Account         string                                                      `json:"account"`
	CloudService    string                                                      `json:"cloudService"`
	ColdStart       int64                                                       `json:"coldStart"`
	Cost            int64                                                       `json:"cost"`
	Duration        int64                                                       `json:"duration"`
	EndTime         int64                                                       `json:"endTime"`
	Error           string                                                      `json:"error"`
	ErrorTemplate   string                                                      `json:"errorTemplate"`
	Fingerprint     string                                                      `json:"fingerprint"`
	Level           string                                                      `json:"level"`
	Message         string                                                      `json:"message"`
	MessageTemplate string                                                      `json:"messageTemplate"`
	MetricName      string                                                      `json:"metricName"`
	Origin          string                                                      `json:"origin"`
	ParentSpanID    string                                                      `json:"parentSpanId"`
	Provider        string                                                      `json:"provider"`
	Region          string                                                      `json:"region"`
	RequestID       string                                                      `json:"requestId"`
	Service         string                                                      `json:"service"`
	SpanID          string                                                      `json:"spanId"`
	SpanName        string                                                      `json:"spanName"`
	StackID         string                                                      `json:"stackId"`
	StartTime       int64                                                       `json:"startTime"`
	StatusCode      int64                                                       `json:"statusCode"`
	TraceDuration   int64                                                       `json:"traceDuration"`
	TraceID         string                                                      `json:"traceId"`
	Trigger         string                                                      `json:"trigger"`
	Type            string                                                      `json:"type"`
	URL             string                                                      `json:"url"`
	JSON            observabilityTelemetryQueryResponseEventsEventsMetadataJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsEventsMetadata) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkers added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkers struct {
	EventType  ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType `json:"eventType,required"`
	Outcome    string                                                          `json:"outcome,required"`
	RequestID  string                                                          `json:"requestId,required"`
	ScriptName string                                                          `json:"scriptName,required"`
	CPUTimeMs  float64                                                         `json:"cpuTimeMs"`
	// This field can have the runtime type of
	// [[]ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectDiagnosticsChannelEvent].
	DiagnosticsChannelEvents interface{} `json:"diagnosticsChannelEvents"`
	DispatchNamespace        string      `json:"dispatchNamespace"`
	Entrypoint               string      `json:"entrypoint"`
	// This field can have the runtime type of
	// [map[string]ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion].
	Event          interface{}                                                          `json:"event"`
	ExecutionModel ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel `json:"executionModel"`
	// This field can have the runtime type of
	// [ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersion].
	ScriptVersion interface{}                                                `json:"scriptVersion"`
	Truncated     bool                                                       `json:"truncated"`
	WallTimeMs    float64                                                    `json:"wallTimeMs"`
	JSON          observabilityTelemetryQueryResponseEventsEventsWorkersJSON `json:"-"`
	// contains filtered or unexported fields
}

Cloudflare Workers event information enriches your logs so you can easily identify and debug issues.

func (ObservabilityTelemetryQueryResponseEventsEventsWorkers) AsUnion added in v4.3.0

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

Possible runtime types of the union are ObservabilityTelemetryQueryResponseEventsEventsWorkersObject, ObservabilityTelemetryQueryResponseEventsEventsWorkersObject.

func (*ObservabilityTelemetryQueryResponseEventsEventsWorkers) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType string
const (
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeFetch     ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "fetch"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeScheduled ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "scheduled"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeAlarm     ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "alarm"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeCron      ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "cron"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeQueue     ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "queue"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeEmail     ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "email"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeTail      ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "tail"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeRpc       ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "rpc"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeWebsocket ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "websocket"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersEventTypeUnknown   ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType = "unknown"
)

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersEventType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel string
const (
	ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModelDurableObject ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel = "durableObject"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModelStateless     ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel = "stateless"
)

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersExecutionModel) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObject added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObject struct {
	EventType      ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType             `json:"eventType,required"`
	Outcome        string                                                                            `json:"outcome,required"`
	RequestID      string                                                                            `json:"requestId,required"`
	ScriptName     string                                                                            `json:"scriptName,required"`
	Entrypoint     string                                                                            `json:"entrypoint"`
	Event          map[string]ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion `json:"event"`
	ExecutionModel ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel        `json:"executionModel"`
	ScriptVersion  ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersion         `json:"scriptVersion"`
	Truncated      bool                                                                              `json:"truncated"`
	JSON           observabilityTelemetryQueryResponseEventsEventsWorkersObjectJSON                  `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsEventsWorkersObject) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMap added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMap map[string]ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMap) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion added in v4.3.0

func (r ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMap) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion()

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMap added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMap map[string]ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMap) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem added in v4.3.0

func (r ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMap) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem()

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArray added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArray []ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArrayUnionItem

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArray) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem added in v4.3.0

func (r ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArray) ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem()

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArrayUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArrayUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArrayUnionItem()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapUnionItem()
}

Union satisfied by ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMapArray, shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapUnionItem()
}

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMapMap.

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType string
const (
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeFetch     ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "fetch"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeScheduled ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "scheduled"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeAlarm     ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "alarm"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeCron      ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "cron"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeQueue     ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "queue"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeEmail     ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "email"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeTail      ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "tail"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeRpc       ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "rpc"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeWebsocket ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "websocket"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventTypeUnknown   ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType = "unknown"
)

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion interface {
	ImplementsObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectEventMap.

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel string
const (
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModelDurableObject ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel = "durableObject"
	ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModelStateless     ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel = "stateless"
)

func (ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectExecutionModel) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersion added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersion struct {
	ID      string                                                                        `json:"id"`
	Message string                                                                        `json:"message"`
	Tag     string                                                                        `json:"tag"`
	JSON    observabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersionJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsEventsWorkersObjectScriptVersion) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsEventsWorkersUnion added in v4.3.0

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

Cloudflare Workers event information enriches your logs so you can easily identify and debug issues.

Union satisfied by ObservabilityTelemetryQueryResponseEventsEventsWorkersObject or ObservabilityTelemetryQueryResponseEventsEventsWorkersObject.

type ObservabilityTelemetryQueryResponseEventsField added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsField struct {
	Key  string                                             `json:"key,required"`
	Type string                                             `json:"type,required"`
	JSON observabilityTelemetryQueryResponseEventsFieldJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsField) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEventsSeriesData added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsSeriesData struct {
	Aggregates     ObservabilityTelemetryQueryResponseEventsSeriesDataAggregates `json:"aggregates,required"`
	Count          float64                                                       `json:"count,required"`
	Interval       float64                                                       `json:"interval,required"`
	SampleInterval float64                                                       `json:"sampleInterval,required"`
	Errors         float64                                                       `json:"errors"`
	// Groups in the query results.
	Groups map[string]ObservabilityTelemetryQueryResponseEventsSeriesDataGroupsUnion `json:"groups"`
	JSON   observabilityTelemetryQueryResponseEventsSeriesDataJSON                   `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsSeriesData) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseEventsSeriesDataAggregates added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsSeriesDataAggregates struct {
	// Deprecated: deprecated
	Count int64 `json:"_count,required"`
	// Deprecated: deprecated
	FirstSeen string `json:"_firstSeen,required"`
	// Deprecated: deprecated
	Interval int64 `json:"_interval,required"`
	// Deprecated: deprecated
	LastSeen string `json:"_lastSeen,required"`
	// Deprecated: deprecated
	Bin  interface{}                                                       `json:"bin"`
	JSON observabilityTelemetryQueryResponseEventsSeriesDataAggregatesJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsSeriesDataAggregates) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsSeriesDataGroupsUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsSeriesDataGroupsUnion interface {
	ImplementsObservabilityTelemetryQueryResponseEventsSeriesDataGroupsUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseEventsSery added in v4.3.0

type ObservabilityTelemetryQueryResponseEventsSery struct {
	Data []ObservabilityTelemetryQueryResponseEventsSeriesData `json:"data,required"`
	Time string                                                `json:"time,required"`
	JSON observabilityTelemetryQueryResponseEventsSeryJSON     `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseEventsSery) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseInvocation added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocation struct {
	Metadata  ObservabilityTelemetryQueryResponseInvocationsMetadata `json:"$metadata,required"`
	Dataset   string                                                 `json:"dataset,required"`
	Source    interface{}                                            `json:"source,required"`
	Timestamp int64                                                  `json:"timestamp,required"`
	// Cloudflare Workers event information enriches your logs so you can easily
	// identify and debug issues.
	Workers ObservabilityTelemetryQueryResponseInvocationsWorkers `json:"$workers"`
	JSON    observabilityTelemetryQueryResponseInvocationJSON     `json:"-"`
}

The data structure of a telemetry event

func (*ObservabilityTelemetryQueryResponseInvocation) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseInvocationsMetadata added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsMetadata struct {
	ID              string                                                     `json:"id,required"`
	Account         string                                                     `json:"account"`
	CloudService    string                                                     `json:"cloudService"`
	ColdStart       int64                                                      `json:"coldStart"`
	Cost            int64                                                      `json:"cost"`
	Duration        int64                                                      `json:"duration"`
	EndTime         int64                                                      `json:"endTime"`
	Error           string                                                     `json:"error"`
	ErrorTemplate   string                                                     `json:"errorTemplate"`
	Fingerprint     string                                                     `json:"fingerprint"`
	Level           string                                                     `json:"level"`
	Message         string                                                     `json:"message"`
	MessageTemplate string                                                     `json:"messageTemplate"`
	MetricName      string                                                     `json:"metricName"`
	Origin          string                                                     `json:"origin"`
	ParentSpanID    string                                                     `json:"parentSpanId"`
	Provider        string                                                     `json:"provider"`
	Region          string                                                     `json:"region"`
	RequestID       string                                                     `json:"requestId"`
	Service         string                                                     `json:"service"`
	SpanID          string                                                     `json:"spanId"`
	SpanName        string                                                     `json:"spanName"`
	StackID         string                                                     `json:"stackId"`
	StartTime       int64                                                      `json:"startTime"`
	StatusCode      int64                                                      `json:"statusCode"`
	TraceDuration   int64                                                      `json:"traceDuration"`
	TraceID         string                                                     `json:"traceId"`
	Trigger         string                                                     `json:"trigger"`
	Type            string                                                     `json:"type"`
	URL             string                                                     `json:"url"`
	JSON            observabilityTelemetryQueryResponseInvocationsMetadataJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseInvocationsMetadata) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseInvocationsWorkers added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkers struct {
	EventType  ObservabilityTelemetryQueryResponseInvocationsWorkersEventType `json:"eventType,required"`
	Outcome    string                                                         `json:"outcome,required"`
	RequestID  string                                                         `json:"requestId,required"`
	ScriptName string                                                         `json:"scriptName,required"`
	CPUTimeMs  float64                                                        `json:"cpuTimeMs"`
	// This field can have the runtime type of
	// [[]ObservabilityTelemetryQueryResponseInvocationsWorkersObjectDiagnosticsChannelEvent].
	DiagnosticsChannelEvents interface{} `json:"diagnosticsChannelEvents"`
	DispatchNamespace        string      `json:"dispatchNamespace"`
	Entrypoint               string      `json:"entrypoint"`
	// This field can have the runtime type of
	// [map[string]ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion].
	Event          interface{}                                                         `json:"event"`
	ExecutionModel ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel `json:"executionModel"`
	// This field can have the runtime type of
	// [ObservabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersion].
	ScriptVersion interface{}                                               `json:"scriptVersion"`
	Truncated     bool                                                      `json:"truncated"`
	WallTimeMs    float64                                                   `json:"wallTimeMs"`
	JSON          observabilityTelemetryQueryResponseInvocationsWorkersJSON `json:"-"`
	// contains filtered or unexported fields
}

Cloudflare Workers event information enriches your logs so you can easily identify and debug issues.

func (ObservabilityTelemetryQueryResponseInvocationsWorkers) AsUnion added in v4.3.0

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

Possible runtime types of the union are ObservabilityTelemetryQueryResponseInvocationsWorkersObject, ObservabilityTelemetryQueryResponseInvocationsWorkersObject.

func (*ObservabilityTelemetryQueryResponseInvocationsWorkers) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseInvocationsWorkersEventType added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersEventType string
const (
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeFetch     ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "fetch"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeScheduled ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "scheduled"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeAlarm     ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "alarm"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeCron      ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "cron"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeQueue     ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "queue"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeEmail     ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "email"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeTail      ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "tail"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeRpc       ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "rpc"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeWebsocket ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "websocket"
	ObservabilityTelemetryQueryResponseInvocationsWorkersEventTypeUnknown   ObservabilityTelemetryQueryResponseInvocationsWorkersEventType = "unknown"
)

func (ObservabilityTelemetryQueryResponseInvocationsWorkersEventType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel string
const (
	ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModelDurableObject ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel = "durableObject"
	ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModelStateless     ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel = "stateless"
)

func (ObservabilityTelemetryQueryResponseInvocationsWorkersExecutionModel) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObject added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObject struct {
	EventType      ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType             `json:"eventType,required"`
	Outcome        string                                                                           `json:"outcome,required"`
	RequestID      string                                                                           `json:"requestId,required"`
	ScriptName     string                                                                           `json:"scriptName,required"`
	Entrypoint     string                                                                           `json:"entrypoint"`
	Event          map[string]ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion `json:"event"`
	ExecutionModel ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel        `json:"executionModel"`
	ScriptVersion  ObservabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersion         `json:"scriptVersion"`
	Truncated      bool                                                                             `json:"truncated"`
	JSON           observabilityTelemetryQueryResponseInvocationsWorkersObjectJSON                  `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseInvocationsWorkersObject) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMap added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMap map[string]ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem

func (ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMap) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion added in v4.3.0

func (r ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMap) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion()

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMap added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMap map[string]ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem

func (ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMap) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem added in v4.3.0

func (r ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMap) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem()

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArray added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArray []ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArrayUnionItem

func (ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArray) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem added in v4.3.0

func (r ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArray) ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem()

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArrayUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArrayUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArrayUnionItem()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapUnionItem()
}

Union satisfied by ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMapArray, shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem interface {
	ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapUnionItem()
}

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMapMap.

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType string
const (
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeFetch     ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "fetch"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeScheduled ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "scheduled"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeAlarm     ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "alarm"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeCron      ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "cron"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeQueue     ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "queue"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeEmail     ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "email"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeTail      ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "tail"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeRpc       ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "rpc"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeWebsocket ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "websocket"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventTypeUnknown   ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType = "unknown"
)

func (ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion interface {
	ImplementsObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or ObservabilityTelemetryQueryResponseInvocationsWorkersObjectEventMap.

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel string
const (
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModelDurableObject ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel = "durableObject"
	ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModelStateless     ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel = "stateless"
)

func (ObservabilityTelemetryQueryResponseInvocationsWorkersObjectExecutionModel) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersion added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersion struct {
	ID      string                                                                       `json:"id"`
	Message string                                                                       `json:"message"`
	Tag     string                                                                       `json:"tag"`
	JSON    observabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersionJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseInvocationsWorkersObjectScriptVersion) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseInvocationsWorkersUnion added in v4.3.0

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

Cloudflare Workers event information enriches your logs so you can easily identify and debug issues.

Union satisfied by ObservabilityTelemetryQueryResponseInvocationsWorkersObject or ObservabilityTelemetryQueryResponseInvocationsWorkersObject.

type ObservabilityTelemetryQueryResponsePattern added in v4.3.0

type ObservabilityTelemetryQueryResponsePattern struct {
	Count   float64                                           `json:"count,required"`
	Pattern string                                            `json:"pattern,required"`
	Series  []ObservabilityTelemetryQueryResponsePatternsSery `json:"series,required"`
	Service string                                            `json:"service,required"`
	JSON    observabilityTelemetryQueryResponsePatternJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponsePattern) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponsePatternsSeriesData added in v4.3.0

type ObservabilityTelemetryQueryResponsePatternsSeriesData struct {
	Count          float64                                                      `json:"count,required"`
	Interval       float64                                                      `json:"interval,required"`
	SampleInterval float64                                                      `json:"sampleInterval,required"`
	Value          float64                                                      `json:"value,required"`
	Groups         []ObservabilityTelemetryQueryResponsePatternsSeriesDataGroup `json:"groups"`
	JSON           observabilityTelemetryQueryResponsePatternsSeriesDataJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponsePatternsSeriesData) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponsePatternsSeriesDataGroup added in v4.3.0

type ObservabilityTelemetryQueryResponsePatternsSeriesDataGroup struct {
	Key   string                                                                `json:"key,required"`
	Value ObservabilityTelemetryQueryResponsePatternsSeriesDataGroupsValueUnion `json:"value,required"`
	JSON  observabilityTelemetryQueryResponsePatternsSeriesDataGroupJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponsePatternsSeriesDataGroup) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponsePatternsSeriesDataGroupsValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponsePatternsSeriesDataGroupsValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponsePatternsSeriesDataGroupsValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponsePatternsSery added in v4.3.0

type ObservabilityTelemetryQueryResponsePatternsSery struct {
	Data ObservabilityTelemetryQueryResponsePatternsSeriesData `json:"data,required"`
	Time string                                                `json:"time,required"`
	JSON observabilityTelemetryQueryResponsePatternsSeryJSON   `json:"-"`
}

func (*ObservabilityTelemetryQueryResponsePatternsSery) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseRun added in v4.3.0

type ObservabilityTelemetryQueryResponseRun struct {
	ID        string `json:"id,required"`
	AccountID string `json:"accountId,required"`
	Dry       bool   `json:"dry,required"`
	// Deprecated: deprecated
	EnvironmentID string                                          `json:"environmentId,required"`
	Granularity   float64                                         `json:"granularity,required"`
	Query         ObservabilityTelemetryQueryResponseRunQuery     `json:"query,required"`
	Status        ObservabilityTelemetryQueryResponseRunStatus    `json:"status,required"`
	Timeframe     ObservabilityTelemetryQueryResponseRunTimeframe `json:"timeframe,required"`
	UserID        string                                          `json:"userId,required"`
	// Deprecated: deprecated
	WorkspaceID string                                           `json:"workspaceId,required"`
	Created     string                                           `json:"created"`
	Statistics  ObservabilityTelemetryQueryResponseRunStatistics `json:"statistics"`
	Updated     string                                           `json:"updated"`
	JSON        observabilityTelemetryQueryResponseRunJSON       `json:"-"`
}

A Workers Observability Query Object

func (*ObservabilityTelemetryQueryResponseRun) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseRunQuery added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQuery struct {
	// ID of the query
	ID          string `json:"id,required"`
	Created     string `json:"created,required"`
	Description string `json:"description,required,nullable"`
	// ID of your environment
	EnvironmentID string `json:"environmentId,required"`
	// Flag for alerts automatically created
	Generated bool `json:"generated,required,nullable"`
	// Query name
	Name       string                                                `json:"name,required,nullable"`
	Parameters ObservabilityTelemetryQueryResponseRunQueryParameters `json:"parameters,required"`
	Updated    string                                                `json:"updated,required"`
	UserID     string                                                `json:"userId,required"`
	// ID of your workspace
	WorkspaceID string                                          `json:"workspaceId,required"`
	JSON        observabilityTelemetryQueryResponseRunQueryJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQuery) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseRunQueryParameters added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParameters struct {
	// Create Calculations to compute as part of the query.
	Calculations []ObservabilityTelemetryQueryResponseRunQueryParametersCalculation `json:"calculations"`
	// Set the Datasets to query. Leave it empty to query all the datasets.
	Datasets []string `json:"datasets"`
	// Set a Flag to describe how to combine the filters on the query.
	FilterCombination ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination `json:"filterCombination"`
	// Configure the Filters to apply to the query.
	Filters []ObservabilityTelemetryQueryResponseRunQueryParametersFilter `json:"filters"`
	// Define how to group the results of the query.
	GroupBys []ObservabilityTelemetryQueryResponseRunQueryParametersGroupBy `json:"groupBys"`
	// Configure the Having clauses that filter on calculations in the query result.
	Havings []ObservabilityTelemetryQueryResponseRunQueryParametersHaving `json:"havings"`
	// Set a limit on the number of results / records returned by the query
	Limit int64 `json:"limit"`
	// Define an expression to search using full-text search.
	Needle ObservabilityTelemetryQueryResponseRunQueryParametersNeedle `json:"needle"`
	// Configure the order of the results returned by the query.
	OrderBy ObservabilityTelemetryQueryResponseRunQueryParametersOrderBy `json:"orderBy"`
	JSON    observabilityTelemetryQueryResponseRunQueryParametersJSON    `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQueryParameters) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculation added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculation struct {
	Operator ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator `json:"operator,required"`
	Alias    string                                                                    `json:"alias"`
	Key      string                                                                    `json:"key"`
	KeyType  ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType  `json:"keyType"`
	JSON     observabilityTelemetryQueryResponseRunQueryParametersCalculationJSON      `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQueryParametersCalculation) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyTypeString  ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType = "string"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyTypeNumber  ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType = "number"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyTypeBoolean ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType = "boolean"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsKeyType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorUniq              ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "uniq"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorCount             ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "count"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMax               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "max"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMin               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "min"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorSum               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "sum"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorAvg               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "avg"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMedian            ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "median"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP001              ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p001"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP01               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p01"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP05               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p05"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP10               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p10"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP25               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p25"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP75               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p75"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP90               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p90"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP95               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p95"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP99               ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p99"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP999              ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "p999"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorStddev            ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "stddev"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorVariance          ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "variance"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorCountDistinct     ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "COUNT_DISTINCT"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorCountUppercase    ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "COUNT"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMaxUppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "MAX"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMinUppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "MIN"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorSumUppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "SUM"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorAvgUppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "AVG"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorMedianUppercase   ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "MEDIAN"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP001Uppercase     ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P001"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP01Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P01"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP05Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P05"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP10Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P10"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP25Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P25"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP75Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P75"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP90Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P90"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP95Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P95"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP99Uppercase      ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P99"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorP999Uppercase     ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "P999"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorStddevUppercase   ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "STDDEV"
	ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperatorVarianceUppercase ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator = "VARIANCE"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersCalculationsOperator) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFilter added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFilter struct {
	Key       string                                                                 `json:"key,required"`
	Operation ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation  `json:"operation,required"`
	Type      ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType       `json:"type,required"`
	Value     ObservabilityTelemetryQueryResponseRunQueryParametersFiltersValueUnion `json:"value"`
	JSON      observabilityTelemetryQueryResponseRunQueryParametersFilterJSON        `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQueryParametersFilter) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination string

Set a Flag to describe how to combine the filters on the query.

const (
	ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombinationAnd          ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination = "and"
	ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombinationOr           ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination = "or"
	ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombinationAndUppercase ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination = "AND"
	ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombinationOrUppercase  ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination = "OR"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersFilterCombination) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationIncludes            ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "includes"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationNotIncludes         ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "not_includes"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationStartsWith          ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "starts_with"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationRegex               ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "regex"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationExists              ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "exists"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationIsNull              ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "is_null"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationIn                  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "in"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationNotIn               ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "not_in"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationEq                  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "eq"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationNeq                 ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "neq"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationGt                  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "gt"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationGte                 ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "gte"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationLt                  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "lt"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationLte                 ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "lte"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationEquals              ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "="
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationNotEquals           ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "!="
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationGreater             ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = ">"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationGreaterOrEquals     ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = ">="
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationLess                ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "<"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationLessOrEquals        ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "<="
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationIncludesUppercase   ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "INCLUDES"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationDoesNotInclude      ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "DOES_NOT_INCLUDE"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationMatchRegex          ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "MATCH_REGEX"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationExistsUppercase     ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "EXISTS"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationDoesNotExist        ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "DOES_NOT_EXIST"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationInUppercase         ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "IN"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationNotInUppercase      ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "NOT_IN"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperationStartsWithUppercase ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation = "STARTS_WITH"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersFiltersOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersTypeString  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType = "string"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersTypeNumber  ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType = "number"
	ObservabilityTelemetryQueryResponseRunQueryParametersFiltersTypeBoolean ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType = "boolean"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersFiltersType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersFiltersValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseRunQueryParametersFiltersValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseRunQueryParametersGroupBy added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersGroupBy struct {
	Type  ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType `json:"type,required"`
	Value string                                                            `json:"value,required"`
	JSON  observabilityTelemetryQueryResponseRunQueryParametersGroupByJSON  `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQueryParametersGroupBy) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysTypeString  ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType = "string"
	ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysTypeNumber  ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType = "number"
	ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysTypeBoolean ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType = "boolean"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersGroupBysType) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersHaving added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersHaving struct {
	Key       string                                                                `json:"key,required"`
	Operation ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation `json:"operation,required"`
	Value     float64                                                               `json:"value,required"`
	JSON      observabilityTelemetryQueryResponseRunQueryParametersHavingJSON       `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunQueryParametersHaving) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation string
const (
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationEq  ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "eq"
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationNeq ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "neq"
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationGt  ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "gt"
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationGte ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "gte"
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationLt  ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "lt"
	ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperationLte ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation = "lte"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersHavingsOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersNeedle added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersNeedle struct {
	Value     ObservabilityTelemetryQueryResponseRunQueryParametersNeedleValueUnion `json:"value,required"`
	IsRegex   bool                                                                  `json:"isRegex"`
	MatchCase bool                                                                  `json:"matchCase"`
	JSON      observabilityTelemetryQueryResponseRunQueryParametersNeedleJSON       `json:"-"`
}

Define an expression to search using full-text search.

func (*ObservabilityTelemetryQueryResponseRunQueryParametersNeedle) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersNeedleValueUnion added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersNeedleValueUnion interface {
	ImplementsObservabilityTelemetryQueryResponseRunQueryParametersNeedleValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

type ObservabilityTelemetryQueryResponseRunQueryParametersOrderBy added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersOrderBy struct {
	// Configure which Calculation to order the results by.
	Value string `json:"value,required"`
	// Set the order of the results
	Order ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder `json:"order"`
	JSON  observabilityTelemetryQueryResponseRunQueryParametersOrderByJSON  `json:"-"`
}

Configure the order of the results returned by the query.

func (*ObservabilityTelemetryQueryResponseRunQueryParametersOrderBy) UnmarshalJSON added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder added in v4.3.0

type ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder string

Set the order of the results

const (
	ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrderAsc  ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder = "asc"
	ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrderDesc ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder = "desc"
)

func (ObservabilityTelemetryQueryResponseRunQueryParametersOrderByOrder) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunStatistics added in v4.3.0

type ObservabilityTelemetryQueryResponseRunStatistics struct {
	// Number of uncompressed bytes read from the table.
	BytesRead float64 `json:"bytes_read,required"`
	// Time in seconds for the query to run.
	Elapsed float64 `json:"elapsed,required"`
	// Number of rows scanned from the table.
	RowsRead float64                                              `json:"rows_read,required"`
	JSON     observabilityTelemetryQueryResponseRunStatisticsJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunStatistics) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseRunStatus added in v4.3.0

type ObservabilityTelemetryQueryResponseRunStatus string
const (
	ObservabilityTelemetryQueryResponseRunStatusStarted   ObservabilityTelemetryQueryResponseRunStatus = "STARTED"
	ObservabilityTelemetryQueryResponseRunStatusCompleted ObservabilityTelemetryQueryResponseRunStatus = "COMPLETED"
)

func (ObservabilityTelemetryQueryResponseRunStatus) IsKnown added in v4.3.0

type ObservabilityTelemetryQueryResponseRunTimeframe added in v4.3.0

type ObservabilityTelemetryQueryResponseRunTimeframe struct {
	// Set the start time for your query using UNIX time in milliseconds.
	From float64 `json:"from,required"`
	// Set the end time for your query using UNIX time in milliseconds.
	To   float64                                             `json:"to,required"`
	JSON observabilityTelemetryQueryResponseRunTimeframeJSON `json:"-"`
}

func (*ObservabilityTelemetryQueryResponseRunTimeframe) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryQueryResponseStatistics added in v4.3.0

type ObservabilityTelemetryQueryResponseStatistics struct {
	// Number of uncompressed bytes read from the table.
	BytesRead float64 `json:"bytes_read,required"`
	// Time in seconds for the query to run.
	Elapsed float64 `json:"elapsed,required"`
	// Number of rows scanned from the table.
	RowsRead float64                                           `json:"rows_read,required"`
	JSON     observabilityTelemetryQueryResponseStatisticsJSON `json:"-"`
}

The statistics object contains information about query performance from the database, it does not include any network latency

func (*ObservabilityTelemetryQueryResponseStatistics) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryService added in v4.3.0

type ObservabilityTelemetryService struct {
	Options []option.RequestOption
}

ObservabilityTelemetryService 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 NewObservabilityTelemetryService method instead.

func NewObservabilityTelemetryService added in v4.3.0

func NewObservabilityTelemetryService(opts ...option.RequestOption) (r *ObservabilityTelemetryService)

NewObservabilityTelemetryService 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 (*ObservabilityTelemetryService) Keys added in v4.3.0

List all the keys in your telemetry events.

func (*ObservabilityTelemetryService) KeysAutoPaging added in v4.3.0

List all the keys in your telemetry events.

func (*ObservabilityTelemetryService) Query added in v4.3.0

Runs a temporary or saved query

func (*ObservabilityTelemetryService) Values added in v4.3.0

List unique values found in your events

func (*ObservabilityTelemetryService) ValuesAutoPaging added in v4.3.0

List unique values found in your events

type ObservabilityTelemetryValuesParams added in v4.3.0

type ObservabilityTelemetryValuesParams struct {
	AccountID param.Field[string]                                      `path:"account_id,required"`
	Datasets  param.Field[[]string]                                    `json:"datasets,required"`
	Key       param.Field[string]                                      `json:"key,required"`
	Timeframe param.Field[ObservabilityTelemetryValuesParamsTimeframe] `json:"timeframe,required"`
	Type      param.Field[ObservabilityTelemetryValuesParamsType]      `json:"type,required"`
	Filters   param.Field[[]ObservabilityTelemetryValuesParamsFilter]  `json:"filters"`
	Limit     param.Field[float64]                                     `json:"limit"`
	// Search for a specific substring in the event.
	Needle param.Field[ObservabilityTelemetryValuesParamsNeedle] `json:"needle"`
}

func (ObservabilityTelemetryValuesParams) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryValuesParamsFilter added in v4.3.0

type ObservabilityTelemetryValuesParamsFilter struct {
	Key       param.Field[string]                                              `json:"key,required"`
	Operation param.Field[ObservabilityTelemetryValuesParamsFiltersOperation]  `json:"operation,required"`
	Type      param.Field[ObservabilityTelemetryValuesParamsFiltersType]       `json:"type,required"`
	Value     param.Field[ObservabilityTelemetryValuesParamsFiltersValueUnion] `json:"value"`
}

func (ObservabilityTelemetryValuesParamsFilter) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryValuesParamsFiltersOperation added in v4.3.0

type ObservabilityTelemetryValuesParamsFiltersOperation string
const (
	ObservabilityTelemetryValuesParamsFiltersOperationIncludes            ObservabilityTelemetryValuesParamsFiltersOperation = "includes"
	ObservabilityTelemetryValuesParamsFiltersOperationNotIncludes         ObservabilityTelemetryValuesParamsFiltersOperation = "not_includes"
	ObservabilityTelemetryValuesParamsFiltersOperationStartsWith          ObservabilityTelemetryValuesParamsFiltersOperation = "starts_with"
	ObservabilityTelemetryValuesParamsFiltersOperationRegex               ObservabilityTelemetryValuesParamsFiltersOperation = "regex"
	ObservabilityTelemetryValuesParamsFiltersOperationExists              ObservabilityTelemetryValuesParamsFiltersOperation = "exists"
	ObservabilityTelemetryValuesParamsFiltersOperationIsNull              ObservabilityTelemetryValuesParamsFiltersOperation = "is_null"
	ObservabilityTelemetryValuesParamsFiltersOperationIn                  ObservabilityTelemetryValuesParamsFiltersOperation = "in"
	ObservabilityTelemetryValuesParamsFiltersOperationNotIn               ObservabilityTelemetryValuesParamsFiltersOperation = "not_in"
	ObservabilityTelemetryValuesParamsFiltersOperationEq                  ObservabilityTelemetryValuesParamsFiltersOperation = "eq"
	ObservabilityTelemetryValuesParamsFiltersOperationNeq                 ObservabilityTelemetryValuesParamsFiltersOperation = "neq"
	ObservabilityTelemetryValuesParamsFiltersOperationGt                  ObservabilityTelemetryValuesParamsFiltersOperation = "gt"
	ObservabilityTelemetryValuesParamsFiltersOperationGte                 ObservabilityTelemetryValuesParamsFiltersOperation = "gte"
	ObservabilityTelemetryValuesParamsFiltersOperationLt                  ObservabilityTelemetryValuesParamsFiltersOperation = "lt"
	ObservabilityTelemetryValuesParamsFiltersOperationLte                 ObservabilityTelemetryValuesParamsFiltersOperation = "lte"
	ObservabilityTelemetryValuesParamsFiltersOperationEquals              ObservabilityTelemetryValuesParamsFiltersOperation = "="
	ObservabilityTelemetryValuesParamsFiltersOperationNotEquals           ObservabilityTelemetryValuesParamsFiltersOperation = "!="
	ObservabilityTelemetryValuesParamsFiltersOperationGreater             ObservabilityTelemetryValuesParamsFiltersOperation = ">"
	ObservabilityTelemetryValuesParamsFiltersOperationGreaterOrEquals     ObservabilityTelemetryValuesParamsFiltersOperation = ">="
	ObservabilityTelemetryValuesParamsFiltersOperationLess                ObservabilityTelemetryValuesParamsFiltersOperation = "<"
	ObservabilityTelemetryValuesParamsFiltersOperationLessOrEquals        ObservabilityTelemetryValuesParamsFiltersOperation = "<="
	ObservabilityTelemetryValuesParamsFiltersOperationIncludesUppercase   ObservabilityTelemetryValuesParamsFiltersOperation = "INCLUDES"
	ObservabilityTelemetryValuesParamsFiltersOperationDoesNotInclude      ObservabilityTelemetryValuesParamsFiltersOperation = "DOES_NOT_INCLUDE"
	ObservabilityTelemetryValuesParamsFiltersOperationMatchRegex          ObservabilityTelemetryValuesParamsFiltersOperation = "MATCH_REGEX"
	ObservabilityTelemetryValuesParamsFiltersOperationExistsUppercase     ObservabilityTelemetryValuesParamsFiltersOperation = "EXISTS"
	ObservabilityTelemetryValuesParamsFiltersOperationDoesNotExist        ObservabilityTelemetryValuesParamsFiltersOperation = "DOES_NOT_EXIST"
	ObservabilityTelemetryValuesParamsFiltersOperationInUppercase         ObservabilityTelemetryValuesParamsFiltersOperation = "IN"
	ObservabilityTelemetryValuesParamsFiltersOperationNotInUppercase      ObservabilityTelemetryValuesParamsFiltersOperation = "NOT_IN"
	ObservabilityTelemetryValuesParamsFiltersOperationStartsWithUppercase ObservabilityTelemetryValuesParamsFiltersOperation = "STARTS_WITH"
)

func (ObservabilityTelemetryValuesParamsFiltersOperation) IsKnown added in v4.3.0

type ObservabilityTelemetryValuesParamsFiltersType added in v4.3.0

type ObservabilityTelemetryValuesParamsFiltersType string
const (
	ObservabilityTelemetryValuesParamsFiltersTypeString  ObservabilityTelemetryValuesParamsFiltersType = "string"
	ObservabilityTelemetryValuesParamsFiltersTypeNumber  ObservabilityTelemetryValuesParamsFiltersType = "number"
	ObservabilityTelemetryValuesParamsFiltersTypeBoolean ObservabilityTelemetryValuesParamsFiltersType = "boolean"
)

func (ObservabilityTelemetryValuesParamsFiltersType) IsKnown added in v4.3.0

type ObservabilityTelemetryValuesParamsFiltersValueUnion added in v4.3.0

type ObservabilityTelemetryValuesParamsFiltersValueUnion interface {
	ImplementsObservabilityTelemetryValuesParamsFiltersValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryValuesParamsNeedle added in v4.3.0

type ObservabilityTelemetryValuesParamsNeedle struct {
	Value     param.Field[ObservabilityTelemetryValuesParamsNeedleValueUnion] `json:"value,required"`
	IsRegex   param.Field[bool]                                               `json:"isRegex"`
	MatchCase param.Field[bool]                                               `json:"matchCase"`
}

Search for a specific substring in the event.

func (ObservabilityTelemetryValuesParamsNeedle) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryValuesParamsNeedleValueUnion added in v4.3.0

type ObservabilityTelemetryValuesParamsNeedleValueUnion interface {
	ImplementsObservabilityTelemetryValuesParamsNeedleValueUnion()
}

Satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool.

type ObservabilityTelemetryValuesParamsTimeframe added in v4.3.0

type ObservabilityTelemetryValuesParamsTimeframe struct {
	From param.Field[float64] `json:"from,required"`
	To   param.Field[float64] `json:"to,required"`
}

func (ObservabilityTelemetryValuesParamsTimeframe) MarshalJSON added in v4.3.0

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

type ObservabilityTelemetryValuesParamsType added in v4.3.0

type ObservabilityTelemetryValuesParamsType string
const (
	ObservabilityTelemetryValuesParamsTypeString  ObservabilityTelemetryValuesParamsType = "string"
	ObservabilityTelemetryValuesParamsTypeBoolean ObservabilityTelemetryValuesParamsType = "boolean"
	ObservabilityTelemetryValuesParamsTypeNumber  ObservabilityTelemetryValuesParamsType = "number"
)

func (ObservabilityTelemetryValuesParamsType) IsKnown added in v4.3.0

type ObservabilityTelemetryValuesResponse added in v4.3.0

type ObservabilityTelemetryValuesResponse struct {
	Dataset string                                         `json:"dataset,required"`
	Key     string                                         `json:"key,required"`
	Type    ObservabilityTelemetryValuesResponseType       `json:"type,required"`
	Value   ObservabilityTelemetryValuesResponseValueUnion `json:"value,required"`
	JSON    observabilityTelemetryValuesResponseJSON       `json:"-"`
}

func (*ObservabilityTelemetryValuesResponse) UnmarshalJSON added in v4.3.0

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

type ObservabilityTelemetryValuesResponseType added in v4.3.0

type ObservabilityTelemetryValuesResponseType string
const (
	ObservabilityTelemetryValuesResponseTypeString  ObservabilityTelemetryValuesResponseType = "string"
	ObservabilityTelemetryValuesResponseTypeBoolean ObservabilityTelemetryValuesResponseType = "boolean"
	ObservabilityTelemetryValuesResponseTypeNumber  ObservabilityTelemetryValuesResponseType = "number"
)

func (ObservabilityTelemetryValuesResponseType) IsKnown added in v4.3.0

type ObservabilityTelemetryValuesResponseValueUnion added in v4.3.0

type ObservabilityTelemetryValuesResponseValueUnion interface {
	ImplementsObservabilityTelemetryValuesResponseValueUnion()
}

Union satisfied by shared.UnionString, shared.UnionFloat or shared.UnionBool.

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 RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0

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

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 RouteDeleteParams

type RouteDeleteParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RouteDeleteResponse

type RouteDeleteResponse struct {
	// Identifier.
	ID   string                  `json:"id"`
	JSON routeDeleteResponseJSON `json:"-"`
}

func (*RouteDeleteResponse) UnmarshalJSON

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

type RouteDeleteResponseEnvelope added in v4.3.0

type RouteDeleteResponseEnvelope struct {
	Errors   []RouteDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RouteDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   RouteDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success RouteDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    routeDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*RouteDeleteResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type RouteDeleteResponseEnvelopeErrors added in v4.3.0

type RouteDeleteResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           RouteDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             routeDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RouteDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type RouteDeleteResponseEnvelopeErrorsSource added in v4.3.0

type RouteDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    routeDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RouteDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type RouteDeleteResponseEnvelopeMessages added in v4.3.0

type RouteDeleteResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           RouteDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             routeDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RouteDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type RouteDeleteResponseEnvelopeMessagesSource added in v4.3.0

type RouteDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    routeDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RouteDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type RouteDeleteResponseEnvelopeSuccess added in v4.3.0

type RouteDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RouteDeleteResponseEnvelopeSuccessTrue RouteDeleteResponseEnvelopeSuccess = true
)

func (RouteDeleteResponseEnvelopeSuccess) IsKnown added in v4.3.0

type RouteGetParams

type RouteGetParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RouteGetResponse

type RouteGetResponse struct {
	// Identifier.
	ID string `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern string `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script string               `json:"script,required"`
	JSON   routeGetResponseJSON `json:"-"`
}

func (*RouteGetResponse) UnmarshalJSON

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

type RouteGetResponseEnvelope

type RouteGetResponseEnvelope struct {
	Errors   []RouteGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RouteGetResponseEnvelopeMessages `json:"messages,required"`
	Result   RouteGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success RouteGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    routeGetResponseEnvelopeJSON    `json:"-"`
}

func (*RouteGetResponseEnvelope) UnmarshalJSON

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

type RouteGetResponseEnvelopeErrors added in v4.3.0

type RouteGetResponseEnvelopeErrors struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           RouteGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             routeGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RouteGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type RouteGetResponseEnvelopeErrorsSource added in v4.3.0

type RouteGetResponseEnvelopeErrorsSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    routeGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RouteGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type RouteGetResponseEnvelopeMessages added in v4.3.0

type RouteGetResponseEnvelopeMessages struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           RouteGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             routeGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RouteGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type RouteGetResponseEnvelopeMessagesSource added in v4.3.0

type RouteGetResponseEnvelopeMessagesSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    routeGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RouteGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type RouteGetResponseEnvelopeSuccess

type RouteGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RouteGetResponseEnvelopeSuccessTrue RouteGetResponseEnvelopeSuccess = true
)

func (RouteGetResponseEnvelopeSuccess) IsKnown

type RouteListParams

type RouteListParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type RouteListResponse

type RouteListResponse struct {
	// Identifier.
	ID string `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern string `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script string                `json:"script,required"`
	JSON   routeListResponseJSON `json:"-"`
}

func (*RouteListResponse) UnmarshalJSON

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

type RouteNewParams

type RouteNewParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Identifier.
	ID param.Field[string] `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern param.Field[string] `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script param.Field[string] `json:"script,required"`
}

func (RouteNewParams) MarshalJSON

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

type RouteNewResponse

type RouteNewResponse struct {
	// Identifier.
	ID string `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern string `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script string               `json:"script,required"`
	JSON   routeNewResponseJSON `json:"-"`
}

func (*RouteNewResponse) UnmarshalJSON

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

type RouteNewResponseEnvelope added in v4.3.0

type RouteNewResponseEnvelope struct {
	Errors   []RouteNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RouteNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success RouteNewResponseEnvelopeSuccess `json:"success,required"`
	Result  RouteNewResponse                `json:"result"`
	JSON    routeNewResponseEnvelopeJSON    `json:"-"`
}

func (*RouteNewResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type RouteNewResponseEnvelopeErrors added in v4.3.0

type RouteNewResponseEnvelopeErrors struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           RouteNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             routeNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RouteNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type RouteNewResponseEnvelopeErrorsSource added in v4.3.0

type RouteNewResponseEnvelopeErrorsSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    routeNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RouteNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type RouteNewResponseEnvelopeMessages added in v4.3.0

type RouteNewResponseEnvelopeMessages struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           RouteNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             routeNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RouteNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type RouteNewResponseEnvelopeMessagesSource added in v4.3.0

type RouteNewResponseEnvelopeMessagesSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    routeNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RouteNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type RouteNewResponseEnvelopeSuccess added in v4.3.0

type RouteNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RouteNewResponseEnvelopeSuccessTrue RouteNewResponseEnvelopeSuccess = true
)

func (RouteNewResponseEnvelopeSuccess) IsKnown added in v4.3.0

type RouteService

type RouteService struct {
	Options []option.RequestOption
}

RouteService 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 NewRouteService method instead.

func NewRouteService

func NewRouteService(opts ...option.RequestOption) (r *RouteService)

NewRouteService 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 (*RouteService) Delete

func (r *RouteService) Delete(ctx context.Context, routeID string, body RouteDeleteParams, opts ...option.RequestOption) (res *RouteDeleteResponse, err error)

Deletes a route.

func (*RouteService) Get

func (r *RouteService) Get(ctx context.Context, routeID string, query RouteGetParams, opts ...option.RequestOption) (res *RouteGetResponse, err error)

Returns information about a route, including URL pattern and Worker.

func (*RouteService) List

Returns routes for a zone.

func (*RouteService) ListAutoPaging

Returns routes for a zone.

func (*RouteService) New

func (r *RouteService) New(ctx context.Context, params RouteNewParams, opts ...option.RequestOption) (res *RouteNewResponse, err error)

Creates a route that maps a URL pattern to a Worker.

func (*RouteService) Update

func (r *RouteService) Update(ctx context.Context, routeID string, params RouteUpdateParams, opts ...option.RequestOption) (res *RouteUpdateResponse, err error)

Updates the URL pattern or Worker associated with a route.

type RouteUpdateParams

type RouteUpdateParams struct {
	// Identifier.
	ZoneID param.Field[string] `path:"zone_id,required"`
	// Identifier.
	ID param.Field[string] `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern param.Field[string] `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script param.Field[string] `json:"script,required"`
}

func (RouteUpdateParams) MarshalJSON

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

type RouteUpdateResponse

type RouteUpdateResponse struct {
	// Identifier.
	ID string `json:"id,required"`
	// Pattern to match incoming requests against.
	// [Learn more](https://developers.cloudflare.com/workers/configuration/routing/routes/#matching-behavior).
	Pattern string `json:"pattern,required"`
	// Name of the script to run if the route matches.
	Script string                  `json:"script,required"`
	JSON   routeUpdateResponseJSON `json:"-"`
}

func (*RouteUpdateResponse) UnmarshalJSON

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

type RouteUpdateResponseEnvelope

type RouteUpdateResponseEnvelope struct {
	Errors   []RouteUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []RouteUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   RouteUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success RouteUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    routeUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*RouteUpdateResponseEnvelope) UnmarshalJSON

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

type RouteUpdateResponseEnvelopeErrors added in v4.3.0

type RouteUpdateResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           RouteUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             routeUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*RouteUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type RouteUpdateResponseEnvelopeErrorsSource added in v4.3.0

type RouteUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    routeUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*RouteUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type RouteUpdateResponseEnvelopeMessages added in v4.3.0

type RouteUpdateResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           RouteUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             routeUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*RouteUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type RouteUpdateResponseEnvelopeMessagesSource added in v4.3.0

type RouteUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    routeUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*RouteUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type RouteUpdateResponseEnvelopeSuccess

type RouteUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	RouteUpdateResponseEnvelopeSuccessTrue RouteUpdateResponseEnvelopeSuccess = true
)

func (RouteUpdateResponseEnvelopeSuccess) IsKnown

type Script

type Script struct {
	// The id of the script in the Workers system. Usually the script name.
	ID string `json:"id"`
	// When the script was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Hashed script content, can be used in a If-None-Match header when updating.
	Etag string `json:"etag"`
	// Whether a Worker contains assets.
	HasAssets bool `json:"has_assets"`
	// Whether a Worker contains modules.
	HasModules bool `json:"has_modules"`
	// Whether Logpush is turned on for the Worker.
	Logpush bool `json:"logpush"`
	// When the script was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement ScriptPlacement `json:"placement"`
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	//
	// Deprecated: deprecated
	PlacementMode ScriptPlacementMode `json:"placement_mode"`
	// Status of
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	//
	// Deprecated: deprecated
	PlacementStatus ScriptPlacementStatus `json:"placement_status"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers []ConsumerScript `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel ScriptUsageModel `json:"usage_model"`
	JSON       scriptJSON       `json:"-"`
}

func (*Script) UnmarshalJSON

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

type ScriptAssetService

type ScriptAssetService struct {
	Options []option.RequestOption
	Upload  *ScriptAssetUploadService
}

ScriptAssetService 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 NewScriptAssetService method instead.

func NewScriptAssetService

func NewScriptAssetService(opts ...option.RequestOption) (r *ScriptAssetService)

NewScriptAssetService 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.

type ScriptAssetUploadNewParams

type ScriptAssetUploadNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// A manifest ([path]: {hash, size}) map of files to upload. As an example,
	// `/blog/hello-world.html` would be a valid path key.
	Manifest param.Field[map[string]ScriptAssetUploadNewParamsManifest] `json:"manifest,required"`
}

func (ScriptAssetUploadNewParams) MarshalJSON

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

type ScriptAssetUploadNewParamsManifest

type ScriptAssetUploadNewParamsManifest struct {
	// The hash of the file.
	Hash param.Field[string] `json:"hash,required"`
	// The size of the file in bytes.
	Size param.Field[int64] `json:"size,required"`
}

func (ScriptAssetUploadNewParamsManifest) MarshalJSON

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

type ScriptAssetUploadNewResponse

type ScriptAssetUploadNewResponse struct {
	// The requests to make to upload assets.
	Buckets [][]string `json:"buckets"`
	// A JWT to use as authentication for uploading assets.
	JWT  string                           `json:"jwt"`
	JSON scriptAssetUploadNewResponseJSON `json:"-"`
}

func (*ScriptAssetUploadNewResponse) UnmarshalJSON

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

type ScriptAssetUploadNewResponseEnvelope

type ScriptAssetUploadNewResponseEnvelope struct {
	Errors   []ScriptAssetUploadNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptAssetUploadNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptAssetUploadNewResponseEnvelopeSuccess `json:"success,required"`
	Result  ScriptAssetUploadNewResponse                `json:"result"`
	JSON    scriptAssetUploadNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptAssetUploadNewResponseEnvelope) UnmarshalJSON

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

type ScriptAssetUploadNewResponseEnvelopeErrors added in v4.3.0

type ScriptAssetUploadNewResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptAssetUploadNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptAssetUploadNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptAssetUploadNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptAssetUploadNewResponseEnvelopeErrorsSource added in v4.3.0

type ScriptAssetUploadNewResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptAssetUploadNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptAssetUploadNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptAssetUploadNewResponseEnvelopeMessages added in v4.3.0

type ScriptAssetUploadNewResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ScriptAssetUploadNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptAssetUploadNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptAssetUploadNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptAssetUploadNewResponseEnvelopeMessagesSource added in v4.3.0

type ScriptAssetUploadNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    scriptAssetUploadNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptAssetUploadNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptAssetUploadNewResponseEnvelopeSuccess

type ScriptAssetUploadNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptAssetUploadNewResponseEnvelopeSuccessTrue ScriptAssetUploadNewResponseEnvelopeSuccess = true
)

func (ScriptAssetUploadNewResponseEnvelopeSuccess) IsKnown

type ScriptAssetUploadService

type ScriptAssetUploadService struct {
	Options []option.RequestOption
}

ScriptAssetUploadService 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 NewScriptAssetUploadService method instead.

func NewScriptAssetUploadService

func NewScriptAssetUploadService(opts ...option.RequestOption) (r *ScriptAssetUploadService)

NewScriptAssetUploadService 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 (*ScriptAssetUploadService) New

Start uploading a collection of assets for use in a Worker version. To learn more about the direct uploads of assets, see https://developers.cloudflare.com/workers/static-assets/direct-upload/.

type ScriptContentGetParams

type ScriptContentGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptContentService

type ScriptContentService struct {
	Options []option.RequestOption
}

ScriptContentService 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 NewScriptContentService method instead.

func NewScriptContentService

func NewScriptContentService(opts ...option.RequestOption) (r *ScriptContentService)

NewScriptContentService 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 (*ScriptContentService) Get

func (r *ScriptContentService) Get(ctx context.Context, scriptName string, query ScriptContentGetParams, opts ...option.RequestOption) (res *http.Response, err error)

Fetch script content only.

func (*ScriptContentService) Update

func (r *ScriptContentService) Update(ctx context.Context, scriptName string, params ScriptContentUpdateParams, opts ...option.RequestOption) (res *Script, err error)

Put script content without touching config or metadata.

type ScriptContentUpdateParams

type ScriptContentUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// JSON encoded metadata about the uploaded parts and Worker configuration.
	Metadata               param.Field[WorkerMetadataParam] `json:"metadata,required"`
	CfWorkerBodyPart       param.Field[string]              `header:"CF-WORKER-BODY-PART"`
	CfWorkerMainModulePart param.Field[string]              `header:"CF-WORKER-MAIN-MODULE-PART"`
}

func (ScriptContentUpdateParams) MarshalMultipart

func (r ScriptContentUpdateParams) MarshalMultipart() (data []byte, contentType string, err error)

type ScriptContentUpdateResponseEnvelope

type ScriptContentUpdateResponseEnvelope struct {
	Errors   []ScriptContentUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptContentUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   Script                                        `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptContentUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptContentUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptContentUpdateResponseEnvelope) UnmarshalJSON

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

type ScriptContentUpdateResponseEnvelopeErrors added in v4.3.0

type ScriptContentUpdateResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ScriptContentUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptContentUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptContentUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptContentUpdateResponseEnvelopeErrorsSource added in v4.3.0

type ScriptContentUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    scriptContentUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptContentUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptContentUpdateResponseEnvelopeMessages added in v4.3.0

type ScriptContentUpdateResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ScriptContentUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptContentUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptContentUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptContentUpdateResponseEnvelopeMessagesSource added in v4.3.0

type ScriptContentUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    scriptContentUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptContentUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptContentUpdateResponseEnvelopeSuccess

type ScriptContentUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptContentUpdateResponseEnvelopeSuccessTrue ScriptContentUpdateResponseEnvelopeSuccess = true
)

func (ScriptContentUpdateResponseEnvelopeSuccess) IsKnown

type ScriptDeleteParams

type ScriptDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// If set to true, delete will not be stopped by associated service binding,
	// durable object, or other binding. Any of these associated bindings/durable
	// objects will be deleted along with the script.
	Force param.Field[bool] `query:"force"`
}

func (ScriptDeleteParams) URLQuery

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

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

type ScriptDeleteResponse added in v4.4.0

type ScriptDeleteResponse = interface{}

type ScriptDeleteResponseEnvelope added in v4.4.0

type ScriptDeleteResponseEnvelope struct {
	Errors   []ScriptDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  ScriptDeleteResponse                `json:"result,nullable"`
	JSON    scriptDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptDeleteResponseEnvelope) UnmarshalJSON added in v4.4.0

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

type ScriptDeleteResponseEnvelopeErrors added in v4.4.0

type ScriptDeleteResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ScriptDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.4.0

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

type ScriptDeleteResponseEnvelopeErrorsSource added in v4.4.0

type ScriptDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    scriptDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.4.0

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

type ScriptDeleteResponseEnvelopeMessages added in v4.4.0

type ScriptDeleteResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ScriptDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.4.0

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

type ScriptDeleteResponseEnvelopeMessagesSource added in v4.4.0

type ScriptDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    scriptDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.4.0

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

type ScriptDeleteResponseEnvelopeSuccess added in v4.4.0

type ScriptDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptDeleteResponseEnvelopeSuccessTrue ScriptDeleteResponseEnvelopeSuccess = true
)

func (ScriptDeleteResponseEnvelopeSuccess) IsKnown added in v4.4.0

type ScriptDeploymentGetParams

type ScriptDeploymentGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptDeploymentGetResponse

type ScriptDeploymentGetResponse struct {
	Deployments []ScriptDeploymentGetResponseDeployment `json:"deployments"`
	JSON        scriptDeploymentGetResponseJSON         `json:"-"`
}

func (*ScriptDeploymentGetResponse) UnmarshalJSON

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

type ScriptDeploymentGetResponseDeployment

type ScriptDeploymentGetResponseDeployment struct {
	Strategy    ScriptDeploymentGetResponseDeploymentsStrategy  `json:"strategy,required"`
	Versions    []ScriptDeploymentGetResponseDeploymentsVersion `json:"versions,required"`
	ID          string                                          `json:"id"`
	Annotations Deployment                                      `json:"annotations"`
	AuthorEmail string                                          `json:"author_email"`
	CreatedOn   string                                          `json:"created_on"`
	Source      string                                          `json:"source"`
	JSON        scriptDeploymentGetResponseDeploymentJSON       `json:"-"`
}

func (*ScriptDeploymentGetResponseDeployment) UnmarshalJSON

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

type ScriptDeploymentGetResponseDeploymentsStrategy

type ScriptDeploymentGetResponseDeploymentsStrategy string
const (
	ScriptDeploymentGetResponseDeploymentsStrategyPercentage ScriptDeploymentGetResponseDeploymentsStrategy = "percentage"
)

func (ScriptDeploymentGetResponseDeploymentsStrategy) IsKnown

type ScriptDeploymentGetResponseDeploymentsVersion

type ScriptDeploymentGetResponseDeploymentsVersion struct {
	Percentage float64                                           `json:"percentage,required"`
	VersionID  string                                            `json:"version_id,required"`
	JSON       scriptDeploymentGetResponseDeploymentsVersionJSON `json:"-"`
}

func (*ScriptDeploymentGetResponseDeploymentsVersion) UnmarshalJSON

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

type ScriptDeploymentGetResponseEnvelope

type ScriptDeploymentGetResponseEnvelope struct {
	Errors   []ScriptDeploymentGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptDeploymentGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptDeploymentGetResponseEnvelopeSuccess `json:"success,required"`
	Result  ScriptDeploymentGetResponse                `json:"result"`
	JSON    scriptDeploymentGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptDeploymentGetResponseEnvelope) UnmarshalJSON

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

type ScriptDeploymentGetResponseEnvelopeErrors added in v4.3.0

type ScriptDeploymentGetResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ScriptDeploymentGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptDeploymentGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptDeploymentGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptDeploymentGetResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    scriptDeploymentGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentGetResponseEnvelopeMessages added in v4.3.0

type ScriptDeploymentGetResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ScriptDeploymentGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptDeploymentGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptDeploymentGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptDeploymentGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    scriptDeploymentGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptDeploymentGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentGetResponseEnvelopeSuccess

type ScriptDeploymentGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptDeploymentGetResponseEnvelopeSuccessTrue ScriptDeploymentGetResponseEnvelopeSuccess = true
)

func (ScriptDeploymentGetResponseEnvelopeSuccess) IsKnown

type ScriptDeploymentNewParams

type ScriptDeploymentNewParams struct {
	// Identifier.
	AccountID param.Field[string]                             `path:"account_id,required"`
	Strategy  param.Field[ScriptDeploymentNewParamsStrategy]  `json:"strategy,required"`
	Versions  param.Field[[]ScriptDeploymentNewParamsVersion] `json:"versions,required"`
	// If set to true, the deployment will be created even if normally blocked by
	// something such rolling back to an older version when a secret has changed.
	Force       param.Field[bool]            `query:"force"`
	Annotations param.Field[DeploymentParam] `json:"annotations"`
}

func (ScriptDeploymentNewParams) MarshalJSON

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

func (ScriptDeploymentNewParams) URLQuery

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

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

type ScriptDeploymentNewParamsStrategy

type ScriptDeploymentNewParamsStrategy string
const (
	ScriptDeploymentNewParamsStrategyPercentage ScriptDeploymentNewParamsStrategy = "percentage"
)

func (ScriptDeploymentNewParamsStrategy) IsKnown

type ScriptDeploymentNewParamsVersion

type ScriptDeploymentNewParamsVersion struct {
	Percentage param.Field[float64] `json:"percentage,required"`
	VersionID  param.Field[string]  `json:"version_id,required"`
}

func (ScriptDeploymentNewParamsVersion) MarshalJSON

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

type ScriptDeploymentNewResponse

type ScriptDeploymentNewResponse struct {
	Strategy    ScriptDeploymentNewResponseStrategy  `json:"strategy,required"`
	Versions    []ScriptDeploymentNewResponseVersion `json:"versions,required"`
	ID          string                               `json:"id"`
	Annotations Deployment                           `json:"annotations"`
	AuthorEmail string                               `json:"author_email"`
	CreatedOn   string                               `json:"created_on"`
	Source      string                               `json:"source"`
	JSON        scriptDeploymentNewResponseJSON      `json:"-"`
}

func (*ScriptDeploymentNewResponse) UnmarshalJSON

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

type ScriptDeploymentNewResponseEnvelope

type ScriptDeploymentNewResponseEnvelope struct {
	Errors   []ScriptDeploymentNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptDeploymentNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptDeploymentNewResponseEnvelopeSuccess `json:"success,required"`
	Result  ScriptDeploymentNewResponse                `json:"result"`
	JSON    scriptDeploymentNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptDeploymentNewResponseEnvelope) UnmarshalJSON

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

type ScriptDeploymentNewResponseEnvelopeErrors added in v4.3.0

type ScriptDeploymentNewResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ScriptDeploymentNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptDeploymentNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptDeploymentNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentNewResponseEnvelopeErrorsSource added in v4.3.0

type ScriptDeploymentNewResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    scriptDeploymentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentNewResponseEnvelopeMessages added in v4.3.0

type ScriptDeploymentNewResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ScriptDeploymentNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptDeploymentNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptDeploymentNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentNewResponseEnvelopeMessagesSource added in v4.3.0

type ScriptDeploymentNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    scriptDeploymentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptDeploymentNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptDeploymentNewResponseEnvelopeSuccess

type ScriptDeploymentNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptDeploymentNewResponseEnvelopeSuccessTrue ScriptDeploymentNewResponseEnvelopeSuccess = true
)

func (ScriptDeploymentNewResponseEnvelopeSuccess) IsKnown

type ScriptDeploymentNewResponseStrategy

type ScriptDeploymentNewResponseStrategy string
const (
	ScriptDeploymentNewResponseStrategyPercentage ScriptDeploymentNewResponseStrategy = "percentage"
)

func (ScriptDeploymentNewResponseStrategy) IsKnown

type ScriptDeploymentNewResponseVersion

type ScriptDeploymentNewResponseVersion struct {
	Percentage float64                                `json:"percentage,required"`
	VersionID  string                                 `json:"version_id,required"`
	JSON       scriptDeploymentNewResponseVersionJSON `json:"-"`
}

func (*ScriptDeploymentNewResponseVersion) UnmarshalJSON

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

type ScriptDeploymentService

type ScriptDeploymentService struct {
	Options []option.RequestOption
}

ScriptDeploymentService 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 NewScriptDeploymentService method instead.

func NewScriptDeploymentService

func NewScriptDeploymentService(opts ...option.RequestOption) (r *ScriptDeploymentService)

NewScriptDeploymentService 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 (*ScriptDeploymentService) Get

List of Worker Deployments. The first deployment in the list is the latest deployment actively serving traffic.

func (*ScriptDeploymentService) New

Deployments configure how [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions) are deployed to traffic. A deployment can consist of one or two versions of a Worker.

type ScriptGetParams

type ScriptGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptListParams

type ScriptListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptPlacement

type ScriptPlacement struct {
	// The last time the script was analyzed for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	LastAnalyzedAt time.Time `json:"last_analyzed_at" format:"date-time"`
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode ScriptPlacementMode `json:"mode"`
	// Status of
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Status ScriptPlacementStatus `json:"status"`
	JSON   scriptPlacementJSON   `json:"-"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (*ScriptPlacement) UnmarshalJSON

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

type ScriptPlacementMode

type ScriptPlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptPlacementModeSmart ScriptPlacementMode = "smart"
)

func (ScriptPlacementMode) IsKnown

func (r ScriptPlacementMode) IsKnown() bool

type ScriptPlacementStatus

type ScriptPlacementStatus string

Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptPlacementStatusSuccess                 ScriptPlacementStatus = "SUCCESS"
	ScriptPlacementStatusUnsupportedApplication  ScriptPlacementStatus = "UNSUPPORTED_APPLICATION"
	ScriptPlacementStatusInsufficientInvocations ScriptPlacementStatus = "INSUFFICIENT_INVOCATIONS"
)

func (ScriptPlacementStatus) IsKnown

func (r ScriptPlacementStatus) IsKnown() bool

type ScriptScheduleGetParams

type ScriptScheduleGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptScheduleGetResponse

type ScriptScheduleGetResponse struct {
	Schedules []ScriptScheduleGetResponseSchedule `json:"schedules,required"`
	JSON      scriptScheduleGetResponseJSON       `json:"-"`
}

func (*ScriptScheduleGetResponse) UnmarshalJSON

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

type ScriptScheduleGetResponseEnvelope

type ScriptScheduleGetResponseEnvelope struct {
	Errors   []ScriptScheduleGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptScheduleGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptScheduleGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptScheduleGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptScheduleGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptScheduleGetResponseEnvelope) UnmarshalJSON

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

type ScriptScheduleGetResponseEnvelopeErrors added in v4.3.0

type ScriptScheduleGetResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ScriptScheduleGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptScheduleGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptScheduleGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptScheduleGetResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    scriptScheduleGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptScheduleGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleGetResponseEnvelopeMessages added in v4.3.0

type ScriptScheduleGetResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ScriptScheduleGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptScheduleGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptScheduleGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptScheduleGetResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    scriptScheduleGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptScheduleGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleGetResponseEnvelopeSuccess

type ScriptScheduleGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptScheduleGetResponseEnvelopeSuccessTrue ScriptScheduleGetResponseEnvelopeSuccess = true
)

func (ScriptScheduleGetResponseEnvelopeSuccess) IsKnown

type ScriptScheduleGetResponseSchedule added in v4.4.0

type ScriptScheduleGetResponseSchedule struct {
	Cron       string                                `json:"cron,required"`
	CreatedOn  string                                `json:"created_on"`
	ModifiedOn string                                `json:"modified_on"`
	JSON       scriptScheduleGetResponseScheduleJSON `json:"-"`
}

func (*ScriptScheduleGetResponseSchedule) UnmarshalJSON added in v4.4.0

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

type ScriptScheduleService

type ScriptScheduleService struct {
	Options []option.RequestOption
}

ScriptScheduleService 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 NewScriptScheduleService method instead.

func NewScriptScheduleService

func NewScriptScheduleService(opts ...option.RequestOption) (r *ScriptScheduleService)

NewScriptScheduleService 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 (*ScriptScheduleService) Get

Fetches Cron Triggers for a Worker.

func (*ScriptScheduleService) Update

Updates Cron Triggers for a Worker.

type ScriptScheduleUpdateParams

type ScriptScheduleUpdateParams struct {
	// Identifier.
	AccountID param.Field[string]              `path:"account_id,required"`
	Body      []ScriptScheduleUpdateParamsBody `json:"body,required"`
}

func (ScriptScheduleUpdateParams) MarshalJSON

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

type ScriptScheduleUpdateParamsBody added in v4.4.0

type ScriptScheduleUpdateParamsBody struct {
	Cron param.Field[string] `json:"cron,required"`
}

func (ScriptScheduleUpdateParamsBody) MarshalJSON added in v4.4.0

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

type ScriptScheduleUpdateResponse

type ScriptScheduleUpdateResponse struct {
	Schedules []ScriptScheduleUpdateResponseSchedule `json:"schedules,required"`
	JSON      scriptScheduleUpdateResponseJSON       `json:"-"`
}

func (*ScriptScheduleUpdateResponse) UnmarshalJSON

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

type ScriptScheduleUpdateResponseEnvelope

type ScriptScheduleUpdateResponseEnvelope struct {
	Errors   []ScriptScheduleUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptScheduleUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptScheduleUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptScheduleUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptScheduleUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptScheduleUpdateResponseEnvelope) UnmarshalJSON

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

type ScriptScheduleUpdateResponseEnvelopeErrors added in v4.3.0

type ScriptScheduleUpdateResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptScheduleUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptScheduleUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptScheduleUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleUpdateResponseEnvelopeErrorsSource added in v4.3.0

type ScriptScheduleUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptScheduleUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptScheduleUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleUpdateResponseEnvelopeMessages added in v4.3.0

type ScriptScheduleUpdateResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ScriptScheduleUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptScheduleUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptScheduleUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleUpdateResponseEnvelopeMessagesSource added in v4.3.0

type ScriptScheduleUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    scriptScheduleUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptScheduleUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptScheduleUpdateResponseEnvelopeSuccess

type ScriptScheduleUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptScheduleUpdateResponseEnvelopeSuccessTrue ScriptScheduleUpdateResponseEnvelopeSuccess = true
)

func (ScriptScheduleUpdateResponseEnvelopeSuccess) IsKnown

type ScriptScheduleUpdateResponseSchedule added in v4.4.0

type ScriptScheduleUpdateResponseSchedule struct {
	Cron       string                                   `json:"cron,required"`
	CreatedOn  string                                   `json:"created_on"`
	ModifiedOn string                                   `json:"modified_on"`
	JSON       scriptScheduleUpdateResponseScheduleJSON `json:"-"`
}

func (*ScriptScheduleUpdateResponseSchedule) UnmarshalJSON added in v4.4.0

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

type ScriptScriptAndVersionSettingEditParams added in v4.3.0

type ScriptScriptAndVersionSettingEditParams struct {
	// Identifier.
	AccountID param.Field[string]                                          `path:"account_id,required"`
	Settings  param.Field[ScriptScriptAndVersionSettingEditParamsSettings] `json:"settings"`
}

func (ScriptScriptAndVersionSettingEditParams) MarshalMultipart added in v4.3.0

func (r ScriptScriptAndVersionSettingEditParams) MarshalMultipart() (data []byte, contentType string, err error)

type ScriptScriptAndVersionSettingEditParamsSettings added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettings struct {
	// List of bindings attached to a Worker. You can find more about bindings on our
	// docs:
	// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
	Bindings param.Field[[]ScriptScriptAndVersionSettingEditParamsSettingsBindingUnion] `json:"bindings"`
	// Date indicating targeted support in the Workers runtime. Backwards incompatible
	// fixes to the runtime following this date will not affect this Worker.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Flags that enable or disable certain features in the Workers runtime. Used to
	// enable upcoming features or opt in or out of specific changes not included in a
	// `compatibility_date`.
	CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
	// Limits to apply for this Worker.
	Limits param.Field[ScriptScriptAndVersionSettingEditParamsSettingsLimits] `json:"limits"`
	// Whether Logpush is turned on for the Worker.
	Logpush param.Field[bool] `json:"logpush"`
	// Migrations to apply for Durable Objects associated with this Worker.
	Migrations param.Field[ScriptScriptAndVersionSettingEditParamsSettingsMigrationsUnion] `json:"migrations"`
	// Observability settings for the Worker.
	Observability param.Field[ScriptScriptAndVersionSettingEditParamsSettingsObservability] `json:"observability"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement param.Field[ScriptScriptAndVersionSettingEditParamsSettingsPlacement] `json:"placement"`
	// Tags to help you manage your Workers.
	Tags param.Field[[]string] `json:"tags"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers param.Field[[]ConsumerScriptParam] `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel param.Field[ScriptScriptAndVersionSettingEditParamsSettingsUsageModel] `json:"usage_model"`
}

func (ScriptScriptAndVersionSettingEditParamsSettings) MarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditParamsSettingsBinding added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBinding struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsType] `json:"type,required"`
	// Identifier of the D1 database to bind to.
	ID        param.Field[string]      `json:"id"`
	Algorithm param.Field[interface{}] `json:"algorithm"`
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name"`
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat] `json:"format"`
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name"`
	// JSON data to use.
	Json param.Field[string] `json:"json"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string]      `json:"key_base64"`
	KeyJwk    param.Field[interface{}] `json:"key_jwk"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace"`
	// Namespace identifier tag.
	NamespaceID param.Field[string]      `json:"namespace_id"`
	Outbound    param.Field[interface{}] `json:"outbound"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id"`
	// The text value to use.
	Text   param.Field[string]      `json:"text"`
	Usages param.Field[interface{}] `json:"usages"`
}

A binding to allow the Worker to communicate with resources.

func (ScriptScriptAndVersionSettingEditParamsSettingsBinding) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingUnion added in v4.3.0

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

A binding to allow the Worker to communicate with resources.

Satisfied by workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAI, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngine, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssets, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowser, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespace, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespace, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdrive, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJson, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespace, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificate, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainText, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelines, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueue, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2Bucket, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretText, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindService, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumer, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorize, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadata, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecret, workers.ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKey, ScriptScriptAndVersionSettingEditParamsSettingsBinding.

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormatRaw   ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat = "raw"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormatPkcs8 ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat = "pkcs8"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormatSpki  ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat = "spki"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormatJwk   ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat = "jwk"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeAI                     ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "ai"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeAnalyticsEngine        ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "analytics_engine"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeAssets                 ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "assets"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeBrowser                ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "browser"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeD1                     ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "d1"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeDispatchNamespace      ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "dispatch_namespace"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeDurableObjectNamespace ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "durable_object_namespace"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeHyperdrive             ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "hyperdrive"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeJson                   ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "json"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeKVNamespace            ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "kv_namespace"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeMTLSCertificate        ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "mtls_certificate"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypePlainText              ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "plain_text"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypePipelines              ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "pipelines"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeQueue                  ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "queue"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeR2Bucket               ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "r2_bucket"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeSecretText             ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "secret_text"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeService                ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "service"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeTailConsumer           ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "tail_consumer"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeVectorize              ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "vectorize"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeVersionMetadata        ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "version_metadata"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeSecretsStoreSecret     ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "secrets_store_secret"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsTypeSecretKey              ScriptScriptAndVersionSettingEditParamsSettingsBindingsType = "secret_key"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAI added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAI struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAIType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAI) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAIType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAIType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAITypeAI ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAIType = "ai"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAIType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngine added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngine struct {
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngine) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineTypeAnalyticsEngine ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineType = "analytics_engine"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAnalyticsEngineType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssets added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssets struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssets) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsTypeAssets ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsType = "assets"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindAssetsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowser added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowser struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowser) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserTypeBrowser ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserType = "browser"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindBrowserType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1 added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1 struct {
	// Identifier of the D1 database to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1Type] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1Type added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1Type string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1TypeD1 ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1Type = "d1"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindD1Type) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceType] `json:"type,required"`
	// Outbound worker.
	Outbound param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutbound] `json:"outbound"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespace) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutbound added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutbound struct {
	// Pass information from the Dispatch Worker to the Outbound Worker through the
	// parameters.
	Params param.Field[[]string] `json:"params"`
	// Outbound worker.
	Worker param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutboundWorker] `json:"worker"`
}

Outbound worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutbound) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutboundWorker added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutboundWorker struct {
	// Environment of the outbound worker.
	Environment param.Field[string] `json:"environment"`
	// Name of the outbound worker.
	Service param.Field[string] `json:"service"`
}

Outbound worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceOutboundWorker) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceTypeDispatchNamespace ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceType = "dispatch_namespace"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDispatchNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceType] `json:"type,required"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespace) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceTypeDurableObjectNamespace ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceType = "durable_object_namespace"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindDurableObjectNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdrive added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdrive struct {
	// Identifier of the Hyperdrive connection to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdrive) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveTypeHyperdrive ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveType = "hyperdrive"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindHyperdriveType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJson added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJson struct {
	// JSON data to use.
	Json param.Field[string] `json:"json,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJson) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonTypeJson ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonType = "json"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindJsonType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespace) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceTypeKVNamespace ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceType = "kv_namespace"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindKVNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificate added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificate struct {
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificate) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateTypeMTLSCertificate ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateType = "mtls_certificate"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindMTLSCertificateType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelines added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelines struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelines) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesTypePipelines ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesType = "pipelines"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPipelinesType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainText added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The text value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainText) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextTypePlainText ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextType = "plain_text"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindPlainTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueue added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueue struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueue) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueTypeQueue ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueType = "queue"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindQueueType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2Bucket added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2Bucket struct {
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2Bucket) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketTypeR2Bucket ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketType = "r2_bucket"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindR2BucketType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKey added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm param.Field[interface{}] `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat] `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyType] `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages param.Field[[]ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage] `json:"usages,required"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string] `json:"key_base64"`
	// Key data in
	// [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key)
	// format. Required if `format` is "jwk".
	KeyJwk param.Field[interface{}] `json:"key_jwk"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKey) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormatRaw   ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat = "raw"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormatPkcs8 ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormatSpki  ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat = "spki"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormatJwk   ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyTypeSecretKey ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage string
const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageEncrypt    ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageDecrypt    ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageSign       ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "sign"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageVerify     ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "verify"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageDeriveKey  ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageDeriveBits ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageWrapKey    ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretText added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The secret value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretText) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextTypeSecretText ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecret added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecret struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name,required"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecret) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretTypeSecretsStoreSecret ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretType = "secrets_store_secret"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindSecretsStoreSecretType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindService added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindService struct {
	// Optional environment if the Worker utilizes one.
	Environment param.Field[string] `json:"environment,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindService) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceTypeService ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceType = "service"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindServiceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumer added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumer struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Tail Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumer) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerTypeTailConsumer ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerType = "tail_consumer"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindTailConsumerType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorize added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorize struct {
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorize) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeTypeVectorize ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeType = "vectorize"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVectorizeType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadata added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadata struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataType] `json:"type,required"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadata) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataType added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataTypeVersionMetadata ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataType = "version_metadata"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsBindingsWorkersBindingKindVersionMetadataType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsLimits added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsLimits struct {
	// The amount of CPU time this Worker can use in milliseconds.
	CPUMs param.Field[int64] `json:"cpu_ms"`
}

Limits to apply for this Worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsLimits) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsMigrations added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsMigrations struct {
	DeletedClasses   param.Field[interface{}] `json:"deleted_classes"`
	NewClasses       param.Field[interface{}] `json:"new_classes"`
	NewSqliteClasses param.Field[interface{}] `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag param.Field[string] `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag             param.Field[string]      `json:"old_tag"`
	RenamedClasses     param.Field[interface{}] `json:"renamed_classes"`
	Steps              param.Field[interface{}] `json:"steps"`
	TransferredClasses param.Field[interface{}] `json:"transferred_classes"`
}

Migrations to apply for Durable Objects associated with this Worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsMigrations) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsMigrationsUnion added in v4.3.0

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

Migrations to apply for Durable Objects associated with this Worker.

Satisfied by workers.SingleStepMigrationParam, workers.ScriptScriptAndVersionSettingEditParamsSettingsMigrationsWorkersMultipleStepMigrations, ScriptScriptAndVersionSettingEditParamsSettingsMigrations.

type ScriptScriptAndVersionSettingEditParamsSettingsMigrationsWorkersMultipleStepMigrations added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsMigrationsWorkersMultipleStepMigrations struct {
	// Tag to set as the latest migration tag.
	NewTag param.Field[string] `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag param.Field[string] `json:"old_tag"`
	// Migrations to apply in order.
	Steps param.Field[[]MigrationStepParam] `json:"steps"`
}

func (ScriptScriptAndVersionSettingEditParamsSettingsMigrationsWorkersMultipleStepMigrations) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsObservability added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsObservability struct {
	// Whether observability is enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
	// Log settings for the Worker.
	Logs param.Field[ScriptScriptAndVersionSettingEditParamsSettingsObservabilityLogs] `json:"logs"`
}

Observability settings for the Worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsObservability) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsObservabilityLogs added in v4.4.0

type ScriptScriptAndVersionSettingEditParamsSettingsObservabilityLogs struct {
	// Whether logs are enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs param.Field[bool] `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
}

Log settings for the Worker.

func (ScriptScriptAndVersionSettingEditParamsSettingsObservabilityLogs) MarshalJSON added in v4.4.0

type ScriptScriptAndVersionSettingEditParamsSettingsPlacement added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsPlacement struct {
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode param.Field[ScriptScriptAndVersionSettingEditParamsSettingsPlacementMode] `json:"mode"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (ScriptScriptAndVersionSettingEditParamsSettingsPlacement) MarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsPlacementMode added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsPlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptScriptAndVersionSettingEditParamsSettingsPlacementModeSmart ScriptScriptAndVersionSettingEditParamsSettingsPlacementMode = "smart"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsPlacementMode) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsUsageModel added in v4.3.0

type ScriptScriptAndVersionSettingEditParamsSettingsUsageModel string

Usage model for the Worker invocations.

const (
	ScriptScriptAndVersionSettingEditParamsSettingsUsageModelStandard ScriptScriptAndVersionSettingEditParamsSettingsUsageModel = "standard"
)

func (ScriptScriptAndVersionSettingEditParamsSettingsUsageModel) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponse added in v4.3.0

type ScriptScriptAndVersionSettingEditResponse struct {
	// List of bindings attached to a Worker. You can find more about bindings on our
	// docs:
	// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
	Bindings []ScriptScriptAndVersionSettingEditResponseBinding `json:"bindings"`
	// Date indicating targeted support in the Workers runtime. Backwards incompatible
	// fixes to the runtime following this date will not affect this Worker.
	CompatibilityDate string `json:"compatibility_date"`
	// Flags that enable or disable certain features in the Workers runtime. Used to
	// enable upcoming features or opt in or out of specific changes not included in a
	// `compatibility_date`.
	CompatibilityFlags []string `json:"compatibility_flags"`
	// Limits to apply for this Worker.
	Limits ScriptScriptAndVersionSettingEditResponseLimits `json:"limits"`
	// Whether Logpush is turned on for the Worker.
	Logpush bool `json:"logpush"`
	// Migrations to apply for Durable Objects associated with this Worker.
	Migrations ScriptScriptAndVersionSettingEditResponseMigrations `json:"migrations"`
	// Observability settings for the Worker.
	Observability ScriptScriptAndVersionSettingEditResponseObservability `json:"observability"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement ScriptScriptAndVersionSettingEditResponsePlacement `json:"placement"`
	// Tags to help you manage your Workers.
	Tags []string `json:"tags"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers []ConsumerScript `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel ScriptScriptAndVersionSettingEditResponseUsageModel `json:"usage_model"`
	JSON       scriptScriptAndVersionSettingEditResponseJSON       `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponse) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseBinding added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBinding struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsType `json:"type,required"`
	// Identifier of the D1 database to bind to.
	ID string `json:"id"`
	// This field can have the runtime type of [interface{}].
	Algorithm interface{} `json:"algorithm"`
	// R2 bucket to bind to.
	BucketName string `json:"bucket_name"`
	// Identifier of the certificate to bind to.
	CertificateID string `json:"certificate_id"`
	// The exported class name of the Durable Object.
	ClassName string `json:"class_name"`
	// The name of the dataset to bind to.
	Dataset string `json:"dataset"`
	// The environment of the script_name to bind to.
	Environment string `json:"environment"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptScriptAndVersionSettingEditResponseBindingsFormat `json:"format"`
	// Name of the Vectorize index to bind to.
	IndexName string `json:"index_name"`
	// JSON data to use.
	Json string `json:"json"`
	// This field can have the runtime type of [interface{}].
	KeyJwk interface{} `json:"key_jwk"`
	// Namespace to bind to.
	Namespace string `json:"namespace"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id"`
	// This field can have the runtime type of
	// [ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutbound].
	Outbound interface{} `json:"outbound"`
	// Name of the Pipeline to bind to.
	Pipeline string `json:"pipeline"`
	// Name of the Queue to bind to.
	QueueName string `json:"queue_name"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName string `json:"script_name"`
	// Name of the secret in the store.
	SecretName string `json:"secret_name"`
	// Name of Worker to bind to.
	Service string `json:"service"`
	// ID of the store containing the secret.
	StoreID string `json:"store_id"`
	// The text value to use.
	Text string `json:"text"`
	// This field can have the runtime type of
	// [[]ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage].
	Usages interface{}                                          `json:"usages"`
	JSON   scriptScriptAndVersionSettingEditResponseBindingJSON `json:"-"`
	// contains filtered or unexported fields
}

A binding to allow the Worker to communicate with resources.

func (ScriptScriptAndVersionSettingEditResponseBinding) AsUnion added in v4.3.0

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

Possible runtime types of the union are ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAI, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngine, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssets, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowser, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdrive, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJson, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificate, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainText, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelines, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueue, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2Bucket, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretText, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindService, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumer, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorize, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadata, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecret, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKey.

func (*ScriptScriptAndVersionSettingEditResponseBinding) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseBindingsFormat added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingEditResponseBindingsFormatRaw   ScriptScriptAndVersionSettingEditResponseBindingsFormat = "raw"
	ScriptScriptAndVersionSettingEditResponseBindingsFormatPkcs8 ScriptScriptAndVersionSettingEditResponseBindingsFormat = "pkcs8"
	ScriptScriptAndVersionSettingEditResponseBindingsFormatSpki  ScriptScriptAndVersionSettingEditResponseBindingsFormat = "spki"
	ScriptScriptAndVersionSettingEditResponseBindingsFormatJwk   ScriptScriptAndVersionSettingEditResponseBindingsFormat = "jwk"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsTypeAI                     ScriptScriptAndVersionSettingEditResponseBindingsType = "ai"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeAnalyticsEngine        ScriptScriptAndVersionSettingEditResponseBindingsType = "analytics_engine"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeAssets                 ScriptScriptAndVersionSettingEditResponseBindingsType = "assets"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeBrowser                ScriptScriptAndVersionSettingEditResponseBindingsType = "browser"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeD1                     ScriptScriptAndVersionSettingEditResponseBindingsType = "d1"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeDispatchNamespace      ScriptScriptAndVersionSettingEditResponseBindingsType = "dispatch_namespace"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeDurableObjectNamespace ScriptScriptAndVersionSettingEditResponseBindingsType = "durable_object_namespace"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeHyperdrive             ScriptScriptAndVersionSettingEditResponseBindingsType = "hyperdrive"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeJson                   ScriptScriptAndVersionSettingEditResponseBindingsType = "json"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeKVNamespace            ScriptScriptAndVersionSettingEditResponseBindingsType = "kv_namespace"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeMTLSCertificate        ScriptScriptAndVersionSettingEditResponseBindingsType = "mtls_certificate"
	ScriptScriptAndVersionSettingEditResponseBindingsTypePlainText              ScriptScriptAndVersionSettingEditResponseBindingsType = "plain_text"
	ScriptScriptAndVersionSettingEditResponseBindingsTypePipelines              ScriptScriptAndVersionSettingEditResponseBindingsType = "pipelines"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeQueue                  ScriptScriptAndVersionSettingEditResponseBindingsType = "queue"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeR2Bucket               ScriptScriptAndVersionSettingEditResponseBindingsType = "r2_bucket"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeSecretText             ScriptScriptAndVersionSettingEditResponseBindingsType = "secret_text"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeService                ScriptScriptAndVersionSettingEditResponseBindingsType = "service"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeTailConsumer           ScriptScriptAndVersionSettingEditResponseBindingsType = "tail_consumer"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeVectorize              ScriptScriptAndVersionSettingEditResponseBindingsType = "vectorize"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeVersionMetadata        ScriptScriptAndVersionSettingEditResponseBindingsType = "version_metadata"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeSecretsStoreSecret     ScriptScriptAndVersionSettingEditResponseBindingsType = "secrets_store_secret"
	ScriptScriptAndVersionSettingEditResponseBindingsTypeSecretKey              ScriptScriptAndVersionSettingEditResponseBindingsType = "secret_key"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsUnion added in v4.3.0

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

A binding to allow the Worker to communicate with resources.

Union satisfied by ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAI, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngine, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssets, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowser, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdrive, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJson, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespace, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificate, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainText, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelines, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueue, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2Bucket, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretText, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindService, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumer, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorize, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadata, ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecret or ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKey.

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAI added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAI struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAI) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAITypeAI ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIType = "ai"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAIType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngine added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngine struct {
	// The name of the dataset to bind to.
	Dataset string `json:"dataset,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngine) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineTypeAnalyticsEngine ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineType = "analytics_engine"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAnalyticsEngineType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssets added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssets struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssets) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsTypeAssets ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsType = "assets"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindAssetsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowser added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowser struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowser) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserTypeBrowser ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserType = "browser"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindBrowserType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1 added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1 struct {
	// Identifier of the D1 database to bind to.
	ID string `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1Type `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1JSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1Type added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1Type string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1TypeD1 ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1Type = "d1"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindD1Type) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Namespace to bind to.
	Namespace string `json:"namespace,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceType `json:"type,required"`
	// Outbound worker.
	Outbound ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutbound `json:"outbound"`
	JSON     scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceJSON     `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutbound added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutbound struct {
	// Pass information from the Dispatch Worker to the Outbound Worker through the
	// parameters.
	Params []string `json:"params"`
	// Outbound worker.
	Worker ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker `json:"worker"`
	JSON   scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundJSON   `json:"-"`
}

Outbound worker.

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutbound) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker struct {
	// Environment of the outbound worker.
	Environment string `json:"environment"`
	// Name of the outbound worker.
	Service string                                                                                                 `json:"service"`
	JSON    scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorkerJSON `json:"-"`
}

Outbound worker.

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceTypeDispatchNamespace ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceType = "dispatch_namespace"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDispatchNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceType `json:"type,required"`
	// The exported class name of the Durable Object.
	ClassName string `json:"class_name"`
	// The environment of the script_name to bind to.
	Environment string `json:"environment"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName string                                                                                        `json:"script_name"`
	JSON       scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceTypeDurableObjectNamespace ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceType = "durable_object_namespace"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindDurableObjectNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdrive added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdrive struct {
	// Identifier of the Hyperdrive connection to bind to.
	ID string `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdrive) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveTypeHyperdrive ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveType = "hyperdrive"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindHyperdriveType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJson added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJson struct {
	// JSON data to use.
	Json string `json:"json,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJson) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonTypeJson ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonType = "json"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindJsonType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespace added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceTypeKVNamespace ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceType = "kv_namespace"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindKVNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificate added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificate struct {
	// Identifier of the certificate to bind to.
	CertificateID string `json:"certificate_id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificate) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateTypeMTLSCertificate ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateType = "mtls_certificate"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindMTLSCertificateType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelines added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelines struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the Pipeline to bind to.
	Pipeline string `json:"pipeline,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelines) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesTypePipelines ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesType = "pipelines"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPipelinesType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainText added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The text value to use.
	Text string `json:"text,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainText) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextTypePlainText ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextType = "plain_text"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindPlainTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueue added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueue struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the Queue to bind to.
	QueueName string `json:"queue_name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueue) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueTypeQueue ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueType = "queue"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindQueueType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2Bucket added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2Bucket struct {
	// R2 bucket to bind to.
	BucketName string `json:"bucket_name,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2Bucket) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketTypeR2Bucket ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketType = "r2_bucket"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindR2BucketType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKey added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm interface{} `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyType `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages []ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage `json:"usages,required"`
	JSON   scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyJSON    `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKey) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormatRaw   ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat = "raw"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormatPkcs8 ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormatSpki  ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat = "spki"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormatJwk   ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyTypeSecretKey ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage string
const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageEncrypt    ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageDecrypt    ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageSign       ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "sign"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageVerify     ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "verify"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageDeriveKey  ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageDeriveBits ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageWrapKey    ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretText added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretText) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextTypeSecretText ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecret added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecret struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the secret in the store.
	SecretName string `json:"secret_name,required"`
	// ID of the store containing the secret.
	StoreID string `json:"store_id,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecret) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretTypeSecretsStoreSecret ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretType = "secrets_store_secret"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindSecretsStoreSecretType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindService added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindService struct {
	// Optional environment if the Worker utilizes one.
	Environment string `json:"environment,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of Worker to bind to.
	Service string `json:"service,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindService) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceTypeService ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceType = "service"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindServiceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumer added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumer struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of Tail Worker to bind to.
	Service string `json:"service,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumer) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerTypeTailConsumer ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerType = "tail_consumer"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindTailConsumerType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorize added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorize struct {
	// Name of the Vectorize index to bind to.
	IndexName string `json:"index_name,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorize) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeTypeVectorize ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeType = "vectorize"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVectorizeType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadata added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadata struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataType `json:"type,required"`
	JSON scriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadata) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataType added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataTypeVersionMetadata ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataType = "version_metadata"
)

func (ScriptScriptAndVersionSettingEditResponseBindingsWorkersBindingKindVersionMetadataType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelope added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelope struct {
	Errors   []ScriptScriptAndVersionSettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptScriptAndVersionSettingEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptScriptAndVersionSettingEditResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptScriptAndVersionSettingEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptScriptAndVersionSettingEditResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseEnvelopeErrors added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeErrors struct {
	Code             int64                                                         `json:"code,required"`
	Message          string                                                        `json:"message,required"`
	DocumentationURL string                                                        `json:"documentation_url"`
	Source           ScriptScriptAndVersionSettingEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptScriptAndVersionSettingEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeErrorsSource added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeErrorsSource struct {
	Pointer string                                                            `json:"pointer"`
	JSON    scriptScriptAndVersionSettingEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeMessages added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeMessages struct {
	Code             int64                                                           `json:"code,required"`
	Message          string                                                          `json:"message,required"`
	DocumentationURL string                                                          `json:"documentation_url"`
	Source           ScriptScriptAndVersionSettingEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptScriptAndVersionSettingEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeMessagesSource added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeMessagesSource struct {
	Pointer string                                                              `json:"pointer"`
	JSON    scriptScriptAndVersionSettingEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeSuccess added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptScriptAndVersionSettingEditResponseEnvelopeSuccessTrue ScriptScriptAndVersionSettingEditResponseEnvelopeSuccess = true
)

func (ScriptScriptAndVersionSettingEditResponseEnvelopeSuccess) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseLimits added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseLimits struct {
	// The amount of CPU time this Worker can use in milliseconds.
	CPUMs int64                                               `json:"cpu_ms"`
	JSON  scriptScriptAndVersionSettingEditResponseLimitsJSON `json:"-"`
}

Limits to apply for this Worker.

func (*ScriptScriptAndVersionSettingEditResponseLimits) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseMigrations added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseMigrations struct {
	// This field can have the runtime type of [[]string].
	DeletedClasses interface{} `json:"deleted_classes"`
	// This field can have the runtime type of [[]string].
	NewClasses interface{} `json:"new_classes"`
	// This field can have the runtime type of [[]string].
	NewSqliteClasses interface{} `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag string `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag string `json:"old_tag"`
	// This field can have the runtime type of [[]SingleStepMigrationRenamedClass].
	RenamedClasses interface{} `json:"renamed_classes"`
	// This field can have the runtime type of [[]MigrationStep].
	Steps interface{} `json:"steps"`
	// This field can have the runtime type of [[]SingleStepMigrationTransferredClass].
	TransferredClasses interface{}                                             `json:"transferred_classes"`
	JSON               scriptScriptAndVersionSettingEditResponseMigrationsJSON `json:"-"`
	// contains filtered or unexported fields
}

Migrations to apply for Durable Objects associated with this Worker.

func (ScriptScriptAndVersionSettingEditResponseMigrations) AsUnion added in v4.3.0

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

Possible runtime types of the union are SingleStepMigration, ScriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrations.

func (*ScriptScriptAndVersionSettingEditResponseMigrations) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseMigrationsUnion added in v4.3.0

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

Migrations to apply for Durable Objects associated with this Worker.

Union satisfied by SingleStepMigration or ScriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrations.

type ScriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrations added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrations struct {
	// Tag to set as the latest migration tag.
	NewTag string `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag string `json:"old_tag"`
	// Migrations to apply in order.
	Steps []MigrationStep                                                                      `json:"steps"`
	JSON  scriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrationsJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingEditResponseMigrationsWorkersMultipleStepMigrations) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseObservability added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseObservability struct {
	// Whether observability is enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate float64 `json:"head_sampling_rate,nullable"`
	// Log settings for the Worker.
	Logs ScriptScriptAndVersionSettingEditResponseObservabilityLogs `json:"logs,nullable"`
	JSON scriptScriptAndVersionSettingEditResponseObservabilityJSON `json:"-"`
}

Observability settings for the Worker.

func (*ScriptScriptAndVersionSettingEditResponseObservability) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponseObservabilityLogs added in v4.4.0

type ScriptScriptAndVersionSettingEditResponseObservabilityLogs struct {
	// Whether logs are enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs bool `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate float64                                                        `json:"head_sampling_rate,nullable"`
	JSON             scriptScriptAndVersionSettingEditResponseObservabilityLogsJSON `json:"-"`
}

Log settings for the Worker.

func (*ScriptScriptAndVersionSettingEditResponseObservabilityLogs) UnmarshalJSON added in v4.4.0

type ScriptScriptAndVersionSettingEditResponsePlacement added in v4.3.0

type ScriptScriptAndVersionSettingEditResponsePlacement struct {
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode ScriptScriptAndVersionSettingEditResponsePlacementMode `json:"mode"`
	JSON scriptScriptAndVersionSettingEditResponsePlacementJSON `json:"-"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (*ScriptScriptAndVersionSettingEditResponsePlacement) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingEditResponsePlacementMode added in v4.3.0

type ScriptScriptAndVersionSettingEditResponsePlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptScriptAndVersionSettingEditResponsePlacementModeSmart ScriptScriptAndVersionSettingEditResponsePlacementMode = "smart"
)

func (ScriptScriptAndVersionSettingEditResponsePlacementMode) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseUsageModel added in v4.3.0

type ScriptScriptAndVersionSettingEditResponseUsageModel string

Usage model for the Worker invocations.

const (
	ScriptScriptAndVersionSettingEditResponseUsageModelStandard ScriptScriptAndVersionSettingEditResponseUsageModel = "standard"
)

func (ScriptScriptAndVersionSettingEditResponseUsageModel) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetParams added in v4.3.0

type ScriptScriptAndVersionSettingGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptScriptAndVersionSettingGetResponse added in v4.3.0

type ScriptScriptAndVersionSettingGetResponse struct {
	// List of bindings attached to a Worker. You can find more about bindings on our
	// docs:
	// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
	Bindings []ScriptScriptAndVersionSettingGetResponseBinding `json:"bindings"`
	// Date indicating targeted support in the Workers runtime. Backwards incompatible
	// fixes to the runtime following this date will not affect this Worker.
	CompatibilityDate string `json:"compatibility_date"`
	// Flags that enable or disable certain features in the Workers runtime. Used to
	// enable upcoming features or opt in or out of specific changes not included in a
	// `compatibility_date`.
	CompatibilityFlags []string `json:"compatibility_flags"`
	// Limits to apply for this Worker.
	Limits ScriptScriptAndVersionSettingGetResponseLimits `json:"limits"`
	// Whether Logpush is turned on for the Worker.
	Logpush bool `json:"logpush"`
	// Migrations to apply for Durable Objects associated with this Worker.
	Migrations ScriptScriptAndVersionSettingGetResponseMigrations `json:"migrations"`
	// Observability settings for the Worker.
	Observability ScriptScriptAndVersionSettingGetResponseObservability `json:"observability"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement ScriptScriptAndVersionSettingGetResponsePlacement `json:"placement"`
	// Tags to help you manage your Workers.
	Tags []string `json:"tags"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers []ConsumerScript `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel ScriptScriptAndVersionSettingGetResponseUsageModel `json:"usage_model"`
	JSON       scriptScriptAndVersionSettingGetResponseJSON       `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponse) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseBinding added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBinding struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsType `json:"type,required"`
	// Identifier of the D1 database to bind to.
	ID string `json:"id"`
	// This field can have the runtime type of [interface{}].
	Algorithm interface{} `json:"algorithm"`
	// R2 bucket to bind to.
	BucketName string `json:"bucket_name"`
	// Identifier of the certificate to bind to.
	CertificateID string `json:"certificate_id"`
	// The exported class name of the Durable Object.
	ClassName string `json:"class_name"`
	// The name of the dataset to bind to.
	Dataset string `json:"dataset"`
	// The environment of the script_name to bind to.
	Environment string `json:"environment"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptScriptAndVersionSettingGetResponseBindingsFormat `json:"format"`
	// Name of the Vectorize index to bind to.
	IndexName string `json:"index_name"`
	// JSON data to use.
	Json string `json:"json"`
	// This field can have the runtime type of [interface{}].
	KeyJwk interface{} `json:"key_jwk"`
	// Namespace to bind to.
	Namespace string `json:"namespace"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id"`
	// This field can have the runtime type of
	// [ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutbound].
	Outbound interface{} `json:"outbound"`
	// Name of the Pipeline to bind to.
	Pipeline string `json:"pipeline"`
	// Name of the Queue to bind to.
	QueueName string `json:"queue_name"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName string `json:"script_name"`
	// Name of the secret in the store.
	SecretName string `json:"secret_name"`
	// Name of Worker to bind to.
	Service string `json:"service"`
	// ID of the store containing the secret.
	StoreID string `json:"store_id"`
	// The text value to use.
	Text string `json:"text"`
	// This field can have the runtime type of
	// [[]ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage].
	Usages interface{}                                         `json:"usages"`
	JSON   scriptScriptAndVersionSettingGetResponseBindingJSON `json:"-"`
	// contains filtered or unexported fields
}

A binding to allow the Worker to communicate with resources.

func (ScriptScriptAndVersionSettingGetResponseBinding) AsUnion added in v4.3.0

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

Possible runtime types of the union are ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAI, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngine, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssets, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowser, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdrive, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJson, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificate, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainText, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelines, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueue, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2Bucket, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretText, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindService, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumer, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorize, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadata, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecret, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKey.

func (*ScriptScriptAndVersionSettingGetResponseBinding) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseBindingsFormat added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingGetResponseBindingsFormatRaw   ScriptScriptAndVersionSettingGetResponseBindingsFormat = "raw"
	ScriptScriptAndVersionSettingGetResponseBindingsFormatPkcs8 ScriptScriptAndVersionSettingGetResponseBindingsFormat = "pkcs8"
	ScriptScriptAndVersionSettingGetResponseBindingsFormatSpki  ScriptScriptAndVersionSettingGetResponseBindingsFormat = "spki"
	ScriptScriptAndVersionSettingGetResponseBindingsFormatJwk   ScriptScriptAndVersionSettingGetResponseBindingsFormat = "jwk"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsTypeAI                     ScriptScriptAndVersionSettingGetResponseBindingsType = "ai"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeAnalyticsEngine        ScriptScriptAndVersionSettingGetResponseBindingsType = "analytics_engine"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeAssets                 ScriptScriptAndVersionSettingGetResponseBindingsType = "assets"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeBrowser                ScriptScriptAndVersionSettingGetResponseBindingsType = "browser"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeD1                     ScriptScriptAndVersionSettingGetResponseBindingsType = "d1"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeDispatchNamespace      ScriptScriptAndVersionSettingGetResponseBindingsType = "dispatch_namespace"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeDurableObjectNamespace ScriptScriptAndVersionSettingGetResponseBindingsType = "durable_object_namespace"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeHyperdrive             ScriptScriptAndVersionSettingGetResponseBindingsType = "hyperdrive"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeJson                   ScriptScriptAndVersionSettingGetResponseBindingsType = "json"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeKVNamespace            ScriptScriptAndVersionSettingGetResponseBindingsType = "kv_namespace"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeMTLSCertificate        ScriptScriptAndVersionSettingGetResponseBindingsType = "mtls_certificate"
	ScriptScriptAndVersionSettingGetResponseBindingsTypePlainText              ScriptScriptAndVersionSettingGetResponseBindingsType = "plain_text"
	ScriptScriptAndVersionSettingGetResponseBindingsTypePipelines              ScriptScriptAndVersionSettingGetResponseBindingsType = "pipelines"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeQueue                  ScriptScriptAndVersionSettingGetResponseBindingsType = "queue"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeR2Bucket               ScriptScriptAndVersionSettingGetResponseBindingsType = "r2_bucket"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeSecretText             ScriptScriptAndVersionSettingGetResponseBindingsType = "secret_text"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeService                ScriptScriptAndVersionSettingGetResponseBindingsType = "service"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeTailConsumer           ScriptScriptAndVersionSettingGetResponseBindingsType = "tail_consumer"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeVectorize              ScriptScriptAndVersionSettingGetResponseBindingsType = "vectorize"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeVersionMetadata        ScriptScriptAndVersionSettingGetResponseBindingsType = "version_metadata"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeSecretsStoreSecret     ScriptScriptAndVersionSettingGetResponseBindingsType = "secrets_store_secret"
	ScriptScriptAndVersionSettingGetResponseBindingsTypeSecretKey              ScriptScriptAndVersionSettingGetResponseBindingsType = "secret_key"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsUnion added in v4.3.0

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

A binding to allow the Worker to communicate with resources.

Union satisfied by ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAI, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngine, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssets, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowser, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdrive, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJson, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespace, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificate, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainText, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelines, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueue, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2Bucket, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretText, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindService, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumer, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorize, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadata, ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecret or ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKey.

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAI added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAI struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAI) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAITypeAI ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIType = "ai"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAIType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngine added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngine struct {
	// The name of the dataset to bind to.
	Dataset string `json:"dataset,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngine) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineTypeAnalyticsEngine ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineType = "analytics_engine"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAnalyticsEngineType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssets added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssets struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssets) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsTypeAssets ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsType = "assets"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindAssetsType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowser added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowser struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowser) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserTypeBrowser ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserType = "browser"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindBrowserType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1 added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1 struct {
	// Identifier of the D1 database to bind to.
	ID string `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1Type `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1JSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1Type added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1Type string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1TypeD1 ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1Type = "d1"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindD1Type) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespace added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Namespace to bind to.
	Namespace string `json:"namespace,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceType `json:"type,required"`
	// Outbound worker.
	Outbound ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutbound `json:"outbound"`
	JSON     scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceJSON     `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutbound added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutbound struct {
	// Pass information from the Dispatch Worker to the Outbound Worker through the
	// parameters.
	Params []string `json:"params"`
	// Outbound worker.
	Worker ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker `json:"worker"`
	JSON   scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundJSON   `json:"-"`
}

Outbound worker.

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutbound) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker struct {
	// Environment of the outbound worker.
	Environment string `json:"environment"`
	// Name of the outbound worker.
	Service string                                                                                                `json:"service"`
	JSON    scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorkerJSON `json:"-"`
}

Outbound worker.

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceOutboundWorker) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceTypeDispatchNamespace ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceType = "dispatch_namespace"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDispatchNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespace added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceType `json:"type,required"`
	// The exported class name of the Durable Object.
	ClassName string `json:"class_name"`
	// The environment of the script_name to bind to.
	Environment string `json:"environment"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName string                                                                                       `json:"script_name"`
	JSON       scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceTypeDurableObjectNamespace ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceType = "durable_object_namespace"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindDurableObjectNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdrive added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdrive struct {
	// Identifier of the Hyperdrive connection to bind to.
	ID string `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdrive) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveTypeHyperdrive ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveType = "hyperdrive"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindHyperdriveType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJson added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJson struct {
	// JSON data to use.
	Json string `json:"json,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJson) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonTypeJson ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonType = "json"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindJsonType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespace added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespace struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Namespace identifier tag.
	NamespaceID string `json:"namespace_id,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespace) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceTypeKVNamespace ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceType = "kv_namespace"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindKVNamespaceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificate added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificate struct {
	// Identifier of the certificate to bind to.
	CertificateID string `json:"certificate_id,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificate) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateTypeMTLSCertificate ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateType = "mtls_certificate"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindMTLSCertificateType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelines added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelines struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the Pipeline to bind to.
	Pipeline string `json:"pipeline,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelines) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesTypePipelines ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesType = "pipelines"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPipelinesType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainText added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The text value to use.
	Text string `json:"text,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainText) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextTypePlainText ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextType = "plain_text"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindPlainTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueue added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueue struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the Queue to bind to.
	QueueName string `json:"queue_name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueue) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueTypeQueue ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueType = "queue"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindQueueType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2Bucket added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2Bucket struct {
	// R2 bucket to bind to.
	BucketName string `json:"bucket_name,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2Bucket) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketTypeR2Bucket ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketType = "r2_bucket"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindR2BucketType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKey added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm interface{} `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyType `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages []ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage `json:"usages,required"`
	JSON   scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyJSON    `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKey) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormatRaw   ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat = "raw"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormatPkcs8 ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormatSpki  ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat = "spki"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormatJwk   ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyTypeSecretKey ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage string
const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageEncrypt    ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageDecrypt    ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageSign       ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "sign"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageVerify     ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "verify"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageDeriveKey  ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageDeriveBits ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageWrapKey    ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretText added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretText) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextTypeSecretText ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecret added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecret struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of the secret in the store.
	SecretName string `json:"secret_name,required"`
	// ID of the store containing the secret.
	StoreID string `json:"store_id,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecret) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretTypeSecretsStoreSecret ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretType = "secrets_store_secret"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindSecretsStoreSecretType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindService added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindService struct {
	// Optional environment if the Worker utilizes one.
	Environment string `json:"environment,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of Worker to bind to.
	Service string `json:"service,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindService) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceTypeService ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceType = "service"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindServiceType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumer added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumer struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// Name of Tail Worker to bind to.
	Service string `json:"service,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumer) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerTypeTailConsumer ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerType = "tail_consumer"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindTailConsumerType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorize added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorize struct {
	// Name of the Vectorize index to bind to.
	IndexName string `json:"index_name,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorize) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeTypeVectorize ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeType = "vectorize"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVectorizeType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadata added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadata struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataType `json:"type,required"`
	JSON scriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadata) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataType added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataType string

The kind of resource that the binding provides.

const (
	ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataTypeVersionMetadata ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataType = "version_metadata"
)

func (ScriptScriptAndVersionSettingGetResponseBindingsWorkersBindingKindVersionMetadataType) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelope added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelope struct {
	Errors   []ScriptScriptAndVersionSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptScriptAndVersionSettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptScriptAndVersionSettingGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptScriptAndVersionSettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptScriptAndVersionSettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseEnvelopeErrors added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeErrors struct {
	Code             int64                                                        `json:"code,required"`
	Message          string                                                       `json:"message,required"`
	DocumentationURL string                                                       `json:"documentation_url"`
	Source           ScriptScriptAndVersionSettingGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptScriptAndVersionSettingGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                           `json:"pointer"`
	JSON    scriptScriptAndVersionSettingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeMessages added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeMessages struct {
	Code             int64                                                          `json:"code,required"`
	Message          string                                                         `json:"message,required"`
	DocumentationURL string                                                         `json:"documentation_url"`
	Source           ScriptScriptAndVersionSettingGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptScriptAndVersionSettingGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                             `json:"pointer"`
	JSON    scriptScriptAndVersionSettingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeSuccess added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptScriptAndVersionSettingGetResponseEnvelopeSuccessTrue ScriptScriptAndVersionSettingGetResponseEnvelopeSuccess = true
)

func (ScriptScriptAndVersionSettingGetResponseEnvelopeSuccess) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseLimits added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseLimits struct {
	// The amount of CPU time this Worker can use in milliseconds.
	CPUMs int64                                              `json:"cpu_ms"`
	JSON  scriptScriptAndVersionSettingGetResponseLimitsJSON `json:"-"`
}

Limits to apply for this Worker.

func (*ScriptScriptAndVersionSettingGetResponseLimits) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseMigrations added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseMigrations struct {
	// This field can have the runtime type of [[]string].
	DeletedClasses interface{} `json:"deleted_classes"`
	// This field can have the runtime type of [[]string].
	NewClasses interface{} `json:"new_classes"`
	// This field can have the runtime type of [[]string].
	NewSqliteClasses interface{} `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag string `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag string `json:"old_tag"`
	// This field can have the runtime type of [[]SingleStepMigrationRenamedClass].
	RenamedClasses interface{} `json:"renamed_classes"`
	// This field can have the runtime type of [[]MigrationStep].
	Steps interface{} `json:"steps"`
	// This field can have the runtime type of [[]SingleStepMigrationTransferredClass].
	TransferredClasses interface{}                                            `json:"transferred_classes"`
	JSON               scriptScriptAndVersionSettingGetResponseMigrationsJSON `json:"-"`
	// contains filtered or unexported fields
}

Migrations to apply for Durable Objects associated with this Worker.

func (ScriptScriptAndVersionSettingGetResponseMigrations) AsUnion added in v4.3.0

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

Possible runtime types of the union are SingleStepMigration, ScriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrations.

func (*ScriptScriptAndVersionSettingGetResponseMigrations) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseMigrationsUnion added in v4.3.0

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

Migrations to apply for Durable Objects associated with this Worker.

Union satisfied by SingleStepMigration or ScriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrations.

type ScriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrations added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrations struct {
	// Tag to set as the latest migration tag.
	NewTag string `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag string `json:"old_tag"`
	// Migrations to apply in order.
	Steps []MigrationStep                                                                     `json:"steps"`
	JSON  scriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrationsJSON `json:"-"`
}

func (*ScriptScriptAndVersionSettingGetResponseMigrationsWorkersMultipleStepMigrations) UnmarshalJSON added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseObservability added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseObservability struct {
	// Whether observability is enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate float64 `json:"head_sampling_rate,nullable"`
	// Log settings for the Worker.
	Logs ScriptScriptAndVersionSettingGetResponseObservabilityLogs `json:"logs,nullable"`
	JSON scriptScriptAndVersionSettingGetResponseObservabilityJSON `json:"-"`
}

Observability settings for the Worker.

func (*ScriptScriptAndVersionSettingGetResponseObservability) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponseObservabilityLogs added in v4.4.0

type ScriptScriptAndVersionSettingGetResponseObservabilityLogs struct {
	// Whether logs are enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs bool `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate float64                                                       `json:"head_sampling_rate,nullable"`
	JSON             scriptScriptAndVersionSettingGetResponseObservabilityLogsJSON `json:"-"`
}

Log settings for the Worker.

func (*ScriptScriptAndVersionSettingGetResponseObservabilityLogs) UnmarshalJSON added in v4.4.0

type ScriptScriptAndVersionSettingGetResponsePlacement added in v4.3.0

type ScriptScriptAndVersionSettingGetResponsePlacement struct {
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode ScriptScriptAndVersionSettingGetResponsePlacementMode `json:"mode"`
	JSON scriptScriptAndVersionSettingGetResponsePlacementJSON `json:"-"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (*ScriptScriptAndVersionSettingGetResponsePlacement) UnmarshalJSON added in v4.3.0

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

type ScriptScriptAndVersionSettingGetResponsePlacementMode added in v4.3.0

type ScriptScriptAndVersionSettingGetResponsePlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptScriptAndVersionSettingGetResponsePlacementModeSmart ScriptScriptAndVersionSettingGetResponsePlacementMode = "smart"
)

func (ScriptScriptAndVersionSettingGetResponsePlacementMode) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseUsageModel added in v4.3.0

type ScriptScriptAndVersionSettingGetResponseUsageModel string

Usage model for the Worker invocations.

const (
	ScriptScriptAndVersionSettingGetResponseUsageModelStandard ScriptScriptAndVersionSettingGetResponseUsageModel = "standard"
)

func (ScriptScriptAndVersionSettingGetResponseUsageModel) IsKnown added in v4.3.0

type ScriptScriptAndVersionSettingService added in v4.3.0

type ScriptScriptAndVersionSettingService struct {
	Options []option.RequestOption
}

ScriptScriptAndVersionSettingService 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 NewScriptScriptAndVersionSettingService method instead.

func NewScriptScriptAndVersionSettingService added in v4.3.0

func NewScriptScriptAndVersionSettingService(opts ...option.RequestOption) (r *ScriptScriptAndVersionSettingService)

NewScriptScriptAndVersionSettingService 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 (*ScriptScriptAndVersionSettingService) Edit added in v4.3.0

Patch metadata or config, such as bindings or usage model.

func (*ScriptScriptAndVersionSettingService) Get added in v4.3.0

Get metadata and config, such as bindings or usage model.

type ScriptSecretDeleteParams added in v4.2.0

type ScriptSecretDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSecretDeleteResponse added in v4.2.0

type ScriptSecretDeleteResponse = interface{}

type ScriptSecretDeleteResponseEnvelope added in v4.2.0

type ScriptSecretDeleteResponseEnvelope struct {
	Errors   []ScriptSecretDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSecretDeleteResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptSecretDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  ScriptSecretDeleteResponse                `json:"result,nullable"`
	JSON    scriptSecretDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSecretDeleteResponseEnvelope) UnmarshalJSON added in v4.2.0

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

type ScriptSecretDeleteResponseEnvelopeErrors added in v4.3.0

type ScriptSecretDeleteResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptSecretDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSecretDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSecretDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptSecretDeleteResponseEnvelopeErrorsSource added in v4.3.0

type ScriptSecretDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptSecretDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSecretDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretDeleteResponseEnvelopeMessages added in v4.3.0

type ScriptSecretDeleteResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptSecretDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSecretDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSecretDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptSecretDeleteResponseEnvelopeMessagesSource added in v4.3.0

type ScriptSecretDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptSecretDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSecretDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretDeleteResponseEnvelopeSuccess added in v4.2.0

type ScriptSecretDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSecretDeleteResponseEnvelopeSuccessTrue ScriptSecretDeleteResponseEnvelopeSuccess = true
)

func (ScriptSecretDeleteResponseEnvelopeSuccess) IsKnown added in v4.2.0

type ScriptSecretGetParams added in v4.2.0

type ScriptSecretGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSecretGetResponse added in v4.2.0

type ScriptSecretGetResponse struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretGetResponseType `json:"type,required"`
	// This field can have the runtime type of [interface{}].
	Algorithm interface{} `json:"algorithm"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretGetResponseFormat `json:"format"`
	// This field can have the runtime type of [interface{}].
	KeyJwk interface{} `json:"key_jwk"`
	// This field can have the runtime type of
	// [[]ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage].
	Usages interface{}                 `json:"usages"`
	JSON   scriptSecretGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

A secret value accessible through a binding.

func (ScriptSecretGetResponse) AsUnion added in v4.3.0

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

Possible runtime types of the union are ScriptSecretGetResponseWorkersBindingKindSecretText, ScriptSecretGetResponseWorkersBindingKindSecretKey.

func (*ScriptSecretGetResponse) UnmarshalJSON added in v4.2.0

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

type ScriptSecretGetResponseEnvelope added in v4.2.0

type ScriptSecretGetResponseEnvelope struct {
	Errors   []ScriptSecretGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSecretGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptSecretGetResponseEnvelopeSuccess `json:"success,required"`
	// A secret value accessible through a binding.
	Result ScriptSecretGetResponse             `json:"result"`
	JSON   scriptSecretGetResponseEnvelopeJSON `json:"-"`
}

func (*ScriptSecretGetResponseEnvelope) UnmarshalJSON added in v4.2.0

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

type ScriptSecretGetResponseEnvelopeErrors added in v4.3.0

type ScriptSecretGetResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ScriptSecretGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSecretGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSecretGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptSecretGetResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    scriptSecretGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSecretGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseEnvelopeMessages added in v4.3.0

type ScriptSecretGetResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ScriptSecretGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSecretGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSecretGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptSecretGetResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    scriptSecretGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSecretGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseEnvelopeSuccess added in v4.2.0

type ScriptSecretGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSecretGetResponseEnvelopeSuccessTrue ScriptSecretGetResponseEnvelopeSuccess = true
)

func (ScriptSecretGetResponseEnvelopeSuccess) IsKnown added in v4.2.0

type ScriptSecretGetResponseFormat added in v4.3.0

type ScriptSecretGetResponseFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretGetResponseFormatRaw   ScriptSecretGetResponseFormat = "raw"
	ScriptSecretGetResponseFormatPkcs8 ScriptSecretGetResponseFormat = "pkcs8"
	ScriptSecretGetResponseFormatSpki  ScriptSecretGetResponseFormat = "spki"
	ScriptSecretGetResponseFormatJwk   ScriptSecretGetResponseFormat = "jwk"
)

func (ScriptSecretGetResponseFormat) IsKnown added in v4.3.0

func (r ScriptSecretGetResponseFormat) IsKnown() bool

type ScriptSecretGetResponseType added in v4.2.0

type ScriptSecretGetResponseType string

The kind of resource that the binding provides.

const (
	ScriptSecretGetResponseTypeSecretText ScriptSecretGetResponseType = "secret_text"
	ScriptSecretGetResponseTypeSecretKey  ScriptSecretGetResponseType = "secret_key"
)

func (ScriptSecretGetResponseType) IsKnown added in v4.2.0

func (r ScriptSecretGetResponseType) IsKnown() bool

type ScriptSecretGetResponseUnion added in v4.3.0

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

A secret value accessible through a binding.

Union satisfied by ScriptSecretGetResponseWorkersBindingKindSecretText or ScriptSecretGetResponseWorkersBindingKindSecretKey.

type ScriptSecretGetResponseWorkersBindingKindSecretKey added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm interface{} `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretGetResponseWorkersBindingKindSecretKeyType `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages []ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage `json:"usages,required"`
	JSON   scriptSecretGetResponseWorkersBindingKindSecretKeyJSON    `json:"-"`
}

func (*ScriptSecretGetResponseWorkersBindingKindSecretKey) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretGetResponseWorkersBindingKindSecretKeyFormatRaw   ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat = "raw"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyFormatPkcs8 ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyFormatSpki  ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat = "spki"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyFormatJwk   ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptSecretGetResponseWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptSecretGetResponseWorkersBindingKindSecretKeyTypeSecretKey ScriptSecretGetResponseWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptSecretGetResponseWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage string
const (
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageEncrypt    ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageDecrypt    ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageSign       ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "sign"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageVerify     ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "verify"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageDeriveKey  ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageDeriveBits ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageWrapKey    ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptSecretGetResponseWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptSecretGetResponseWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretText added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretGetResponseWorkersBindingKindSecretTextType `json:"type,required"`
	JSON scriptSecretGetResponseWorkersBindingKindSecretTextJSON `json:"-"`
}

func (*ScriptSecretGetResponseWorkersBindingKindSecretText) UnmarshalJSON added in v4.3.0

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

type ScriptSecretGetResponseWorkersBindingKindSecretTextType added in v4.3.0

type ScriptSecretGetResponseWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptSecretGetResponseWorkersBindingKindSecretTextTypeSecretText ScriptSecretGetResponseWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptSecretGetResponseWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptSecretListParams added in v4.2.0

type ScriptSecretListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSecretListResponse added in v4.2.0

type ScriptSecretListResponse struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretListResponseType `json:"type,required"`
	// This field can have the runtime type of [interface{}].
	Algorithm interface{} `json:"algorithm"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretListResponseFormat `json:"format"`
	// This field can have the runtime type of [interface{}].
	KeyJwk interface{} `json:"key_jwk"`
	// This field can have the runtime type of
	// [[]ScriptSecretListResponseWorkersBindingKindSecretKeyUsage].
	Usages interface{}                  `json:"usages"`
	JSON   scriptSecretListResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

A secret value accessible through a binding.

func (ScriptSecretListResponse) AsUnion added in v4.3.0

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

Possible runtime types of the union are ScriptSecretListResponseWorkersBindingKindSecretText, ScriptSecretListResponseWorkersBindingKindSecretKey.

func (*ScriptSecretListResponse) UnmarshalJSON added in v4.2.0

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

type ScriptSecretListResponseFormat added in v4.3.0

type ScriptSecretListResponseFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretListResponseFormatRaw   ScriptSecretListResponseFormat = "raw"
	ScriptSecretListResponseFormatPkcs8 ScriptSecretListResponseFormat = "pkcs8"
	ScriptSecretListResponseFormatSpki  ScriptSecretListResponseFormat = "spki"
	ScriptSecretListResponseFormatJwk   ScriptSecretListResponseFormat = "jwk"
)

func (ScriptSecretListResponseFormat) IsKnown added in v4.3.0

type ScriptSecretListResponseType added in v4.2.0

type ScriptSecretListResponseType string

The kind of resource that the binding provides.

const (
	ScriptSecretListResponseTypeSecretText ScriptSecretListResponseType = "secret_text"
	ScriptSecretListResponseTypeSecretKey  ScriptSecretListResponseType = "secret_key"
)

func (ScriptSecretListResponseType) IsKnown added in v4.2.0

func (r ScriptSecretListResponseType) IsKnown() bool

type ScriptSecretListResponseUnion added in v4.3.0

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

A secret value accessible through a binding.

Union satisfied by ScriptSecretListResponseWorkersBindingKindSecretText or ScriptSecretListResponseWorkersBindingKindSecretKey.

type ScriptSecretListResponseWorkersBindingKindSecretKey added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm interface{} `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretListResponseWorkersBindingKindSecretKeyFormat `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretListResponseWorkersBindingKindSecretKeyType `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages []ScriptSecretListResponseWorkersBindingKindSecretKeyUsage `json:"usages,required"`
	JSON   scriptSecretListResponseWorkersBindingKindSecretKeyJSON    `json:"-"`
}

func (*ScriptSecretListResponseWorkersBindingKindSecretKey) UnmarshalJSON added in v4.3.0

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

type ScriptSecretListResponseWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretListResponseWorkersBindingKindSecretKeyFormatRaw   ScriptSecretListResponseWorkersBindingKindSecretKeyFormat = "raw"
	ScriptSecretListResponseWorkersBindingKindSecretKeyFormatPkcs8 ScriptSecretListResponseWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptSecretListResponseWorkersBindingKindSecretKeyFormatSpki  ScriptSecretListResponseWorkersBindingKindSecretKeyFormat = "spki"
	ScriptSecretListResponseWorkersBindingKindSecretKeyFormatJwk   ScriptSecretListResponseWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptSecretListResponseWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptSecretListResponseWorkersBindingKindSecretKeyTypeSecretKey ScriptSecretListResponseWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptSecretListResponseWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretKeyUsage string
const (
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageEncrypt    ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageDecrypt    ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageSign       ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "sign"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageVerify     ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "verify"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageDeriveKey  ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageDeriveBits ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageWrapKey    ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptSecretListResponseWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptSecretListResponseWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptSecretListResponseWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretText added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretListResponseWorkersBindingKindSecretTextType `json:"type,required"`
	JSON scriptSecretListResponseWorkersBindingKindSecretTextJSON `json:"-"`
}

func (*ScriptSecretListResponseWorkersBindingKindSecretText) UnmarshalJSON added in v4.3.0

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

type ScriptSecretListResponseWorkersBindingKindSecretTextType added in v4.3.0

type ScriptSecretListResponseWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptSecretListResponseWorkersBindingKindSecretTextTypeSecretText ScriptSecretListResponseWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptSecretListResponseWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptSecretService added in v4.2.0

type ScriptSecretService struct {
	Options []option.RequestOption
}

ScriptSecretService 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 NewScriptSecretService method instead.

func NewScriptSecretService added in v4.2.0

func NewScriptSecretService(opts ...option.RequestOption) (r *ScriptSecretService)

NewScriptSecretService 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 (*ScriptSecretService) Delete added in v4.2.0

func (r *ScriptSecretService) Delete(ctx context.Context, scriptName string, secretName string, body ScriptSecretDeleteParams, opts ...option.RequestOption) (res *ScriptSecretDeleteResponse, err error)

Remove a secret from a script.

func (*ScriptSecretService) Get added in v4.2.0

func (r *ScriptSecretService) Get(ctx context.Context, scriptName string, secretName string, query ScriptSecretGetParams, opts ...option.RequestOption) (res *ScriptSecretGetResponse, err error)

Get a given secret binding (value omitted) on a script.

func (*ScriptSecretService) List added in v4.2.0

List secrets bound to a script.

func (*ScriptSecretService) ListAutoPaging added in v4.2.0

List secrets bound to a script.

func (*ScriptSecretService) Update added in v4.2.0

Add a secret to a script.

type ScriptSecretUpdateParams added in v4.2.0

type ScriptSecretUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// A secret value accessible through a binding.
	Body ScriptSecretUpdateParamsBodyUnion `json:"body,required"`
}

func (ScriptSecretUpdateParams) MarshalJSON added in v4.2.0

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

type ScriptSecretUpdateParamsBody added in v4.3.0

type ScriptSecretUpdateParamsBody struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type      param.Field[ScriptSecretUpdateParamsBodyType] `json:"type,required"`
	Algorithm param.Field[interface{}]                      `json:"algorithm"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptSecretUpdateParamsBodyFormat] `json:"format"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string]      `json:"key_base64"`
	KeyJwk    param.Field[interface{}] `json:"key_jwk"`
	// The secret value to use.
	Text   param.Field[string]      `json:"text"`
	Usages param.Field[interface{}] `json:"usages"`
}

A secret value accessible through a binding.

func (ScriptSecretUpdateParamsBody) MarshalJSON added in v4.3.0

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

type ScriptSecretUpdateParamsBodyFormat added in v4.3.0

type ScriptSecretUpdateParamsBodyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretUpdateParamsBodyFormatRaw   ScriptSecretUpdateParamsBodyFormat = "raw"
	ScriptSecretUpdateParamsBodyFormatPkcs8 ScriptSecretUpdateParamsBodyFormat = "pkcs8"
	ScriptSecretUpdateParamsBodyFormatSpki  ScriptSecretUpdateParamsBodyFormat = "spki"
	ScriptSecretUpdateParamsBodyFormatJwk   ScriptSecretUpdateParamsBodyFormat = "jwk"
)

func (ScriptSecretUpdateParamsBodyFormat) IsKnown added in v4.3.0

type ScriptSecretUpdateParamsBodyType added in v4.3.0

type ScriptSecretUpdateParamsBodyType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateParamsBodyTypeSecretText ScriptSecretUpdateParamsBodyType = "secret_text"
	ScriptSecretUpdateParamsBodyTypeSecretKey  ScriptSecretUpdateParamsBodyType = "secret_key"
)

func (ScriptSecretUpdateParamsBodyType) IsKnown added in v4.3.0

type ScriptSecretUpdateParamsBodyUnion added in v4.3.0

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

A secret value accessible through a binding.

Satisfied by workers.ScriptSecretUpdateParamsBodyWorkersBindingKindSecretText, workers.ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKey, ScriptSecretUpdateParamsBody.

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKey added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm param.Field[interface{}] `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat] `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyType] `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages param.Field[[]ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage] `json:"usages,required"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string] `json:"key_base64"`
	// Key data in
	// [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key)
	// format. Required if `format` is "jwk".
	KeyJwk param.Field[interface{}] `json:"key_jwk"`
}

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKey) MarshalJSON added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormatRaw   ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat = "raw"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormatPkcs8 ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormatSpki  ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat = "spki"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormatJwk   ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyTypeSecretKey ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage string
const (
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageEncrypt    ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageDecrypt    ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageSign       ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "sign"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageVerify     ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "verify"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageDeriveKey  ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageDeriveBits ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageWrapKey    ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretText added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The secret value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextType] `json:"type,required"`
}

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretText) MarshalJSON added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextType added in v4.3.0

type ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextTypeSecretText ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptSecretUpdateParamsBodyWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptSecretUpdateResponse added in v4.2.0

type ScriptSecretUpdateResponse struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretUpdateResponseType `json:"type,required"`
	// This field can have the runtime type of [interface{}].
	Algorithm interface{} `json:"algorithm"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretUpdateResponseFormat `json:"format"`
	// This field can have the runtime type of [interface{}].
	KeyJwk interface{} `json:"key_jwk"`
	// This field can have the runtime type of
	// [[]ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage].
	Usages interface{}                    `json:"usages"`
	JSON   scriptSecretUpdateResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

A secret value accessible through a binding.

func (ScriptSecretUpdateResponse) AsUnion added in v4.3.0

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

Possible runtime types of the union are ScriptSecretUpdateResponseWorkersBindingKindSecretText, ScriptSecretUpdateResponseWorkersBindingKindSecretKey.

func (*ScriptSecretUpdateResponse) UnmarshalJSON added in v4.2.0

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

type ScriptSecretUpdateResponseEnvelope added in v4.2.0

type ScriptSecretUpdateResponseEnvelope struct {
	Errors   []ScriptSecretUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSecretUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptSecretUpdateResponseEnvelopeSuccess `json:"success,required"`
	// A secret value accessible through a binding.
	Result ScriptSecretUpdateResponse             `json:"result"`
	JSON   scriptSecretUpdateResponseEnvelopeJSON `json:"-"`
}

func (*ScriptSecretUpdateResponseEnvelope) UnmarshalJSON added in v4.2.0

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

type ScriptSecretUpdateResponseEnvelopeErrors added in v4.3.0

type ScriptSecretUpdateResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptSecretUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSecretUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSecretUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseEnvelopeErrorsSource added in v4.3.0

type ScriptSecretUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptSecretUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSecretUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseEnvelopeMessages added in v4.3.0

type ScriptSecretUpdateResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptSecretUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSecretUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSecretUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseEnvelopeMessagesSource added in v4.3.0

type ScriptSecretUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptSecretUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSecretUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseEnvelopeSuccess added in v4.2.0

type ScriptSecretUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSecretUpdateResponseEnvelopeSuccessTrue ScriptSecretUpdateResponseEnvelopeSuccess = true
)

func (ScriptSecretUpdateResponseEnvelopeSuccess) IsKnown added in v4.2.0

type ScriptSecretUpdateResponseFormat added in v4.3.0

type ScriptSecretUpdateResponseFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretUpdateResponseFormatRaw   ScriptSecretUpdateResponseFormat = "raw"
	ScriptSecretUpdateResponseFormatPkcs8 ScriptSecretUpdateResponseFormat = "pkcs8"
	ScriptSecretUpdateResponseFormatSpki  ScriptSecretUpdateResponseFormat = "spki"
	ScriptSecretUpdateResponseFormatJwk   ScriptSecretUpdateResponseFormat = "jwk"
)

func (ScriptSecretUpdateResponseFormat) IsKnown added in v4.3.0

type ScriptSecretUpdateResponseType added in v4.2.0

type ScriptSecretUpdateResponseType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateResponseTypeSecretText ScriptSecretUpdateResponseType = "secret_text"
	ScriptSecretUpdateResponseTypeSecretKey  ScriptSecretUpdateResponseType = "secret_key"
)

func (ScriptSecretUpdateResponseType) IsKnown added in v4.2.0

type ScriptSecretUpdateResponseUnion added in v4.3.0

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

A secret value accessible through a binding.

Union satisfied by ScriptSecretUpdateResponseWorkersBindingKindSecretText or ScriptSecretUpdateResponseWorkersBindingKindSecretKey.

type ScriptSecretUpdateResponseWorkersBindingKindSecretKey added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm interface{} `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyType `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages []ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage `json:"usages,required"`
	JSON   scriptSecretUpdateResponseWorkersBindingKindSecretKeyJSON    `json:"-"`
}

func (*ScriptSecretUpdateResponseWorkersBindingKindSecretKey) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormatRaw   ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat = "raw"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormatPkcs8 ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormatSpki  ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat = "spki"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormatJwk   ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptSecretUpdateResponseWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyTypeSecretKey ScriptSecretUpdateResponseWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptSecretUpdateResponseWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage string
const (
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageEncrypt    ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageDecrypt    ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageSign       ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "sign"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageVerify     ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "verify"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageDeriveKey  ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageDeriveBits ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageWrapKey    ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptSecretUpdateResponseWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretText added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name string `json:"name,required"`
	// The kind of resource that the binding provides.
	Type ScriptSecretUpdateResponseWorkersBindingKindSecretTextType `json:"type,required"`
	JSON scriptSecretUpdateResponseWorkersBindingKindSecretTextJSON `json:"-"`
}

func (*ScriptSecretUpdateResponseWorkersBindingKindSecretText) UnmarshalJSON added in v4.3.0

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

type ScriptSecretUpdateResponseWorkersBindingKindSecretTextType added in v4.3.0

type ScriptSecretUpdateResponseWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptSecretUpdateResponseWorkersBindingKindSecretTextTypeSecretText ScriptSecretUpdateResponseWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptSecretUpdateResponseWorkersBindingKindSecretTextType) IsKnown added in v4.3.0

type ScriptService

type ScriptService struct {
	Options                  []option.RequestOption
	Assets                   *ScriptAssetService
	Subdomain                *ScriptSubdomainService
	Schedules                *ScriptScheduleService
	Tail                     *ScriptTailService
	Content                  *ScriptContentService
	Settings                 *ScriptSettingService
	Deployments              *ScriptDeploymentService
	Versions                 *ScriptVersionService
	Secrets                  *ScriptSecretService
	ScriptAndVersionSettings *ScriptScriptAndVersionSettingService
}

ScriptService 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 NewScriptService method instead.

func NewScriptService

func NewScriptService(opts ...option.RequestOption) (r *ScriptService)

NewScriptService 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 (*ScriptService) Delete

func (r *ScriptService) Delete(ctx context.Context, scriptName string, params ScriptDeleteParams, opts ...option.RequestOption) (res *ScriptDeleteResponse, err error)

Delete your worker. This call has no response body on a successful delete.

func (*ScriptService) Get

func (r *ScriptService) Get(ctx context.Context, scriptName string, query ScriptGetParams, opts ...option.RequestOption) (res *string, err error)

Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.

func (*ScriptService) List

Fetch a list of uploaded workers.

func (*ScriptService) ListAutoPaging

Fetch a list of uploaded workers.

func (*ScriptService) Update

func (r *ScriptService) Update(ctx context.Context, scriptName string, params ScriptUpdateParams, opts ...option.RequestOption) (res *ScriptUpdateResponse, err error)

Upload a worker module. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.

type ScriptSetting

type ScriptSetting struct {
	// Whether Logpush is turned on for the Worker.
	Logpush bool `json:"logpush"`
	// Observability settings for the Worker.
	Observability ScriptSettingObservability `json:"observability,nullable"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers []ConsumerScript  `json:"tail_consumers,nullable"`
	JSON          scriptSettingJSON `json:"-"`
}

func (*ScriptSetting) UnmarshalJSON

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

type ScriptSettingEditParams

type ScriptSettingEditParams struct {
	// Identifier.
	AccountID     param.Field[string] `path:"account_id,required"`
	ScriptSetting ScriptSettingParam  `json:"script_setting,required"`
}

func (ScriptSettingEditParams) MarshalJSON

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

type ScriptSettingEditResponseEnvelope

type ScriptSettingEditResponseEnvelope struct {
	Errors   []ScriptSettingEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSettingEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptSetting                               `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptSettingEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptSettingEditResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSettingEditResponseEnvelope) UnmarshalJSON

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

type ScriptSettingEditResponseEnvelopeErrors added in v4.3.0

type ScriptSettingEditResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ScriptSettingEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSettingEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSettingEditResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptSettingEditResponseEnvelopeErrorsSource added in v4.3.0

type ScriptSettingEditResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    scriptSettingEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSettingEditResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptSettingEditResponseEnvelopeMessages added in v4.3.0

type ScriptSettingEditResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ScriptSettingEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSettingEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSettingEditResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptSettingEditResponseEnvelopeMessagesSource added in v4.3.0

type ScriptSettingEditResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    scriptSettingEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSettingEditResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptSettingEditResponseEnvelopeSuccess

type ScriptSettingEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSettingEditResponseEnvelopeSuccessTrue ScriptSettingEditResponseEnvelopeSuccess = true
)

func (ScriptSettingEditResponseEnvelopeSuccess) IsKnown

type ScriptSettingGetParams

type ScriptSettingGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSettingGetResponseEnvelope

type ScriptSettingGetResponseEnvelope struct {
	Errors   []ScriptSettingGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSettingGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptSetting                              `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptSettingGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptSettingGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSettingGetResponseEnvelope) UnmarshalJSON

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

type ScriptSettingGetResponseEnvelopeErrors added in v4.3.0

type ScriptSettingGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ScriptSettingGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSettingGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSettingGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptSettingGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptSettingGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    scriptSettingGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSettingGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptSettingGetResponseEnvelopeMessages added in v4.3.0

type ScriptSettingGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptSettingGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSettingGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSettingGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptSettingGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptSettingGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptSettingGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSettingGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptSettingGetResponseEnvelopeSuccess

type ScriptSettingGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSettingGetResponseEnvelopeSuccessTrue ScriptSettingGetResponseEnvelopeSuccess = true
)

func (ScriptSettingGetResponseEnvelopeSuccess) IsKnown

type ScriptSettingObservability

type ScriptSettingObservability struct {
	// Whether observability is enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate float64 `json:"head_sampling_rate,nullable"`
	// Log settings for the Worker.
	Logs ScriptSettingObservabilityLogs `json:"logs,nullable"`
	JSON scriptSettingObservabilityJSON `json:"-"`
}

Observability settings for the Worker.

func (*ScriptSettingObservability) UnmarshalJSON

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

type ScriptSettingObservabilityLogs added in v4.4.0

type ScriptSettingObservabilityLogs struct {
	// Whether logs are enabled for the Worker.
	Enabled bool `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs bool `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate float64                            `json:"head_sampling_rate,nullable"`
	JSON             scriptSettingObservabilityLogsJSON `json:"-"`
}

Log settings for the Worker.

func (*ScriptSettingObservabilityLogs) UnmarshalJSON added in v4.4.0

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

type ScriptSettingObservabilityLogsParam added in v4.4.0

type ScriptSettingObservabilityLogsParam struct {
	// Whether logs are enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs param.Field[bool] `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
}

Log settings for the Worker.

func (ScriptSettingObservabilityLogsParam) MarshalJSON added in v4.4.0

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

type ScriptSettingObservabilityParam

type ScriptSettingObservabilityParam struct {
	// Whether observability is enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
	// Log settings for the Worker.
	Logs param.Field[ScriptSettingObservabilityLogsParam] `json:"logs"`
}

Observability settings for the Worker.

func (ScriptSettingObservabilityParam) MarshalJSON

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

type ScriptSettingParam

type ScriptSettingParam struct {
	// Whether Logpush is turned on for the Worker.
	Logpush param.Field[bool] `json:"logpush"`
	// Observability settings for the Worker.
	Observability param.Field[ScriptSettingObservabilityParam] `json:"observability"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers param.Field[[]ConsumerScriptParam] `json:"tail_consumers"`
}

func (ScriptSettingParam) MarshalJSON

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

type ScriptSettingService

type ScriptSettingService struct {
	Options []option.RequestOption
}

ScriptSettingService 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 NewScriptSettingService method instead.

func NewScriptSettingService

func NewScriptSettingService(opts ...option.RequestOption) (r *ScriptSettingService)

NewScriptSettingService 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 (*ScriptSettingService) Edit

func (r *ScriptSettingService) Edit(ctx context.Context, scriptName string, params ScriptSettingEditParams, opts ...option.RequestOption) (res *ScriptSetting, err error)

Patch script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Including but not limited to Logpush and Tail Consumers.

func (*ScriptSettingService) Get

func (r *ScriptSettingService) Get(ctx context.Context, scriptName string, query ScriptSettingGetParams, opts ...option.RequestOption) (res *ScriptSetting, err error)

Get script-level settings when using [Worker Versions](https://developers.cloudflare.com/api/operations/worker-versions-list-versions). Includes Logpush and Tail Consumers.

type ScriptSubdomainDeleteParams added in v4.4.0

type ScriptSubdomainDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSubdomainDeleteResponse added in v4.4.0

type ScriptSubdomainDeleteResponse struct {
	// Whether the Worker is available on the workers.dev subdomain.
	Enabled bool `json:"enabled,required"`
	// Whether the Worker's Preview URLs are available on the workers.dev subdomain.
	PreviewsEnabled bool                              `json:"previews_enabled,required"`
	JSON            scriptSubdomainDeleteResponseJSON `json:"-"`
}

func (*ScriptSubdomainDeleteResponse) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelope added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelope struct {
	Errors   []ScriptSubdomainDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSubdomainDeleteResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptSubdomainDeleteResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptSubdomainDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptSubdomainDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSubdomainDeleteResponseEnvelope) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelopeErrors added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelopeErrors struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ScriptSubdomainDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSubdomainDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSubdomainDeleteResponseEnvelopeErrors) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelopeErrorsSource added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    scriptSubdomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSubdomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelopeMessages added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelopeMessages struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           ScriptSubdomainDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSubdomainDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSubdomainDeleteResponseEnvelopeMessages) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelopeMessagesSource added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    scriptSubdomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSubdomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainDeleteResponseEnvelopeSuccess added in v4.4.0

type ScriptSubdomainDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSubdomainDeleteResponseEnvelopeSuccessTrue ScriptSubdomainDeleteResponseEnvelopeSuccess = true
)

func (ScriptSubdomainDeleteResponseEnvelopeSuccess) IsKnown added in v4.4.0

type ScriptSubdomainGetParams

type ScriptSubdomainGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptSubdomainGetResponse

type ScriptSubdomainGetResponse struct {
	// Whether the Worker is available on the workers.dev subdomain.
	Enabled bool `json:"enabled,required"`
	// Whether the Worker's Preview URLs are available on the workers.dev subdomain.
	PreviewsEnabled bool                           `json:"previews_enabled,required"`
	JSON            scriptSubdomainGetResponseJSON `json:"-"`
}

func (*ScriptSubdomainGetResponse) UnmarshalJSON

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

type ScriptSubdomainGetResponseEnvelope added in v4.4.0

type ScriptSubdomainGetResponseEnvelope struct {
	Errors   []ScriptSubdomainGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSubdomainGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptSubdomainGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptSubdomainGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptSubdomainGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSubdomainGetResponseEnvelope) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainGetResponseEnvelopeErrors added in v4.4.0

type ScriptSubdomainGetResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptSubdomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSubdomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSubdomainGetResponseEnvelopeErrors) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainGetResponseEnvelopeErrorsSource added in v4.4.0

type ScriptSubdomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptSubdomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSubdomainGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainGetResponseEnvelopeMessages added in v4.4.0

type ScriptSubdomainGetResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptSubdomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSubdomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSubdomainGetResponseEnvelopeMessages) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainGetResponseEnvelopeMessagesSource added in v4.4.0

type ScriptSubdomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptSubdomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSubdomainGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainGetResponseEnvelopeSuccess added in v4.4.0

type ScriptSubdomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSubdomainGetResponseEnvelopeSuccessTrue ScriptSubdomainGetResponseEnvelopeSuccess = true
)

func (ScriptSubdomainGetResponseEnvelopeSuccess) IsKnown added in v4.4.0

type ScriptSubdomainNewParams

type ScriptSubdomainNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Whether the Worker should be available on the workers.dev subdomain.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Whether the Worker's Preview URLs should be available on the workers.dev
	// subdomain.
	PreviewsEnabled param.Field[bool] `json:"previews_enabled"`
}

func (ScriptSubdomainNewParams) MarshalJSON

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

type ScriptSubdomainNewResponse

type ScriptSubdomainNewResponse struct {
	// Whether the Worker is available on the workers.dev subdomain.
	Enabled bool `json:"enabled,required"`
	// Whether the Worker's Preview URLs are available on the workers.dev subdomain.
	PreviewsEnabled bool                           `json:"previews_enabled,required"`
	JSON            scriptSubdomainNewResponseJSON `json:"-"`
}

func (*ScriptSubdomainNewResponse) UnmarshalJSON

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

type ScriptSubdomainNewResponseEnvelope added in v4.4.0

type ScriptSubdomainNewResponseEnvelope struct {
	Errors   []ScriptSubdomainNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptSubdomainNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptSubdomainNewResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptSubdomainNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptSubdomainNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptSubdomainNewResponseEnvelope) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainNewResponseEnvelopeErrors added in v4.4.0

type ScriptSubdomainNewResponseEnvelopeErrors struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptSubdomainNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptSubdomainNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptSubdomainNewResponseEnvelopeErrors) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainNewResponseEnvelopeErrorsSource added in v4.4.0

type ScriptSubdomainNewResponseEnvelopeErrorsSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptSubdomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptSubdomainNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainNewResponseEnvelopeMessages added in v4.4.0

type ScriptSubdomainNewResponseEnvelopeMessages struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ScriptSubdomainNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptSubdomainNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptSubdomainNewResponseEnvelopeMessages) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainNewResponseEnvelopeMessagesSource added in v4.4.0

type ScriptSubdomainNewResponseEnvelopeMessagesSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    scriptSubdomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptSubdomainNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.4.0

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

type ScriptSubdomainNewResponseEnvelopeSuccess added in v4.4.0

type ScriptSubdomainNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptSubdomainNewResponseEnvelopeSuccessTrue ScriptSubdomainNewResponseEnvelopeSuccess = true
)

func (ScriptSubdomainNewResponseEnvelopeSuccess) IsKnown added in v4.4.0

type ScriptSubdomainService

type ScriptSubdomainService struct {
	Options []option.RequestOption
}

ScriptSubdomainService 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 NewScriptSubdomainService method instead.

func NewScriptSubdomainService

func NewScriptSubdomainService(opts ...option.RequestOption) (r *ScriptSubdomainService)

NewScriptSubdomainService 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 (*ScriptSubdomainService) Delete added in v4.4.0

Disable all workers.dev subdomains for a Worker.

func (*ScriptSubdomainService) Get

Get if the Worker is available on the workers.dev subdomain.

func (*ScriptSubdomainService) New

Enable or disable the Worker on the workers.dev subdomain.

type ScriptTailDeleteParams

type ScriptTailDeleteParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptTailDeleteResponse

type ScriptTailDeleteResponse struct {
	Errors   []ScriptTailDeleteResponseError   `json:"errors,required"`
	Messages []ScriptTailDeleteResponseMessage `json:"messages,required"`
	// Whether the API call was successful.
	Success ScriptTailDeleteResponseSuccess `json:"success,required"`
	JSON    scriptTailDeleteResponseJSON    `json:"-"`
}

func (*ScriptTailDeleteResponse) UnmarshalJSON

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

type ScriptTailDeleteResponseError added in v4.3.0

type ScriptTailDeleteResponseError struct {
	Code             int64                                `json:"code,required"`
	Message          string                               `json:"message,required"`
	DocumentationURL string                               `json:"documentation_url"`
	Source           ScriptTailDeleteResponseErrorsSource `json:"source"`
	JSON             scriptTailDeleteResponseErrorJSON    `json:"-"`
}

func (*ScriptTailDeleteResponseError) UnmarshalJSON added in v4.3.0

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

type ScriptTailDeleteResponseErrorsSource added in v4.3.0

type ScriptTailDeleteResponseErrorsSource struct {
	Pointer string                                   `json:"pointer"`
	JSON    scriptTailDeleteResponseErrorsSourceJSON `json:"-"`
}

func (*ScriptTailDeleteResponseErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailDeleteResponseMessage added in v4.3.0

type ScriptTailDeleteResponseMessage struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           ScriptTailDeleteResponseMessagesSource `json:"source"`
	JSON             scriptTailDeleteResponseMessageJSON    `json:"-"`
}

func (*ScriptTailDeleteResponseMessage) UnmarshalJSON added in v4.3.0

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

type ScriptTailDeleteResponseMessagesSource added in v4.3.0

type ScriptTailDeleteResponseMessagesSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    scriptTailDeleteResponseMessagesSourceJSON `json:"-"`
}

func (*ScriptTailDeleteResponseMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailDeleteResponseSuccess

type ScriptTailDeleteResponseSuccess bool

Whether the API call was successful.

const (
	ScriptTailDeleteResponseSuccessTrue ScriptTailDeleteResponseSuccess = true
)

func (ScriptTailDeleteResponseSuccess) IsKnown

type ScriptTailGetParams

type ScriptTailGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptTailGetResponse

type ScriptTailGetResponse struct {
	// Identifier.
	ID        string                    `json:"id,required"`
	ExpiresAt string                    `json:"expires_at,required"`
	URL       string                    `json:"url,required"`
	JSON      scriptTailGetResponseJSON `json:"-"`
}

func (*ScriptTailGetResponse) UnmarshalJSON

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

type ScriptTailGetResponseEnvelope

type ScriptTailGetResponseEnvelope struct {
	Errors   []ScriptTailGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptTailGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptTailGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptTailGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptTailGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptTailGetResponseEnvelope) UnmarshalJSON

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

type ScriptTailGetResponseEnvelopeErrors added in v4.3.0

type ScriptTailGetResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ScriptTailGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptTailGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptTailGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptTailGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptTailGetResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    scriptTailGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptTailGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailGetResponseEnvelopeMessages added in v4.3.0

type ScriptTailGetResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ScriptTailGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptTailGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptTailGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptTailGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptTailGetResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    scriptTailGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptTailGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailGetResponseEnvelopeSuccess

type ScriptTailGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptTailGetResponseEnvelopeSuccessTrue ScriptTailGetResponseEnvelopeSuccess = true
)

func (ScriptTailGetResponseEnvelopeSuccess) IsKnown

type ScriptTailNewParams

type ScriptTailNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	Body      interface{}         `json:"body,required"`
}

func (ScriptTailNewParams) MarshalJSON

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

type ScriptTailNewResponse

type ScriptTailNewResponse struct {
	// Identifier.
	ID        string                    `json:"id,required"`
	ExpiresAt string                    `json:"expires_at,required"`
	URL       string                    `json:"url,required"`
	JSON      scriptTailNewResponseJSON `json:"-"`
}

func (*ScriptTailNewResponse) UnmarshalJSON

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

type ScriptTailNewResponseEnvelope

type ScriptTailNewResponseEnvelope struct {
	Errors   []ScriptTailNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptTailNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptTailNewResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptTailNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptTailNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptTailNewResponseEnvelope) UnmarshalJSON

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

type ScriptTailNewResponseEnvelopeErrors added in v4.3.0

type ScriptTailNewResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ScriptTailNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptTailNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptTailNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptTailNewResponseEnvelopeErrorsSource added in v4.3.0

type ScriptTailNewResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    scriptTailNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptTailNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailNewResponseEnvelopeMessages added in v4.3.0

type ScriptTailNewResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ScriptTailNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptTailNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptTailNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptTailNewResponseEnvelopeMessagesSource added in v4.3.0

type ScriptTailNewResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    scriptTailNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptTailNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptTailNewResponseEnvelopeSuccess

type ScriptTailNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptTailNewResponseEnvelopeSuccessTrue ScriptTailNewResponseEnvelopeSuccess = true
)

func (ScriptTailNewResponseEnvelopeSuccess) IsKnown

type ScriptTailService

type ScriptTailService struct {
	Options []option.RequestOption
}

ScriptTailService 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 NewScriptTailService method instead.

func NewScriptTailService

func NewScriptTailService(opts ...option.RequestOption) (r *ScriptTailService)

NewScriptTailService 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 (*ScriptTailService) Delete

func (r *ScriptTailService) Delete(ctx context.Context, scriptName string, id string, body ScriptTailDeleteParams, opts ...option.RequestOption) (res *ScriptTailDeleteResponse, err error)

Deletes a tail from a Worker.

func (*ScriptTailService) Get

func (r *ScriptTailService) Get(ctx context.Context, scriptName string, query ScriptTailGetParams, opts ...option.RequestOption) (res *ScriptTailGetResponse, err error)

Get list of tails currently deployed on a Worker.

func (*ScriptTailService) New

func (r *ScriptTailService) New(ctx context.Context, scriptName string, params ScriptTailNewParams, opts ...option.RequestOption) (res *ScriptTailNewResponse, err error)

Starts a tail that receives logs and exception from a Worker.

type ScriptUpdateParams

type ScriptUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// JSON encoded metadata about the uploaded parts and Worker configuration.
	Metadata param.Field[ScriptUpdateParamsMetadata] `json:"metadata,required"`
}

func (ScriptUpdateParams) MarshalJSON

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

type ScriptUpdateParamsMetadata

type ScriptUpdateParamsMetadata struct {
	// Configuration for assets within a Worker.
	Assets param.Field[ScriptUpdateParamsMetadataAssets] `json:"assets"`
	// List of bindings attached to a Worker. You can find more about bindings on our
	// docs:
	// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
	Bindings param.Field[[]ScriptUpdateParamsMetadataBindingUnion] `json:"bindings"`
	// Name of the part in the multipart request that contains the script (e.g. the
	// file adding a listener to the `fetch` event). Indicates a
	// `service worker syntax` Worker.
	BodyPart param.Field[string] `json:"body_part"`
	// Date indicating targeted support in the Workers runtime. Backwards incompatible
	// fixes to the runtime following this date will not affect this Worker.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Flags that enable or disable certain features in the Workers runtime. Used to
	// enable upcoming features or opt in or out of specific changes not included in a
	// `compatibility_date`.
	CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
	// Retain assets which exist for a previously uploaded Worker version; used in lieu
	// of providing a completion token.
	KeepAssets param.Field[bool] `json:"keep_assets"`
	// List of binding types to keep from previous_upload.
	KeepBindings param.Field[[]string] `json:"keep_bindings"`
	// Whether Logpush is turned on for the Worker.
	Logpush param.Field[bool] `json:"logpush"`
	// Name of the part in the multipart request that contains the main module (e.g.
	// the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
	MainModule param.Field[string] `json:"main_module"`
	// Migrations to apply for Durable Objects associated with this Worker.
	Migrations param.Field[ScriptUpdateParamsMetadataMigrationsUnion] `json:"migrations"`
	// Observability settings for the Worker.
	Observability param.Field[ScriptUpdateParamsMetadataObservability] `json:"observability"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement param.Field[ScriptUpdateParamsMetadataPlacement] `json:"placement"`
	// List of strings to use as tags for this Worker.
	Tags param.Field[[]string] `json:"tags"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers param.Field[[]ConsumerScriptParam] `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel param.Field[ScriptUpdateParamsMetadataUsageModel] `json:"usage_model"`
}

JSON encoded metadata about the uploaded parts and Worker configuration.

func (ScriptUpdateParamsMetadata) MarshalJSON

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

type ScriptUpdateParamsMetadataAssets

type ScriptUpdateParamsMetadataAssets struct {
	// Configuration for assets within a Worker.
	Config param.Field[ScriptUpdateParamsMetadataAssetsConfig] `json:"config"`
	// Token provided upon successful upload of all files from a registered manifest.
	JWT param.Field[string] `json:"jwt"`
}

Configuration for assets within a Worker.

func (ScriptUpdateParamsMetadataAssets) MarshalJSON

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

type ScriptUpdateParamsMetadataAssetsConfig

type ScriptUpdateParamsMetadataAssetsConfig struct {
	// The contents of a \_headers file (used to attach custom headers on asset
	// responses).
	Headers param.Field[string] `json:"_headers"`
	// The contents of a \_redirects file (used to apply redirects or proxy paths ahead
	// of asset serving).
	Redirects param.Field[string] `json:"_redirects"`
	// Determines the redirects and rewrites of requests for HTML content.
	HTMLHandling param.Field[ScriptUpdateParamsMetadataAssetsConfigHTMLHandling] `json:"html_handling"`
	// Determines the response when a request does not match a static asset, and there
	// is no Worker script.
	NotFoundHandling param.Field[ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling] `json:"not_found_handling"`
	// When true, requests will always invoke the Worker script. Otherwise, attempt to
	// serve an asset matching the request, falling back to the Worker script.
	RunWorkerFirst param.Field[bool] `json:"run_worker_first"`
	// When true and the incoming request matches an asset, that will be served instead
	// of invoking the Worker script. When false, requests will always invoke the
	// Worker script.
	//
	// Deprecated: deprecated
	ServeDirectly param.Field[bool] `json:"serve_directly"`
}

Configuration for assets within a Worker.

func (ScriptUpdateParamsMetadataAssetsConfig) MarshalJSON

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

type ScriptUpdateParamsMetadataAssetsConfigHTMLHandling

type ScriptUpdateParamsMetadataAssetsConfigHTMLHandling string

Determines the redirects and rewrites of requests for HTML content.

const (
	ScriptUpdateParamsMetadataAssetsConfigHTMLHandlingAutoTrailingSlash  ScriptUpdateParamsMetadataAssetsConfigHTMLHandling = "auto-trailing-slash"
	ScriptUpdateParamsMetadataAssetsConfigHTMLHandlingForceTrailingSlash ScriptUpdateParamsMetadataAssetsConfigHTMLHandling = "force-trailing-slash"
	ScriptUpdateParamsMetadataAssetsConfigHTMLHandlingDropTrailingSlash  ScriptUpdateParamsMetadataAssetsConfigHTMLHandling = "drop-trailing-slash"
	ScriptUpdateParamsMetadataAssetsConfigHTMLHandlingNone               ScriptUpdateParamsMetadataAssetsConfigHTMLHandling = "none"
)

func (ScriptUpdateParamsMetadataAssetsConfigHTMLHandling) IsKnown

type ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling

type ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling string

Determines the response when a request does not match a static asset, and there is no Worker script.

const (
	ScriptUpdateParamsMetadataAssetsConfigNotFoundHandlingNone                  ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling = "none"
	ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling404Page               ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling = "404-page"
	ScriptUpdateParamsMetadataAssetsConfigNotFoundHandlingSinglePageApplication ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling = "single-page-application"
)

func (ScriptUpdateParamsMetadataAssetsConfigNotFoundHandling) IsKnown

type ScriptUpdateParamsMetadataBinding

type ScriptUpdateParamsMetadataBinding struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsType] `json:"type,required"`
	// Identifier of the D1 database to bind to.
	ID        param.Field[string]      `json:"id"`
	Algorithm param.Field[interface{}] `json:"algorithm"`
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name"`
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptUpdateParamsMetadataBindingsFormat] `json:"format"`
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name"`
	// JSON data to use.
	Json param.Field[string] `json:"json"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string]      `json:"key_base64"`
	KeyJwk    param.Field[interface{}] `json:"key_jwk"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace"`
	// Namespace identifier tag.
	NamespaceID param.Field[string]      `json:"namespace_id"`
	Outbound    param.Field[interface{}] `json:"outbound"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id"`
	// The text value to use.
	Text   param.Field[string]      `json:"text"`
	Usages param.Field[interface{}] `json:"usages"`
}

A binding to allow the Worker to communicate with resources.

func (ScriptUpdateParamsMetadataBinding) MarshalJSON

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

type ScriptUpdateParamsMetadataBindingUnion

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

A binding to allow the Worker to communicate with resources.

Satisfied by workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindAI, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngine, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssets, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowser, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespace, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdrive, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindJson, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespace, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificate, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainText, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelines, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueue, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2Bucket, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretText, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindService, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumer, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorize, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadata, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret, workers.ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKey, ScriptUpdateParamsMetadataBinding.

type ScriptUpdateParamsMetadataBindingsFormat added in v4.3.0

type ScriptUpdateParamsMetadataBindingsFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptUpdateParamsMetadataBindingsFormatRaw   ScriptUpdateParamsMetadataBindingsFormat = "raw"
	ScriptUpdateParamsMetadataBindingsFormatPkcs8 ScriptUpdateParamsMetadataBindingsFormat = "pkcs8"
	ScriptUpdateParamsMetadataBindingsFormatSpki  ScriptUpdateParamsMetadataBindingsFormat = "spki"
	ScriptUpdateParamsMetadataBindingsFormatJwk   ScriptUpdateParamsMetadataBindingsFormat = "jwk"
)

func (ScriptUpdateParamsMetadataBindingsFormat) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsType added in v4.2.0

type ScriptUpdateParamsMetadataBindingsType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsTypeAI                     ScriptUpdateParamsMetadataBindingsType = "ai"
	ScriptUpdateParamsMetadataBindingsTypeAnalyticsEngine        ScriptUpdateParamsMetadataBindingsType = "analytics_engine"
	ScriptUpdateParamsMetadataBindingsTypeAssets                 ScriptUpdateParamsMetadataBindingsType = "assets"
	ScriptUpdateParamsMetadataBindingsTypeBrowser                ScriptUpdateParamsMetadataBindingsType = "browser"
	ScriptUpdateParamsMetadataBindingsTypeD1                     ScriptUpdateParamsMetadataBindingsType = "d1"
	ScriptUpdateParamsMetadataBindingsTypeDispatchNamespace      ScriptUpdateParamsMetadataBindingsType = "dispatch_namespace"
	ScriptUpdateParamsMetadataBindingsTypeDurableObjectNamespace ScriptUpdateParamsMetadataBindingsType = "durable_object_namespace"
	ScriptUpdateParamsMetadataBindingsTypeHyperdrive             ScriptUpdateParamsMetadataBindingsType = "hyperdrive"
	ScriptUpdateParamsMetadataBindingsTypeJson                   ScriptUpdateParamsMetadataBindingsType = "json"
	ScriptUpdateParamsMetadataBindingsTypeKVNamespace            ScriptUpdateParamsMetadataBindingsType = "kv_namespace"
	ScriptUpdateParamsMetadataBindingsTypeMTLSCertificate        ScriptUpdateParamsMetadataBindingsType = "mtls_certificate"
	ScriptUpdateParamsMetadataBindingsTypePlainText              ScriptUpdateParamsMetadataBindingsType = "plain_text"
	ScriptUpdateParamsMetadataBindingsTypePipelines              ScriptUpdateParamsMetadataBindingsType = "pipelines"
	ScriptUpdateParamsMetadataBindingsTypeQueue                  ScriptUpdateParamsMetadataBindingsType = "queue"
	ScriptUpdateParamsMetadataBindingsTypeR2Bucket               ScriptUpdateParamsMetadataBindingsType = "r2_bucket"
	ScriptUpdateParamsMetadataBindingsTypeSecretText             ScriptUpdateParamsMetadataBindingsType = "secret_text"
	ScriptUpdateParamsMetadataBindingsTypeService                ScriptUpdateParamsMetadataBindingsType = "service"
	ScriptUpdateParamsMetadataBindingsTypeTailConsumer           ScriptUpdateParamsMetadataBindingsType = "tail_consumer"
	ScriptUpdateParamsMetadataBindingsTypeVectorize              ScriptUpdateParamsMetadataBindingsType = "vectorize"
	ScriptUpdateParamsMetadataBindingsTypeVersionMetadata        ScriptUpdateParamsMetadataBindingsType = "version_metadata"
	ScriptUpdateParamsMetadataBindingsTypeSecretsStoreSecret     ScriptUpdateParamsMetadataBindingsType = "secrets_store_secret"
	ScriptUpdateParamsMetadataBindingsTypeSecretKey              ScriptUpdateParamsMetadataBindingsType = "secret_key"
)

func (ScriptUpdateParamsMetadataBindingsType) IsKnown added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAI

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAI struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindAIType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAI) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAIType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAIType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindAITypeAI ScriptUpdateParamsMetadataBindingsWorkersBindingKindAIType = "ai"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAIType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngine

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngine struct {
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngine) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineTypeAnalyticsEngine ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType = "analytics_engine"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssets

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssets struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssets) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsTypeAssets ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsType = "assets"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindAssetsType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowser added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowser struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowser) MarshalJSON added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserType added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserTypeBrowser ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserType = "browser"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindBrowserType) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1 struct {
	// Identifier of the D1 database to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1Type] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1Type

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1Type string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1TypeD1 ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1Type = "d1"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindD1Type) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespace

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType] `json:"type,required"`
	// Outbound worker.
	Outbound param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound] `json:"outbound"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespace) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound struct {
	// Pass information from the Dispatch Worker to the Outbound Worker through the
	// parameters.
	Params param.Field[[]string] `json:"params"`
	// Outbound worker.
	Worker param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker] `json:"worker"`
}

Outbound worker.

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker struct {
	// Environment of the outbound worker.
	Environment param.Field[string] `json:"environment"`
	// Name of the outbound worker.
	Service param.Field[string] `json:"service"`
}

Outbound worker.

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceTypeDispatchNamespace ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType = "dispatch_namespace"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType] `json:"type,required"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace) MarshalJSON added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceTypeDurableObjectNamespace ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType = "durable_object_namespace"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType) IsKnown added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdrive

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdrive struct {
	// Identifier of the Hyperdrive connection to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdrive) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveTypeHyperdrive ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveType = "hyperdrive"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindHyperdriveType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindJson

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindJson struct {
	// JSON data to use.
	Json param.Field[string] `json:"json,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindJson) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonTypeJson ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonType = "json"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindJsonType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespace

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespace) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceTypeKVNamespace ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceType = "kv_namespace"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindKVNamespaceType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificate added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificate struct {
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificate) MarshalJSON added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateType added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateTypeMTLSCertificate ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateType = "mtls_certificate"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindMTLSCertificateType) IsKnown added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelines added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelines struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelines) MarshalJSON added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesType added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesTypePipelines ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesType = "pipelines"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindPipelinesType) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainText

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The text value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainText) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextTypePlainText ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextType = "plain_text"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindPlainTextType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueue

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueue struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueue) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueTypeQueue ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueType = "queue"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindQueueType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2Bucket added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2Bucket struct {
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2Bucket) MarshalJSON added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketType added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketTypeR2Bucket ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketType = "r2_bucket"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindR2BucketType) IsKnown added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKey added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm param.Field[interface{}] `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat] `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyType] `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages param.Field[[]ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage] `json:"usages,required"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string] `json:"key_base64"`
	// Key data in
	// [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key)
	// format. Required if `format` is "jwk".
	KeyJwk param.Field[interface{}] `json:"key_jwk"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKey) MarshalJSON added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormatRaw   ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "raw"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormatPkcs8 ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormatSpki  ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "spki"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormatJwk   ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyTypeSecretKey ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage string
const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageEncrypt    ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDecrypt    ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageSign       ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "sign"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageVerify     ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "verify"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDeriveKey  ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDeriveBits ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageWrapKey    ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretText added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The secret value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretText) MarshalJSON added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextType added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextTypeSecretText ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretTextType) IsKnown added in v4.2.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name,required"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret) MarshalJSON added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretTypeSecretsStoreSecret ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType = "secrets_store_secret"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType) IsKnown added in v4.3.0

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindService

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindService struct {
	// Optional environment if the Worker utilizes one.
	Environment param.Field[string] `json:"environment,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindService) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceTypeService ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceType = "service"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindServiceType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumer

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumer struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Tail Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumer) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerTypeTailConsumer ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerType = "tail_consumer"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindTailConsumerType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorize

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorize struct {
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorize) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeTypeVectorize ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeType = "vectorize"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindVectorizeType) IsKnown

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadata

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadata struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataType] `json:"type,required"`
}

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadata) MarshalJSON

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataType

type ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataType string

The kind of resource that the binding provides.

const (
	ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataTypeVersionMetadata ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataType = "version_metadata"
)

func (ScriptUpdateParamsMetadataBindingsWorkersBindingKindVersionMetadataType) IsKnown

type ScriptUpdateParamsMetadataMigrations

type ScriptUpdateParamsMetadataMigrations struct {
	DeletedClasses   param.Field[interface{}] `json:"deleted_classes"`
	NewClasses       param.Field[interface{}] `json:"new_classes"`
	NewSqliteClasses param.Field[interface{}] `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag param.Field[string] `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag             param.Field[string]      `json:"old_tag"`
	RenamedClasses     param.Field[interface{}] `json:"renamed_classes"`
	Steps              param.Field[interface{}] `json:"steps"`
	TransferredClasses param.Field[interface{}] `json:"transferred_classes"`
}

Migrations to apply for Durable Objects associated with this Worker.

func (ScriptUpdateParamsMetadataMigrations) MarshalJSON

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

type ScriptUpdateParamsMetadataMigrationsUnion

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

Migrations to apply for Durable Objects associated with this Worker.

Satisfied by workers.SingleStepMigrationParam, workers.ScriptUpdateParamsMetadataMigrationsWorkersMultipleStepMigrations, ScriptUpdateParamsMetadataMigrations.

type ScriptUpdateParamsMetadataMigrationsWorkersMultipleStepMigrations

type ScriptUpdateParamsMetadataMigrationsWorkersMultipleStepMigrations struct {
	// Tag to set as the latest migration tag.
	NewTag param.Field[string] `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag param.Field[string] `json:"old_tag"`
	// Migrations to apply in order.
	Steps param.Field[[]MigrationStepParam] `json:"steps"`
}

func (ScriptUpdateParamsMetadataMigrationsWorkersMultipleStepMigrations) MarshalJSON

type ScriptUpdateParamsMetadataObservability

type ScriptUpdateParamsMetadataObservability struct {
	// Whether observability is enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// The sampling rate for incoming requests. From 0 to 1 (1 = 100%, 0.1 = 10%).
	// Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
	// Log settings for the Worker.
	Logs param.Field[ScriptUpdateParamsMetadataObservabilityLogs] `json:"logs"`
}

Observability settings for the Worker.

func (ScriptUpdateParamsMetadataObservability) MarshalJSON

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

type ScriptUpdateParamsMetadataObservabilityLogs added in v4.4.0

type ScriptUpdateParamsMetadataObservabilityLogs struct {
	// Whether logs are enabled for the Worker.
	Enabled param.Field[bool] `json:"enabled,required"`
	// Whether
	// [invocation logs](https://developers.cloudflare.com/workers/observability/logs/workers-logs/#invocation-logs)
	// are enabled for the Worker.
	InvocationLogs param.Field[bool] `json:"invocation_logs,required"`
	// The sampling rate for logs. From 0 to 1 (1 = 100%, 0.1 = 10%). Default is 1.
	HeadSamplingRate param.Field[float64] `json:"head_sampling_rate"`
}

Log settings for the Worker.

func (ScriptUpdateParamsMetadataObservabilityLogs) MarshalJSON added in v4.4.0

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

type ScriptUpdateParamsMetadataPlacement

type ScriptUpdateParamsMetadataPlacement struct {
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode param.Field[ScriptUpdateParamsMetadataPlacementMode] `json:"mode"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (ScriptUpdateParamsMetadataPlacement) MarshalJSON

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

type ScriptUpdateParamsMetadataPlacementMode

type ScriptUpdateParamsMetadataPlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptUpdateParamsMetadataPlacementModeSmart ScriptUpdateParamsMetadataPlacementMode = "smart"
)

func (ScriptUpdateParamsMetadataPlacementMode) IsKnown

type ScriptUpdateParamsMetadataPlacementStatus

type ScriptUpdateParamsMetadataPlacementStatus string

Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptUpdateParamsMetadataPlacementStatusSuccess                 ScriptUpdateParamsMetadataPlacementStatus = "SUCCESS"
	ScriptUpdateParamsMetadataPlacementStatusUnsupportedApplication  ScriptUpdateParamsMetadataPlacementStatus = "UNSUPPORTED_APPLICATION"
	ScriptUpdateParamsMetadataPlacementStatusInsufficientInvocations ScriptUpdateParamsMetadataPlacementStatus = "INSUFFICIENT_INVOCATIONS"
)

func (ScriptUpdateParamsMetadataPlacementStatus) IsKnown

type ScriptUpdateParamsMetadataUsageModel

type ScriptUpdateParamsMetadataUsageModel string

Usage model for the Worker invocations.

const (
	ScriptUpdateParamsMetadataUsageModelStandard ScriptUpdateParamsMetadataUsageModel = "standard"
)

func (ScriptUpdateParamsMetadataUsageModel) IsKnown

type ScriptUpdateResponse

type ScriptUpdateResponse struct {
	StartupTimeMs int64 `json:"startup_time_ms,required"`
	// The id of the script in the Workers system. Usually the script name.
	ID string `json:"id"`
	// When the script was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Hashed script content, can be used in a If-None-Match header when updating.
	Etag string `json:"etag"`
	// Whether a Worker contains assets.
	HasAssets bool `json:"has_assets"`
	// Whether a Worker contains modules.
	HasModules bool `json:"has_modules"`
	// Whether Logpush is turned on for the Worker.
	Logpush bool `json:"logpush"`
	// When the script was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// Configuration for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Placement ScriptUpdateResponsePlacement `json:"placement"`
	// Deprecated: deprecated
	PlacementMode ScriptUpdateResponsePlacementMode `json:"placement_mode"`
	// Deprecated: deprecated
	PlacementStatus ScriptUpdateResponsePlacementStatus `json:"placement_status"`
	// List of Workers that will consume logs from the attached Worker.
	TailConsumers []ConsumerScript `json:"tail_consumers"`
	// Usage model for the Worker invocations.
	UsageModel ScriptUpdateResponseUsageModel `json:"usage_model"`
	JSON       scriptUpdateResponseJSON       `json:"-"`
}

func (*ScriptUpdateResponse) UnmarshalJSON

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

type ScriptUpdateResponseEnvelope

type ScriptUpdateResponseEnvelope struct {
	Errors   []ScriptUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptUpdateResponseEnvelope) UnmarshalJSON

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

type ScriptUpdateResponseEnvelopeErrors added in v4.3.0

type ScriptUpdateResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ScriptUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptUpdateResponseEnvelopeErrorsSource added in v4.3.0

type ScriptUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    scriptUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptUpdateResponseEnvelopeMessages added in v4.3.0

type ScriptUpdateResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           ScriptUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptUpdateResponseEnvelopeMessagesSource added in v4.3.0

type ScriptUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    scriptUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptUpdateResponseEnvelopeSuccess

type ScriptUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptUpdateResponseEnvelopeSuccessTrue ScriptUpdateResponseEnvelopeSuccess = true
)

func (ScriptUpdateResponseEnvelopeSuccess) IsKnown

type ScriptUpdateResponsePlacement

type ScriptUpdateResponsePlacement struct {
	// The last time the script was analyzed for
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	LastAnalyzedAt time.Time `json:"last_analyzed_at" format:"date-time"`
	// Enables
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Mode ScriptUpdateResponsePlacementMode `json:"mode"`
	// Status of
	// [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).
	Status ScriptUpdateResponsePlacementStatus `json:"status"`
	JSON   scriptUpdateResponsePlacementJSON   `json:"-"`
}

Configuration for [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

func (*ScriptUpdateResponsePlacement) UnmarshalJSON

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

type ScriptUpdateResponsePlacementMode

type ScriptUpdateResponsePlacementMode string

Enables [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptUpdateResponsePlacementModeSmart ScriptUpdateResponsePlacementMode = "smart"
)

func (ScriptUpdateResponsePlacementMode) IsKnown

type ScriptUpdateResponsePlacementStatus

type ScriptUpdateResponsePlacementStatus string

Status of [Smart Placement](https://developers.cloudflare.com/workers/configuration/smart-placement).

const (
	ScriptUpdateResponsePlacementStatusSuccess                 ScriptUpdateResponsePlacementStatus = "SUCCESS"
	ScriptUpdateResponsePlacementStatusUnsupportedApplication  ScriptUpdateResponsePlacementStatus = "UNSUPPORTED_APPLICATION"
	ScriptUpdateResponsePlacementStatusInsufficientInvocations ScriptUpdateResponsePlacementStatus = "INSUFFICIENT_INVOCATIONS"
)

func (ScriptUpdateResponsePlacementStatus) IsKnown

type ScriptUpdateResponseUsageModel

type ScriptUpdateResponseUsageModel string

Usage model for the Worker invocations.

const (
	ScriptUpdateResponseUsageModelStandard ScriptUpdateResponseUsageModel = "standard"
)

func (ScriptUpdateResponseUsageModel) IsKnown

type ScriptUsageModel

type ScriptUsageModel string

Usage model for the Worker invocations.

const (
	ScriptUsageModelStandard ScriptUsageModel = "standard"
)

func (ScriptUsageModel) IsKnown

func (r ScriptUsageModel) IsKnown() bool

type ScriptVersionGetParams

type ScriptVersionGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type ScriptVersionGetResponse

type ScriptVersionGetResponse struct {
	Resources interface{}                  `json:"resources,required"`
	ID        string                       `json:"id"`
	Metadata  interface{}                  `json:"metadata"`
	Number    float64                      `json:"number"`
	JSON      scriptVersionGetResponseJSON `json:"-"`
}

func (*ScriptVersionGetResponse) UnmarshalJSON

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

type ScriptVersionGetResponseEnvelope

type ScriptVersionGetResponseEnvelope struct {
	Errors   []ScriptVersionGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptVersionGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptVersionGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptVersionGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptVersionGetResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptVersionGetResponseEnvelope) UnmarshalJSON

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

type ScriptVersionGetResponseEnvelopeErrors added in v4.3.0

type ScriptVersionGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ScriptVersionGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptVersionGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptVersionGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptVersionGetResponseEnvelopeErrorsSource added in v4.3.0

type ScriptVersionGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    scriptVersionGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptVersionGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptVersionGetResponseEnvelopeMessages added in v4.3.0

type ScriptVersionGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptVersionGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptVersionGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptVersionGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptVersionGetResponseEnvelopeMessagesSource added in v4.3.0

type ScriptVersionGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptVersionGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptVersionGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptVersionGetResponseEnvelopeSuccess

type ScriptVersionGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptVersionGetResponseEnvelopeSuccessTrue ScriptVersionGetResponseEnvelopeSuccess = true
)

func (ScriptVersionGetResponseEnvelopeSuccess) IsKnown

type ScriptVersionListParams

type ScriptVersionListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Only return versions that can be used in a deployment. Ignores pagination.
	Deployable param.Field[bool] `query:"deployable"`
	// Current page.
	Page param.Field[int64] `query:"page"`
	// Items per-page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (ScriptVersionListParams) URLQuery

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

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

type ScriptVersionListResponse

type ScriptVersionListResponse struct {
	ID       string                        `json:"id"`
	Metadata interface{}                   `json:"metadata"`
	Number   float64                       `json:"number"`
	JSON     scriptVersionListResponseJSON `json:"-"`
}

func (*ScriptVersionListResponse) UnmarshalJSON

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

type ScriptVersionNewParams

type ScriptVersionNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// JSON encoded metadata about the uploaded parts and Worker configuration.
	Metadata param.Field[ScriptVersionNewParamsMetadata] `json:"metadata,required"`
}

func (ScriptVersionNewParams) MarshalMultipart

func (r ScriptVersionNewParams) MarshalMultipart() (data []byte, contentType string, err error)

type ScriptVersionNewParamsMetadata

type ScriptVersionNewParamsMetadata struct {
	// Name of the part in the multipart request that contains the main module (e.g.
	// the file exporting a `fetch` handler). Indicates a `module syntax` Worker, which
	// is required for Version Upload.
	MainModule  param.Field[string]                                    `json:"main_module,required"`
	Annotations param.Field[ScriptVersionNewParamsMetadataAnnotations] `json:"annotations"`
	// List of bindings attached to a Worker. You can find more about bindings on our
	// docs:
	// https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/#bindings.
	Bindings param.Field[[]ScriptVersionNewParamsMetadataBindingUnion] `json:"bindings"`
	// Date indicating targeted support in the Workers runtime. Backwards incompatible
	// fixes to the runtime following this date will not affect this Worker.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Flags that enable or disable certain features in the Workers runtime. Used to
	// enable upcoming features or opt in or out of specific changes not included in a
	// `compatibility_date`.
	CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
	// List of binding types to keep from previous_upload.
	KeepBindings param.Field[[]string] `json:"keep_bindings"`
	// Usage model for the Worker invocations.
	UsageModel param.Field[ScriptVersionNewParamsMetadataUsageModel] `json:"usage_model"`
}

JSON encoded metadata about the uploaded parts and Worker configuration.

func (ScriptVersionNewParamsMetadata) MarshalJSON

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

type ScriptVersionNewParamsMetadataAnnotations

type ScriptVersionNewParamsMetadataAnnotations struct {
	// Human-readable message about the version. Truncated to 100 bytes.
	WorkersMessage param.Field[string] `json:"workers/message"`
	// User-provided identifier for the version.
	WorkersTag param.Field[string] `json:"workers/tag"`
}

func (ScriptVersionNewParamsMetadataAnnotations) MarshalJSON

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

type ScriptVersionNewParamsMetadataBinding

type ScriptVersionNewParamsMetadataBinding struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsType] `json:"type,required"`
	// Identifier of the D1 database to bind to.
	ID        param.Field[string]      `json:"id"`
	Algorithm param.Field[interface{}] `json:"algorithm"`
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name"`
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptVersionNewParamsMetadataBindingsFormat] `json:"format"`
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name"`
	// JSON data to use.
	Json param.Field[string] `json:"json"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string]      `json:"key_base64"`
	KeyJwk    param.Field[interface{}] `json:"key_jwk"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace"`
	// Namespace identifier tag.
	NamespaceID param.Field[string]      `json:"namespace_id"`
	Outbound    param.Field[interface{}] `json:"outbound"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id"`
	// The text value to use.
	Text   param.Field[string]      `json:"text"`
	Usages param.Field[interface{}] `json:"usages"`
}

A binding to allow the Worker to communicate with resources.

func (ScriptVersionNewParamsMetadataBinding) MarshalJSON

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

type ScriptVersionNewParamsMetadataBindingUnion

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

A binding to allow the Worker to communicate with resources.

Satisfied by workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAI, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngine, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssets, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowser, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespace, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdrive, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJson, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespace, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificate, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainText, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelines, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueue, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2Bucket, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretText, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindService, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumer, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorize, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadata, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret, workers.ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKey, ScriptVersionNewParamsMetadataBinding.

type ScriptVersionNewParamsMetadataBindingsFormat added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptVersionNewParamsMetadataBindingsFormatRaw   ScriptVersionNewParamsMetadataBindingsFormat = "raw"
	ScriptVersionNewParamsMetadataBindingsFormatPkcs8 ScriptVersionNewParamsMetadataBindingsFormat = "pkcs8"
	ScriptVersionNewParamsMetadataBindingsFormatSpki  ScriptVersionNewParamsMetadataBindingsFormat = "spki"
	ScriptVersionNewParamsMetadataBindingsFormatJwk   ScriptVersionNewParamsMetadataBindingsFormat = "jwk"
)

func (ScriptVersionNewParamsMetadataBindingsFormat) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsType added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsTypeAI                     ScriptVersionNewParamsMetadataBindingsType = "ai"
	ScriptVersionNewParamsMetadataBindingsTypeAnalyticsEngine        ScriptVersionNewParamsMetadataBindingsType = "analytics_engine"
	ScriptVersionNewParamsMetadataBindingsTypeAssets                 ScriptVersionNewParamsMetadataBindingsType = "assets"
	ScriptVersionNewParamsMetadataBindingsTypeBrowser                ScriptVersionNewParamsMetadataBindingsType = "browser"
	ScriptVersionNewParamsMetadataBindingsTypeD1                     ScriptVersionNewParamsMetadataBindingsType = "d1"
	ScriptVersionNewParamsMetadataBindingsTypeDispatchNamespace      ScriptVersionNewParamsMetadataBindingsType = "dispatch_namespace"
	ScriptVersionNewParamsMetadataBindingsTypeDurableObjectNamespace ScriptVersionNewParamsMetadataBindingsType = "durable_object_namespace"
	ScriptVersionNewParamsMetadataBindingsTypeHyperdrive             ScriptVersionNewParamsMetadataBindingsType = "hyperdrive"
	ScriptVersionNewParamsMetadataBindingsTypeJson                   ScriptVersionNewParamsMetadataBindingsType = "json"
	ScriptVersionNewParamsMetadataBindingsTypeKVNamespace            ScriptVersionNewParamsMetadataBindingsType = "kv_namespace"
	ScriptVersionNewParamsMetadataBindingsTypeMTLSCertificate        ScriptVersionNewParamsMetadataBindingsType = "mtls_certificate"
	ScriptVersionNewParamsMetadataBindingsTypePlainText              ScriptVersionNewParamsMetadataBindingsType = "plain_text"
	ScriptVersionNewParamsMetadataBindingsTypePipelines              ScriptVersionNewParamsMetadataBindingsType = "pipelines"
	ScriptVersionNewParamsMetadataBindingsTypeQueue                  ScriptVersionNewParamsMetadataBindingsType = "queue"
	ScriptVersionNewParamsMetadataBindingsTypeR2Bucket               ScriptVersionNewParamsMetadataBindingsType = "r2_bucket"
	ScriptVersionNewParamsMetadataBindingsTypeSecretText             ScriptVersionNewParamsMetadataBindingsType = "secret_text"
	ScriptVersionNewParamsMetadataBindingsTypeService                ScriptVersionNewParamsMetadataBindingsType = "service"
	ScriptVersionNewParamsMetadataBindingsTypeTailConsumer           ScriptVersionNewParamsMetadataBindingsType = "tail_consumer"
	ScriptVersionNewParamsMetadataBindingsTypeVectorize              ScriptVersionNewParamsMetadataBindingsType = "vectorize"
	ScriptVersionNewParamsMetadataBindingsTypeVersionMetadata        ScriptVersionNewParamsMetadataBindingsType = "version_metadata"
	ScriptVersionNewParamsMetadataBindingsTypeSecretsStoreSecret     ScriptVersionNewParamsMetadataBindingsType = "secrets_store_secret"
	ScriptVersionNewParamsMetadataBindingsTypeSecretKey              ScriptVersionNewParamsMetadataBindingsType = "secret_key"
)

func (ScriptVersionNewParamsMetadataBindingsType) IsKnown added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAI

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAI struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAIType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAI) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAIType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAIType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAITypeAI ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAIType = "ai"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAIType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngine

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngine struct {
	// The name of the dataset to bind to.
	Dataset param.Field[string] `json:"dataset,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngine) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineTypeAnalyticsEngine ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType = "analytics_engine"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAnalyticsEngineType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssets

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssets struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssets) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsTypeAssets ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsType = "assets"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindAssetsType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowser added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowser struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowser) MarshalJSON added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserType added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserTypeBrowser ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserType = "browser"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindBrowserType) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1 struct {
	// Identifier of the D1 database to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1Type] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1Type

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1Type string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1TypeD1 ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1Type = "d1"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindD1Type) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespace

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace to bind to.
	Namespace param.Field[string] `json:"namespace,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType] `json:"type,required"`
	// Outbound worker.
	Outbound param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound] `json:"outbound"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespace) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound struct {
	// Pass information from the Dispatch Worker to the Outbound Worker through the
	// parameters.
	Params param.Field[[]string] `json:"params"`
	// Outbound worker.
	Worker param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker] `json:"worker"`
}

Outbound worker.

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutbound) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker struct {
	// Environment of the outbound worker.
	Environment param.Field[string] `json:"environment"`
	// Name of the outbound worker.
	Service param.Field[string] `json:"service"`
}

Outbound worker.

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceOutboundWorker) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceTypeDispatchNamespace ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType = "dispatch_namespace"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDispatchNamespaceType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType] `json:"type,required"`
	// The exported class name of the Durable Object.
	ClassName param.Field[string] `json:"class_name"`
	// The environment of the script_name to bind to.
	Environment param.Field[string] `json:"environment"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id"`
	// The script where the Durable Object is defined, if it is external to this
	// Worker.
	ScriptName param.Field[string] `json:"script_name"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespace) MarshalJSON added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceTypeDurableObjectNamespace ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType = "durable_object_namespace"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindDurableObjectNamespaceType) IsKnown added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdrive

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdrive struct {
	// Identifier of the Hyperdrive connection to bind to.
	ID param.Field[string] `json:"id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdrive) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveTypeHyperdrive ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveType = "hyperdrive"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindHyperdriveType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJson

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJson struct {
	// JSON data to use.
	Json param.Field[string] `json:"json,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJson) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonTypeJson ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonType = "json"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindJsonType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespace

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespace struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Namespace identifier tag.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespace) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceTypeKVNamespace ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceType = "kv_namespace"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindKVNamespaceType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificate added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificate struct {
	// Identifier of the certificate to bind to.
	CertificateID param.Field[string] `json:"certificate_id,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificate) MarshalJSON added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateType added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateTypeMTLSCertificate ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateType = "mtls_certificate"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindMTLSCertificateType) IsKnown added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelines added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelines struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Pipeline to bind to.
	Pipeline param.Field[string] `json:"pipeline,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelines) MarshalJSON added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesType added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesTypePipelines ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesType = "pipelines"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPipelinesType) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainText

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The text value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainText) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextTypePlainText ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextType = "plain_text"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindPlainTextType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueue

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueue struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the Queue to bind to.
	QueueName param.Field[string] `json:"queue_name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueue) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueTypeQueue ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueType = "queue"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindQueueType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2Bucket added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2Bucket struct {
	// R2 bucket to bind to.
	BucketName param.Field[string] `json:"bucket_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2Bucket) MarshalJSON added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketType added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketTypeR2Bucket ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketType = "r2_bucket"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindR2BucketType) IsKnown added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKey added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKey struct {
	// Algorithm-specific key parameters.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#algorithm).
	Algorithm param.Field[interface{}] `json:"algorithm,required"`
	// Data format of the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).
	Format param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat] `json:"format,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyType] `json:"type,required"`
	// Allowed operations with the key.
	// [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#keyUsages).
	Usages param.Field[[]ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage] `json:"usages,required"`
	// Base64-encoded key data. Required if `format` is "raw", "pkcs8", or "spki".
	KeyBase64 param.Field[string] `json:"key_base64"`
	// Key data in
	// [JSON Web Key](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#json_web_key)
	// format. Required if `format` is "jwk".
	KeyJwk param.Field[interface{}] `json:"key_jwk"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKey) MarshalJSON added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat string

Data format of the key. [Learn more](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto/importKey#format).

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormatRaw   ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "raw"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormatPkcs8 ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "pkcs8"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormatSpki  ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "spki"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormatJwk   ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat = "jwk"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyFormat) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyType added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyTypeSecretKey ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyType = "secret_key"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyType) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage string
const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageEncrypt    ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "encrypt"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDecrypt    ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "decrypt"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageSign       ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "sign"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageVerify     ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "verify"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDeriveKey  ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "deriveKey"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageDeriveBits ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "deriveBits"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageWrapKey    ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "wrapKey"
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsageUnwrapKey  ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage = "unwrapKey"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretKeyUsage) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretText added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretText struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The secret value to use.
	Text param.Field[string] `json:"text,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretText) MarshalJSON added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextType added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextTypeSecretText ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextType = "secret_text"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretTextType) IsKnown added in v4.2.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of the secret in the store.
	SecretName param.Field[string] `json:"secret_name,required"`
	// ID of the store containing the secret.
	StoreID param.Field[string] `json:"store_id,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecret) MarshalJSON added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretTypeSecretsStoreSecret ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType = "secrets_store_secret"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindSecretsStoreSecretType) IsKnown added in v4.3.0

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindService

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindService struct {
	// Optional environment if the Worker utilizes one.
	Environment param.Field[string] `json:"environment,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindService) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceTypeService ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceType = "service"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindServiceType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumer

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumer struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// Name of Tail Worker to bind to.
	Service param.Field[string] `json:"service,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumer) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerTypeTailConsumer ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerType = "tail_consumer"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindTailConsumerType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorize

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorize struct {
	// Name of the Vectorize index to bind to.
	IndexName param.Field[string] `json:"index_name,required"`
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorize) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeTypeVectorize ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeType = "vectorize"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVectorizeType) IsKnown

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadata

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadata struct {
	// A JavaScript variable name for the binding.
	Name param.Field[string] `json:"name,required"`
	// The kind of resource that the binding provides.
	Type param.Field[ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataType] `json:"type,required"`
}

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadata) MarshalJSON

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataType

type ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataType string

The kind of resource that the binding provides.

const (
	ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataTypeVersionMetadata ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataType = "version_metadata"
)

func (ScriptVersionNewParamsMetadataBindingsWorkersBindingKindVersionMetadataType) IsKnown

type ScriptVersionNewParamsMetadataUsageModel

type ScriptVersionNewParamsMetadataUsageModel string

Usage model for the Worker invocations.

const (
	ScriptVersionNewParamsMetadataUsageModelStandard ScriptVersionNewParamsMetadataUsageModel = "standard"
)

func (ScriptVersionNewParamsMetadataUsageModel) IsKnown

type ScriptVersionNewResponse

type ScriptVersionNewResponse struct {
	Resources     interface{}                  `json:"resources,required"`
	ID            string                       `json:"id"`
	Metadata      interface{}                  `json:"metadata"`
	Number        float64                      `json:"number"`
	StartupTimeMs int64                        `json:"startup_time_ms"`
	JSON          scriptVersionNewResponseJSON `json:"-"`
}

func (*ScriptVersionNewResponse) UnmarshalJSON

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

type ScriptVersionNewResponseEnvelope

type ScriptVersionNewResponseEnvelope struct {
	Errors   []ScriptVersionNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ScriptVersionNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ScriptVersionNewResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success ScriptVersionNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    scriptVersionNewResponseEnvelopeJSON    `json:"-"`
}

func (*ScriptVersionNewResponseEnvelope) UnmarshalJSON

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

type ScriptVersionNewResponseEnvelopeErrors added in v4.3.0

type ScriptVersionNewResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ScriptVersionNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             scriptVersionNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ScriptVersionNewResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type ScriptVersionNewResponseEnvelopeErrorsSource added in v4.3.0

type ScriptVersionNewResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    scriptVersionNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ScriptVersionNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type ScriptVersionNewResponseEnvelopeMessages added in v4.3.0

type ScriptVersionNewResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ScriptVersionNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             scriptVersionNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ScriptVersionNewResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type ScriptVersionNewResponseEnvelopeMessagesSource added in v4.3.0

type ScriptVersionNewResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    scriptVersionNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ScriptVersionNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type ScriptVersionNewResponseEnvelopeSuccess

type ScriptVersionNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ScriptVersionNewResponseEnvelopeSuccessTrue ScriptVersionNewResponseEnvelopeSuccess = true
)

func (ScriptVersionNewResponseEnvelopeSuccess) IsKnown

type ScriptVersionService

type ScriptVersionService struct {
	Options []option.RequestOption
}

ScriptVersionService 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 NewScriptVersionService method instead.

func NewScriptVersionService

func NewScriptVersionService(opts ...option.RequestOption) (r *ScriptVersionService)

NewScriptVersionService 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 (*ScriptVersionService) Get

func (r *ScriptVersionService) Get(ctx context.Context, scriptName string, versionID string, query ScriptVersionGetParams, opts ...option.RequestOption) (res *ScriptVersionGetResponse, err error)

Get Version Detail

func (*ScriptVersionService) List

List of Worker Versions. The first version in the list is the latest version.

func (*ScriptVersionService) ListAutoPaging

List of Worker Versions. The first version in the list is the latest version.

func (*ScriptVersionService) New

Upload a Worker Version without deploying to Cloudflare's network. You can find more about the multipart metadata on our docs: https://developers.cloudflare.com/workers/configuration/multipart-upload-metadata/.

type SingleStepMigration

type SingleStepMigration struct {
	// A list of classes to delete Durable Object namespaces from.
	DeletedClasses []string `json:"deleted_classes"`
	// A list of classes to create Durable Object namespaces from.
	NewClasses []string `json:"new_classes"`
	// A list of classes to create Durable Object namespaces with SQLite from.
	NewSqliteClasses []string `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag string `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag string `json:"old_tag"`
	// A list of classes with Durable Object namespaces that were renamed.
	RenamedClasses []SingleStepMigrationRenamedClass `json:"renamed_classes"`
	// A list of transfers for Durable Object namespaces from a different Worker and
	// class to a class defined in this Worker.
	TransferredClasses []SingleStepMigrationTransferredClass `json:"transferred_classes"`
	JSON               singleStepMigrationJSON               `json:"-"`
}

A single set of migrations to apply.

func (SingleStepMigration) ImplementsDispatchNamespaceScriptSettingEditResponseMigrations added in v4.1.0

func (r SingleStepMigration) ImplementsDispatchNamespaceScriptSettingEditResponseMigrations()

func (SingleStepMigration) ImplementsDispatchNamespaceScriptSettingGetResponseMigrations added in v4.1.0

func (r SingleStepMigration) ImplementsDispatchNamespaceScriptSettingGetResponseMigrations()

func (*SingleStepMigration) UnmarshalJSON

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

type SingleStepMigrationParam

type SingleStepMigrationParam struct {
	// A list of classes to delete Durable Object namespaces from.
	DeletedClasses param.Field[[]string] `json:"deleted_classes"`
	// A list of classes to create Durable Object namespaces from.
	NewClasses param.Field[[]string] `json:"new_classes"`
	// A list of classes to create Durable Object namespaces with SQLite from.
	NewSqliteClasses param.Field[[]string] `json:"new_sqlite_classes"`
	// Tag to set as the latest migration tag.
	NewTag param.Field[string] `json:"new_tag"`
	// Tag used to verify against the latest migration tag for this Worker. If they
	// don't match, the upload is rejected.
	OldTag param.Field[string] `json:"old_tag"`
	// A list of classes with Durable Object namespaces that were renamed.
	RenamedClasses param.Field[[]SingleStepMigrationRenamedClassParam] `json:"renamed_classes"`
	// A list of transfers for Durable Object namespaces from a different Worker and
	// class to a class defined in this Worker.
	TransferredClasses param.Field[[]SingleStepMigrationTransferredClassParam] `json:"transferred_classes"`
}

A single set of migrations to apply.

func (SingleStepMigrationParam) ImplementsDispatchNamespaceScriptSettingEditParamsSettingsMigrationsUnion added in v4.1.0

func (r SingleStepMigrationParam) ImplementsDispatchNamespaceScriptSettingEditParamsSettingsMigrationsUnion()

func (SingleStepMigrationParam) ImplementsDispatchNamespaceScriptUpdateParamsMetadataMigrationsUnion added in v4.1.0

func (r SingleStepMigrationParam) ImplementsDispatchNamespaceScriptUpdateParamsMetadataMigrationsUnion()

func (SingleStepMigrationParam) MarshalJSON

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

type SingleStepMigrationRenamedClass

type SingleStepMigrationRenamedClass struct {
	From string                              `json:"from"`
	To   string                              `json:"to"`
	JSON singleStepMigrationRenamedClassJSON `json:"-"`
}

func (*SingleStepMigrationRenamedClass) UnmarshalJSON

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

type SingleStepMigrationRenamedClassParam

type SingleStepMigrationRenamedClassParam struct {
	From param.Field[string] `json:"from"`
	To   param.Field[string] `json:"to"`
}

func (SingleStepMigrationRenamedClassParam) MarshalJSON

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

type SingleStepMigrationTransferredClass

type SingleStepMigrationTransferredClass struct {
	From       string                                  `json:"from"`
	FromScript string                                  `json:"from_script"`
	To         string                                  `json:"to"`
	JSON       singleStepMigrationTransferredClassJSON `json:"-"`
}

func (*SingleStepMigrationTransferredClass) UnmarshalJSON

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

type SingleStepMigrationTransferredClassParam

type SingleStepMigrationTransferredClassParam struct {
	From       param.Field[string] `json:"from"`
	FromScript param.Field[string] `json:"from_script"`
	To         param.Field[string] `json:"to"`
}

func (SingleStepMigrationTransferredClassParam) MarshalJSON

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

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type SubdomainGetParams

type SubdomainGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
}

type SubdomainGetResponse

type SubdomainGetResponse struct {
	Subdomain string                   `json:"subdomain,required"`
	JSON      subdomainGetResponseJSON `json:"-"`
}

func (*SubdomainGetResponse) UnmarshalJSON

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

type SubdomainGetResponseEnvelope

type SubdomainGetResponseEnvelope struct {
	Errors   []SubdomainGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SubdomainGetResponseEnvelopeMessages `json:"messages,required"`
	Result   SubdomainGetResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success SubdomainGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    subdomainGetResponseEnvelopeJSON    `json:"-"`
}

func (*SubdomainGetResponseEnvelope) UnmarshalJSON

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

type SubdomainGetResponseEnvelopeErrors added in v4.3.0

type SubdomainGetResponseEnvelopeErrors struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           SubdomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             subdomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SubdomainGetResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type SubdomainGetResponseEnvelopeErrorsSource added in v4.3.0

type SubdomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    subdomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SubdomainGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type SubdomainGetResponseEnvelopeMessages added in v4.3.0

type SubdomainGetResponseEnvelopeMessages struct {
	Code             int64                                      `json:"code,required"`
	Message          string                                     `json:"message,required"`
	DocumentationURL string                                     `json:"documentation_url"`
	Source           SubdomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             subdomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SubdomainGetResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type SubdomainGetResponseEnvelopeMessagesSource added in v4.3.0

type SubdomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                         `json:"pointer"`
	JSON    subdomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SubdomainGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type SubdomainGetResponseEnvelopeSuccess

type SubdomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SubdomainGetResponseEnvelopeSuccessTrue SubdomainGetResponseEnvelopeSuccess = true
)

func (SubdomainGetResponseEnvelopeSuccess) IsKnown

type SubdomainService

type SubdomainService struct {
	Options []option.RequestOption
}

SubdomainService 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 NewSubdomainService method instead.

func NewSubdomainService

func NewSubdomainService(opts ...option.RequestOption) (r *SubdomainService)

NewSubdomainService 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 (*SubdomainService) Get

Returns a Workers subdomain for an account.

func (*SubdomainService) Update

Creates a Workers subdomain for an account.

type SubdomainUpdateParams

type SubdomainUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	Subdomain param.Field[string] `json:"subdomain,required"`
}

func (SubdomainUpdateParams) MarshalJSON

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

type SubdomainUpdateResponse

type SubdomainUpdateResponse struct {
	Subdomain string                      `json:"subdomain,required"`
	JSON      subdomainUpdateResponseJSON `json:"-"`
}

func (*SubdomainUpdateResponse) UnmarshalJSON

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

type SubdomainUpdateResponseEnvelope

type SubdomainUpdateResponseEnvelope struct {
	Errors   []SubdomainUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []SubdomainUpdateResponseEnvelopeMessages `json:"messages,required"`
	Result   SubdomainUpdateResponse                   `json:"result,required"`
	// Whether the API call was successful.
	Success SubdomainUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    subdomainUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*SubdomainUpdateResponseEnvelope) UnmarshalJSON

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

type SubdomainUpdateResponseEnvelopeErrors added in v4.3.0

type SubdomainUpdateResponseEnvelopeErrors struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           SubdomainUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             subdomainUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*SubdomainUpdateResponseEnvelopeErrors) UnmarshalJSON added in v4.3.0

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

type SubdomainUpdateResponseEnvelopeErrorsSource added in v4.3.0

type SubdomainUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    subdomainUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*SubdomainUpdateResponseEnvelopeErrorsSource) UnmarshalJSON added in v4.3.0

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

type SubdomainUpdateResponseEnvelopeMessages added in v4.3.0

type SubdomainUpdateResponseEnvelopeMessages struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           SubdomainUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             subdomainUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*SubdomainUpdateResponseEnvelopeMessages) UnmarshalJSON added in v4.3.0

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

type SubdomainUpdateResponseEnvelopeMessagesSource added in v4.3.0

type SubdomainUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    subdomainUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*SubdomainUpdateResponseEnvelopeMessagesSource) UnmarshalJSON added in v4.3.0

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

type SubdomainUpdateResponseEnvelopeSuccess

type SubdomainUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	SubdomainUpdateResponseEnvelopeSuccessTrue SubdomainUpdateResponseEnvelopeSuccess = true
)

func (SubdomainUpdateResponseEnvelopeSuccess) IsKnown

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 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.

type WorkerMetadataParam

type WorkerMetadataParam struct {
	// Name of the part in the multipart request that contains the script (e.g. the
	// file adding a listener to the `fetch` event). Indicates a
	// `service worker syntax` Worker.
	BodyPart param.Field[string] `json:"body_part"`
	// Name of the part in the multipart request that contains the main module (e.g.
	// the file exporting a `fetch` handler). Indicates a `module syntax` Worker.
	MainModule param.Field[string] `json:"main_module"`
}

JSON encoded metadata about the uploaded parts and Worker configuration.

func (WorkerMetadataParam) MarshalJSON

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

type WorkerService

type WorkerService struct {
	Options         []option.RequestOption
	Routes          *RouteService
	Assets          *AssetService
	Scripts         *ScriptService
	AccountSettings *AccountSettingService
	Domains         *DomainService
	Subdomains      *SubdomainService
	Observability   *ObservabilityService
}

WorkerService 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 NewWorkerService method instead.

func NewWorkerService

func NewWorkerService(opts ...option.RequestOption) (r *WorkerService)

NewWorkerService 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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL