pages

package
v6.7.0 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2026 License: Apache-2.0 Imports: 21 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 CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Deployment

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

func (*Deployment) UnmarshalJSON

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

type DeploymentBuildConfig

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

Configs for the project build process.

func (*DeploymentBuildConfig) UnmarshalJSON

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

type DeploymentDeploymentTrigger

type DeploymentDeploymentTrigger struct {
	// Additional info about the trigger.
	Metadata DeploymentDeploymentTriggerMetadata `json:"metadata,required"`
	// What caused the deployment.
	Type DeploymentDeploymentTriggerType `json:"type,required"`
	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,required"`
	// Whether the deployment trigger commit was dirty.
	CommitDirty bool `json:"commit_dirty,required"`
	// Hash of the deployment trigger commit.
	CommitHash string `json:"commit_hash,required"`
	// Message of the deployment trigger commit.
	CommitMessage string                                  `json:"commit_message,required"`
	JSON          deploymentDeploymentTriggerMetadataJSON `json:"-"`
}

Additional info about the trigger.

func (*DeploymentDeploymentTriggerMetadata) UnmarshalJSON

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

type DeploymentDeploymentTriggerType

type DeploymentDeploymentTriggerType string

What caused the deployment.

const (
	DeploymentDeploymentTriggerTypeGitHubPush DeploymentDeploymentTriggerType = "github:push"
	DeploymentDeploymentTriggerTypeADHoc      DeploymentDeploymentTriggerType = "ad_hoc"
	DeploymentDeploymentTriggerTypeDeployHook DeploymentDeploymentTriggerType = "deploy_hook"
)

func (DeploymentDeploymentTriggerType) IsKnown

type DeploymentEnvVar

type DeploymentEnvVar struct {
	Type DeploymentEnvVarsType `json:"type,required"`
	// Environment variable value.
	Value string               `json:"value,required"`
	JSON  deploymentEnvVarJSON `json:"-"`
	// contains filtered or unexported fields
}

A plaintext environment variable.

func (DeploymentEnvVar) AsUnion

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

Possible runtime types of the union are DeploymentEnvVarsPagesPlainTextEnvVar, DeploymentEnvVarsPagesSecretTextEnvVar.

func (*DeploymentEnvVar) UnmarshalJSON

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

type DeploymentEnvVarsPagesPlainTextEnvVar

type DeploymentEnvVarsPagesPlainTextEnvVar struct {
	Type DeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
	// Environment variable value.
	Value string                                    `json:"value,required"`
	JSON  deploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}

A plaintext environment variable.

func (*DeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON

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

type DeploymentEnvVarsPagesPlainTextEnvVarType

type DeploymentEnvVarsPagesPlainTextEnvVarType string
const (
	DeploymentEnvVarsPagesPlainTextEnvVarTypePlainText DeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (DeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown

type DeploymentEnvVarsPagesSecretTextEnvVar

type DeploymentEnvVarsPagesSecretTextEnvVar struct {
	Type DeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
	// Secret value.
	Value string                                     `json:"value,required"`
	JSON  deploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}

An encrypted environment variable.

func (*DeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON

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

type DeploymentEnvVarsPagesSecretTextEnvVarType

type DeploymentEnvVarsPagesSecretTextEnvVarType string
const (
	DeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText DeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (DeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown

type DeploymentEnvVarsType

type DeploymentEnvVarsType string
const (
	DeploymentEnvVarsTypePlainText  DeploymentEnvVarsType = "plain_text"
	DeploymentEnvVarsTypeSecretText DeploymentEnvVarsType = "secret_text"
)

func (DeploymentEnvVarsType) IsKnown

func (r DeploymentEnvVarsType) IsKnown() bool

type DeploymentEnvVarsUnion

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

A plaintext environment variable.

Union satisfied by DeploymentEnvVarsPagesPlainTextEnvVar or DeploymentEnvVarsPagesSecretTextEnvVar.

type DeploymentEnvironment

type DeploymentEnvironment string

Type of deploy.

const (
	DeploymentEnvironmentPreview    DeploymentEnvironment = "preview"
	DeploymentEnvironmentProduction DeploymentEnvironment = "production"
)

func (DeploymentEnvironment) IsKnown

func (r DeploymentEnvironment) IsKnown() bool

type DeploymentSource

type DeploymentSource struct {
	Config DeploymentSourceConfig `json:"config,required"`
	// The source control management provider.
	Type DeploymentSourceType `json:"type,required"`
	JSON deploymentSourceJSON `json:"-"`
}

Configs for the project source control.

func (*DeploymentSource) UnmarshalJSON

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

type DeploymentSourceConfig

type DeploymentSourceConfig struct {
	// Whether to enable automatic deployments when pushing to the source repository.
	// When disabled, no deployments (production or preview) will be triggered
	// automatically.
	//
	// Deprecated: Use `production_deployments_enabled` and
	// `preview_deployment_setting` for more granular control.
	DeploymentsEnabled bool `json:"deployments_enabled,required"`
	// The owner of the repository.
	Owner string `json:"owner,required"`
	// The owner ID of the repository.
	OwnerID string `json:"owner_id,required"`
	// A list of paths that should be excluded from triggering a preview deployment.
	// Wildcard syntax (`*`) is supported.
	PathExcludes []string `json:"path_excludes,required"`
	// A list of paths that should be watched to trigger a preview deployment. Wildcard
	// syntax (`*`) is supported.
	PathIncludes []string `json:"path_includes,required"`
	// Whether to enable PR comments.
	PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
	// A list of branches that should not trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchExcludes []string `json:"preview_branch_excludes,required"`
	// A list of branches that should trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchIncludes []string `json:"preview_branch_includes,required"`
	// Controls whether commits to preview branches trigger a preview deployment.
	PreviewDeploymentSetting DeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting,required"`
	// The production branch of the repository.
	ProductionBranch string `json:"production_branch,required"`
	// Whether to trigger a production deployment on commits to the production branch.
	ProductionDeploymentsEnabled bool `json:"production_deployments_enabled,required"`
	// The ID of the repository.
	RepoID string `json:"repo_id,required"`
	// The name of the repository.
	RepoName string                     `json:"repo_name,required"`
	JSON     deploymentSourceConfigJSON `json:"-"`
}

func (*DeploymentSourceConfig) UnmarshalJSON

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

type DeploymentSourceConfigPreviewDeploymentSetting

type DeploymentSourceConfigPreviewDeploymentSetting string

Controls whether commits to preview branches trigger a preview deployment.

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

func (DeploymentSourceConfigPreviewDeploymentSetting) IsKnown

type DeploymentSourceType added in v6.2.0

type DeploymentSourceType string

The source control management provider.

const (
	DeploymentSourceTypeGitHub DeploymentSourceType = "github"
	DeploymentSourceTypeGitlab DeploymentSourceType = "gitlab"
)

func (DeploymentSourceType) IsKnown added in v6.2.0

func (r DeploymentSourceType) IsKnown() bool

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type 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,required"`
	// Most recent production deployment of the project.
	CanonicalDeployment Deployment `json:"canonical_deployment,required,nullable"`
	// When the project was created.
	CreatedOn time.Time `json:"created_on,required" format:"date-time"`
	// Configs for deployments in a project.
	DeploymentConfigs ProjectDeploymentConfigs `json:"deployment_configs,required"`
	// Framework the project is using.
	Framework string `json:"framework,required"`
	// Version of the framework the project is using.
	FrameworkVersion string `json:"framework_version,required"`
	// Most recent deployment of the project.
	LatestDeployment Deployment `json:"latest_deployment,required,nullable"`
	// Name of the project.
	Name string `json:"name,required"`
	// Name of the preview script.
	PreviewScriptName string `json:"preview_script_name,required"`
	// Production branch of the project. Used to identify production deployments.
	ProductionBranch string `json:"production_branch,required"`
	// Name of the production script.
	ProductionScriptName string `json:"production_script_name,required"`
	// Whether the project uses functions.
	UsesFunctions bool `json:"uses_functions,required,nullable"`
	// Configs for the project build process.
	BuildConfig ProjectBuildConfig `json:"build_config"`
	// A list of associated custom domains for the project.
	Domains []string `json:"domains"`
	// Configs for the project source control.
	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 {
	// The classifying tag for analytics.
	WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
	// The auth token for analytics.
	WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
	// Enable build caching for the project.
	BuildCaching bool `json:"build_caching,nullable"`
	// Command used to build project.
	BuildCommand string `json:"build_command,nullable"`
	// Assets output directory of the build.
	DestinationDir string `json:"destination_dir,nullable"`
	// Directory to run the command.
	RootDir string                 `json:"root_dir,nullable"`
	JSON    projectBuildConfigJSON `json:"-"`
}

Configs for the project build process.

func (*ProjectBuildConfig) UnmarshalJSON

func (r *ProjectBuildConfig) UnmarshalJSON(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   []ProjectDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeleteResponseEnvelopeMessages `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 ProjectDeleteResponseEnvelopeErrors added in v6.4.0

type ProjectDeleteResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ProjectDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeleteResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeleteResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    projectDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeleteResponseEnvelopeMessages added in v6.4.0

type ProjectDeleteResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           ProjectDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeleteResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeleteResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    projectDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeleteResponseEnvelopeSuccess

type ProjectDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeleteResponseEnvelopeSuccessTrue ProjectDeleteResponseEnvelopeSuccess = true
)

func (ProjectDeleteResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentConfigs

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

Configs for deployments in a project.

func (*ProjectDeploymentConfigs) UnmarshalJSON

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

type ProjectDeploymentConfigsPreview

type ProjectDeploymentConfigsPreview struct {
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date,required"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []string `json:"compatibility_flags,required"`
	// Environment variables used for builds and Pages Functions.
	EnvVars map[string]ProjectDeploymentConfigsPreviewEnvVar `json:"env_vars,required,nullable"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen bool `json:"fail_open,required"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel ProjectDeploymentConfigsPreviewUsageModel `json:"usage_model,required"`
	// Constellation bindings used for Pages Functions.
	AIBindings map[string]ProjectDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers map[string]ProjectDeploymentConfigsPreviewBrowser `json:"browsers"`
	// D1 databases used for Pages Functions.
	D1Databases map[string]ProjectDeploymentConfigsPreviewD1Database `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces map[string]ProjectDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings map[string]ProjectDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces map[string]ProjectDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits ProjectDeploymentConfigsPreviewLimits `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates map[string]ProjectDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsPreviewPlacement `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers map[string]ProjectDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets map[string]ProjectDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services map[string]ProjectDeploymentConfigsPreviewService `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings map[string]ProjectDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash string                              `json:"wrangler_config_hash"`
	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,required"`
	JSON      projectDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsPreviewAIBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset

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

Analytics Engine binding.

func (*ProjectDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON

func (r *ProjectDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(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 ProjectDeploymentConfigsPreviewD1Database

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

D1 binding.

func (*ProjectDeploymentConfigsPreviewD1Database) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewDurableObjectNamespace

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

Durable Object binding.

func (*ProjectDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewEnvVar

type ProjectDeploymentConfigsPreviewEnvVar struct {
	Type ProjectDeploymentConfigsPreviewEnvVarsType `json:"type,required"`
	// Environment variable value.
	Value string                                    `json:"value,required"`
	JSON  projectDeploymentConfigsPreviewEnvVarJSON `json:"-"`
	// contains filtered or unexported fields
}

A plaintext environment variable.

func (ProjectDeploymentConfigsPreviewEnvVar) AsUnion

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

Possible runtime types of the union are ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.

func (*ProjectDeploymentConfigsPreviewEnvVar) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar

type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
	Type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
	// Environment variable value.
	Value string                                                         `json:"value,required"`
	JSON  projectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}

A plaintext environment variable.

func (*ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON

type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType

type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown

type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar

type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
	Type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
	// Secret value.
	Value string                                                          `json:"value,required"`
	JSON  projectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}

An encrypted environment variable.

func (*ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON

type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType

type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown

type ProjectDeploymentConfigsPreviewEnvVarsType

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

func (ProjectDeploymentConfigsPreviewEnvVarsType) IsKnown

type ProjectDeploymentConfigsPreviewEnvVarsUnion

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

A plaintext environment variable.

Union satisfied by ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.

type ProjectDeploymentConfigsPreviewHyperdriveBinding

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

Hyperdrive binding.

func (*ProjectDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewKVNamespace

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

KV namespace binding.

func (*ProjectDeploymentConfigsPreviewKVNamespace) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewLimits added in v6.2.0

type ProjectDeploymentConfigsPreviewLimits struct {
	// CPU time limit in milliseconds.
	CPUMs int64                                     `json:"cpu_ms,required"`
	JSON  projectDeploymentConfigsPreviewLimitsJSON `json:"-"`
}

Limits for Pages Functions.

func (*ProjectDeploymentConfigsPreviewLimits) UnmarshalJSON added in v6.2.0

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

type ProjectDeploymentConfigsPreviewMTLSCertificate

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

mTLS binding.

func (*ProjectDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewPlacement

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

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewPlacement) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewQueueProducer

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

Queue Producer binding.

func (*ProjectDeploymentConfigsPreviewQueueProducer) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewR2Bucket

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

R2 binding.

func (*ProjectDeploymentConfigsPreviewR2Bucket) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewService

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

Service binding.

func (*ProjectDeploymentConfigsPreviewService) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewUsageModel added in v6.2.0

type ProjectDeploymentConfigsPreviewUsageModel string

The usage model for Pages Functions.

const (
	ProjectDeploymentConfigsPreviewUsageModelStandard ProjectDeploymentConfigsPreviewUsageModel = "standard"
	ProjectDeploymentConfigsPreviewUsageModelBundled  ProjectDeploymentConfigsPreviewUsageModel = "bundled"
	ProjectDeploymentConfigsPreviewUsageModelUnbound  ProjectDeploymentConfigsPreviewUsageModel = "unbound"
)

func (ProjectDeploymentConfigsPreviewUsageModel) IsKnown added in v6.2.0

type ProjectDeploymentConfigsPreviewVectorizeBinding

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

Vectorize binding.

func (*ProjectDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsProduction

type ProjectDeploymentConfigsProduction struct {
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date,required"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []string `json:"compatibility_flags,required"`
	// Environment variables used for builds and Pages Functions.
	EnvVars map[string]ProjectDeploymentConfigsProductionEnvVar `json:"env_vars,required,nullable"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen bool `json:"fail_open,required"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel ProjectDeploymentConfigsProductionUsageModel `json:"usage_model,required"`
	// Constellation bindings used for Pages Functions.
	AIBindings map[string]ProjectDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers map[string]ProjectDeploymentConfigsProductionBrowser `json:"browsers"`
	// D1 databases used for Pages Functions.
	D1Databases map[string]ProjectDeploymentConfigsProductionD1Database `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces map[string]ProjectDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings map[string]ProjectDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces map[string]ProjectDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits ProjectDeploymentConfigsProductionLimits `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates map[string]ProjectDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsProductionPlacement `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers map[string]ProjectDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets map[string]ProjectDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services map[string]ProjectDeploymentConfigsProductionService `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings map[string]ProjectDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash string                                 `json:"wrangler_config_hash"`
	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,required"`
	JSON      projectDeploymentConfigsProductionAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsProductionAIBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionAnalyticsEngineDataset

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

Analytics Engine binding.

func (*ProjectDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON

type ProjectDeploymentConfigsProductionBrowser

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

Browser binding.

func (*ProjectDeploymentConfigsProductionBrowser) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionD1Database

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

D1 binding.

func (*ProjectDeploymentConfigsProductionD1Database) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionDurableObjectNamespace

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

Durable Object binding.

func (*ProjectDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON

type ProjectDeploymentConfigsProductionEnvVar

type ProjectDeploymentConfigsProductionEnvVar struct {
	Type ProjectDeploymentConfigsProductionEnvVarsType `json:"type,required"`
	// Environment variable value.
	Value string                                       `json:"value,required"`
	JSON  projectDeploymentConfigsProductionEnvVarJSON `json:"-"`
	// contains filtered or unexported fields
}

A plaintext environment variable.

func (ProjectDeploymentConfigsProductionEnvVar) AsUnion

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

Possible runtime types of the union are ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.

func (*ProjectDeploymentConfigsProductionEnvVar) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar

type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
	Type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
	// Environment variable value.
	Value string                                                            `json:"value,required"`
	JSON  projectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}

A plaintext environment variable.

func (*ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON

type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType

type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown

type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar

type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
	Type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
	// Secret value.
	Value string                                                             `json:"value,required"`
	JSON  projectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}

An encrypted environment variable.

func (*ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON

type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType

type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown

type ProjectDeploymentConfigsProductionEnvVarsType

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

func (ProjectDeploymentConfigsProductionEnvVarsType) IsKnown

type ProjectDeploymentConfigsProductionEnvVarsUnion

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

A plaintext environment variable.

Union satisfied by ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.

type ProjectDeploymentConfigsProductionHyperdriveBinding

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

Hyperdrive binding.

func (*ProjectDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionKVNamespace

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

KV namespace binding.

func (*ProjectDeploymentConfigsProductionKVNamespace) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionLimits added in v6.2.0

type ProjectDeploymentConfigsProductionLimits struct {
	// CPU time limit in milliseconds.
	CPUMs int64                                        `json:"cpu_ms,required"`
	JSON  projectDeploymentConfigsProductionLimitsJSON `json:"-"`
}

Limits for Pages Functions.

func (*ProjectDeploymentConfigsProductionLimits) UnmarshalJSON added in v6.2.0

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

type ProjectDeploymentConfigsProductionMTLSCertificate

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

mTLS binding.

func (*ProjectDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionPlacement

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

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsProductionPlacement) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionQueueProducer

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

Queue Producer binding.

func (*ProjectDeploymentConfigsProductionQueueProducer) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionR2Bucket

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

R2 binding.

func (*ProjectDeploymentConfigsProductionR2Bucket) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionService

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

Service binding.

func (*ProjectDeploymentConfigsProductionService) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionUsageModel added in v6.2.0

type ProjectDeploymentConfigsProductionUsageModel string

The usage model for Pages Functions.

const (
	ProjectDeploymentConfigsProductionUsageModelStandard ProjectDeploymentConfigsProductionUsageModel = "standard"
	ProjectDeploymentConfigsProductionUsageModelBundled  ProjectDeploymentConfigsProductionUsageModel = "bundled"
	ProjectDeploymentConfigsProductionUsageModelUnbound  ProjectDeploymentConfigsProductionUsageModel = "unbound"
)

func (ProjectDeploymentConfigsProductionUsageModel) IsKnown added in v6.2.0

type ProjectDeploymentConfigsProductionVectorizeBinding

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

Vectorize binding.

func (*ProjectDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON

func (r *ProjectDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(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   []ProjectDeploymentDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentDeleteResponseEnvelopeMessages `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 ProjectDeploymentDeleteResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentDeleteResponseEnvelopeErrors struct {
	Code             int64                                               `json:"code,required"`
	Message          string                                              `json:"message,required"`
	DocumentationURL string                                              `json:"documentation_url"`
	Source           ProjectDeploymentDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentDeleteResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentDeleteResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                                  `json:"pointer"`
	JSON    projectDeploymentDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentDeleteResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentDeleteResponseEnvelopeMessages struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           ProjectDeploymentDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentDeleteResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentDeleteResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    projectDeploymentDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentDeleteResponseEnvelopeSuccess

type ProjectDeploymentDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentDeleteResponseEnvelopeSuccessTrue ProjectDeploymentDeleteResponseEnvelopeSuccess = true
)

func (ProjectDeploymentDeleteResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentGetParams

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

type ProjectDeploymentGetResponseEnvelope

type ProjectDeploymentGetResponseEnvelope struct {
	Errors   []ProjectDeploymentGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentGetResponseEnvelopeMessages `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 ProjectDeploymentGetResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentGetResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ProjectDeploymentGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentGetResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentGetResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    projectDeploymentGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentGetResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentGetResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ProjectDeploymentGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentGetResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    projectDeploymentGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentGetResponseEnvelopeSuccess

type ProjectDeploymentGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentGetResponseEnvelopeSuccessTrue ProjectDeploymentGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentHistoryLogGetParams

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

type ProjectDeploymentHistoryLogGetResponse

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

func (*ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseData

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

func (*ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseEnvelope

type ProjectDeploymentHistoryLogGetResponseEnvelope struct {
	Errors   []ProjectDeploymentHistoryLogGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentHistoryLogGetResponseEnvelopeMessages `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 ProjectDeploymentHistoryLogGetResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors struct {
	Code             int64                                                      `json:"code,required"`
	Message          string                                                     `json:"message,required"`
	DocumentationURL string                                                     `json:"documentation_url"`
	Source           ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentHistoryLogGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource struct {
	Pointer string                                                         `json:"pointer"`
	JSON    projectDeploymentHistoryLogGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages struct {
	Code             int64                                                        `json:"code,required"`
	Message          string                                                       `json:"message,required"`
	DocumentationURL string                                                       `json:"documentation_url"`
	Source           ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentHistoryLogGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                           `json:"pointer"`
	JSON    projectDeploymentHistoryLogGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessTrue ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown

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

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"`
	// Which page of deployments to fetch.
	Page param.Field[int64] `query:"page"`
	// How many deployments to return per page.
	PerPage param.Field[int64] `query:"per_page"`
}

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

type ProjectDeploymentNewParams

type ProjectDeploymentNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Headers configuration file for the deployment.
	Headers param.Field[io.Reader] `json:"_headers" format:"binary"`
	// Redirects configuration file for the deployment.
	Redirects param.Field[io.Reader] `json:"_redirects" format:"binary"`
	// Routes configuration file defining routing rules.
	RoutesJson param.Field[io.Reader] `json:"_routes.json" format:"binary"`
	// Worker bundle file in multipart/form-data format. Mutually exclusive with
	// `_worker.js`. Cannot specify both `_worker.js` and `_worker.bundle` in the same
	// request. Maximum size: 25 MiB.
	WorkerBundle param.Field[io.Reader] `json:"_worker.bundle" format:"binary"`
	// Worker JavaScript file. Mutually exclusive with `_worker.bundle`. Cannot specify
	// both `_worker.js` and `_worker.bundle` in the same request.
	WorkerJS param.Field[io.Reader] `json:"_worker.js" format:"binary"`
	// 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"`
	// Boolean string indicating if the working directory has uncommitted changes.
	CommitDirty param.Field[ProjectDeploymentNewParamsCommitDirty] `json:"commit_dirty"`
	// Git commit SHA associated with this deployment.
	CommitHash param.Field[string] `json:"commit_hash"`
	// Git commit message associated with this deployment.
	CommitMessage param.Field[string] `json:"commit_message"`
	// Functions routing configuration file.
	FunctionsFilepathRoutingConfigJson param.Field[io.Reader] `json:"functions-filepath-routing-config.json" format:"binary"`
	// JSON string containing a manifest of files to deploy. Maps file paths to their
	// content hashes. Required for direct upload deployments. Maximum 20,000 entries.
	Manifest param.Field[string] `json:"manifest"`
	// The build output directory path.
	PagesBuildOutputDir param.Field[string] `json:"pages_build_output_dir"`
	// Hash of the Wrangler configuration file used for this deployment.
	WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}

func (ProjectDeploymentNewParams) MarshalMultipart

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

type ProjectDeploymentNewParamsCommitDirty added in v6.2.0

type ProjectDeploymentNewParamsCommitDirty string

Boolean string indicating if the working directory has uncommitted changes.

const (
	ProjectDeploymentNewParamsCommitDirtyTrue  ProjectDeploymentNewParamsCommitDirty = "true"
	ProjectDeploymentNewParamsCommitDirtyFalse ProjectDeploymentNewParamsCommitDirty = "false"
)

func (ProjectDeploymentNewParamsCommitDirty) IsKnown added in v6.2.0

type ProjectDeploymentNewResponseEnvelope

type ProjectDeploymentNewResponseEnvelope struct {
	Errors   []ProjectDeploymentNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentNewResponseEnvelopeMessages `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 ProjectDeploymentNewResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentNewResponseEnvelopeErrors struct {
	Code             int64                                            `json:"code,required"`
	Message          string                                           `json:"message,required"`
	DocumentationURL string                                           `json:"documentation_url"`
	Source           ProjectDeploymentNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentNewResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentNewResponseEnvelopeErrorsSource struct {
	Pointer string                                               `json:"pointer"`
	JSON    projectDeploymentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentNewResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentNewResponseEnvelopeMessages struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ProjectDeploymentNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentNewResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    projectDeploymentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentNewResponseEnvelopeSuccess

type ProjectDeploymentNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentNewResponseEnvelopeSuccessTrue ProjectDeploymentNewResponseEnvelopeSuccess = true
)

func (ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentRetryParams

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

type ProjectDeploymentRetryResponseEnvelope

type ProjectDeploymentRetryResponseEnvelope struct {
	Errors   []ProjectDeploymentRetryResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentRetryResponseEnvelopeMessages `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 ProjectDeploymentRetryResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentRetryResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ProjectDeploymentRetryResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentRetryResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRetryResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentRetryResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    projectDeploymentRetryResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentRetryResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRetryResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentRetryResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           ProjectDeploymentRetryResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentRetryResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRetryResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentRetryResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    projectDeploymentRetryResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentRetryResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRetryResponseEnvelopeSuccess

type ProjectDeploymentRetryResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentRetryResponseEnvelopeSuccessTrue ProjectDeploymentRetryResponseEnvelopeSuccess = true
)

func (ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentRollbackParams

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

type ProjectDeploymentRollbackResponseEnvelope

type ProjectDeploymentRollbackResponseEnvelope struct {
	Errors   []ProjectDeploymentRollbackResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentRollbackResponseEnvelopeMessages `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 ProjectDeploymentRollbackResponseEnvelopeErrors added in v6.4.0

type ProjectDeploymentRollbackResponseEnvelopeErrors struct {
	Code             int64                                                 `json:"code,required"`
	Message          string                                                `json:"message,required"`
	DocumentationURL string                                                `json:"documentation_url"`
	Source           ProjectDeploymentRollbackResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDeploymentRollbackResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRollbackResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDeploymentRollbackResponseEnvelopeErrorsSource struct {
	Pointer string                                                    `json:"pointer"`
	JSON    projectDeploymentRollbackResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDeploymentRollbackResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRollbackResponseEnvelopeMessages added in v6.4.0

type ProjectDeploymentRollbackResponseEnvelopeMessages struct {
	Code             int64                                                   `json:"code,required"`
	Message          string                                                  `json:"message,required"`
	DocumentationURL string                                                  `json:"documentation_url"`
	Source           ProjectDeploymentRollbackResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDeploymentRollbackResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDeploymentRollbackResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDeploymentRollbackResponseEnvelopeMessagesSource struct {
	Pointer string                                                      `json:"pointer"`
	JSON    projectDeploymentRollbackResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDeploymentRollbackResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

type ProjectDeploymentRollbackResponseEnvelopeSuccess

type ProjectDeploymentRollbackResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDeploymentRollbackResponseEnvelopeSuccessTrue ProjectDeploymentRollbackResponseEnvelopeSuccess = true
)

func (ProjectDeploymentRollbackResponseEnvelopeSuccess) IsKnown

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

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

Fetch a list of project deployments.

func (*ProjectDeploymentService) ListAutoPaging

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, body 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, body 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   []ProjectDomainDeleteResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDomainDeleteResponseEnvelopeMessages `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 ProjectDomainDeleteResponseEnvelopeErrors added in v6.4.0

type ProjectDomainDeleteResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ProjectDomainDeleteResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDomainDeleteResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDomainDeleteResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDomainDeleteResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDomainDeleteResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    projectDomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainDeleteResponseEnvelopeMessages added in v6.4.0

type ProjectDomainDeleteResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           ProjectDomainDeleteResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDomainDeleteResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDomainDeleteResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDomainDeleteResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDomainDeleteResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    projectDomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainDeleteResponseEnvelopeSuccess

type ProjectDomainDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDomainDeleteResponseEnvelopeSuccessTrue ProjectDomainDeleteResponseEnvelopeSuccess = true
)

func (ProjectDomainDeleteResponseEnvelopeSuccess) IsKnown

type ProjectDomainEditParams

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

type ProjectDomainEditResponse

type ProjectDomainEditResponse struct {
	ID                   string                                        `json:"id,required"`
	CertificateAuthority ProjectDomainEditResponseCertificateAuthority `json:"certificate_authority,required"`
	CreatedOn            string                                        `json:"created_on,required"`
	DomainID             string                                        `json:"domain_id,required"`
	// The domain name.
	Name             string                                    `json:"name,required"`
	Status           ProjectDomainEditResponseStatus           `json:"status,required"`
	ValidationData   ProjectDomainEditResponseValidationData   `json:"validation_data,required"`
	VerificationData ProjectDomainEditResponseVerificationData `json:"verification_data,required"`
	ZoneTag          string                                    `json:"zone_tag,required"`
	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

type ProjectDomainEditResponseEnvelope

type ProjectDomainEditResponseEnvelope struct {
	Errors   []ProjectDomainEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDomainEditResponseEnvelopeMessages `json:"messages,required"`
	Result   ProjectDomainEditResponse                   `json:"result,required"`
	// 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 ProjectDomainEditResponseEnvelopeErrors added in v6.4.0

type ProjectDomainEditResponseEnvelopeErrors struct {
	Code             int64                                         `json:"code,required"`
	Message          string                                        `json:"message,required"`
	DocumentationURL string                                        `json:"documentation_url"`
	Source           ProjectDomainEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDomainEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDomainEditResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDomainEditResponseEnvelopeErrorsSource struct {
	Pointer string                                            `json:"pointer"`
	JSON    projectDomainEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainEditResponseEnvelopeMessages added in v6.4.0

type ProjectDomainEditResponseEnvelopeMessages struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           ProjectDomainEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDomainEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDomainEditResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDomainEditResponseEnvelopeMessagesSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    projectDomainEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainEditResponseEnvelopeSuccess

type ProjectDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDomainEditResponseEnvelopeSuccessTrue ProjectDomainEditResponseEnvelopeSuccess = true
)

func (ProjectDomainEditResponseEnvelopeSuccess) IsKnown

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

type ProjectDomainEditResponseValidationData

type ProjectDomainEditResponseValidationData struct {
	Method       ProjectDomainEditResponseValidationDataMethod `json:"method,required"`
	Status       ProjectDomainEditResponseValidationDataStatus `json:"status,required"`
	ErrorMessage string                                        `json:"error_message"`
	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

type ProjectDomainEditResponseValidationDataStatus

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

func (ProjectDomainEditResponseValidationDataStatus) IsKnown

type ProjectDomainEditResponseVerificationData

type ProjectDomainEditResponseVerificationData struct {
	Status       ProjectDomainEditResponseVerificationDataStatus `json:"status,required"`
	ErrorMessage string                                          `json:"error_message"`
	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

type ProjectDomainGetParams

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

type ProjectDomainGetResponse

type ProjectDomainGetResponse struct {
	ID                   string                                       `json:"id,required"`
	CertificateAuthority ProjectDomainGetResponseCertificateAuthority `json:"certificate_authority,required"`
	CreatedOn            string                                       `json:"created_on,required"`
	DomainID             string                                       `json:"domain_id,required"`
	// The domain name.
	Name             string                                   `json:"name,required"`
	Status           ProjectDomainGetResponseStatus           `json:"status,required"`
	ValidationData   ProjectDomainGetResponseValidationData   `json:"validation_data,required"`
	VerificationData ProjectDomainGetResponseVerificationData `json:"verification_data,required"`
	ZoneTag          string                                   `json:"zone_tag,required"`
	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

type ProjectDomainGetResponseEnvelope

type ProjectDomainGetResponseEnvelope struct {
	Errors   []ProjectDomainGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDomainGetResponseEnvelopeMessages `json:"messages,required"`
	Result   ProjectDomainGetResponse                   `json:"result,required"`
	// 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 ProjectDomainGetResponseEnvelopeErrors added in v6.4.0

type ProjectDomainGetResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ProjectDomainGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDomainGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDomainGetResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDomainGetResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    projectDomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainGetResponseEnvelopeMessages added in v6.4.0

type ProjectDomainGetResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ProjectDomainGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDomainGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDomainGetResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDomainGetResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    projectDomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainGetResponseEnvelopeSuccess

type ProjectDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDomainGetResponseEnvelopeSuccessTrue ProjectDomainGetResponseEnvelopeSuccess = true
)

func (ProjectDomainGetResponseEnvelopeSuccess) IsKnown

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

type ProjectDomainGetResponseValidationData

type ProjectDomainGetResponseValidationData struct {
	Method       ProjectDomainGetResponseValidationDataMethod `json:"method,required"`
	Status       ProjectDomainGetResponseValidationDataStatus `json:"status,required"`
	ErrorMessage string                                       `json:"error_message"`
	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

type ProjectDomainGetResponseValidationDataStatus

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

func (ProjectDomainGetResponseValidationDataStatus) IsKnown

type ProjectDomainGetResponseVerificationData

type ProjectDomainGetResponseVerificationData struct {
	Status       ProjectDomainGetResponseVerificationDataStatus `json:"status,required"`
	ErrorMessage string                                         `json:"error_message"`
	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

type ProjectDomainListParams

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

type ProjectDomainListResponse

type ProjectDomainListResponse struct {
	ID                   string                                        `json:"id,required"`
	CertificateAuthority ProjectDomainListResponseCertificateAuthority `json:"certificate_authority,required"`
	CreatedOn            string                                        `json:"created_on,required"`
	DomainID             string                                        `json:"domain_id,required"`
	// The domain name.
	Name             string                                    `json:"name,required"`
	Status           ProjectDomainListResponseStatus           `json:"status,required"`
	ValidationData   ProjectDomainListResponseValidationData   `json:"validation_data,required"`
	VerificationData ProjectDomainListResponseVerificationData `json:"verification_data,required"`
	ZoneTag          string                                    `json:"zone_tag,required"`
	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

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

type ProjectDomainListResponseValidationData

type ProjectDomainListResponseValidationData struct {
	Method       ProjectDomainListResponseValidationDataMethod `json:"method,required"`
	Status       ProjectDomainListResponseValidationDataStatus `json:"status,required"`
	ErrorMessage string                                        `json:"error_message"`
	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

type ProjectDomainListResponseValidationDataStatus

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

func (ProjectDomainListResponseValidationDataStatus) IsKnown

type ProjectDomainListResponseVerificationData

type ProjectDomainListResponseVerificationData struct {
	Status       ProjectDomainListResponseVerificationDataStatus `json:"status,required"`
	ErrorMessage string                                          `json:"error_message"`
	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

type ProjectDomainNewParams

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

func (ProjectDomainNewParams) MarshalJSON

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

type ProjectDomainNewResponse

type ProjectDomainNewResponse struct {
	ID                   string                                       `json:"id,required"`
	CertificateAuthority ProjectDomainNewResponseCertificateAuthority `json:"certificate_authority,required"`
	CreatedOn            string                                       `json:"created_on,required"`
	DomainID             string                                       `json:"domain_id,required"`
	// The domain name.
	Name             string                                   `json:"name,required"`
	Status           ProjectDomainNewResponseStatus           `json:"status,required"`
	ValidationData   ProjectDomainNewResponseValidationData   `json:"validation_data,required"`
	VerificationData ProjectDomainNewResponseVerificationData `json:"verification_data,required"`
	ZoneTag          string                                   `json:"zone_tag,required"`
	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

type ProjectDomainNewResponseEnvelope

type ProjectDomainNewResponseEnvelope struct {
	Errors   []ProjectDomainNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDomainNewResponseEnvelopeMessages `json:"messages,required"`
	Result   ProjectDomainNewResponse                   `json:"result,required"`
	// 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 ProjectDomainNewResponseEnvelopeErrors added in v6.4.0

type ProjectDomainNewResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           ProjectDomainNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectDomainNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectDomainNewResponseEnvelopeErrorsSource added in v6.4.0

type ProjectDomainNewResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    projectDomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainNewResponseEnvelopeMessages added in v6.4.0

type ProjectDomainNewResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           ProjectDomainNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectDomainNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectDomainNewResponseEnvelopeMessagesSource added in v6.4.0

type ProjectDomainNewResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    projectDomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectDomainNewResponseEnvelopeSuccess

type ProjectDomainNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectDomainNewResponseEnvelopeSuccessTrue ProjectDomainNewResponseEnvelopeSuccess = true
)

func (ProjectDomainNewResponseEnvelopeSuccess) IsKnown

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

type ProjectDomainNewResponseValidationData

type ProjectDomainNewResponseValidationData struct {
	Method       ProjectDomainNewResponseValidationDataMethod `json:"method,required"`
	Status       ProjectDomainNewResponseValidationDataStatus `json:"status,required"`
	ErrorMessage string                                       `json:"error_message"`
	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

type ProjectDomainNewResponseValidationDataStatus

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

func (ProjectDomainNewResponseValidationDataStatus) IsKnown

type ProjectDomainNewResponseVerificationData

type ProjectDomainNewResponseVerificationData struct {
	Status       ProjectDomainNewResponseVerificationDataStatus `json:"status,required"`
	ErrorMessage string                                         `json:"error_message"`
	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

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, body 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

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

func (*ProjectDomainService) ListAutoPaging

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

func (*ProjectDomainService) New

Add a new domain for the Pages project.

type ProjectEditParams

type ProjectEditParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Configs for the project build process.
	BuildConfig param.Field[ProjectEditParamsBuildConfig] `json:"build_config"`
	// Configs for deployments in a project.
	DeploymentConfigs param.Field[ProjectEditParamsDeploymentConfigs] `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"`
	// Configs for the project source control.
	Source param.Field[ProjectEditParamsSource] `json:"source"`
}

func (ProjectEditParams) MarshalJSON

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

type ProjectEditParamsBuildConfig added in v6.4.0

type ProjectEditParamsBuildConfig 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 (ProjectEditParamsBuildConfig) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigs added in v6.4.0

type ProjectEditParamsDeploymentConfigs struct {
	// Configs for preview deploys.
	Preview param.Field[ProjectEditParamsDeploymentConfigsPreview] `json:"preview"`
	// Configs for production deploys.
	Production param.Field[ProjectEditParamsDeploymentConfigsProduction] `json:"production"`
}

Configs for deployments in a project.

func (ProjectEditParamsDeploymentConfigs) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreview added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewAIBindings] `json:"ai_bindings"`
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewBrowsers] `json:"browsers"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
	// 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]ProjectEditParamsDeploymentConfigsPreviewD1Databases] `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables used for builds and Pages Functions.
	EnvVars param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion] `json:"env_vars"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen param.Field[bool] `json:"fail_open"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewKVNamespaces] `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits param.Field[ProjectEditParamsDeploymentConfigsPreviewLimits] `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectEditParamsDeploymentConfigsPreviewPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewServices] `json:"services"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel param.Field[ProjectEditParamsDeploymentConfigsPreviewUsageModel] `json:"usage_model"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings] `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}

Configs for preview deploys.

func (ProjectEditParamsDeploymentConfigsPreview) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewAIBindings added in v6.4.0

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

AI binding.

func (ProjectEditParamsDeploymentConfigsPreviewAIBindings) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets added in v6.4.0

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

Analytics Engine binding.

func (ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewBrowsers added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewBrowsers struct {
}

Browser binding.

func (ProjectEditParamsDeploymentConfigsPreviewBrowsers) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewD1Databases added in v6.4.0

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

D1 binding.

func (ProjectEditParamsDeploymentConfigsPreviewD1Databases) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
	// ID of the Durable Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
}

Durable Object binding.

func (ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVars added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVars struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectEditParamsDeploymentConfigsPreviewEnvVars) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
	// Secret value.
	Value param.Field[string] `json:"value,required"`
}

An encrypted environment variable.

func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType string
const (
	ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypePlainText  ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "plain_text"
	ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "secret_text"
)

func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion added in v6.4.0

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

A plaintext environment variable.

Satisfied by pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsPreviewEnvVars.

type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings added in v6.4.0

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

Hyperdrive binding.

func (ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces added in v6.4.0

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

KV namespace binding.

func (ProjectEditParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewLimits added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewLimits struct {
	// CPU time limit in milliseconds.
	CPUMs param.Field[int64] `json:"cpu_ms,required"`
}

Limits for Pages Functions.

func (ProjectEditParamsDeploymentConfigsPreviewLimits) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates added in v6.4.0

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

mTLS binding.

func (ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewPlacement added in v6.4.0

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

Placement setting used for Pages Functions.

func (ProjectEditParamsDeploymentConfigsPreviewPlacement) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewQueueProducers added in v6.4.0

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

Queue Producer binding.

func (ProjectEditParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewR2Buckets added in v6.4.0

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

R2 binding.

func (ProjectEditParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewServices added in v6.4.0

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

Service binding.

func (ProjectEditParamsDeploymentConfigsPreviewServices) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsPreviewUsageModel added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewUsageModel string

The usage model for Pages Functions.

const (
	ProjectEditParamsDeploymentConfigsPreviewUsageModelStandard ProjectEditParamsDeploymentConfigsPreviewUsageModel = "standard"
	ProjectEditParamsDeploymentConfigsPreviewUsageModelBundled  ProjectEditParamsDeploymentConfigsPreviewUsageModel = "bundled"
	ProjectEditParamsDeploymentConfigsPreviewUsageModelUnbound  ProjectEditParamsDeploymentConfigsPreviewUsageModel = "unbound"
)

func (ProjectEditParamsDeploymentConfigsPreviewUsageModel) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings added in v6.4.0

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

Vectorize binding.

func (ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProduction added in v6.4.0

type ProjectEditParamsDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionAIBindings] `json:"ai_bindings"`
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionBrowsers] `json:"browsers"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
	// 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]ProjectEditParamsDeploymentConfigsProductionD1Databases] `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables used for builds and Pages Functions.
	EnvVars param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion] `json:"env_vars"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen param.Field[bool] `json:"fail_open"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionKVNamespaces] `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits param.Field[ProjectEditParamsDeploymentConfigsProductionLimits] `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectEditParamsDeploymentConfigsProductionPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionServices] `json:"services"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel param.Field[ProjectEditParamsDeploymentConfigsProductionUsageModel] `json:"usage_model"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionVectorizeBindings] `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}

Configs for production deploys.

func (ProjectEditParamsDeploymentConfigsProduction) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsProductionAIBindings added in v6.4.0

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

AI binding.

func (ProjectEditParamsDeploymentConfigsProductionAIBindings) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets added in v6.4.0

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

Analytics Engine binding.

func (ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionBrowsers added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionBrowsers struct {
}

Browser binding.

func (ProjectEditParamsDeploymentConfigsProductionBrowsers) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsProductionD1Databases added in v6.4.0

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

D1 binding.

func (ProjectEditParamsDeploymentConfigsProductionD1Databases) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
	// ID of the Durable Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
}

Durable Object binding.

func (ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVars added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVars struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectEditParamsDeploymentConfigsProductionEnvVars) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
	Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
	// Secret value.
	Value param.Field[string] `json:"value,required"`
}

An encrypted environment variable.

func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsType added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsType string
const (
	ProjectEditParamsDeploymentConfigsProductionEnvVarsTypePlainText  ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "plain_text"
	ProjectEditParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "secret_text"
)

func (ProjectEditParamsDeploymentConfigsProductionEnvVarsType) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion added in v6.4.0

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

A plaintext environment variable.

Satisfied by pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsProductionEnvVars.

type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings added in v6.4.0

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

Hyperdrive binding.

func (ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionKVNamespaces added in v6.4.0

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

KV namespace binding.

func (ProjectEditParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionLimits added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionLimits struct {
	// CPU time limit in milliseconds.
	CPUMs param.Field[int64] `json:"cpu_ms,required"`
}

Limits for Pages Functions.

func (ProjectEditParamsDeploymentConfigsProductionLimits) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates added in v6.4.0

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

mTLS binding.

func (ProjectEditParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionPlacement added in v6.4.0

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

Placement setting used for Pages Functions.

func (ProjectEditParamsDeploymentConfigsProductionPlacement) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionQueueProducers added in v6.4.0

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

Queue Producer binding.

func (ProjectEditParamsDeploymentConfigsProductionQueueProducers) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionR2Buckets added in v6.4.0

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

R2 binding.

func (ProjectEditParamsDeploymentConfigsProductionR2Buckets) MarshalJSON added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionServices added in v6.4.0

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

Service binding.

func (ProjectEditParamsDeploymentConfigsProductionServices) MarshalJSON added in v6.4.0

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

type ProjectEditParamsDeploymentConfigsProductionUsageModel added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionUsageModel string

The usage model for Pages Functions.

const (
	ProjectEditParamsDeploymentConfigsProductionUsageModelStandard ProjectEditParamsDeploymentConfigsProductionUsageModel = "standard"
	ProjectEditParamsDeploymentConfigsProductionUsageModelBundled  ProjectEditParamsDeploymentConfigsProductionUsageModel = "bundled"
	ProjectEditParamsDeploymentConfigsProductionUsageModelUnbound  ProjectEditParamsDeploymentConfigsProductionUsageModel = "unbound"
)

func (ProjectEditParamsDeploymentConfigsProductionUsageModel) IsKnown added in v6.4.0

type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings added in v6.4.0

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

Vectorize binding.

func (ProjectEditParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON added in v6.4.0

type ProjectEditParamsSource added in v6.4.0

type ProjectEditParamsSource struct {
	Config param.Field[ProjectEditParamsSourceConfig] `json:"config,required"`
	// The source control management provider.
	Type param.Field[ProjectEditParamsSourceType] `json:"type,required"`
}

Configs for the project source control.

func (ProjectEditParamsSource) MarshalJSON added in v6.4.0

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

type ProjectEditParamsSourceConfig added in v6.4.0

type ProjectEditParamsSourceConfig struct {
	// Whether to enable automatic deployments when pushing to the source repository.
	// When disabled, no deployments (production or preview) will be triggered
	// automatically.
	//
	// Deprecated: Use `production_deployments_enabled` and
	// `preview_deployment_setting` for more granular control.
	DeploymentsEnabled param.Field[bool] `json:"deployments_enabled"`
	// The owner of the repository.
	Owner param.Field[string] `json:"owner"`
	// The owner ID of the repository.
	OwnerID param.Field[string] `json:"owner_id"`
	// A list of paths that should be excluded from triggering a preview deployment.
	// Wildcard syntax (`*`) is supported.
	PathExcludes param.Field[[]string] `json:"path_excludes"`
	// A list of paths that should be watched to trigger a preview deployment. Wildcard
	// syntax (`*`) is supported.
	PathIncludes param.Field[[]string] `json:"path_includes"`
	// Whether to enable PR comments.
	PrCommentsEnabled param.Field[bool] `json:"pr_comments_enabled"`
	// A list of branches that should not trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchExcludes param.Field[[]string] `json:"preview_branch_excludes"`
	// A list of branches that should trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchIncludes param.Field[[]string] `json:"preview_branch_includes"`
	// Controls whether commits to preview branches trigger a preview deployment.
	PreviewDeploymentSetting param.Field[ProjectEditParamsSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
	// The production branch of the repository.
	ProductionBranch param.Field[string] `json:"production_branch"`
	// Whether to trigger a production deployment on commits to the production branch.
	ProductionDeploymentsEnabled param.Field[bool] `json:"production_deployments_enabled"`
	// The ID of the repository.
	RepoID param.Field[string] `json:"repo_id"`
	// The name of the repository.
	RepoName param.Field[string] `json:"repo_name"`
}

func (ProjectEditParamsSourceConfig) MarshalJSON added in v6.4.0

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

type ProjectEditParamsSourceConfigPreviewDeploymentSetting added in v6.4.0

type ProjectEditParamsSourceConfigPreviewDeploymentSetting string

Controls whether commits to preview branches trigger a preview deployment.

const (
	ProjectEditParamsSourceConfigPreviewDeploymentSettingAll    ProjectEditParamsSourceConfigPreviewDeploymentSetting = "all"
	ProjectEditParamsSourceConfigPreviewDeploymentSettingNone   ProjectEditParamsSourceConfigPreviewDeploymentSetting = "none"
	ProjectEditParamsSourceConfigPreviewDeploymentSettingCustom ProjectEditParamsSourceConfigPreviewDeploymentSetting = "custom"
)

func (ProjectEditParamsSourceConfigPreviewDeploymentSetting) IsKnown added in v6.4.0

type ProjectEditParamsSourceType added in v6.4.0

type ProjectEditParamsSourceType string

The source control management provider.

const (
	ProjectEditParamsSourceTypeGitHub ProjectEditParamsSourceType = "github"
	ProjectEditParamsSourceTypeGitlab ProjectEditParamsSourceType = "gitlab"
)

func (ProjectEditParamsSourceType) IsKnown added in v6.4.0

func (r ProjectEditParamsSourceType) IsKnown() bool

type ProjectEditResponseEnvelope

type ProjectEditResponseEnvelope struct {
	Errors   []ProjectEditResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectEditResponseEnvelopeMessages `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 ProjectEditResponseEnvelopeErrors added in v6.4.0

type ProjectEditResponseEnvelopeErrors struct {
	Code             int64                                   `json:"code,required"`
	Message          string                                  `json:"message,required"`
	DocumentationURL string                                  `json:"documentation_url"`
	Source           ProjectEditResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectEditResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectEditResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectEditResponseEnvelopeErrorsSource added in v6.4.0

type ProjectEditResponseEnvelopeErrorsSource struct {
	Pointer string                                      `json:"pointer"`
	JSON    projectEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectEditResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectEditResponseEnvelopeMessages added in v6.4.0

type ProjectEditResponseEnvelopeMessages struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           ProjectEditResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectEditResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectEditResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectEditResponseEnvelopeMessagesSource added in v6.4.0

type ProjectEditResponseEnvelopeMessagesSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    projectEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectEditResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectEditResponseEnvelopeSuccess

type ProjectEditResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectEditResponseEnvelopeSuccessTrue ProjectEditResponseEnvelopeSuccess = true
)

func (ProjectEditResponseEnvelopeSuccess) IsKnown

type ProjectGetParams

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

type ProjectGetResponseEnvelope

type ProjectGetResponseEnvelope struct {
	Errors   []ProjectGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectGetResponseEnvelopeMessages `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 ProjectGetResponseEnvelopeErrors added in v6.4.0

type ProjectGetResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           ProjectGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectGetResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectGetResponseEnvelopeErrorsSource added in v6.4.0

type ProjectGetResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    projectGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectGetResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectGetResponseEnvelopeMessages added in v6.4.0

type ProjectGetResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ProjectGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectGetResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectGetResponseEnvelopeMessagesSource added in v6.4.0

type ProjectGetResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    projectGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectGetResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectGetResponseEnvelopeSuccess

type ProjectGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectGetResponseEnvelopeSuccessTrue ProjectGetResponseEnvelopeSuccess = true
)

func (ProjectGetResponseEnvelopeSuccess) IsKnown

type ProjectListParams

type ProjectListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Which page of projects to fetch.
	Page param.Field[int64] `query:"page"`
	// How many projects to return per page.
	PerPage param.Field[int64] `query:"per_page"`
}

func (ProjectListParams) URLQuery added in v6.2.0

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

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

type ProjectNewParams

type ProjectNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Name of the project.
	Name param.Field[string] `json:"name,required"`
	// Production branch of the project. Used to identify production deployments.
	ProductionBranch param.Field[string] `json:"production_branch,required"`
	// Configs for the project build process.
	BuildConfig param.Field[ProjectNewParamsBuildConfig] `json:"build_config"`
	// Configs for deployments in a project.
	DeploymentConfigs param.Field[ProjectNewParamsDeploymentConfigs] `json:"deployment_configs"`
	// Configs for the project source control.
	Source param.Field[ProjectNewParamsSource] `json:"source"`
}

func (ProjectNewParams) MarshalJSON

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

type ProjectNewParamsBuildConfig added in v6.4.0

type ProjectNewParamsBuildConfig 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 (ProjectNewParamsBuildConfig) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigs added in v6.4.0

type ProjectNewParamsDeploymentConfigs struct {
	// Configs for preview deploys.
	Preview param.Field[ProjectNewParamsDeploymentConfigsPreview] `json:"preview"`
	// Configs for production deploys.
	Production param.Field[ProjectNewParamsDeploymentConfigsProduction] `json:"production"`
}

Configs for deployments in a project.

func (ProjectNewParamsDeploymentConfigs) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreview added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewAIBindings] `json:"ai_bindings"`
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewBrowsers] `json:"browsers"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
	// 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]ProjectNewParamsDeploymentConfigsPreviewD1Databases] `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables used for builds and Pages Functions.
	EnvVars param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion] `json:"env_vars"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen param.Field[bool] `json:"fail_open"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewKVNamespaces] `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits param.Field[ProjectNewParamsDeploymentConfigsPreviewLimits] `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectNewParamsDeploymentConfigsPreviewPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewServices] `json:"services"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel param.Field[ProjectNewParamsDeploymentConfigsPreviewUsageModel] `json:"usage_model"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings] `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}

Configs for preview deploys.

func (ProjectNewParamsDeploymentConfigsPreview) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewAIBindings added in v6.4.0

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

AI binding.

func (ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets added in v6.4.0

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

Analytics Engine binding.

func (ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewBrowsers added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewBrowsers struct {
}

Browser binding.

func (ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewD1Databases added in v6.4.0

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

D1 binding.

func (ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
	// ID of the Durable Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
}

Durable Object binding.

func (ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVars added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVars struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
	// Secret value.
	Value param.Field[string] `json:"value,required"`
}

An encrypted environment variable.

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType string
const (
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypePlainText  ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "plain_text"
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "secret_text"
)

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion added in v6.4.0

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

A plaintext environment variable.

Satisfied by pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsPreviewEnvVars.

type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings added in v6.4.0

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

Hyperdrive binding.

func (ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces added in v6.4.0

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

KV namespace binding.

func (ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewLimits added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewLimits struct {
	// CPU time limit in milliseconds.
	CPUMs param.Field[int64] `json:"cpu_ms,required"`
}

Limits for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewLimits) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates added in v6.4.0

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

mTLS binding.

func (ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewPlacement added in v6.4.0

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

Placement setting used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewQueueProducers added in v6.4.0

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

Queue Producer binding.

func (ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewR2Buckets added in v6.4.0

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

R2 binding.

func (ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewServices added in v6.4.0

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

Service binding.

func (ProjectNewParamsDeploymentConfigsPreviewServices) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsPreviewUsageModel added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewUsageModel string

The usage model for Pages Functions.

const (
	ProjectNewParamsDeploymentConfigsPreviewUsageModelStandard ProjectNewParamsDeploymentConfigsPreviewUsageModel = "standard"
	ProjectNewParamsDeploymentConfigsPreviewUsageModelBundled  ProjectNewParamsDeploymentConfigsPreviewUsageModel = "bundled"
	ProjectNewParamsDeploymentConfigsPreviewUsageModelUnbound  ProjectNewParamsDeploymentConfigsPreviewUsageModel = "unbound"
)

func (ProjectNewParamsDeploymentConfigsPreviewUsageModel) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings added in v6.4.0

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

Vectorize binding.

func (ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProduction added in v6.4.0

type ProjectNewParamsDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionAIBindings] `json:"ai_bindings"`
	// Whether to always use the latest compatibility date for Pages Functions.
	AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionBrowsers] `json:"browsers"`
	// The major version of the build image to use for Pages Functions.
	BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
	// 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]ProjectNewParamsDeploymentConfigsProductionD1Databases] `json:"d1_databases"`
	// Durable Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables used for builds and Pages Functions.
	EnvVars param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion] `json:"env_vars"`
	// Whether to fail open when the deployment config cannot be applied.
	FailOpen param.Field[bool] `json:"fail_open"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionKVNamespaces] `json:"kv_namespaces"`
	// Limits for Pages Functions.
	Limits param.Field[ProjectNewParamsDeploymentConfigsProductionLimits] `json:"limits"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectNewParamsDeploymentConfigsProductionPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionServices] `json:"services"`
	// The usage model for Pages Functions.
	//
	// Deprecated: All new projects now use the Standard usage model.
	UsageModel param.Field[ProjectNewParamsDeploymentConfigsProductionUsageModel] `json:"usage_model"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionVectorizeBindings] `json:"vectorize_bindings"`
	// Hash of the Wrangler configuration used for the deployment.
	WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}

Configs for production deploys.

func (ProjectNewParamsDeploymentConfigsProduction) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionAIBindings added in v6.4.0

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

AI binding.

func (ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets added in v6.4.0

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

Analytics Engine binding.

func (ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionBrowsers added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionBrowsers struct {
}

Browser binding.

func (ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionD1Databases added in v6.4.0

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

D1 binding.

func (ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
	// ID of the Durable Object namespace.
	NamespaceID param.Field[string] `json:"namespace_id,required"`
}

Durable Object binding.

func (ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVars added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVars struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
	// Environment variable value.
	Value param.Field[string] `json:"value,required"`
}

A plaintext environment variable.

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
	ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
	Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
	// Secret value.
	Value param.Field[string] `json:"value,required"`
}

An encrypted environment variable.

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
	ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsType added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsType string
const (
	ProjectNewParamsDeploymentConfigsProductionEnvVarsTypePlainText  ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "plain_text"
	ProjectNewParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "secret_text"
)

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsType) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion added in v6.4.0

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

A plaintext environment variable.

Satisfied by pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsProductionEnvVars.

type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings added in v6.4.0

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

Hyperdrive binding.

func (ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionKVNamespaces added in v6.4.0

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

KV namespace binding.

func (ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionLimits added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionLimits struct {
	// CPU time limit in milliseconds.
	CPUMs param.Field[int64] `json:"cpu_ms,required"`
}

Limits for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionLimits) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates added in v6.4.0

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

mTLS binding.

func (ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionPlacement added in v6.4.0

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

Placement setting used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionQueueProducers added in v6.4.0

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

Queue Producer binding.

func (ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionR2Buckets added in v6.4.0

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

R2 binding.

func (ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionServices added in v6.4.0

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

Service binding.

func (ProjectNewParamsDeploymentConfigsProductionServices) MarshalJSON added in v6.4.0

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

type ProjectNewParamsDeploymentConfigsProductionUsageModel added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionUsageModel string

The usage model for Pages Functions.

const (
	ProjectNewParamsDeploymentConfigsProductionUsageModelStandard ProjectNewParamsDeploymentConfigsProductionUsageModel = "standard"
	ProjectNewParamsDeploymentConfigsProductionUsageModelBundled  ProjectNewParamsDeploymentConfigsProductionUsageModel = "bundled"
	ProjectNewParamsDeploymentConfigsProductionUsageModelUnbound  ProjectNewParamsDeploymentConfigsProductionUsageModel = "unbound"
)

func (ProjectNewParamsDeploymentConfigsProductionUsageModel) IsKnown added in v6.4.0

type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings added in v6.4.0

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

Vectorize binding.

func (ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON added in v6.4.0

type ProjectNewParamsSource added in v6.4.0

type ProjectNewParamsSource struct {
	Config param.Field[ProjectNewParamsSourceConfig] `json:"config,required"`
	// The source control management provider.
	Type param.Field[ProjectNewParamsSourceType] `json:"type,required"`
}

Configs for the project source control.

func (ProjectNewParamsSource) MarshalJSON added in v6.4.0

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

type ProjectNewParamsSourceConfig added in v6.4.0

type ProjectNewParamsSourceConfig struct {
	// Whether to enable automatic deployments when pushing to the source repository.
	// When disabled, no deployments (production or preview) will be triggered
	// automatically.
	//
	// Deprecated: Use `production_deployments_enabled` and
	// `preview_deployment_setting` for more granular control.
	DeploymentsEnabled param.Field[bool] `json:"deployments_enabled"`
	// The owner of the repository.
	Owner param.Field[string] `json:"owner"`
	// The owner ID of the repository.
	OwnerID param.Field[string] `json:"owner_id"`
	// A list of paths that should be excluded from triggering a preview deployment.
	// Wildcard syntax (`*`) is supported.
	PathExcludes param.Field[[]string] `json:"path_excludes"`
	// A list of paths that should be watched to trigger a preview deployment. Wildcard
	// syntax (`*`) is supported.
	PathIncludes param.Field[[]string] `json:"path_includes"`
	// Whether to enable PR comments.
	PrCommentsEnabled param.Field[bool] `json:"pr_comments_enabled"`
	// A list of branches that should not trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchExcludes param.Field[[]string] `json:"preview_branch_excludes"`
	// A list of branches that should trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchIncludes param.Field[[]string] `json:"preview_branch_includes"`
	// Controls whether commits to preview branches trigger a preview deployment.
	PreviewDeploymentSetting param.Field[ProjectNewParamsSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
	// The production branch of the repository.
	ProductionBranch param.Field[string] `json:"production_branch"`
	// Whether to trigger a production deployment on commits to the production branch.
	ProductionDeploymentsEnabled param.Field[bool] `json:"production_deployments_enabled"`
	// The ID of the repository.
	RepoID param.Field[string] `json:"repo_id"`
	// The name of the repository.
	RepoName param.Field[string] `json:"repo_name"`
}

func (ProjectNewParamsSourceConfig) MarshalJSON added in v6.4.0

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

type ProjectNewParamsSourceConfigPreviewDeploymentSetting added in v6.4.0

type ProjectNewParamsSourceConfigPreviewDeploymentSetting string

Controls whether commits to preview branches trigger a preview deployment.

const (
	ProjectNewParamsSourceConfigPreviewDeploymentSettingAll    ProjectNewParamsSourceConfigPreviewDeploymentSetting = "all"
	ProjectNewParamsSourceConfigPreviewDeploymentSettingNone   ProjectNewParamsSourceConfigPreviewDeploymentSetting = "none"
	ProjectNewParamsSourceConfigPreviewDeploymentSettingCustom ProjectNewParamsSourceConfigPreviewDeploymentSetting = "custom"
)

func (ProjectNewParamsSourceConfigPreviewDeploymentSetting) IsKnown added in v6.4.0

type ProjectNewParamsSourceType added in v6.4.0

type ProjectNewParamsSourceType string

The source control management provider.

const (
	ProjectNewParamsSourceTypeGitHub ProjectNewParamsSourceType = "github"
	ProjectNewParamsSourceTypeGitlab ProjectNewParamsSourceType = "gitlab"
)

func (ProjectNewParamsSourceType) IsKnown added in v6.4.0

func (r ProjectNewParamsSourceType) IsKnown() bool

type ProjectNewResponseEnvelope

type ProjectNewResponseEnvelope struct {
	Errors   []ProjectNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectNewResponseEnvelopeMessages `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 ProjectNewResponseEnvelopeErrors added in v6.4.0

type ProjectNewResponseEnvelopeErrors struct {
	Code             int64                                  `json:"code,required"`
	Message          string                                 `json:"message,required"`
	DocumentationURL string                                 `json:"documentation_url"`
	Source           ProjectNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectNewResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectNewResponseEnvelopeErrorsSource added in v6.4.0

type ProjectNewResponseEnvelopeErrorsSource struct {
	Pointer string                                     `json:"pointer"`
	JSON    projectNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectNewResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectNewResponseEnvelopeMessages added in v6.4.0

type ProjectNewResponseEnvelopeMessages struct {
	Code             int64                                    `json:"code,required"`
	Message          string                                   `json:"message,required"`
	DocumentationURL string                                   `json:"documentation_url"`
	Source           ProjectNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectNewResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectNewResponseEnvelopeMessagesSource added in v6.4.0

type ProjectNewResponseEnvelopeMessagesSource struct {
	Pointer string                                       `json:"pointer"`
	JSON    projectNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectNewResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectNewResponseEnvelopeSuccess

type ProjectNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectNewResponseEnvelopeSuccessTrue ProjectNewResponseEnvelopeSuccess = true
)

func (ProjectNewResponseEnvelopeSuccess) IsKnown

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   []ProjectPurgeBuildCacheResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectPurgeBuildCacheResponseEnvelopeMessages `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 ProjectPurgeBuildCacheResponseEnvelopeErrors added in v6.4.0

type ProjectPurgeBuildCacheResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           ProjectPurgeBuildCacheResponseEnvelopeErrorsSource `json:"source"`
	JSON             projectPurgeBuildCacheResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*ProjectPurgeBuildCacheResponseEnvelopeErrors) UnmarshalJSON added in v6.4.0

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

type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource added in v6.4.0

type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    projectPurgeBuildCacheResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*ProjectPurgeBuildCacheResponseEnvelopeErrorsSource) UnmarshalJSON added in v6.4.0

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

type ProjectPurgeBuildCacheResponseEnvelopeMessages added in v6.4.0

type ProjectPurgeBuildCacheResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           ProjectPurgeBuildCacheResponseEnvelopeMessagesSource `json:"source"`
	JSON             projectPurgeBuildCacheResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*ProjectPurgeBuildCacheResponseEnvelopeMessages) UnmarshalJSON added in v6.4.0

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

type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource added in v6.4.0

type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    projectPurgeBuildCacheResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*ProjectPurgeBuildCacheResponseEnvelopeMessagesSource) UnmarshalJSON added in v6.4.0

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

type ProjectPurgeBuildCacheResponseEnvelopeSuccess

type ProjectPurgeBuildCacheResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	ProjectPurgeBuildCacheResponseEnvelopeSuccessTrue ProjectPurgeBuildCacheResponseEnvelopeSuccess = true
)

func (ProjectPurgeBuildCacheResponseEnvelopeSuccess) IsKnown

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

Fetch a list of all user projects.

func (*ProjectService) ListAutoPaging

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,required"`
	// The source control management provider.
	Type ProjectSourceType `json:"type,required"`
	JSON projectSourceJSON `json:"-"`
}

Configs for the project source control.

func (*ProjectSource) UnmarshalJSON

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

type ProjectSourceConfig

type ProjectSourceConfig struct {
	// Whether to enable automatic deployments when pushing to the source repository.
	// When disabled, no deployments (production or preview) will be triggered
	// automatically.
	//
	// Deprecated: Use `production_deployments_enabled` and
	// `preview_deployment_setting` for more granular control.
	DeploymentsEnabled bool `json:"deployments_enabled,required"`
	// The owner of the repository.
	Owner string `json:"owner,required"`
	// The owner ID of the repository.
	OwnerID string `json:"owner_id,required"`
	// A list of paths that should be excluded from triggering a preview deployment.
	// Wildcard syntax (`*`) is supported.
	PathExcludes []string `json:"path_excludes,required"`
	// A list of paths that should be watched to trigger a preview deployment. Wildcard
	// syntax (`*`) is supported.
	PathIncludes []string `json:"path_includes,required"`
	// Whether to enable PR comments.
	PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
	// A list of branches that should not trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchExcludes []string `json:"preview_branch_excludes,required"`
	// A list of branches that should trigger a preview deployment. Wildcard syntax
	// (`*`) is supported. Must be used with `preview_deployment_setting` set to
	// `custom`.
	PreviewBranchIncludes []string `json:"preview_branch_includes,required"`
	// Controls whether commits to preview branches trigger a preview deployment.
	PreviewDeploymentSetting ProjectSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting,required"`
	// The production branch of the repository.
	ProductionBranch string `json:"production_branch,required"`
	// Whether to trigger a production deployment on commits to the production branch.
	ProductionDeploymentsEnabled bool `json:"production_deployments_enabled,required"`
	// The ID of the repository.
	RepoID string `json:"repo_id,required"`
	// The name of the repository.
	RepoName string                  `json:"repo_name,required"`
	JSON     projectSourceConfigJSON `json:"-"`
}

func (*ProjectSourceConfig) UnmarshalJSON

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

type ProjectSourceConfigPreviewDeploymentSetting

type ProjectSourceConfigPreviewDeploymentSetting string

Controls whether commits to preview branches trigger a preview deployment.

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

func (ProjectSourceConfigPreviewDeploymentSetting) IsKnown

type ProjectSourceType added in v6.2.0

type ProjectSourceType string

The source control management provider.

const (
	ProjectSourceTypeGitHub ProjectSourceType = "github"
	ProjectSourceTypeGitlab ProjectSourceType = "gitlab"
)

func (ProjectSourceType) IsKnown added in v6.2.0

func (r ProjectSourceType) IsKnown() bool

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type 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,required,nullable" format:"date-time"`
	// The current build stage.
	Name StageName `json:"name,required"`
	// When the stage started.
	StartedOn time.Time `json:"started_on,required,nullable" format:"date-time"`
	// State of the current stage.
	Status StageStatus `json:"status,required"`
	JSON   stageJSON   `json:"-"`
}

The status of the deployment.

func (*Stage) UnmarshalJSON

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

type StageName

type StageName string

The current build stage.

const (
	StageNameQueued     StageName = "queued"
	StageNameInitialize StageName = "initialize"
	StageNameCloneRepo  StageName = "clone_repo"
	StageNameBuild      StageName = "build"
	StageNameDeploy     StageName = "deploy"
)

func (StageName) IsKnown

func (r StageName) IsKnown() bool

type StageStatus

type StageStatus string

State of the current stage.

const (
	StageStatusSuccess  StageStatus = "success"
	StageStatusIdle     StageStatus = "idle"
	StageStatusActive   StageStatus = "active"
	StageStatusFailure  StageStatus = "failure"
	StageStatusCanceled StageStatus = "canceled"
)

func (StageStatus) IsKnown

func (r StageStatus) IsKnown() bool

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL