pages

package
v4.0.0-...-bae6edb Latest Latest
Warning

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

 Go to latest Published: Dec 19, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

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 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 SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

The type of actor, whether a User, Cloudflare Admin, or an Automated System.

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

A Cloudflare Tunnel that connects your origin to Cloudflare's edge.

This is an alias to an internal type.

type 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 Deployment 

type Deployment struct {
	// Id of the deployment.
	ID string `json:"id"`
	// A list of alias URLs pointing to this deployment.
	Aliases []string `json:"aliases,nullable"`
	// Configs for the project build process.
	BuildConfig DeploymentBuildConfig `json:"build_config"`
	// When the deployment was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Info about what caused the deployment.
	DeploymentTrigger DeploymentDeploymentTrigger `json:"deployment_trigger"`
	// A dict of env variables to build this deploy.
	EnvVars map[string]DeploymentEnvVar `json:"env_vars"`
	// Type of deploy.
	Environment string `json:"environment"`
	// If the deployment has been skipped.
	IsSkipped bool `json:"is_skipped"`
	// The status of the deployment.
	LatestStage Stage `json:"latest_stage"`
	// When the deployment was last modified.
	ModifiedOn time.Time `json:"modified_on" format:"date-time"`
	// Id of the project.
	ProjectID string `json:"project_id"`
	// Name of the project.
	ProjectName string `json:"project_name"`
	// Short Id (8 character) of the deployment.
	ShortID string           `json:"short_id"`
	Source  DeploymentSource `json:"source"`
	// List of past stages.
	Stages []Stage `json:"stages"`
	// The live URL to view this deployment.
	URL  string         `json:"url"`
	JSON deploymentJSON `json:"-"`
}

func (*Deployment) UnmarshalJSON 

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

type DeploymentBuildConfig 

type DeploymentBuildConfig struct {
	// Enable build caching for the project.
	BuildCaching bool `json:"build_caching,nullable"`
	// Command used to build project.
	BuildCommand string `json:"build_command,nullable"`
	// Output directory of the build.
	DestinationDir string `json:"destination_dir,nullable"`
	// Directory to run the command.
	RootDir string `json:"root_dir,nullable"`
	// The classifying tag for analytics.
	WebAnalyticsTag string `json:"web_analytics_tag,nullable"`
	// The auth token for analytics.
	WebAnalyticsToken string                    `json:"web_analytics_token,nullable"`
	JSON              deploymentBuildConfigJSON `json:"-"`
}

Configs for the project build process.

func (*DeploymentBuildConfig) UnmarshalJSON 

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

type DeploymentBuildConfigParam 

type DeploymentBuildConfigParam struct {
	// Enable build caching for the project.
	BuildCaching param.Field[bool] `json:"build_caching"`
	// Command used to build project.
	BuildCommand param.Field[string] `json:"build_command"`
	// Output directory of the build.
	DestinationDir param.Field[string] `json:"destination_dir"`
	// Directory to run the command.
	RootDir param.Field[string] `json:"root_dir"`
	// The classifying tag for analytics.
	WebAnalyticsTag param.Field[string] `json:"web_analytics_tag"`
	// The auth token for analytics.
	WebAnalyticsToken param.Field[string] `json:"web_analytics_token"`
}

Configs for the project build process.

func (DeploymentBuildConfigParam) MarshalJSON 

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

type DeploymentDeploymentTrigger 

type DeploymentDeploymentTrigger struct {
	// Additional info about the trigger.
	Metadata DeploymentDeploymentTriggerMetadata `json:"metadata"`
	// What caused the deployment.
	Type string                          `json:"type"`
	JSON deploymentDeploymentTriggerJSON `json:"-"`
}

Info about what caused the deployment.

func (*DeploymentDeploymentTrigger) UnmarshalJSON 

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

type DeploymentDeploymentTriggerMetadata 

type DeploymentDeploymentTriggerMetadata struct {
	// Where the trigger happened.
	Branch string `json:"branch"`
	// Hash of the deployment trigger commit.
	CommitHash string `json:"commit_hash"`
	// Message of the deployment trigger commit.
	CommitMessage string                                  `json:"commit_message"`
	JSON          deploymentDeploymentTriggerMetadataJSON `json:"-"`
}

Additional info about the trigger.

func (*DeploymentDeploymentTriggerMetadata) UnmarshalJSON 

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

type DeploymentDeploymentTriggerMetadataParam 

type DeploymentDeploymentTriggerMetadataParam struct {
}

Additional info about the trigger.

func (DeploymentDeploymentTriggerMetadataParam) MarshalJSON 

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

type DeploymentDeploymentTriggerParam 

type DeploymentDeploymentTriggerParam struct {
	// Additional info about the trigger.
	Metadata param.Field[DeploymentDeploymentTriggerMetadataParam] `json:"metadata"`
}

Info about what caused the deployment.

func (DeploymentDeploymentTriggerParam) MarshalJSON 

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

type DeploymentEnvVar 

type DeploymentEnvVar struct {
	// Environment variable value.
	Value string `json:"value,required"`
	// The type of environment variable.
	Type string               `json:"type"`
	JSON deploymentEnvVarJSON `json:"-"`
}

Environment variable.

func (*DeploymentEnvVar) UnmarshalJSON 

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

type DeploymentEnvVarParam 

type DeploymentEnvVarParam struct {
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
	// The type of environment variable.
	Type param.Field[string] `json:"type"`
}

Environment variable.

func (DeploymentEnvVarParam) MarshalJSON 

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

type DeploymentParam 

type DeploymentParam struct {
	// Configs for the project build process.
	BuildConfig param.Field[DeploymentBuildConfigParam] `json:"build_config"`
}

func (DeploymentParam) MarshalJSON 

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

type DeploymentSource 

type DeploymentSource struct {
	Config DeploymentSourceConfig `json:"config"`
	Type   string                 `json:"type"`
	JSON   deploymentSourceJSON   `json:"-"`
}

func (*DeploymentSource) UnmarshalJSON 

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

type DeploymentSourceConfig 

type DeploymentSourceConfig struct {
	DeploymentsEnabled           bool                                           `json:"deployments_enabled"`
	Owner                        string                                         `json:"owner"`
	PathExcludes                 []string                                       `json:"path_excludes"`
	PathIncludes                 []string                                       `json:"path_includes"`
	PrCommentsEnabled            bool                                           `json:"pr_comments_enabled"`
	PreviewBranchExcludes        []string                                       `json:"preview_branch_excludes"`
	PreviewBranchIncludes        []string                                       `json:"preview_branch_includes"`
	PreviewDeploymentSetting     DeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
	ProductionBranch             string                                         `json:"production_branch"`
	ProductionDeploymentsEnabled bool                                           `json:"production_deployments_enabled"`
	RepoName                     string                                         `json:"repo_name"`
	JSON                         deploymentSourceConfigJSON                     `json:"-"`
}

func (*DeploymentSourceConfig) UnmarshalJSON 

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

type DeploymentSourceConfigParam 

type DeploymentSourceConfigParam struct {
	DeploymentsEnabled           param.Field[bool]                                           `json:"deployments_enabled"`
	Owner                        param.Field[string]                                         `json:"owner"`
	PathExcludes                 param.Field[[]string]                                       `json:"path_excludes"`
	PathIncludes                 param.Field[[]string]                                       `json:"path_includes"`
	PrCommentsEnabled            param.Field[bool]                                           `json:"pr_comments_enabled"`
	PreviewBranchExcludes        param.Field[[]string]                                       `json:"preview_branch_excludes"`
	PreviewBranchIncludes        param.Field[[]string]                                       `json:"preview_branch_includes"`
	PreviewDeploymentSetting     param.Field[DeploymentSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
	ProductionBranch             param.Field[string]                                         `json:"production_branch"`
	ProductionDeploymentsEnabled param.Field[bool]                                           `json:"production_deployments_enabled"`
	RepoName                     param.Field[string]                                         `json:"repo_name"`
}

func (DeploymentSourceConfigParam) MarshalJSON 

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

type DeploymentSourceConfigPreviewDeploymentSetting 

type DeploymentSourceConfigPreviewDeploymentSetting string
const (
	DeploymentSourceConfigPreviewDeploymentSettingAll    DeploymentSourceConfigPreviewDeploymentSetting = "all"
	DeploymentSourceConfigPreviewDeploymentSettingNone   DeploymentSourceConfigPreviewDeploymentSetting = "none"
	DeploymentSourceConfigPreviewDeploymentSettingCustom DeploymentSourceConfigPreviewDeploymentSetting = "custom"
)

func (DeploymentSourceConfigPreviewDeploymentSetting) IsKnown 

func (r DeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool

type DeploymentSourceParam 

type DeploymentSourceParam struct {
	Config param.Field[DeploymentSourceConfigParam] `json:"config"`
	Type   param.Field[string]                      `json:"type"`
}

func (DeploymentSourceParam) MarshalJSON 

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

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

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 PageService 

type PageService struct {
	Options  []option.RequestOption
	Projects *ProjectService
}

PageService 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 NewPageService method instead.

func NewPageService 

func NewPageService(opts ...option.RequestOption) (r *PageService)

NewPageService 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 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 Project 

type Project struct {
	// Id of the project.
	ID string `json:"id"`
	// Configs for the project build process.
	BuildConfig ProjectBuildConfig `json:"build_config"`
	// Most recent deployment to the repo.
	CanonicalDeployment Deployment `json:"canonical_deployment,nullable"`
	// When the project was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Configs for deployments in a project.
	DeploymentConfigs ProjectDeploymentConfigs `json:"deployment_configs"`
	// A list of associated custom domains for the project.
	Domains []string `json:"domains"`
	// Most recent deployment to the repo.
	LatestDeployment Deployment `json:"latest_deployment,nullable"`
	// Name of the project.
	Name string `json:"name"`
	// Production branch of the project. Used to identify production deployments.
	ProductionBranch string        `json:"production_branch"`
	Source           ProjectSource `json:"source"`
	// The Cloudflare subdomain associated with the project.
	Subdomain string      `json:"subdomain"`
	JSON      projectJSON `json:"-"`
}

func (*Project) UnmarshalJSON 

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

type ProjectBuildConfig 

type ProjectBuildConfig struct {
	// Enable build caching for the project.
	BuildCaching bool `json:"build_caching,nullable"`
	// Command used to build project.
	BuildCommand string `json:"build_command,nullable"`
	// Output directory of the build.
	DestinationDir string `json:"destination_dir,nullable"`
	// Directory to run the command.
	RootDir string `json:"root_dir,nullable"`
	// The classifying tag for analytics.
	WebAnalyticsTag string `json:"web_analytics_tag,nullable"`
	// The auth token for analytics.
	WebAnalyticsToken string                 `json:"web_analytics_token,nullable"`
	JSON              projectBuildConfigJSON `json:"-"`
}

Configs for the project build process.

func (*ProjectBuildConfig) UnmarshalJSON 

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

type ProjectBuildConfigParam 

type ProjectBuildConfigParam struct {
	// Enable build caching for the project.
	BuildCaching param.Field[bool] `json:"build_caching"`
	// Command used to build project.
	BuildCommand param.Field[string] `json:"build_command"`
	// Output directory of the build.
	DestinationDir param.Field[string] `json:"destination_dir"`
	// Directory to run the command.
	RootDir param.Field[string] `json:"root_dir"`
	// The classifying tag for analytics.
	WebAnalyticsTag param.Field[string] `json:"web_analytics_tag"`
	// The auth token for analytics.
	WebAnalyticsToken param.Field[string] `json:"web_analytics_token"`
}

Configs for the project build process.

func (ProjectBuildConfigParam) MarshalJSON 

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

type ProjectDeleteParams 

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

type ProjectDeleteResponse 

type ProjectDeleteResponse = interface{}

type ProjectDeleteResponseEnvelope 

type ProjectDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   ProjectDeleteResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeleteResponseEnvelope) UnmarshalJSON 

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

type ProjectDeleteResponseEnvelopeSuccess 

type ProjectDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeleteResponseEnvelopeSuccessFalse ProjectDeleteResponseEnvelopeSuccess = false
	ProjectDeleteResponseEnvelopeSuccessTrue  ProjectDeleteResponseEnvelopeSuccess = true
)

func (ProjectDeleteResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeleteResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentConfigs 

type ProjectDeploymentConfigs struct {
	// Configs for preview deploys.
	Preview ProjectDeploymentConfigsPreview `json:"preview"`
	// Configs for production deploys.
	Production ProjectDeploymentConfigsProduction `json:"production"`
	JSON       projectDeploymentConfigsJSON       `json:"-"`
}

Configs for deployments in a project.

func (*ProjectDeploymentConfigs) UnmarshalJSON 

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

type ProjectDeploymentConfigsParam 

type ProjectDeploymentConfigsParam struct {
	// Configs for preview deploys.
	Preview param.Field[ProjectDeploymentConfigsPreviewParam] `json:"preview"`
	// Configs for production deploys.
	Production param.Field[ProjectDeploymentConfigsProductionParam] `json:"production"`
}

Configs for deployments in a project.

func (ProjectDeploymentConfigsParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreview 

type ProjectDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings map[string]ProjectDeploymentConfigsPreviewAIBinding `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers map[string]ProjectDeploymentConfigsPreviewBrowser `json:"browsers,nullable"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []string `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases map[string]ProjectDeploymentConfigsPreviewD1Database `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces map[string]ProjectDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars map[string]ProjectDeploymentConfigsPreviewEnvVar `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings map[string]ProjectDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces map[string]ProjectDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces,nullable"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates map[string]ProjectDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsPreviewPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers map[string]ProjectDeploymentConfigsPreviewQueueProducer `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets map[string]ProjectDeploymentConfigsPreviewR2Bucket `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services map[string]ProjectDeploymentConfigsPreviewService `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings map[string]ProjectDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings,nullable"`
	JSON              projectDeploymentConfigsPreviewJSON                        `json:"-"`
}

Configs for preview deploys.

func (*ProjectDeploymentConfigsPreview) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewAIBinding 

type ProjectDeploymentConfigsPreviewAIBinding struct {
	ProjectID string                                       `json:"project_id"`
	JSON      projectDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsPreviewAIBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewAIBindingParam 

type ProjectDeploymentConfigsPreviewAIBindingParam struct {
	ProjectID param.Field[string] `json:"project_id"`
}

AI binding.

func (ProjectDeploymentConfigsPreviewAIBindingParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset 

type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset struct {
	// Name of the dataset.
	Dataset string                                                    `json:"dataset"`
	JSON    projectDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}

Analytics Engine binding.

func (*ProjectDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetParam 

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetParam struct {
	// Name of the dataset.
	Dataset param.Field[string] `json:"dataset"`
}

Analytics Engine binding.

func (ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewBrowser 

type ProjectDeploymentConfigsPreviewBrowser struct {
	JSON projectDeploymentConfigsPreviewBrowserJSON `json:"-"`
}

Browser binding.

func (*ProjectDeploymentConfigsPreviewBrowser) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewBrowserParam 

type ProjectDeploymentConfigsPreviewBrowserParam struct {
}

Browser binding.

func (ProjectDeploymentConfigsPreviewBrowserParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewD1Database 

type ProjectDeploymentConfigsPreviewD1Database struct {
	// UUID of the D1 database.
	ID   string                                        `json:"id"`
	JSON projectDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}

D1 binding.

func (*ProjectDeploymentConfigsPreviewD1Database) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewD1DatabaseParam 

type ProjectDeploymentConfigsPreviewD1DatabaseParam struct {
	// UUID of the D1 database.
	ID param.Field[string] `json:"id"`
}

D1 binding.

func (ProjectDeploymentConfigsPreviewD1DatabaseParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewDurableObjectNamespace 

type ProjectDeploymentConfigsPreviewDurableObjectNamespace struct {
	// ID of the Durabble Object namespace.
	NamespaceID string                                                    `json:"namespace_id"`
	JSON        projectDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}

Durabble Object binding.

func (*ProjectDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewDurableObjectNamespaceParam 

type ProjectDeploymentConfigsPreviewDurableObjectNamespaceParam struct {
	// ID of the Durabble Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id"`
}

Durabble Object binding.

func (ProjectDeploymentConfigsPreviewDurableObjectNamespaceParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewEnvVar 

type ProjectDeploymentConfigsPreviewEnvVar struct {
	// Environment variable value.
	Value string `json:"value,required"`
	// The type of environment variable.
	Type ProjectDeploymentConfigsPreviewEnvVarsType `json:"type"`
	JSON projectDeploymentConfigsPreviewEnvVarJSON  `json:"-"`
}

Environment variable.

func (*ProjectDeploymentConfigsPreviewEnvVar) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewEnvVarParam 

type ProjectDeploymentConfigsPreviewEnvVarParam struct {
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
	// The type of environment variable.
	Type param.Field[ProjectDeploymentConfigsPreviewEnvVarsType] `json:"type"`
}

Environment variable.

func (ProjectDeploymentConfigsPreviewEnvVarParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewEnvVarsType 

type ProjectDeploymentConfigsPreviewEnvVarsType string

The type of environment variable. 

const (
	ProjectDeploymentConfigsPreviewEnvVarsTypePlainText  ProjectDeploymentConfigsPreviewEnvVarsType = "plain_text"
	ProjectDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectDeploymentConfigsPreviewEnvVarsType = "secret_text"
)

func (ProjectDeploymentConfigsPreviewEnvVarsType) IsKnown 

func (r ProjectDeploymentConfigsPreviewEnvVarsType) IsKnown() bool

type ProjectDeploymentConfigsPreviewHyperdriveBinding 

type ProjectDeploymentConfigsPreviewHyperdriveBinding struct {
	ID   string                                               `json:"id"`
	JSON projectDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}

Hyperdrive binding.

func (*ProjectDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewHyperdriveBindingParam 

type ProjectDeploymentConfigsPreviewHyperdriveBindingParam struct {
	ID param.Field[string] `json:"id"`
}

Hyperdrive binding.

func (ProjectDeploymentConfigsPreviewHyperdriveBindingParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewKVNamespace 

type ProjectDeploymentConfigsPreviewKVNamespace struct {
	// ID of the KV namespace.
	NamespaceID string                                         `json:"namespace_id"`
	JSON        projectDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}

KV namespace binding.

func (*ProjectDeploymentConfigsPreviewKVNamespace) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewKVNamespaceParam 

type ProjectDeploymentConfigsPreviewKVNamespaceParam struct {
	// ID of the KV namespace.
	NamespaceID param.Field[string] `json:"namespace_id"`
}

KV namespace binding.

func (ProjectDeploymentConfigsPreviewKVNamespaceParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewMTLSCertificate 

type ProjectDeploymentConfigsPreviewMTLSCertificate struct {
	CertificateID string                                             `json:"certificate_id"`
	JSON          projectDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}

mTLS binding.

func (*ProjectDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewMTLSCertificateParam 

type ProjectDeploymentConfigsPreviewMTLSCertificateParam struct {
	CertificateID param.Field[string] `json:"certificate_id"`
}

mTLS binding.

func (ProjectDeploymentConfigsPreviewMTLSCertificateParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewParam 

type ProjectDeploymentConfigsPreviewParam struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectDeploymentConfigsPreviewAIBindingParam] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetParam] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectDeploymentConfigsPreviewBrowserParam] `json:"browsers"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases param.Field[map[string]ProjectDeploymentConfigsPreviewD1DatabaseParam] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectDeploymentConfigsPreviewDurableObjectNamespaceParam] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[map[string]ProjectDeploymentConfigsPreviewEnvVarParam] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectDeploymentConfigsPreviewHyperdriveBindingParam] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectDeploymentConfigsPreviewKVNamespaceParam] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectDeploymentConfigsPreviewMTLSCertificateParam] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectDeploymentConfigsPreviewPlacementParam] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectDeploymentConfigsPreviewQueueProducerParam] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectDeploymentConfigsPreviewR2BucketParam] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectDeploymentConfigsPreviewServiceParam] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectDeploymentConfigsPreviewVectorizeBindingParam] `json:"vectorize_bindings"`
}

Configs for preview deploys.

func (ProjectDeploymentConfigsPreviewParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewPlacement 

type ProjectDeploymentConfigsPreviewPlacement struct {
	// Placement mode.
	Mode string                                       `json:"mode"`
	JSON projectDeploymentConfigsPreviewPlacementJSON `json:"-"`
}

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewPlacement) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewPlacementParam 

type ProjectDeploymentConfigsPreviewPlacementParam struct {
	// Placement mode.
	Mode param.Field[string] `json:"mode"`
}

Placement setting used for Pages Functions.

func (ProjectDeploymentConfigsPreviewPlacementParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewQueueProducer 

type ProjectDeploymentConfigsPreviewQueueProducer struct {
	// Name of the Queue.
	Name string                                           `json:"name"`
	JSON projectDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}

Queue Producer binding.

func (*ProjectDeploymentConfigsPreviewQueueProducer) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewQueueProducerParam 

type ProjectDeploymentConfigsPreviewQueueProducerParam struct {
	// Name of the Queue.
	Name param.Field[string] `json:"name"`
}

Queue Producer binding.

func (ProjectDeploymentConfigsPreviewQueueProducerParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewR2Bucket 

type ProjectDeploymentConfigsPreviewR2Bucket struct {
	// Jurisdiction of the R2 bucket.
	Jurisdiction string `json:"jurisdiction,nullable"`
	// Name of the R2 bucket.
	Name string                                      `json:"name"`
	JSON projectDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}

R2 binding.

func (*ProjectDeploymentConfigsPreviewR2Bucket) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewR2BucketParam 

type ProjectDeploymentConfigsPreviewR2BucketParam struct {
	// Jurisdiction of the R2 bucket.
	Jurisdiction param.Field[string] `json:"jurisdiction"`
	// Name of the R2 bucket.
	Name param.Field[string] `json:"name"`
}

R2 binding.

func (ProjectDeploymentConfigsPreviewR2BucketParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewService 

type ProjectDeploymentConfigsPreviewService struct {
	// The entrypoint to bind to.
	Entrypoint string `json:"entrypoint,nullable"`
	// The Service environment.
	Environment string `json:"environment"`
	// The Service name.
	Service string                                     `json:"service"`
	JSON    projectDeploymentConfigsPreviewServiceJSON `json:"-"`
}

Service binding.

func (*ProjectDeploymentConfigsPreviewService) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewServiceParam 

type ProjectDeploymentConfigsPreviewServiceParam struct {
	// The entrypoint to bind to.
	Entrypoint param.Field[string] `json:"entrypoint"`
	// The Service environment.
	Environment param.Field[string] `json:"environment"`
	// The Service name.
	Service param.Field[string] `json:"service"`
}

Service binding.

func (ProjectDeploymentConfigsPreviewServiceParam) MarshalJSON 

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

type ProjectDeploymentConfigsPreviewVectorizeBinding 

type ProjectDeploymentConfigsPreviewVectorizeBinding struct {
	IndexName string                                              `json:"index_name"`
	JSON      projectDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}

Vectorize binding.

func (*ProjectDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsPreviewVectorizeBindingParam 

type ProjectDeploymentConfigsPreviewVectorizeBindingParam struct {
	IndexName param.Field[string] `json:"index_name"`
}

Vectorize binding.

func (ProjectDeploymentConfigsPreviewVectorizeBindingParam) MarshalJSON 

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

type ProjectDeploymentConfigsProduction 

type ProjectDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings map[string]ProjectDeploymentConfigsProductionAIBinding `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers map[string]ProjectDeploymentConfigsProductionBrowser `json:"browsers,nullable"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []string `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases map[string]ProjectDeploymentConfigsProductionD1Database `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces map[string]ProjectDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars map[string]ProjectDeploymentConfigsProductionEnvVar `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings map[string]ProjectDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces map[string]ProjectDeploymentConfigsProductionKVNamespace `json:"kv_namespaces,nullable"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates map[string]ProjectDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsProductionPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers map[string]ProjectDeploymentConfigsProductionQueueProducer `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets map[string]ProjectDeploymentConfigsProductionR2Bucket `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services map[string]ProjectDeploymentConfigsProductionService `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings map[string]ProjectDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings,nullable"`
	JSON              projectDeploymentConfigsProductionJSON                        `json:"-"`
}

Configs for production deploys.

func (*ProjectDeploymentConfigsProduction) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionAIBinding 

type ProjectDeploymentConfigsProductionAIBinding struct {
	ProjectID string                                          `json:"project_id"`
	JSON      projectDeploymentConfigsProductionAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsProductionAIBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionAIBindingParam 

type ProjectDeploymentConfigsProductionAIBindingParam struct {
	ProjectID param.Field[string] `json:"project_id"`
}

AI binding.

func (ProjectDeploymentConfigsProductionAIBindingParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionAnalyticsEngineDataset 

type ProjectDeploymentConfigsProductionAnalyticsEngineDataset struct {
	// Name of the dataset.
	Dataset string                                                       `json:"dataset"`
	JSON    projectDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}

Analytics Engine binding.

func (*ProjectDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetParam 

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetParam struct {
	// Name of the dataset.
	Dataset param.Field[string] `json:"dataset"`
}

Analytics Engine binding.

func (ProjectDeploymentConfigsProductionAnalyticsEngineDatasetParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionBrowser 

type ProjectDeploymentConfigsProductionBrowser struct {
	JSON projectDeploymentConfigsProductionBrowserJSON `json:"-"`
}

Browser binding.

func (*ProjectDeploymentConfigsProductionBrowser) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionBrowserParam 

type ProjectDeploymentConfigsProductionBrowserParam struct {
}

Browser binding.

func (ProjectDeploymentConfigsProductionBrowserParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionD1Database 

type ProjectDeploymentConfigsProductionD1Database struct {
	// UUID of the D1 database.
	ID   string                                           `json:"id"`
	JSON projectDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}

D1 binding.

func (*ProjectDeploymentConfigsProductionD1Database) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionD1DatabaseParam 

type ProjectDeploymentConfigsProductionD1DatabaseParam struct {
	// UUID of the D1 database.
	ID param.Field[string] `json:"id"`
}

D1 binding.

func (ProjectDeploymentConfigsProductionD1DatabaseParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionDurableObjectNamespace 

type ProjectDeploymentConfigsProductionDurableObjectNamespace struct {
	// ID of the Durabble Object namespace.
	NamespaceID string                                                       `json:"namespace_id"`
	JSON        projectDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}

Durabble Object binding.

func (*ProjectDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionDurableObjectNamespaceParam 

type ProjectDeploymentConfigsProductionDurableObjectNamespaceParam struct {
	// ID of the Durabble Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id"`
}

Durabble Object binding.

func (ProjectDeploymentConfigsProductionDurableObjectNamespaceParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionEnvVar 

type ProjectDeploymentConfigsProductionEnvVar struct {
	// Environment variable value.
	Value string `json:"value,required"`
	// The type of environment variable.
	Type ProjectDeploymentConfigsProductionEnvVarsType `json:"type"`
	JSON projectDeploymentConfigsProductionEnvVarJSON  `json:"-"`
}

Environment variable.

func (*ProjectDeploymentConfigsProductionEnvVar) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionEnvVarParam 

type ProjectDeploymentConfigsProductionEnvVarParam struct {
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
	// The type of environment variable.
	Type param.Field[ProjectDeploymentConfigsProductionEnvVarsType] `json:"type"`
}

Environment variable.

func (ProjectDeploymentConfigsProductionEnvVarParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionEnvVarsType 

type ProjectDeploymentConfigsProductionEnvVarsType string

The type of environment variable. 

const (
	ProjectDeploymentConfigsProductionEnvVarsTypePlainText  ProjectDeploymentConfigsProductionEnvVarsType = "plain_text"
	ProjectDeploymentConfigsProductionEnvVarsTypeSecretText ProjectDeploymentConfigsProductionEnvVarsType = "secret_text"
)

func (ProjectDeploymentConfigsProductionEnvVarsType) IsKnown 

func (r ProjectDeploymentConfigsProductionEnvVarsType) IsKnown() bool

type ProjectDeploymentConfigsProductionHyperdriveBinding 

type ProjectDeploymentConfigsProductionHyperdriveBinding struct {
	ID   string                                                  `json:"id"`
	JSON projectDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}

Hyperdrive binding.

func (*ProjectDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionHyperdriveBindingParam 

type ProjectDeploymentConfigsProductionHyperdriveBindingParam struct {
	ID param.Field[string] `json:"id"`
}

Hyperdrive binding.

func (ProjectDeploymentConfigsProductionHyperdriveBindingParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionKVNamespace 

type ProjectDeploymentConfigsProductionKVNamespace struct {
	// ID of the KV namespace.
	NamespaceID string                                            `json:"namespace_id"`
	JSON        projectDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}

KV namespace binding.

func (*ProjectDeploymentConfigsProductionKVNamespace) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionKVNamespaceParam 

type ProjectDeploymentConfigsProductionKVNamespaceParam struct {
	// ID of the KV namespace.
	NamespaceID param.Field[string] `json:"namespace_id"`
}

KV namespace binding.

func (ProjectDeploymentConfigsProductionKVNamespaceParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionMTLSCertificate 

type ProjectDeploymentConfigsProductionMTLSCertificate struct {
	CertificateID string                                                `json:"certificate_id"`
	JSON          projectDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}

mTLS binding.

func (*ProjectDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionMTLSCertificateParam 

type ProjectDeploymentConfigsProductionMTLSCertificateParam struct {
	CertificateID param.Field[string] `json:"certificate_id"`
}

mTLS binding.

func (ProjectDeploymentConfigsProductionMTLSCertificateParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionParam 

type ProjectDeploymentConfigsProductionParam struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectDeploymentConfigsProductionAIBindingParam] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectDeploymentConfigsProductionAnalyticsEngineDatasetParam] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectDeploymentConfigsProductionBrowserParam] `json:"browsers"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases param.Field[map[string]ProjectDeploymentConfigsProductionD1DatabaseParam] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectDeploymentConfigsProductionDurableObjectNamespaceParam] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[map[string]ProjectDeploymentConfigsProductionEnvVarParam] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectDeploymentConfigsProductionHyperdriveBindingParam] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectDeploymentConfigsProductionKVNamespaceParam] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectDeploymentConfigsProductionMTLSCertificateParam] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectDeploymentConfigsProductionPlacementParam] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectDeploymentConfigsProductionQueueProducerParam] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectDeploymentConfigsProductionR2BucketParam] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectDeploymentConfigsProductionServiceParam] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectDeploymentConfigsProductionVectorizeBindingParam] `json:"vectorize_bindings"`
}

Configs for production deploys.

func (ProjectDeploymentConfigsProductionParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionPlacement 

type ProjectDeploymentConfigsProductionPlacement struct {
	// Placement mode.
	Mode string                                          `json:"mode"`
	JSON projectDeploymentConfigsProductionPlacementJSON `json:"-"`
}

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsProductionPlacement) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionPlacementParam 

type ProjectDeploymentConfigsProductionPlacementParam struct {
	// Placement mode.
	Mode param.Field[string] `json:"mode"`
}

Placement setting used for Pages Functions.

func (ProjectDeploymentConfigsProductionPlacementParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionQueueProducer 

type ProjectDeploymentConfigsProductionQueueProducer struct {
	// Name of the Queue.
	Name string                                              `json:"name"`
	JSON projectDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}

Queue Producer binding.

func (*ProjectDeploymentConfigsProductionQueueProducer) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionQueueProducerParam 

type ProjectDeploymentConfigsProductionQueueProducerParam struct {
	// Name of the Queue.
	Name param.Field[string] `json:"name"`
}

Queue Producer binding.

func (ProjectDeploymentConfigsProductionQueueProducerParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionR2Bucket 

type ProjectDeploymentConfigsProductionR2Bucket struct {
	// Jurisdiction of the R2 bucket.
	Jurisdiction string `json:"jurisdiction,nullable"`
	// Name of the R2 bucket.
	Name string                                         `json:"name"`
	JSON projectDeploymentConfigsProductionR2BucketJSON `json:"-"`
}

R2 binding.

func (*ProjectDeploymentConfigsProductionR2Bucket) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionR2BucketParam 

type ProjectDeploymentConfigsProductionR2BucketParam struct {
	// Jurisdiction of the R2 bucket.
	Jurisdiction param.Field[string] `json:"jurisdiction"`
	// Name of the R2 bucket.
	Name param.Field[string] `json:"name"`
}

R2 binding.

func (ProjectDeploymentConfigsProductionR2BucketParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionService 

type ProjectDeploymentConfigsProductionService struct {
	// The entrypoint to bind to.
	Entrypoint string `json:"entrypoint,nullable"`
	// The Service environment.
	Environment string `json:"environment"`
	// The Service name.
	Service string                                        `json:"service"`
	JSON    projectDeploymentConfigsProductionServiceJSON `json:"-"`
}

Service binding.

func (*ProjectDeploymentConfigsProductionService) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionServiceParam 

type ProjectDeploymentConfigsProductionServiceParam struct {
	// The entrypoint to bind to.
	Entrypoint param.Field[string] `json:"entrypoint"`
	// The Service environment.
	Environment param.Field[string] `json:"environment"`
	// The Service name.
	Service param.Field[string] `json:"service"`
}

Service binding.

func (ProjectDeploymentConfigsProductionServiceParam) MarshalJSON 

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

type ProjectDeploymentConfigsProductionVectorizeBinding 

type ProjectDeploymentConfigsProductionVectorizeBinding struct {
	IndexName string                                                 `json:"index_name"`
	JSON      projectDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}

Vectorize binding.

func (*ProjectDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON 

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

type ProjectDeploymentConfigsProductionVectorizeBindingParam 

type ProjectDeploymentConfigsProductionVectorizeBindingParam struct {
	IndexName param.Field[string] `json:"index_name"`
}

Vectorize binding.

func (ProjectDeploymentConfigsProductionVectorizeBindingParam) MarshalJSON 

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

type ProjectDeploymentDeleteParams 

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

type ProjectDeploymentDeleteResponse 

type ProjectDeploymentDeleteResponse = interface{}

type ProjectDeploymentDeleteResponseEnvelope 

type ProjectDeploymentDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo           `json:"errors,required"`
	Messages []shared.ResponseInfo           `json:"messages,required"`
	Result   ProjectDeploymentDeleteResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDeploymentDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentDeleteResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentDeleteResponseEnvelopeSuccess 

type ProjectDeploymentDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentDeleteResponseEnvelopeSuccessFalse ProjectDeploymentDeleteResponseEnvelopeSuccess = false
	ProjectDeploymentDeleteResponseEnvelopeSuccessTrue  ProjectDeploymentDeleteResponseEnvelopeSuccess = true
)

func (ProjectDeploymentDeleteResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentDeleteResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentGetParams 

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

type ProjectDeploymentGetResponseEnvelope 

type ProjectDeploymentGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Deployment            `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentGetResponseEnvelopeSuccess 

type ProjectDeploymentGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentGetResponseEnvelopeSuccessFalse ProjectDeploymentGetResponseEnvelopeSuccess = false
	ProjectDeploymentGetResponseEnvelopeSuccessTrue  ProjectDeploymentGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentHistoryLogGetParams 

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

type ProjectDeploymentHistoryLogGetResponse 

type ProjectDeploymentHistoryLogGetResponse struct {
	Data                  []ProjectDeploymentHistoryLogGetResponseData `json:"data"`
	IncludesContainerLogs bool                                         `json:"includes_container_logs"`
	Total                 int64                                        `json:"total"`
	JSON                  projectDeploymentHistoryLogGetResponseJSON   `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON 

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

type ProjectDeploymentHistoryLogGetResponseData 

type ProjectDeploymentHistoryLogGetResponseData struct {
	Line string                                         `json:"line"`
	Ts   string                                         `json:"ts"`
	JSON projectDeploymentHistoryLogGetResponseDataJSON `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON 

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

type ProjectDeploymentHistoryLogGetResponseEnvelope 

type ProjectDeploymentHistoryLogGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo                  `json:"errors,required"`
	Messages []shared.ResponseInfo                  `json:"messages,required"`
	Result   ProjectDeploymentHistoryLogGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentHistoryLogGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess 

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessFalse ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = false
	ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessTrue  ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentHistoryLogService 

type ProjectDeploymentHistoryLogService struct {
	Options []option.RequestOption
}

ProjectDeploymentHistoryLogService 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 NewProjectDeploymentHistoryLogService method instead.

func NewProjectDeploymentHistoryLogService 

func NewProjectDeploymentHistoryLogService(opts ...option.RequestOption) (r *ProjectDeploymentHistoryLogService)

NewProjectDeploymentHistoryLogService 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 (*ProjectDeploymentHistoryLogService) Get 

func (r *ProjectDeploymentHistoryLogService) Get(ctx context.Context, projectName string, deploymentID string, query ProjectDeploymentHistoryLogGetParams, opts ...option.RequestOption) (res *ProjectDeploymentHistoryLogGetResponse, err error)

Fetch deployment logs for a project.

type ProjectDeploymentHistoryService 

type ProjectDeploymentHistoryService struct {
	Options []option.RequestOption
	Logs    *ProjectDeploymentHistoryLogService
}

ProjectDeploymentHistoryService 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 NewProjectDeploymentHistoryService method instead.

func NewProjectDeploymentHistoryService 

func NewProjectDeploymentHistoryService(opts ...option.RequestOption) (r *ProjectDeploymentHistoryService)

NewProjectDeploymentHistoryService 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 ProjectDeploymentListParams 

type ProjectDeploymentListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// What type of deployments to fetch.
	Env param.Field[ProjectDeploymentListParamsEnv] `query:"env"`
}

func (ProjectDeploymentListParams) URLQuery 

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

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

type ProjectDeploymentListParamsEnv 

type ProjectDeploymentListParamsEnv string

What type of deployments to fetch. 

const (
	ProjectDeploymentListParamsEnvProduction ProjectDeploymentListParamsEnv = "production"
	ProjectDeploymentListParamsEnvPreview    ProjectDeploymentListParamsEnv = "preview"
)

func (ProjectDeploymentListParamsEnv) IsKnown 

func (r ProjectDeploymentListParamsEnv) IsKnown() bool

type ProjectDeploymentNewParams 

type ProjectDeploymentNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// The branch to build the new deployment from. The `HEAD` of the branch will be
	// used. If omitted, the production branch will be used by default.
	Branch param.Field[string] `json:"branch"`
}

func (ProjectDeploymentNewParams) MarshalMultipart 

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

type ProjectDeploymentNewResponseEnvelope 

type ProjectDeploymentNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Deployment            `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentNewResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentNewResponseEnvelopeSuccess 

type ProjectDeploymentNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentNewResponseEnvelopeSuccessFalse ProjectDeploymentNewResponseEnvelopeSuccess = false
	ProjectDeploymentNewResponseEnvelopeSuccessTrue  ProjectDeploymentNewResponseEnvelopeSuccess = true
)

func (ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentRetryParams 

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

func (ProjectDeploymentRetryParams) MarshalJSON 

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

type ProjectDeploymentRetryResponseEnvelope 

type ProjectDeploymentRetryResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Deployment            `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentRetryResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentRetryResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentRetryResponseEnvelopeSuccess 

type ProjectDeploymentRetryResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentRetryResponseEnvelopeSuccessFalse ProjectDeploymentRetryResponseEnvelopeSuccess = false
	ProjectDeploymentRetryResponseEnvelopeSuccessTrue  ProjectDeploymentRetryResponseEnvelopeSuccess = true
)

func (ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentRollbackParams 

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

func (ProjectDeploymentRollbackParams) MarshalJSON 

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

type ProjectDeploymentRollbackResponseEnvelope 

type ProjectDeploymentRollbackResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Deployment            `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentRollbackResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentRollbackResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON 

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

type ProjectDeploymentRollbackResponseEnvelopeSuccess 

type ProjectDeploymentRollbackResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDeploymentRollbackResponseEnvelopeSuccessFalse ProjectDeploymentRollbackResponseEnvelopeSuccess = false
	ProjectDeploymentRollbackResponseEnvelopeSuccessTrue  ProjectDeploymentRollbackResponseEnvelopeSuccess = true
)

func (ProjectDeploymentRollbackResponseEnvelopeSuccess) IsKnown 

func (r ProjectDeploymentRollbackResponseEnvelopeSuccess) IsKnown() bool

type ProjectDeploymentService 

type ProjectDeploymentService struct {
	Options []option.RequestOption
	History *ProjectDeploymentHistoryService
}

ProjectDeploymentService 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 NewProjectDeploymentService method instead.

func NewProjectDeploymentService 

func NewProjectDeploymentService(opts ...option.RequestOption) (r *ProjectDeploymentService)

NewProjectDeploymentService 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 (*ProjectDeploymentService) Delete 

func (r *ProjectDeploymentService) Delete(ctx context.Context, projectName string, deploymentID string, body ProjectDeploymentDeleteParams, opts ...option.RequestOption) (res *ProjectDeploymentDeleteResponse, err error)

Delete a deployment.

func (*ProjectDeploymentService) Get 

func (r *ProjectDeploymentService) Get(ctx context.Context, projectName string, deploymentID string, query ProjectDeploymentGetParams, opts ...option.RequestOption) (res *Deployment, err error)

Fetch information about a deployment.

func (*ProjectDeploymentService) List 

func (r *ProjectDeploymentService) List(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Deployment], err error)

Fetch a list of project deployments.

func (*ProjectDeploymentService) ListAutoPaging 

func (r *ProjectDeploymentService) ListAutoPaging(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Deployment]

Fetch a list of project deployments.

func (*ProjectDeploymentService) New 

func (r *ProjectDeploymentService) New(ctx context.Context, projectName string, params ProjectDeploymentNewParams, opts ...option.RequestOption) (res *Deployment, err error)

Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.

func (*ProjectDeploymentService) Retry 

func (r *ProjectDeploymentService) Retry(ctx context.Context, projectName string, deploymentID string, params ProjectDeploymentRetryParams, opts ...option.RequestOption) (res *Deployment, err error)

Retry a previous deployment.

func (*ProjectDeploymentService) Rollback 

func (r *ProjectDeploymentService) Rollback(ctx context.Context, projectName string, deploymentID string, params ProjectDeploymentRollbackParams, opts ...option.RequestOption) (res *Deployment, err error)

Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.

type ProjectDomainDeleteParams 

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

type ProjectDomainDeleteResponse 

type ProjectDomainDeleteResponse = interface{}

type ProjectDomainDeleteResponseEnvelope 

type ProjectDomainDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo       `json:"errors,required"`
	Messages []shared.ResponseInfo       `json:"messages,required"`
	Result   ProjectDomainDeleteResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDomainDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDomainDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDomainDeleteResponseEnvelope) UnmarshalJSON 

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

type ProjectDomainDeleteResponseEnvelopeSuccess 

type ProjectDomainDeleteResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDomainDeleteResponseEnvelopeSuccessFalse ProjectDomainDeleteResponseEnvelopeSuccess = false
	ProjectDomainDeleteResponseEnvelopeSuccessTrue  ProjectDomainDeleteResponseEnvelopeSuccess = true
)

func (ProjectDomainDeleteResponseEnvelopeSuccess) IsKnown 

func (r ProjectDomainDeleteResponseEnvelopeSuccess) IsKnown() bool

type ProjectDomainEditParams 

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

func (ProjectDomainEditParams) MarshalJSON 

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

type ProjectDomainEditResponse 

type ProjectDomainEditResponse struct {
	ID                   string                                        `json:"id"`
	CertificateAuthority ProjectDomainEditResponseCertificateAuthority `json:"certificate_authority"`
	CreatedOn            string                                        `json:"created_on"`
	DomainID             string                                        `json:"domain_id"`
	Name                 string                                        `json:"name"`
	Status               ProjectDomainEditResponseStatus               `json:"status"`
	ValidationData       ProjectDomainEditResponseValidationData       `json:"validation_data"`
	VerificationData     ProjectDomainEditResponseVerificationData     `json:"verification_data"`
	ZoneTag              string                                        `json:"zone_tag"`
	JSON                 projectDomainEditResponseJSON                 `json:"-"`
}

func (*ProjectDomainEditResponse) UnmarshalJSON 

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

type ProjectDomainEditResponseCertificateAuthority 

type ProjectDomainEditResponseCertificateAuthority string
const (
	ProjectDomainEditResponseCertificateAuthorityGoogle      ProjectDomainEditResponseCertificateAuthority = "google"
	ProjectDomainEditResponseCertificateAuthorityLetsEncrypt ProjectDomainEditResponseCertificateAuthority = "lets_encrypt"
)

func (ProjectDomainEditResponseCertificateAuthority) IsKnown 

func (r ProjectDomainEditResponseCertificateAuthority) IsKnown() bool

type ProjectDomainEditResponseEnvelope 

type ProjectDomainEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo     `json:"errors,required"`
	Messages []shared.ResponseInfo     `json:"messages,required"`
	Result   ProjectDomainEditResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDomainEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDomainEditResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDomainEditResponseEnvelope) UnmarshalJSON 

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

type ProjectDomainEditResponseEnvelopeSuccess 

type ProjectDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDomainEditResponseEnvelopeSuccessFalse ProjectDomainEditResponseEnvelopeSuccess = false
	ProjectDomainEditResponseEnvelopeSuccessTrue  ProjectDomainEditResponseEnvelopeSuccess = true
)

func (ProjectDomainEditResponseEnvelopeSuccess) IsKnown 

func (r ProjectDomainEditResponseEnvelopeSuccess) IsKnown() bool

type ProjectDomainEditResponseStatus 

type ProjectDomainEditResponseStatus string
const (
	ProjectDomainEditResponseStatusInitializing ProjectDomainEditResponseStatus = "initializing"
	ProjectDomainEditResponseStatusPending      ProjectDomainEditResponseStatus = "pending"
	ProjectDomainEditResponseStatusActive       ProjectDomainEditResponseStatus = "active"
	ProjectDomainEditResponseStatusDeactivated  ProjectDomainEditResponseStatus = "deactivated"
	ProjectDomainEditResponseStatusBlocked      ProjectDomainEditResponseStatus = "blocked"
	ProjectDomainEditResponseStatusError        ProjectDomainEditResponseStatus = "error"
)

func (ProjectDomainEditResponseStatus) IsKnown 

func (r ProjectDomainEditResponseStatus) IsKnown() bool

type ProjectDomainEditResponseValidationData 

type ProjectDomainEditResponseValidationData struct {
	ErrorMessage string                                        `json:"error_message"`
	Method       ProjectDomainEditResponseValidationDataMethod `json:"method"`
	Status       ProjectDomainEditResponseValidationDataStatus `json:"status"`
	TXTName      string                                        `json:"txt_name"`
	TXTValue     string                                        `json:"txt_value"`
	JSON         projectDomainEditResponseValidationDataJSON   `json:"-"`
}

func (*ProjectDomainEditResponseValidationData) UnmarshalJSON 

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

type ProjectDomainEditResponseValidationDataMethod 

type ProjectDomainEditResponseValidationDataMethod string
const (
	ProjectDomainEditResponseValidationDataMethodHTTP ProjectDomainEditResponseValidationDataMethod = "http"
	ProjectDomainEditResponseValidationDataMethodTXT  ProjectDomainEditResponseValidationDataMethod = "txt"
)

func (ProjectDomainEditResponseValidationDataMethod) IsKnown 

func (r ProjectDomainEditResponseValidationDataMethod) IsKnown() bool

type ProjectDomainEditResponseValidationDataStatus 

type ProjectDomainEditResponseValidationDataStatus string
const (
	ProjectDomainEditResponseValidationDataStatusInitializing ProjectDomainEditResponseValidationDataStatus = "initializing"
	ProjectDomainEditResponseValidationDataStatusPending      ProjectDomainEditResponseValidationDataStatus = "pending"
	ProjectDomainEditResponseValidationDataStatusActive       ProjectDomainEditResponseValidationDataStatus = "active"
	ProjectDomainEditResponseValidationDataStatusDeactivated  ProjectDomainEditResponseValidationDataStatus = "deactivated"
	ProjectDomainEditResponseValidationDataStatusError        ProjectDomainEditResponseValidationDataStatus = "error"
)

func (ProjectDomainEditResponseValidationDataStatus) IsKnown 

func (r ProjectDomainEditResponseValidationDataStatus) IsKnown() bool

type ProjectDomainEditResponseVerificationData 

type ProjectDomainEditResponseVerificationData struct {
	ErrorMessage string                                          `json:"error_message"`
	Status       ProjectDomainEditResponseVerificationDataStatus `json:"status"`
	JSON         projectDomainEditResponseVerificationDataJSON   `json:"-"`
}

func (*ProjectDomainEditResponseVerificationData) UnmarshalJSON 

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

type ProjectDomainEditResponseVerificationDataStatus 

type ProjectDomainEditResponseVerificationDataStatus string
const (
	ProjectDomainEditResponseVerificationDataStatusPending     ProjectDomainEditResponseVerificationDataStatus = "pending"
	ProjectDomainEditResponseVerificationDataStatusActive      ProjectDomainEditResponseVerificationDataStatus = "active"
	ProjectDomainEditResponseVerificationDataStatusDeactivated ProjectDomainEditResponseVerificationDataStatus = "deactivated"
	ProjectDomainEditResponseVerificationDataStatusBlocked     ProjectDomainEditResponseVerificationDataStatus = "blocked"
	ProjectDomainEditResponseVerificationDataStatusError       ProjectDomainEditResponseVerificationDataStatus = "error"
)

func (ProjectDomainEditResponseVerificationDataStatus) IsKnown 

func (r ProjectDomainEditResponseVerificationDataStatus) IsKnown() bool

type ProjectDomainGetParams 

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

type ProjectDomainGetResponse 

type ProjectDomainGetResponse struct {
	ID                   string                                       `json:"id"`
	CertificateAuthority ProjectDomainGetResponseCertificateAuthority `json:"certificate_authority"`
	CreatedOn            string                                       `json:"created_on"`
	DomainID             string                                       `json:"domain_id"`
	Name                 string                                       `json:"name"`
	Status               ProjectDomainGetResponseStatus               `json:"status"`
	ValidationData       ProjectDomainGetResponseValidationData       `json:"validation_data"`
	VerificationData     ProjectDomainGetResponseVerificationData     `json:"verification_data"`
	ZoneTag              string                                       `json:"zone_tag"`
	JSON                 projectDomainGetResponseJSON                 `json:"-"`
}

func (*ProjectDomainGetResponse) UnmarshalJSON 

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

type ProjectDomainGetResponseCertificateAuthority 

type ProjectDomainGetResponseCertificateAuthority string
const (
	ProjectDomainGetResponseCertificateAuthorityGoogle      ProjectDomainGetResponseCertificateAuthority = "google"
	ProjectDomainGetResponseCertificateAuthorityLetsEncrypt ProjectDomainGetResponseCertificateAuthority = "lets_encrypt"
)

func (ProjectDomainGetResponseCertificateAuthority) IsKnown 

func (r ProjectDomainGetResponseCertificateAuthority) IsKnown() bool

type ProjectDomainGetResponseEnvelope 

type ProjectDomainGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo    `json:"errors,required"`
	Messages []shared.ResponseInfo    `json:"messages,required"`
	Result   ProjectDomainGetResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDomainGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDomainGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDomainGetResponseEnvelope) UnmarshalJSON 

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

type ProjectDomainGetResponseEnvelopeSuccess 

type ProjectDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDomainGetResponseEnvelopeSuccessFalse ProjectDomainGetResponseEnvelopeSuccess = false
	ProjectDomainGetResponseEnvelopeSuccessTrue  ProjectDomainGetResponseEnvelopeSuccess = true
)

func (ProjectDomainGetResponseEnvelopeSuccess) IsKnown 

func (r ProjectDomainGetResponseEnvelopeSuccess) IsKnown() bool

type ProjectDomainGetResponseStatus 

type ProjectDomainGetResponseStatus string
const (
	ProjectDomainGetResponseStatusInitializing ProjectDomainGetResponseStatus = "initializing"
	ProjectDomainGetResponseStatusPending      ProjectDomainGetResponseStatus = "pending"
	ProjectDomainGetResponseStatusActive       ProjectDomainGetResponseStatus = "active"
	ProjectDomainGetResponseStatusDeactivated  ProjectDomainGetResponseStatus = "deactivated"
	ProjectDomainGetResponseStatusBlocked      ProjectDomainGetResponseStatus = "blocked"
	ProjectDomainGetResponseStatusError        ProjectDomainGetResponseStatus = "error"
)

func (ProjectDomainGetResponseStatus) IsKnown 

func (r ProjectDomainGetResponseStatus) IsKnown() bool

type ProjectDomainGetResponseValidationData 

type ProjectDomainGetResponseValidationData struct {
	ErrorMessage string                                       `json:"error_message"`
	Method       ProjectDomainGetResponseValidationDataMethod `json:"method"`
	Status       ProjectDomainGetResponseValidationDataStatus `json:"status"`
	TXTName      string                                       `json:"txt_name"`
	TXTValue     string                                       `json:"txt_value"`
	JSON         projectDomainGetResponseValidationDataJSON   `json:"-"`
}

func (*ProjectDomainGetResponseValidationData) UnmarshalJSON 

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

type ProjectDomainGetResponseValidationDataMethod 

type ProjectDomainGetResponseValidationDataMethod string
const (
	ProjectDomainGetResponseValidationDataMethodHTTP ProjectDomainGetResponseValidationDataMethod = "http"
	ProjectDomainGetResponseValidationDataMethodTXT  ProjectDomainGetResponseValidationDataMethod = "txt"
)

func (ProjectDomainGetResponseValidationDataMethod) IsKnown 

func (r ProjectDomainGetResponseValidationDataMethod) IsKnown() bool

type ProjectDomainGetResponseValidationDataStatus 

type ProjectDomainGetResponseValidationDataStatus string
const (
	ProjectDomainGetResponseValidationDataStatusInitializing ProjectDomainGetResponseValidationDataStatus = "initializing"
	ProjectDomainGetResponseValidationDataStatusPending      ProjectDomainGetResponseValidationDataStatus = "pending"
	ProjectDomainGetResponseValidationDataStatusActive       ProjectDomainGetResponseValidationDataStatus = "active"
	ProjectDomainGetResponseValidationDataStatusDeactivated  ProjectDomainGetResponseValidationDataStatus = "deactivated"
	ProjectDomainGetResponseValidationDataStatusError        ProjectDomainGetResponseValidationDataStatus = "error"
)

func (ProjectDomainGetResponseValidationDataStatus) IsKnown 

func (r ProjectDomainGetResponseValidationDataStatus) IsKnown() bool

type ProjectDomainGetResponseVerificationData 

type ProjectDomainGetResponseVerificationData struct {
	ErrorMessage string                                         `json:"error_message"`
	Status       ProjectDomainGetResponseVerificationDataStatus `json:"status"`
	JSON         projectDomainGetResponseVerificationDataJSON   `json:"-"`
}

func (*ProjectDomainGetResponseVerificationData) UnmarshalJSON 

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

type ProjectDomainGetResponseVerificationDataStatus 

type ProjectDomainGetResponseVerificationDataStatus string
const (
	ProjectDomainGetResponseVerificationDataStatusPending     ProjectDomainGetResponseVerificationDataStatus = "pending"
	ProjectDomainGetResponseVerificationDataStatusActive      ProjectDomainGetResponseVerificationDataStatus = "active"
	ProjectDomainGetResponseVerificationDataStatusDeactivated ProjectDomainGetResponseVerificationDataStatus = "deactivated"
	ProjectDomainGetResponseVerificationDataStatusBlocked     ProjectDomainGetResponseVerificationDataStatus = "blocked"
	ProjectDomainGetResponseVerificationDataStatusError       ProjectDomainGetResponseVerificationDataStatus = "error"
)

func (ProjectDomainGetResponseVerificationDataStatus) IsKnown 

func (r ProjectDomainGetResponseVerificationDataStatus) IsKnown() bool

type ProjectDomainListParams 

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

type ProjectDomainListResponse 

type ProjectDomainListResponse struct {
	ID                   string                                        `json:"id"`
	CertificateAuthority ProjectDomainListResponseCertificateAuthority `json:"certificate_authority"`
	CreatedOn            string                                        `json:"created_on"`
	DomainID             string                                        `json:"domain_id"`
	Name                 string                                        `json:"name"`
	Status               ProjectDomainListResponseStatus               `json:"status"`
	ValidationData       ProjectDomainListResponseValidationData       `json:"validation_data"`
	VerificationData     ProjectDomainListResponseVerificationData     `json:"verification_data"`
	ZoneTag              string                                        `json:"zone_tag"`
	JSON                 projectDomainListResponseJSON                 `json:"-"`
}

func (*ProjectDomainListResponse) UnmarshalJSON 

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

type ProjectDomainListResponseCertificateAuthority 

type ProjectDomainListResponseCertificateAuthority string
const (
	ProjectDomainListResponseCertificateAuthorityGoogle      ProjectDomainListResponseCertificateAuthority = "google"
	ProjectDomainListResponseCertificateAuthorityLetsEncrypt ProjectDomainListResponseCertificateAuthority = "lets_encrypt"
)

func (ProjectDomainListResponseCertificateAuthority) IsKnown 

func (r ProjectDomainListResponseCertificateAuthority) IsKnown() bool

type ProjectDomainListResponseStatus 

type ProjectDomainListResponseStatus string
const (
	ProjectDomainListResponseStatusInitializing ProjectDomainListResponseStatus = "initializing"
	ProjectDomainListResponseStatusPending      ProjectDomainListResponseStatus = "pending"
	ProjectDomainListResponseStatusActive       ProjectDomainListResponseStatus = "active"
	ProjectDomainListResponseStatusDeactivated  ProjectDomainListResponseStatus = "deactivated"
	ProjectDomainListResponseStatusBlocked      ProjectDomainListResponseStatus = "blocked"
	ProjectDomainListResponseStatusError        ProjectDomainListResponseStatus = "error"
)

func (ProjectDomainListResponseStatus) IsKnown 

func (r ProjectDomainListResponseStatus) IsKnown() bool

type ProjectDomainListResponseValidationData 

type ProjectDomainListResponseValidationData struct {
	ErrorMessage string                                        `json:"error_message"`
	Method       ProjectDomainListResponseValidationDataMethod `json:"method"`
	Status       ProjectDomainListResponseValidationDataStatus `json:"status"`
	TXTName      string                                        `json:"txt_name"`
	TXTValue     string                                        `json:"txt_value"`
	JSON         projectDomainListResponseValidationDataJSON   `json:"-"`
}

func (*ProjectDomainListResponseValidationData) UnmarshalJSON 

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

type ProjectDomainListResponseValidationDataMethod 

type ProjectDomainListResponseValidationDataMethod string
const (
	ProjectDomainListResponseValidationDataMethodHTTP ProjectDomainListResponseValidationDataMethod = "http"
	ProjectDomainListResponseValidationDataMethodTXT  ProjectDomainListResponseValidationDataMethod = "txt"
)

func (ProjectDomainListResponseValidationDataMethod) IsKnown 

func (r ProjectDomainListResponseValidationDataMethod) IsKnown() bool

type ProjectDomainListResponseValidationDataStatus 

type ProjectDomainListResponseValidationDataStatus string
const (
	ProjectDomainListResponseValidationDataStatusInitializing ProjectDomainListResponseValidationDataStatus = "initializing"
	ProjectDomainListResponseValidationDataStatusPending      ProjectDomainListResponseValidationDataStatus = "pending"
	ProjectDomainListResponseValidationDataStatusActive       ProjectDomainListResponseValidationDataStatus = "active"
	ProjectDomainListResponseValidationDataStatusDeactivated  ProjectDomainListResponseValidationDataStatus = "deactivated"
	ProjectDomainListResponseValidationDataStatusError        ProjectDomainListResponseValidationDataStatus = "error"
)

func (ProjectDomainListResponseValidationDataStatus) IsKnown 

func (r ProjectDomainListResponseValidationDataStatus) IsKnown() bool

type ProjectDomainListResponseVerificationData 

type ProjectDomainListResponseVerificationData struct {
	ErrorMessage string                                          `json:"error_message"`
	Status       ProjectDomainListResponseVerificationDataStatus `json:"status"`
	JSON         projectDomainListResponseVerificationDataJSON   `json:"-"`
}

func (*ProjectDomainListResponseVerificationData) UnmarshalJSON 

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

type ProjectDomainListResponseVerificationDataStatus 

type ProjectDomainListResponseVerificationDataStatus string
const (
	ProjectDomainListResponseVerificationDataStatusPending     ProjectDomainListResponseVerificationDataStatus = "pending"
	ProjectDomainListResponseVerificationDataStatusActive      ProjectDomainListResponseVerificationDataStatus = "active"
	ProjectDomainListResponseVerificationDataStatusDeactivated ProjectDomainListResponseVerificationDataStatus = "deactivated"
	ProjectDomainListResponseVerificationDataStatusBlocked     ProjectDomainListResponseVerificationDataStatus = "blocked"
	ProjectDomainListResponseVerificationDataStatusError       ProjectDomainListResponseVerificationDataStatus = "error"
)

func (ProjectDomainListResponseVerificationDataStatus) IsKnown 

func (r ProjectDomainListResponseVerificationDataStatus) IsKnown() bool

type ProjectDomainNewParams 

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

func (ProjectDomainNewParams) MarshalJSON 

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

type ProjectDomainNewResponse 

type ProjectDomainNewResponse struct {
	ID                   string                                       `json:"id"`
	CertificateAuthority ProjectDomainNewResponseCertificateAuthority `json:"certificate_authority"`
	CreatedOn            string                                       `json:"created_on"`
	DomainID             string                                       `json:"domain_id"`
	Name                 string                                       `json:"name"`
	Status               ProjectDomainNewResponseStatus               `json:"status"`
	ValidationData       ProjectDomainNewResponseValidationData       `json:"validation_data"`
	VerificationData     ProjectDomainNewResponseVerificationData     `json:"verification_data"`
	ZoneTag              string                                       `json:"zone_tag"`
	JSON                 projectDomainNewResponseJSON                 `json:"-"`
}

func (*ProjectDomainNewResponse) UnmarshalJSON 

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

type ProjectDomainNewResponseCertificateAuthority 

type ProjectDomainNewResponseCertificateAuthority string
const (
	ProjectDomainNewResponseCertificateAuthorityGoogle      ProjectDomainNewResponseCertificateAuthority = "google"
	ProjectDomainNewResponseCertificateAuthorityLetsEncrypt ProjectDomainNewResponseCertificateAuthority = "lets_encrypt"
)

func (ProjectDomainNewResponseCertificateAuthority) IsKnown 

func (r ProjectDomainNewResponseCertificateAuthority) IsKnown() bool

type ProjectDomainNewResponseEnvelope 

type ProjectDomainNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo    `json:"errors,required"`
	Messages []shared.ResponseInfo    `json:"messages,required"`
	Result   ProjectDomainNewResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectDomainNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDomainNewResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDomainNewResponseEnvelope) UnmarshalJSON 

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

type ProjectDomainNewResponseEnvelopeSuccess 

type ProjectDomainNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectDomainNewResponseEnvelopeSuccessFalse ProjectDomainNewResponseEnvelopeSuccess = false
	ProjectDomainNewResponseEnvelopeSuccessTrue  ProjectDomainNewResponseEnvelopeSuccess = true
)

func (ProjectDomainNewResponseEnvelopeSuccess) IsKnown 

func (r ProjectDomainNewResponseEnvelopeSuccess) IsKnown() bool

type ProjectDomainNewResponseStatus 

type ProjectDomainNewResponseStatus string
const (
	ProjectDomainNewResponseStatusInitializing ProjectDomainNewResponseStatus = "initializing"
	ProjectDomainNewResponseStatusPending      ProjectDomainNewResponseStatus = "pending"
	ProjectDomainNewResponseStatusActive       ProjectDomainNewResponseStatus = "active"
	ProjectDomainNewResponseStatusDeactivated  ProjectDomainNewResponseStatus = "deactivated"
	ProjectDomainNewResponseStatusBlocked      ProjectDomainNewResponseStatus = "blocked"
	ProjectDomainNewResponseStatusError        ProjectDomainNewResponseStatus = "error"
)

func (ProjectDomainNewResponseStatus) IsKnown 

func (r ProjectDomainNewResponseStatus) IsKnown() bool

type ProjectDomainNewResponseValidationData 

type ProjectDomainNewResponseValidationData struct {
	ErrorMessage string                                       `json:"error_message"`
	Method       ProjectDomainNewResponseValidationDataMethod `json:"method"`
	Status       ProjectDomainNewResponseValidationDataStatus `json:"status"`
	TXTName      string                                       `json:"txt_name"`
	TXTValue     string                                       `json:"txt_value"`
	JSON         projectDomainNewResponseValidationDataJSON   `json:"-"`
}

func (*ProjectDomainNewResponseValidationData) UnmarshalJSON 

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

type ProjectDomainNewResponseValidationDataMethod 

type ProjectDomainNewResponseValidationDataMethod string
const (
	ProjectDomainNewResponseValidationDataMethodHTTP ProjectDomainNewResponseValidationDataMethod = "http"
	ProjectDomainNewResponseValidationDataMethodTXT  ProjectDomainNewResponseValidationDataMethod = "txt"
)

func (ProjectDomainNewResponseValidationDataMethod) IsKnown 

func (r ProjectDomainNewResponseValidationDataMethod) IsKnown() bool

type ProjectDomainNewResponseValidationDataStatus 

type ProjectDomainNewResponseValidationDataStatus string
const (
	ProjectDomainNewResponseValidationDataStatusInitializing ProjectDomainNewResponseValidationDataStatus = "initializing"
	ProjectDomainNewResponseValidationDataStatusPending      ProjectDomainNewResponseValidationDataStatus = "pending"
	ProjectDomainNewResponseValidationDataStatusActive       ProjectDomainNewResponseValidationDataStatus = "active"
	ProjectDomainNewResponseValidationDataStatusDeactivated  ProjectDomainNewResponseValidationDataStatus = "deactivated"
	ProjectDomainNewResponseValidationDataStatusError        ProjectDomainNewResponseValidationDataStatus = "error"
)

func (ProjectDomainNewResponseValidationDataStatus) IsKnown 

func (r ProjectDomainNewResponseValidationDataStatus) IsKnown() bool

type ProjectDomainNewResponseVerificationData 

type ProjectDomainNewResponseVerificationData struct {
	ErrorMessage string                                         `json:"error_message"`
	Status       ProjectDomainNewResponseVerificationDataStatus `json:"status"`
	JSON         projectDomainNewResponseVerificationDataJSON   `json:"-"`
}

func (*ProjectDomainNewResponseVerificationData) UnmarshalJSON 

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

type ProjectDomainNewResponseVerificationDataStatus 

type ProjectDomainNewResponseVerificationDataStatus string
const (
	ProjectDomainNewResponseVerificationDataStatusPending     ProjectDomainNewResponseVerificationDataStatus = "pending"
	ProjectDomainNewResponseVerificationDataStatusActive      ProjectDomainNewResponseVerificationDataStatus = "active"
	ProjectDomainNewResponseVerificationDataStatusDeactivated ProjectDomainNewResponseVerificationDataStatus = "deactivated"
	ProjectDomainNewResponseVerificationDataStatusBlocked     ProjectDomainNewResponseVerificationDataStatus = "blocked"
	ProjectDomainNewResponseVerificationDataStatusError       ProjectDomainNewResponseVerificationDataStatus = "error"
)

func (ProjectDomainNewResponseVerificationDataStatus) IsKnown 

func (r ProjectDomainNewResponseVerificationDataStatus) IsKnown() bool

type ProjectDomainService 

type ProjectDomainService struct {
	Options []option.RequestOption
}

ProjectDomainService 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 NewProjectDomainService method instead.

func NewProjectDomainService 

func NewProjectDomainService(opts ...option.RequestOption) (r *ProjectDomainService)

NewProjectDomainService 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 (*ProjectDomainService) Delete 

func (r *ProjectDomainService) Delete(ctx context.Context, projectName string, domainName string, body ProjectDomainDeleteParams, opts ...option.RequestOption) (res *ProjectDomainDeleteResponse, err error)

Delete a Pages project's domain.

func (*ProjectDomainService) Edit 

func (r *ProjectDomainService) Edit(ctx context.Context, projectName string, domainName string, params ProjectDomainEditParams, opts ...option.RequestOption) (res *ProjectDomainEditResponse, err error)

Retry the validation status of a single domain.

func (*ProjectDomainService) Get 

func (r *ProjectDomainService) Get(ctx context.Context, projectName string, domainName string, query ProjectDomainGetParams, opts ...option.RequestOption) (res *ProjectDomainGetResponse, err error)

Fetch a single domain.

func (*ProjectDomainService) List 

func (r *ProjectDomainService) List(ctx context.Context, projectName string, query ProjectDomainListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ProjectDomainListResponse], err error)

Fetch a list of all domains associated with a Pages project.

func (*ProjectDomainService) ListAutoPaging 

func (r *ProjectDomainService) ListAutoPaging(ctx context.Context, projectName string, query ProjectDomainListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ProjectDomainListResponse]

Fetch a list of all domains associated with a Pages project.

func (*ProjectDomainService) New 

func (r *ProjectDomainService) New(ctx context.Context, projectName string, params ProjectDomainNewParams, opts ...option.RequestOption) (res *ProjectDomainNewResponse, err error)

Add a new domain for the Pages project.

type ProjectEditParams 

type ProjectEditParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Project   ProjectParam        `json:"project,required"`
}

func (ProjectEditParams) MarshalJSON 

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

type ProjectEditResponseEnvelope 

type ProjectEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Project               `json:"result,required"`
	// Whether the API call was successful
	Success ProjectEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectEditResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectEditResponseEnvelope) UnmarshalJSON 

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

type ProjectEditResponseEnvelopeSuccess 

type ProjectEditResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectEditResponseEnvelopeSuccessFalse ProjectEditResponseEnvelopeSuccess = false
	ProjectEditResponseEnvelopeSuccessTrue  ProjectEditResponseEnvelopeSuccess = true
)

func (ProjectEditResponseEnvelopeSuccess) IsKnown 

func (r ProjectEditResponseEnvelopeSuccess) IsKnown() bool

type ProjectGetParams 

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

type ProjectGetResponseEnvelope 

type ProjectGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Project               `json:"result,required"`
	// Whether the API call was successful
	Success ProjectGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectGetResponseEnvelope) UnmarshalJSON 

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

type ProjectGetResponseEnvelopeSuccess 

type ProjectGetResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectGetResponseEnvelopeSuccessFalse ProjectGetResponseEnvelopeSuccess = false
	ProjectGetResponseEnvelopeSuccessTrue  ProjectGetResponseEnvelopeSuccess = true
)

func (ProjectGetResponseEnvelopeSuccess) IsKnown 

func (r ProjectGetResponseEnvelopeSuccess) IsKnown() bool

type ProjectListParams 

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

type ProjectNewParams 

type ProjectNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	Project   ProjectParam        `json:"project,required"`
}

func (ProjectNewParams) MarshalJSON 

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

type ProjectNewResponseEnvelope 

type ProjectNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Project               `json:"result,required"`
	// Whether the API call was successful
	Success ProjectNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectNewResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectNewResponseEnvelope) UnmarshalJSON 

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

type ProjectNewResponseEnvelopeSuccess 

type ProjectNewResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectNewResponseEnvelopeSuccessFalse ProjectNewResponseEnvelopeSuccess = false
	ProjectNewResponseEnvelopeSuccessTrue  ProjectNewResponseEnvelopeSuccess = true
)

func (ProjectNewResponseEnvelopeSuccess) IsKnown 

func (r ProjectNewResponseEnvelopeSuccess) IsKnown() bool

type ProjectParam 

type ProjectParam struct {
	// Configs for the project build process.
	BuildConfig param.Field[ProjectBuildConfigParam] `json:"build_config"`
	// Configs for deployments in a project.
	DeploymentConfigs param.Field[ProjectDeploymentConfigsParam] `json:"deployment_configs"`
	// Name of the project.
	Name param.Field[string] `json:"name"`
	// Production branch of the project. Used to identify production deployments.
	ProductionBranch param.Field[string] `json:"production_branch"`
}

func (ProjectParam) MarshalJSON 

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

type ProjectPurgeBuildCacheParams 

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

type ProjectPurgeBuildCacheResponse 

type ProjectPurgeBuildCacheResponse = interface{}

type ProjectPurgeBuildCacheResponseEnvelope 

type ProjectPurgeBuildCacheResponseEnvelope struct {
	Errors   []shared.ResponseInfo          `json:"errors,required"`
	Messages []shared.ResponseInfo          `json:"messages,required"`
	Result   ProjectPurgeBuildCacheResponse `json:"result,required,nullable"`
	// Whether the API call was successful
	Success ProjectPurgeBuildCacheResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectPurgeBuildCacheResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectPurgeBuildCacheResponseEnvelope) UnmarshalJSON 

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

type ProjectPurgeBuildCacheResponseEnvelopeSuccess 

type ProjectPurgeBuildCacheResponseEnvelopeSuccess bool

Whether the API call was successful 

const (
	ProjectPurgeBuildCacheResponseEnvelopeSuccessFalse ProjectPurgeBuildCacheResponseEnvelopeSuccess = false
	ProjectPurgeBuildCacheResponseEnvelopeSuccessTrue  ProjectPurgeBuildCacheResponseEnvelopeSuccess = true
)

func (ProjectPurgeBuildCacheResponseEnvelopeSuccess) IsKnown 

func (r ProjectPurgeBuildCacheResponseEnvelopeSuccess) IsKnown() bool

type ProjectService 

type ProjectService struct {
	Options     []option.RequestOption
	Deployments *ProjectDeploymentService
	Domains     *ProjectDomainService
}

ProjectService 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 NewProjectService method instead.

func NewProjectService 

func NewProjectService(opts ...option.RequestOption) (r *ProjectService)

NewProjectService 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 (*ProjectService) Delete 

func (r *ProjectService) Delete(ctx context.Context, projectName string, body ProjectDeleteParams, opts ...option.RequestOption) (res *ProjectDeleteResponse, err error)

Delete a project by name.

func (*ProjectService) Edit 

func (r *ProjectService) Edit(ctx context.Context, projectName string, params ProjectEditParams, opts ...option.RequestOption) (res *Project, err error)

Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.

func (*ProjectService) Get 

func (r *ProjectService) Get(ctx context.Context, projectName string, query ProjectGetParams, opts ...option.RequestOption) (res *Project, err error)

Fetch a project by name.

func (*ProjectService) List 

func (r *ProjectService) List(ctx context.Context, query ProjectListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Deployment], err error)

Fetch a list of all user projects.

func (*ProjectService) ListAutoPaging 

func (r *ProjectService) ListAutoPaging(ctx context.Context, query ProjectListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Deployment]

Fetch a list of all user projects.

func (*ProjectService) New 

func (r *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (res *Project, err error)

Create a new project.

func (*ProjectService) PurgeBuildCache 

func (r *ProjectService) PurgeBuildCache(ctx context.Context, projectName string, body ProjectPurgeBuildCacheParams, opts ...option.RequestOption) (res *ProjectPurgeBuildCacheResponse, err error)

Purge all cached build artifacts for a Pages project

type ProjectSource 

type ProjectSource struct {
	Config ProjectSourceConfig `json:"config"`
	Type   string              `json:"type"`
	JSON   projectSourceJSON   `json:"-"`
}

func (*ProjectSource) UnmarshalJSON 

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

type ProjectSourceConfig 

type ProjectSourceConfig struct {
	DeploymentsEnabled           bool                                        `json:"deployments_enabled"`
	Owner                        string                                      `json:"owner"`
	PathExcludes                 []string                                    `json:"path_excludes"`
	PathIncludes                 []string                                    `json:"path_includes"`
	PrCommentsEnabled            bool                                        `json:"pr_comments_enabled"`
	PreviewBranchExcludes        []string                                    `json:"preview_branch_excludes"`
	PreviewBranchIncludes        []string                                    `json:"preview_branch_includes"`
	PreviewDeploymentSetting     ProjectSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
	ProductionBranch             string                                      `json:"production_branch"`
	ProductionDeploymentsEnabled bool                                        `json:"production_deployments_enabled"`
	RepoName                     string                                      `json:"repo_name"`
	JSON                         projectSourceConfigJSON                     `json:"-"`
}

func (*ProjectSourceConfig) UnmarshalJSON 

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

type ProjectSourceConfigParam 

type ProjectSourceConfigParam struct {
	DeploymentsEnabled           param.Field[bool]                                        `json:"deployments_enabled"`
	Owner                        param.Field[string]                                      `json:"owner"`
	PathExcludes                 param.Field[[]string]                                    `json:"path_excludes"`
	PathIncludes                 param.Field[[]string]                                    `json:"path_includes"`
	PrCommentsEnabled            param.Field[bool]                                        `json:"pr_comments_enabled"`
	PreviewBranchExcludes        param.Field[[]string]                                    `json:"preview_branch_excludes"`
	PreviewBranchIncludes        param.Field[[]string]                                    `json:"preview_branch_includes"`
	PreviewDeploymentSetting     param.Field[ProjectSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
	ProductionBranch             param.Field[string]                                      `json:"production_branch"`
	ProductionDeploymentsEnabled param.Field[bool]                                        `json:"production_deployments_enabled"`
	RepoName                     param.Field[string]                                      `json:"repo_name"`
}

func (ProjectSourceConfigParam) MarshalJSON 

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

type ProjectSourceConfigPreviewDeploymentSetting 

type ProjectSourceConfigPreviewDeploymentSetting string
const (
	ProjectSourceConfigPreviewDeploymentSettingAll    ProjectSourceConfigPreviewDeploymentSetting = "all"
	ProjectSourceConfigPreviewDeploymentSettingNone   ProjectSourceConfigPreviewDeploymentSetting = "none"
	ProjectSourceConfigPreviewDeploymentSettingCustom ProjectSourceConfigPreviewDeploymentSetting = "custom"
)

func (ProjectSourceConfigPreviewDeploymentSetting) IsKnown 

func (r ProjectSourceConfigPreviewDeploymentSetting) IsKnown() bool

type ProjectSourceParam 

type ProjectSourceParam struct {
	Config param.Field[ProjectSourceConfigParam] `json:"config"`
	Type   param.Field[string]                   `json:"type"`
}

func (ProjectSourceParam) MarshalJSON 

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

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type 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 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 SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Stage 

type Stage struct {
	// When the stage ended.
	EndedOn time.Time `json:"ended_on,nullable" format:"date-time"`
	// The current build stage.
	Name string `json:"name"`
	// When the stage started.
	StartedOn time.Time `json:"started_on,nullable" format:"date-time"`
	// State of the current stage.
	Status string    `json:"status"`
	JSON   stageJSON `json:"-"`
}

The status of the deployment.

func (*Stage) UnmarshalJSON 

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

type StageParam 

type StageParam struct {
	// The current build stage.
	Name param.Field[string] `json:"name"`
}

The status of the deployment.

func (StageParam) MarshalJSON 

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

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.