pages

package
v2.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 15 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 CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0

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 CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Deployment

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

func (*Deployment) UnmarshalJSON

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

type DeploymentDeploymentTrigger

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

Info about what caused the deployment.

func (*DeploymentDeploymentTrigger) UnmarshalJSON

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

type DeploymentDeploymentTriggerMetadata

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

Additional info about the trigger.

func (*DeploymentDeploymentTriggerMetadata) UnmarshalJSON

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

type DeploymentDeploymentTriggerMetadataParam

type DeploymentDeploymentTriggerMetadataParam struct {
}

Additional info about the trigger.

func (DeploymentDeploymentTriggerMetadataParam) MarshalJSON

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

type DeploymentDeploymentTriggerParam

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

Info about what caused the deployment.

func (DeploymentDeploymentTriggerParam) MarshalJSON

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

type DeploymentParam

type DeploymentParam struct {
}

func (DeploymentParam) MarshalJSON

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

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Member added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

type MemberParam added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole added in v2.1.0

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions added in v2.1.0

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser added in v2.1.0

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam added in v2.1.0

type MemberUserParam = shared.MemberUserParam

This is an alias to an internal type.

type PageService

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

PageService contains methods and other services that help with interacting with the cloudflare API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPageService method instead.

func NewPageService

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

NewPageService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type Project

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

func (*Project) UnmarshalJSON

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

type ProjectBuildConfig

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

Configs for the project build process.

func (*ProjectBuildConfig) UnmarshalJSON

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

type ProjectBuildConfigParam

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

Configs for the project build process.

func (ProjectBuildConfigParam) MarshalJSON

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

type ProjectDeleteParams

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

func (ProjectDeleteParams) MarshalJSON

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

type ProjectDeleteResponse

type ProjectDeleteResponse = interface{}

type ProjectDeploymentConfigs

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

Configs for deployments in a project.

func (*ProjectDeploymentConfigs) UnmarshalJSON

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

type ProjectDeploymentConfigsParam

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

Configs for deployments in a project.

func (ProjectDeploymentConfigsParam) MarshalJSON

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

type ProjectDeploymentConfigsPreview

type ProjectDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings ProjectDeploymentConfigsPreviewAIBindings `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets ProjectDeploymentConfigsPreviewAnalyticsEngineDatasets `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers ProjectDeploymentConfigsPreviewBrowsers `json:"browsers,nullable"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []interface{} `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases ProjectDeploymentConfigsPreviewD1Databases `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces ProjectDeploymentConfigsPreviewDurableObjectNamespaces `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars ProjectDeploymentConfigsPreviewEnvVars `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings ProjectDeploymentConfigsPreviewHyperdriveBindings `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces ProjectDeploymentConfigsPreviewKVNamespaces `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates ProjectDeploymentConfigsPreviewMTLSCertificates `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsPreviewPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers ProjectDeploymentConfigsPreviewQueueProducers `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets ProjectDeploymentConfigsPreviewR2Buckets `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services ProjectDeploymentConfigsPreviewServices `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings ProjectDeploymentConfigsPreviewVectorizeBindings `json:"vectorize_bindings,nullable"`
	JSON              projectDeploymentConfigsPreviewJSON              `json:"-"`
}

Configs for preview deploys.

func (*ProjectDeploymentConfigsPreview) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewAIBindings

type ProjectDeploymentConfigsPreviewAIBindings struct {
	// AI binding.
	AIBinding ProjectDeploymentConfigsPreviewAIBindingsAIBinding `json:"AI_BINDING"`
	JSON      projectDeploymentConfigsPreviewAIBindingsJSON      `json:"-"`
}

Constellation bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewAIBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewAIBindingsAIBinding

type ProjectDeploymentConfigsPreviewAIBindingsAIBinding struct {
	ProjectID interface{}                                            `json:"project_id"`
	JSON      projectDeploymentConfigsPreviewAIBindingsAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsPreviewAIBindingsAIBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewAIBindingsAIBindingParam

type ProjectDeploymentConfigsPreviewAIBindingsAIBindingParam struct {
	ProjectID param.Field[interface{}] `json:"project_id"`
}

AI binding.

func (ProjectDeploymentConfigsPreviewAIBindingsAIBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewAIBindingsParam

type ProjectDeploymentConfigsPreviewAIBindingsParam struct {
	// AI binding.
	AIBinding param.Field[ProjectDeploymentConfigsPreviewAIBindingsAIBindingParam] `json:"AI_BINDING"`
}

Constellation bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewAIBindingsParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasets

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding `json:"ANALYTICS_ENGINE_BINDING"`
	JSON                   projectDeploymentConfigsPreviewAnalyticsEngineDatasetsJSON                   `json:"-"`
}

Analytics Engine bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewAnalyticsEngineDatasets) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (*ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding) UnmarshalJSON

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBindingParam

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

Analytics Engine binding.

func (ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsParam

type ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsParam struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding param.Field[ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBindingParam] `json:"ANALYTICS_ENGINE_BINDING"`
}

Analytics Engine bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsParam) MarshalJSON

type ProjectDeploymentConfigsPreviewBrowsers

type ProjectDeploymentConfigsPreviewBrowsers struct {
	// Browser binding.
	Browser interface{}                                 `json:"BROWSER"`
	JSON    projectDeploymentConfigsPreviewBrowsersJSON `json:"-"`
}

Browser bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewBrowsers) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewBrowsersParam

type ProjectDeploymentConfigsPreviewBrowsersParam struct {
	// Browser binding.
	Browser param.Field[interface{}] `json:"BROWSER"`
}

Browser bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewBrowsersParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewD1Databases

type ProjectDeploymentConfigsPreviewD1Databases struct {
	// D1 binding.
	D1Binding ProjectDeploymentConfigsPreviewD1DatabasesD1Binding `json:"D1_BINDING"`
	JSON      projectDeploymentConfigsPreviewD1DatabasesJSON      `json:"-"`
}

D1 databases used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewD1Databases) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewD1DatabasesD1Binding

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

D1 binding.

func (*ProjectDeploymentConfigsPreviewD1DatabasesD1Binding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewD1DatabasesD1BindingParam

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

D1 binding.

func (ProjectDeploymentConfigsPreviewD1DatabasesD1BindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewD1DatabasesParam

type ProjectDeploymentConfigsPreviewD1DatabasesParam struct {
	// D1 binding.
	D1Binding param.Field[ProjectDeploymentConfigsPreviewD1DatabasesD1BindingParam] `json:"D1_BINDING"`
}

D1 databases used for Pages Functions.

func (ProjectDeploymentConfigsPreviewD1DatabasesParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewDurableObjectNamespaces

type ProjectDeploymentConfigsPreviewDurableObjectNamespaces struct {
	// Durabble Object binding.
	DoBinding ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBinding `json:"DO_BINDING"`
	JSON      projectDeploymentConfigsPreviewDurableObjectNamespacesJSON      `json:"-"`
}

Durabble Object namespaces used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewDurableObjectNamespaces) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (*ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBinding) UnmarshalJSON

type ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBindingParam

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

Durabble Object binding.

func (ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewDurableObjectNamespacesParam

type ProjectDeploymentConfigsPreviewDurableObjectNamespacesParam struct {
	// Durabble Object binding.
	DoBinding param.Field[ProjectDeploymentConfigsPreviewDurableObjectNamespacesDoBindingParam] `json:"DO_BINDING"`
}

Durabble Object namespaces used for Pages Functions.

func (ProjectDeploymentConfigsPreviewDurableObjectNamespacesParam) MarshalJSON

type ProjectDeploymentConfigsPreviewEnvVars

type ProjectDeploymentConfigsPreviewEnvVars struct {
	// Environment variable.
	EnvironmentVariable ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariable `json:"ENVIRONMENT_VARIABLE"`
	JSON                projectDeploymentConfigsPreviewEnvVarsJSON                `json:"-"`
}

Environment variables for build configs.

func (*ProjectDeploymentConfigsPreviewEnvVars) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariable

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariable struct {
	// The type of environment variable (plain text or secret)
	Type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType `json:"type"`
	// Environment variable value.
	Value string                                                        `json:"value"`
	JSON  projectDeploymentConfigsPreviewEnvVarsEnvironmentVariableJSON `json:"-"`
}

Environment variable.

func (*ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariable) UnmarshalJSON

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableParam

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableParam struct {
	// The type of environment variable (plain text or secret)
	Type param.Field[ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType] `json:"type"`
	// Environment variable value.
	Value param.Field[string] `json:"value"`
}

Environment variable.

func (ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableParam) MarshalJSON

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType

type ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypePlainText  ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "plain_text"
	ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypeSecretText ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "secret_text"
)

func (ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableType) IsKnown

type ProjectDeploymentConfigsPreviewEnvVarsParam

type ProjectDeploymentConfigsPreviewEnvVarsParam struct {
	// Environment variable.
	EnvironmentVariable param.Field[ProjectDeploymentConfigsPreviewEnvVarsEnvironmentVariableParam] `json:"ENVIRONMENT_VARIABLE"`
}

Environment variables for build configs.

func (ProjectDeploymentConfigsPreviewEnvVarsParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewHyperdriveBindings

type ProjectDeploymentConfigsPreviewHyperdriveBindings struct {
	// Hyperdrive binding.
	Hyperdrive ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdrive `json:"HYPERDRIVE"`
	JSON       projectDeploymentConfigsPreviewHyperdriveBindingsJSON       `json:"-"`
}

Hyperdrive bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewHyperdriveBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdrive

type ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdrive struct {
	ID   string                                                          `json:"id"`
	JSON projectDeploymentConfigsPreviewHyperdriveBindingsHyperdriveJSON `json:"-"`
}

Hyperdrive binding.

func (*ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdrive) UnmarshalJSON

type ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdriveParam

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

Hyperdrive binding.

func (ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdriveParam) MarshalJSON

type ProjectDeploymentConfigsPreviewHyperdriveBindingsParam

type ProjectDeploymentConfigsPreviewHyperdriveBindingsParam struct {
	// Hyperdrive binding.
	Hyperdrive param.Field[ProjectDeploymentConfigsPreviewHyperdriveBindingsHyperdriveParam] `json:"HYPERDRIVE"`
}

Hyperdrive bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewHyperdriveBindingsParam) MarshalJSON

type ProjectDeploymentConfigsPreviewKVNamespaces

type ProjectDeploymentConfigsPreviewKVNamespaces struct {
	// KV binding.
	KVBinding ProjectDeploymentConfigsPreviewKVNamespacesKVBinding `json:"KV_BINDING"`
	JSON      projectDeploymentConfigsPreviewKVNamespacesJSON      `json:"-"`
}

KV namespaces used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewKVNamespaces) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewKVNamespacesKVBinding

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

KV binding.

func (*ProjectDeploymentConfigsPreviewKVNamespacesKVBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewKVNamespacesKVBindingParam

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

KV binding.

func (ProjectDeploymentConfigsPreviewKVNamespacesKVBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewKVNamespacesParam

type ProjectDeploymentConfigsPreviewKVNamespacesParam struct {
	// KV binding.
	KVBinding param.Field[ProjectDeploymentConfigsPreviewKVNamespacesKVBindingParam] `json:"KV_BINDING"`
}

KV namespaces used for Pages Functions.

func (ProjectDeploymentConfigsPreviewKVNamespacesParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewMTLSCertificates

type ProjectDeploymentConfigsPreviewMTLSCertificates struct {
	// mTLS binding.
	MTLS ProjectDeploymentConfigsPreviewMTLSCertificatesMTLS `json:"MTLS"`
	JSON projectDeploymentConfigsPreviewMTLSCertificatesJSON `json:"-"`
}

mTLS bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewMTLSCertificates) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewMTLSCertificatesMTLS

type ProjectDeploymentConfigsPreviewMTLSCertificatesMTLS struct {
	CertificateID string                                                  `json:"certificate_id"`
	JSON          projectDeploymentConfigsPreviewMTLSCertificatesMTLSJSON `json:"-"`
}

mTLS binding.

func (*ProjectDeploymentConfigsPreviewMTLSCertificatesMTLS) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewMTLSCertificatesMTLSParam

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

mTLS binding.

func (ProjectDeploymentConfigsPreviewMTLSCertificatesMTLSParam) MarshalJSON

type ProjectDeploymentConfigsPreviewMTLSCertificatesParam

type ProjectDeploymentConfigsPreviewMTLSCertificatesParam struct {
	// mTLS binding.
	MTLS param.Field[ProjectDeploymentConfigsPreviewMTLSCertificatesMTLSParam] `json:"MTLS"`
}

mTLS bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewMTLSCertificatesParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewParam

type ProjectDeploymentConfigsPreviewParam struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[ProjectDeploymentConfigsPreviewAIBindingsParam] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[ProjectDeploymentConfigsPreviewAnalyticsEngineDatasetsParam] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[ProjectDeploymentConfigsPreviewBrowsersParam] `json:"browsers"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags param.Field[[]interface{}] `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases param.Field[ProjectDeploymentConfigsPreviewD1DatabasesParam] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[ProjectDeploymentConfigsPreviewDurableObjectNamespacesParam] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[ProjectDeploymentConfigsPreviewEnvVarsParam] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[ProjectDeploymentConfigsPreviewHyperdriveBindingsParam] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[ProjectDeploymentConfigsPreviewKVNamespacesParam] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[ProjectDeploymentConfigsPreviewMTLSCertificatesParam] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectDeploymentConfigsPreviewPlacementParam] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[ProjectDeploymentConfigsPreviewQueueProducersParam] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[ProjectDeploymentConfigsPreviewR2BucketsParam] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[ProjectDeploymentConfigsPreviewServicesParam] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[ProjectDeploymentConfigsPreviewVectorizeBindingsParam] `json:"vectorize_bindings"`
}

Configs for preview deploys.

func (ProjectDeploymentConfigsPreviewParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewPlacement

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

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewPlacement) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewPlacementParam

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

Placement setting used for Pages Functions.

func (ProjectDeploymentConfigsPreviewPlacementParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewQueueProducers

type ProjectDeploymentConfigsPreviewQueueProducers struct {
	// Queue Producer binding.
	QueueProducerBinding ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBinding `json:"QUEUE_PRODUCER_BINDING"`
	JSON                 projectDeploymentConfigsPreviewQueueProducersJSON                 `json:"-"`
}

Queue Producer bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewQueueProducers) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewQueueProducersParam

type ProjectDeploymentConfigsPreviewQueueProducersParam struct {
	// Queue Producer binding.
	QueueProducerBinding param.Field[ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBindingParam] `json:"QUEUE_PRODUCER_BINDING"`
}

Queue Producer bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewQueueProducersParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (*ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBinding) UnmarshalJSON

type ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBindingParam

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

Queue Producer binding.

func (ProjectDeploymentConfigsPreviewQueueProducersQueueProducerBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewR2Buckets

type ProjectDeploymentConfigsPreviewR2Buckets struct {
	// R2 binding.
	R2Binding ProjectDeploymentConfigsPreviewR2BucketsR2Binding `json:"R2_BINDING"`
	JSON      projectDeploymentConfigsPreviewR2BucketsJSON      `json:"-"`
}

R2 buckets used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewR2Buckets) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewR2BucketsParam

type ProjectDeploymentConfigsPreviewR2BucketsParam struct {
	// R2 binding.
	R2Binding param.Field[ProjectDeploymentConfigsPreviewR2BucketsR2BindingParam] `json:"R2_BINDING"`
}

R2 buckets used for Pages Functions.

func (ProjectDeploymentConfigsPreviewR2BucketsParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewR2BucketsR2Binding

type ProjectDeploymentConfigsPreviewR2BucketsR2Binding struct {
	// Name of the R2 bucket.
	Name string                                                `json:"name"`
	JSON projectDeploymentConfigsPreviewR2BucketsR2BindingJSON `json:"-"`
}

R2 binding.

func (*ProjectDeploymentConfigsPreviewR2BucketsR2Binding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewR2BucketsR2BindingParam

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

R2 binding.

func (ProjectDeploymentConfigsPreviewR2BucketsR2BindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewServices

type ProjectDeploymentConfigsPreviewServices struct {
	// Service binding.
	ServiceBinding ProjectDeploymentConfigsPreviewServicesServiceBinding `json:"SERVICE_BINDING"`
	JSON           projectDeploymentConfigsPreviewServicesJSON           `json:"-"`
}

Services used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewServices) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewServicesParam

type ProjectDeploymentConfigsPreviewServicesParam struct {
	// Service binding.
	ServiceBinding param.Field[ProjectDeploymentConfigsPreviewServicesServiceBindingParam] `json:"SERVICE_BINDING"`
}

Services used for Pages Functions.

func (ProjectDeploymentConfigsPreviewServicesParam) MarshalJSON

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

type ProjectDeploymentConfigsPreviewServicesServiceBinding

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

Service binding.

func (*ProjectDeploymentConfigsPreviewServicesServiceBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewServicesServiceBindingParam

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

Service binding.

func (ProjectDeploymentConfigsPreviewServicesServiceBindingParam) MarshalJSON

type ProjectDeploymentConfigsPreviewVectorizeBindings

type ProjectDeploymentConfigsPreviewVectorizeBindings struct {
	// Vectorize binding.
	Vectorize ProjectDeploymentConfigsPreviewVectorizeBindingsVectorize `json:"VECTORIZE"`
	JSON      projectDeploymentConfigsPreviewVectorizeBindingsJSON      `json:"-"`
}

Vectorize bindings used for Pages Functions.

func (*ProjectDeploymentConfigsPreviewVectorizeBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsPreviewVectorizeBindingsParam

type ProjectDeploymentConfigsPreviewVectorizeBindingsParam struct {
	// Vectorize binding.
	Vectorize param.Field[ProjectDeploymentConfigsPreviewVectorizeBindingsVectorizeParam] `json:"VECTORIZE"`
}

Vectorize bindings used for Pages Functions.

func (ProjectDeploymentConfigsPreviewVectorizeBindingsParam) MarshalJSON

type ProjectDeploymentConfigsPreviewVectorizeBindingsVectorize

type ProjectDeploymentConfigsPreviewVectorizeBindingsVectorize struct {
	IndexName string                                                        `json:"index_name"`
	JSON      projectDeploymentConfigsPreviewVectorizeBindingsVectorizeJSON `json:"-"`
}

Vectorize binding.

func (*ProjectDeploymentConfigsPreviewVectorizeBindingsVectorize) UnmarshalJSON

type ProjectDeploymentConfigsPreviewVectorizeBindingsVectorizeParam

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

Vectorize binding.

func (ProjectDeploymentConfigsPreviewVectorizeBindingsVectorizeParam) MarshalJSON

type ProjectDeploymentConfigsProduction

type ProjectDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings ProjectDeploymentConfigsProductionAIBindings `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets ProjectDeploymentConfigsProductionAnalyticsEngineDatasets `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers ProjectDeploymentConfigsProductionBrowsers `json:"browsers,nullable"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate string `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags []interface{} `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases ProjectDeploymentConfigsProductionD1Databases `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces ProjectDeploymentConfigsProductionDurableObjectNamespaces `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars ProjectDeploymentConfigsProductionEnvVars `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings ProjectDeploymentConfigsProductionHyperdriveBindings `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces ProjectDeploymentConfigsProductionKVNamespaces `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates ProjectDeploymentConfigsProductionMTLSCertificates `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement ProjectDeploymentConfigsProductionPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers ProjectDeploymentConfigsProductionQueueProducers `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets ProjectDeploymentConfigsProductionR2Buckets `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services ProjectDeploymentConfigsProductionServices `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings ProjectDeploymentConfigsProductionVectorizeBindings `json:"vectorize_bindings,nullable"`
	JSON              projectDeploymentConfigsProductionJSON              `json:"-"`
}

Configs for production deploys.

func (*ProjectDeploymentConfigsProduction) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionAIBindings

type ProjectDeploymentConfigsProductionAIBindings struct {
	// AI binding.
	AIBinding ProjectDeploymentConfigsProductionAIBindingsAIBinding `json:"AI_BINDING"`
	JSON      projectDeploymentConfigsProductionAIBindingsJSON      `json:"-"`
}

Constellation bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionAIBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionAIBindingsAIBinding

type ProjectDeploymentConfigsProductionAIBindingsAIBinding struct {
	ProjectID interface{}                                               `json:"project_id"`
	JSON      projectDeploymentConfigsProductionAIBindingsAIBindingJSON `json:"-"`
}

AI binding.

func (*ProjectDeploymentConfigsProductionAIBindingsAIBinding) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionAIBindingsAIBindingParam

type ProjectDeploymentConfigsProductionAIBindingsAIBindingParam struct {
	ProjectID param.Field[interface{}] `json:"project_id"`
}

AI binding.

func (ProjectDeploymentConfigsProductionAIBindingsAIBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionAIBindingsParam

type ProjectDeploymentConfigsProductionAIBindingsParam struct {
	// AI binding.
	AIBinding param.Field[ProjectDeploymentConfigsProductionAIBindingsAIBindingParam] `json:"AI_BINDING"`
}

Constellation bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionAIBindingsParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasets

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasets struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding `json:"ANALYTICS_ENGINE_BINDING"`
	JSON                   projectDeploymentConfigsProductionAnalyticsEngineDatasetsJSON                   `json:"-"`
}

Analytics Engine bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionAnalyticsEngineDatasets) UnmarshalJSON

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (*ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding) UnmarshalJSON

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBindingParam

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

Analytics Engine binding.

func (ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsParam

type ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsParam struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding param.Field[ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBindingParam] `json:"ANALYTICS_ENGINE_BINDING"`
}

Analytics Engine bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsParam) MarshalJSON

type ProjectDeploymentConfigsProductionBrowsers

type ProjectDeploymentConfigsProductionBrowsers struct {
	// Browser binding.
	Browser interface{}                                    `json:"BROWSER"`
	JSON    projectDeploymentConfigsProductionBrowsersJSON `json:"-"`
}

Browser bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionBrowsers) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionBrowsersParam

type ProjectDeploymentConfigsProductionBrowsersParam struct {
	// Browser binding.
	Browser param.Field[interface{}] `json:"BROWSER"`
}

Browser bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionBrowsersParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionD1Databases

type ProjectDeploymentConfigsProductionD1Databases struct {
	// D1 binding.
	D1Binding ProjectDeploymentConfigsProductionD1DatabasesD1Binding `json:"D1_BINDING"`
	JSON      projectDeploymentConfigsProductionD1DatabasesJSON      `json:"-"`
}

D1 databases used for Pages Functions.

func (*ProjectDeploymentConfigsProductionD1Databases) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionD1DatabasesD1Binding

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

D1 binding.

func (*ProjectDeploymentConfigsProductionD1DatabasesD1Binding) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionD1DatabasesD1BindingParam

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

D1 binding.

func (ProjectDeploymentConfigsProductionD1DatabasesD1BindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionD1DatabasesParam

type ProjectDeploymentConfigsProductionD1DatabasesParam struct {
	// D1 binding.
	D1Binding param.Field[ProjectDeploymentConfigsProductionD1DatabasesD1BindingParam] `json:"D1_BINDING"`
}

D1 databases used for Pages Functions.

func (ProjectDeploymentConfigsProductionD1DatabasesParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionDurableObjectNamespaces

type ProjectDeploymentConfigsProductionDurableObjectNamespaces struct {
	// Durabble Object binding.
	DoBinding ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBinding `json:"DO_BINDING"`
	JSON      projectDeploymentConfigsProductionDurableObjectNamespacesJSON      `json:"-"`
}

Durabble Object namespaces used for Pages Functions.

func (*ProjectDeploymentConfigsProductionDurableObjectNamespaces) UnmarshalJSON

type ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (*ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBinding) UnmarshalJSON

type ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBindingParam

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

Durabble Object binding.

func (ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionDurableObjectNamespacesParam

type ProjectDeploymentConfigsProductionDurableObjectNamespacesParam struct {
	// Durabble Object binding.
	DoBinding param.Field[ProjectDeploymentConfigsProductionDurableObjectNamespacesDoBindingParam] `json:"DO_BINDING"`
}

Durabble Object namespaces used for Pages Functions.

func (ProjectDeploymentConfigsProductionDurableObjectNamespacesParam) MarshalJSON

type ProjectDeploymentConfigsProductionEnvVars

type ProjectDeploymentConfigsProductionEnvVars struct {
	// Environment variable.
	EnvironmentVariable ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariable `json:"ENVIRONMENT_VARIABLE"`
	JSON                projectDeploymentConfigsProductionEnvVarsJSON                `json:"-"`
}

Environment variables for build configs.

func (*ProjectDeploymentConfigsProductionEnvVars) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariable

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariable struct {
	// The type of environment variable (plain text or secret)
	Type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType `json:"type"`
	// Environment variable value.
	Value string                                                           `json:"value"`
	JSON  projectDeploymentConfigsProductionEnvVarsEnvironmentVariableJSON `json:"-"`
}

Environment variable.

func (*ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariable) UnmarshalJSON

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableParam

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableParam struct {
	// The type of environment variable (plain text or secret)
	Type param.Field[ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType] `json:"type"`
	// Environment variable value.
	Value param.Field[string] `json:"value"`
}

Environment variable.

func (ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableParam) MarshalJSON

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType

type ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableTypePlainText  ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "plain_text"
	ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableTypeSecretText ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "secret_text"
)

func (ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableType) IsKnown

type ProjectDeploymentConfigsProductionEnvVarsParam

type ProjectDeploymentConfigsProductionEnvVarsParam struct {
	// Environment variable.
	EnvironmentVariable param.Field[ProjectDeploymentConfigsProductionEnvVarsEnvironmentVariableParam] `json:"ENVIRONMENT_VARIABLE"`
}

Environment variables for build configs.

func (ProjectDeploymentConfigsProductionEnvVarsParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionHyperdriveBindings

type ProjectDeploymentConfigsProductionHyperdriveBindings struct {
	// Hyperdrive binding.
	Hyperdrive ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdrive `json:"HYPERDRIVE"`
	JSON       projectDeploymentConfigsProductionHyperdriveBindingsJSON       `json:"-"`
}

Hyperdrive bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionHyperdriveBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdrive

type ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdrive struct {
	ID   string                                                             `json:"id"`
	JSON projectDeploymentConfigsProductionHyperdriveBindingsHyperdriveJSON `json:"-"`
}

Hyperdrive binding.

func (*ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdrive) UnmarshalJSON

type ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdriveParam

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

Hyperdrive binding.

func (ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdriveParam) MarshalJSON

type ProjectDeploymentConfigsProductionHyperdriveBindingsParam

type ProjectDeploymentConfigsProductionHyperdriveBindingsParam struct {
	// Hyperdrive binding.
	Hyperdrive param.Field[ProjectDeploymentConfigsProductionHyperdriveBindingsHyperdriveParam] `json:"HYPERDRIVE"`
}

Hyperdrive bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionHyperdriveBindingsParam) MarshalJSON

type ProjectDeploymentConfigsProductionKVNamespaces

type ProjectDeploymentConfigsProductionKVNamespaces struct {
	// KV binding.
	KVBinding ProjectDeploymentConfigsProductionKVNamespacesKVBinding `json:"KV_BINDING"`
	JSON      projectDeploymentConfigsProductionKVNamespacesJSON      `json:"-"`
}

KV namespaces used for Pages Functions.

func (*ProjectDeploymentConfigsProductionKVNamespaces) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionKVNamespacesKVBinding

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

KV binding.

func (*ProjectDeploymentConfigsProductionKVNamespacesKVBinding) UnmarshalJSON

type ProjectDeploymentConfigsProductionKVNamespacesKVBindingParam

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

KV binding.

func (ProjectDeploymentConfigsProductionKVNamespacesKVBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionKVNamespacesParam

type ProjectDeploymentConfigsProductionKVNamespacesParam struct {
	// KV binding.
	KVBinding param.Field[ProjectDeploymentConfigsProductionKVNamespacesKVBindingParam] `json:"KV_BINDING"`
}

KV namespaces used for Pages Functions.

func (ProjectDeploymentConfigsProductionKVNamespacesParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionMTLSCertificates

type ProjectDeploymentConfigsProductionMTLSCertificates struct {
	// mTLS binding.
	MTLS ProjectDeploymentConfigsProductionMTLSCertificatesMTLS `json:"MTLS"`
	JSON projectDeploymentConfigsProductionMTLSCertificatesJSON `json:"-"`
}

mTLS bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionMTLSCertificates) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionMTLSCertificatesMTLS

type ProjectDeploymentConfigsProductionMTLSCertificatesMTLS struct {
	CertificateID string                                                     `json:"certificate_id"`
	JSON          projectDeploymentConfigsProductionMTLSCertificatesMTLSJSON `json:"-"`
}

mTLS binding.

func (*ProjectDeploymentConfigsProductionMTLSCertificatesMTLS) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionMTLSCertificatesMTLSParam

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

mTLS binding.

func (ProjectDeploymentConfigsProductionMTLSCertificatesMTLSParam) MarshalJSON

type ProjectDeploymentConfigsProductionMTLSCertificatesParam

type ProjectDeploymentConfigsProductionMTLSCertificatesParam struct {
	// mTLS binding.
	MTLS param.Field[ProjectDeploymentConfigsProductionMTLSCertificatesMTLSParam] `json:"MTLS"`
}

mTLS bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionMTLSCertificatesParam) MarshalJSON

type ProjectDeploymentConfigsProductionParam

type ProjectDeploymentConfigsProductionParam struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[ProjectDeploymentConfigsProductionAIBindingsParam] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[ProjectDeploymentConfigsProductionAnalyticsEngineDatasetsParam] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[ProjectDeploymentConfigsProductionBrowsersParam] `json:"browsers"`
	// Compatibility date used for Pages Functions.
	CompatibilityDate param.Field[string] `json:"compatibility_date"`
	// Compatibility flags used for Pages Functions.
	CompatibilityFlags param.Field[[]interface{}] `json:"compatibility_flags"`
	// D1 databases used for Pages Functions.
	D1Databases param.Field[ProjectDeploymentConfigsProductionD1DatabasesParam] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[ProjectDeploymentConfigsProductionDurableObjectNamespacesParam] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[ProjectDeploymentConfigsProductionEnvVarsParam] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[ProjectDeploymentConfigsProductionHyperdriveBindingsParam] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[ProjectDeploymentConfigsProductionKVNamespacesParam] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[ProjectDeploymentConfigsProductionMTLSCertificatesParam] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectDeploymentConfigsProductionPlacementParam] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[ProjectDeploymentConfigsProductionQueueProducersParam] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[ProjectDeploymentConfigsProductionR2BucketsParam] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[ProjectDeploymentConfigsProductionServicesParam] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[ProjectDeploymentConfigsProductionVectorizeBindingsParam] `json:"vectorize_bindings"`
}

Configs for production deploys.

func (ProjectDeploymentConfigsProductionParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionPlacement

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

Placement setting used for Pages Functions.

func (*ProjectDeploymentConfigsProductionPlacement) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionPlacementParam

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

Placement setting used for Pages Functions.

func (ProjectDeploymentConfigsProductionPlacementParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionQueueProducers

type ProjectDeploymentConfigsProductionQueueProducers struct {
	// Queue Producer binding.
	QueueProducerBinding ProjectDeploymentConfigsProductionQueueProducersQueueProducerBinding `json:"QUEUE_PRODUCER_BINDING"`
	JSON                 projectDeploymentConfigsProductionQueueProducersJSON                 `json:"-"`
}

Queue Producer bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionQueueProducers) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionQueueProducersParam

type ProjectDeploymentConfigsProductionQueueProducersParam struct {
	// Queue Producer binding.
	QueueProducerBinding param.Field[ProjectDeploymentConfigsProductionQueueProducersQueueProducerBindingParam] `json:"QUEUE_PRODUCER_BINDING"`
}

Queue Producer bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionQueueProducersParam) MarshalJSON

type ProjectDeploymentConfigsProductionQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (*ProjectDeploymentConfigsProductionQueueProducersQueueProducerBinding) UnmarshalJSON

type ProjectDeploymentConfigsProductionQueueProducersQueueProducerBindingParam

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

Queue Producer binding.

func (ProjectDeploymentConfigsProductionQueueProducersQueueProducerBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionR2Buckets

type ProjectDeploymentConfigsProductionR2Buckets struct {
	// R2 binding.
	R2Binding ProjectDeploymentConfigsProductionR2BucketsR2Binding `json:"R2_BINDING"`
	JSON      projectDeploymentConfigsProductionR2BucketsJSON      `json:"-"`
}

R2 buckets used for Pages Functions.

func (*ProjectDeploymentConfigsProductionR2Buckets) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionR2BucketsParam

type ProjectDeploymentConfigsProductionR2BucketsParam struct {
	// R2 binding.
	R2Binding param.Field[ProjectDeploymentConfigsProductionR2BucketsR2BindingParam] `json:"R2_BINDING"`
}

R2 buckets used for Pages Functions.

func (ProjectDeploymentConfigsProductionR2BucketsParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionR2BucketsR2Binding

type ProjectDeploymentConfigsProductionR2BucketsR2Binding struct {
	// Name of the R2 bucket.
	Name string                                                   `json:"name"`
	JSON projectDeploymentConfigsProductionR2BucketsR2BindingJSON `json:"-"`
}

R2 binding.

func (*ProjectDeploymentConfigsProductionR2BucketsR2Binding) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionR2BucketsR2BindingParam

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

R2 binding.

func (ProjectDeploymentConfigsProductionR2BucketsR2BindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionServices

type ProjectDeploymentConfigsProductionServices struct {
	// Service binding.
	ServiceBinding ProjectDeploymentConfigsProductionServicesServiceBinding `json:"SERVICE_BINDING"`
	JSON           projectDeploymentConfigsProductionServicesJSON           `json:"-"`
}

Services used for Pages Functions.

func (*ProjectDeploymentConfigsProductionServices) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionServicesParam

type ProjectDeploymentConfigsProductionServicesParam struct {
	// Service binding.
	ServiceBinding param.Field[ProjectDeploymentConfigsProductionServicesServiceBindingParam] `json:"SERVICE_BINDING"`
}

Services used for Pages Functions.

func (ProjectDeploymentConfigsProductionServicesParam) MarshalJSON

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

type ProjectDeploymentConfigsProductionServicesServiceBinding

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

Service binding.

func (*ProjectDeploymentConfigsProductionServicesServiceBinding) UnmarshalJSON

type ProjectDeploymentConfigsProductionServicesServiceBindingParam

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

Service binding.

func (ProjectDeploymentConfigsProductionServicesServiceBindingParam) MarshalJSON

type ProjectDeploymentConfigsProductionVectorizeBindings

type ProjectDeploymentConfigsProductionVectorizeBindings struct {
	// Vectorize binding.
	Vectorize ProjectDeploymentConfigsProductionVectorizeBindingsVectorize `json:"VECTORIZE"`
	JSON      projectDeploymentConfigsProductionVectorizeBindingsJSON      `json:"-"`
}

Vectorize bindings used for Pages Functions.

func (*ProjectDeploymentConfigsProductionVectorizeBindings) UnmarshalJSON

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

type ProjectDeploymentConfigsProductionVectorizeBindingsParam

type ProjectDeploymentConfigsProductionVectorizeBindingsParam struct {
	// Vectorize binding.
	Vectorize param.Field[ProjectDeploymentConfigsProductionVectorizeBindingsVectorizeParam] `json:"VECTORIZE"`
}

Vectorize bindings used for Pages Functions.

func (ProjectDeploymentConfigsProductionVectorizeBindingsParam) MarshalJSON

type ProjectDeploymentConfigsProductionVectorizeBindingsVectorize

type ProjectDeploymentConfigsProductionVectorizeBindingsVectorize struct {
	IndexName string                                                           `json:"index_name"`
	JSON      projectDeploymentConfigsProductionVectorizeBindingsVectorizeJSON `json:"-"`
}

Vectorize binding.

func (*ProjectDeploymentConfigsProductionVectorizeBindingsVectorize) UnmarshalJSON

type ProjectDeploymentConfigsProductionVectorizeBindingsVectorizeParam

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

Vectorize binding.

func (ProjectDeploymentConfigsProductionVectorizeBindingsVectorizeParam) MarshalJSON

type ProjectDeploymentDeleteParams

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

func (ProjectDeploymentDeleteParams) MarshalJSON

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

type ProjectDeploymentDeleteResponse

type ProjectDeploymentDeleteResponse = interface{}

type ProjectDeploymentGetParams

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

type ProjectDeploymentGetResponseEnvelope

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

func (*ProjectDeploymentGetResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentGetResponseEnvelopeSuccess

type ProjectDeploymentGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentGetResponseEnvelopeSuccessTrue ProjectDeploymentGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentHistoryLogGetParams

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

type ProjectDeploymentHistoryLogGetResponseArray

type ProjectDeploymentHistoryLogGetResponseArray []interface{}

func (ProjectDeploymentHistoryLogGetResponseArray) ImplementsPagesProjectDeploymentHistoryLogGetResponseUnion

func (r ProjectDeploymentHistoryLogGetResponseArray) ImplementsPagesProjectDeploymentHistoryLogGetResponseUnion()

type ProjectDeploymentHistoryLogGetResponseEnvelope

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

func (*ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessTrue ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = true
)

func (ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentHistoryLogGetResponseUnion

type ProjectDeploymentHistoryLogGetResponseUnion interface {
	ImplementsPagesProjectDeploymentHistoryLogGetResponseUnion()
}

Union satisfied by pages.ProjectDeploymentHistoryLogGetResponseUnknown, pages.ProjectDeploymentHistoryLogGetResponseArray or shared.UnionString.

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"`
}

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"`
	// The branch to build the new deployment from. The `HEAD` of the branch will be
	// used. If omitted, the production branch will be used by default.
	Branch param.Field[string] `json:"branch"`
}

func (ProjectDeploymentNewParams) MarshalJSON

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

type ProjectDeploymentNewResponseEnvelope

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

func (*ProjectDeploymentNewResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentNewResponseEnvelopeSuccess

type ProjectDeploymentNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentNewResponseEnvelopeSuccessTrue ProjectDeploymentNewResponseEnvelopeSuccess = true
)

func (ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentRetryParams

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

func (ProjectDeploymentRetryParams) MarshalJSON

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

type ProjectDeploymentRetryResponseEnvelope

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

func (*ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentRetryResponseEnvelopeSuccess

type ProjectDeploymentRetryResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentRetryResponseEnvelopeSuccessTrue ProjectDeploymentRetryResponseEnvelopeSuccess = true
)

func (ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown

type ProjectDeploymentRollbackParams

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

func (ProjectDeploymentRollbackParams) MarshalJSON

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

type ProjectDeploymentRollbackResponseEnvelope

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

func (*ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentRollbackResponseEnvelopeSuccess

type ProjectDeploymentRollbackResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	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, params ProjectDeploymentRetryParams, opts ...option.RequestOption) (res *Deployment, err error)

Retry a previous deployment.

func (*ProjectDeploymentService) Rollback

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

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

type ProjectDomainDeleteParams

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

func (ProjectDomainDeleteParams) MarshalJSON

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

type ProjectDomainDeleteResponse

type ProjectDomainDeleteResponse = interface{}

type ProjectDomainEditParams

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

func (ProjectDomainEditParams) MarshalJSON

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

type ProjectDomainEditResponseArray

type ProjectDomainEditResponseArray []interface{}

func (ProjectDomainEditResponseArray) ImplementsPagesProjectDomainEditResponseUnion

func (r ProjectDomainEditResponseArray) ImplementsPagesProjectDomainEditResponseUnion()

type ProjectDomainEditResponseEnvelope

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

func (*ProjectDomainEditResponseEnvelope) UnmarshalJSON

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

type ProjectDomainEditResponseEnvelopeSuccess

type ProjectDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainEditResponseEnvelopeSuccessTrue ProjectDomainEditResponseEnvelopeSuccess = true
)

func (ProjectDomainEditResponseEnvelopeSuccess) IsKnown

type ProjectDomainEditResponseUnion

type ProjectDomainEditResponseUnion interface {
	ImplementsPagesProjectDomainEditResponseUnion()
}

Union satisfied by pages.ProjectDomainEditResponseUnknown, pages.ProjectDomainEditResponseArray or shared.UnionString.

type ProjectDomainGetParams

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

type ProjectDomainGetResponseArray

type ProjectDomainGetResponseArray []interface{}

func (ProjectDomainGetResponseArray) ImplementsPagesProjectDomainGetResponseUnion

func (r ProjectDomainGetResponseArray) ImplementsPagesProjectDomainGetResponseUnion()

type ProjectDomainGetResponseEnvelope

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

func (*ProjectDomainGetResponseEnvelope) UnmarshalJSON

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

type ProjectDomainGetResponseEnvelopeSuccess

type ProjectDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainGetResponseEnvelopeSuccessTrue ProjectDomainGetResponseEnvelopeSuccess = true
)

func (ProjectDomainGetResponseEnvelopeSuccess) IsKnown

type ProjectDomainGetResponseUnion

type ProjectDomainGetResponseUnion interface {
	ImplementsPagesProjectDomainGetResponseUnion()
}

Union satisfied by pages.ProjectDomainGetResponseUnknown, pages.ProjectDomainGetResponseArray or shared.UnionString.

type ProjectDomainListParams

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

type ProjectDomainListResponse

type ProjectDomainListResponse = interface{}

type ProjectDomainNewParams

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

func (ProjectDomainNewParams) MarshalJSON

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

type ProjectDomainNewResponseArray

type ProjectDomainNewResponseArray []interface{}

func (ProjectDomainNewResponseArray) ImplementsPagesProjectDomainNewResponseUnion

func (r ProjectDomainNewResponseArray) ImplementsPagesProjectDomainNewResponseUnion()

type ProjectDomainNewResponseEnvelope

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

func (*ProjectDomainNewResponseEnvelope) UnmarshalJSON

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

type ProjectDomainNewResponseEnvelopeSuccess

type ProjectDomainNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainNewResponseEnvelopeSuccessTrue ProjectDomainNewResponseEnvelopeSuccess = true
)

func (ProjectDomainNewResponseEnvelopeSuccess) IsKnown

type ProjectDomainNewResponseUnion

type ProjectDomainNewResponseUnion interface {
	ImplementsPagesProjectDomainNewResponseUnion()
}

Union satisfied by pages.ProjectDomainNewResponseUnknown, pages.ProjectDomainNewResponseArray or shared.UnionString.

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, params ProjectDomainDeleteParams, opts ...option.RequestOption) (res *ProjectDomainDeleteResponse, err error)

Delete a Pages project's domain.

func (*ProjectDomainService) Edit

func (r *ProjectDomainService) Edit(ctx context.Context, projectName string, domainName string, params ProjectDomainEditParams, opts ...option.RequestOption) (res *ProjectDomainEditResponseUnion, 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 *ProjectDomainGetResponseUnion, 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"`
	Body      interface{}         `json:"body,required"`
}

func (ProjectEditParams) MarshalJSON

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

type ProjectEditResponseArray

type ProjectEditResponseArray []interface{}

func (ProjectEditResponseArray) ImplementsPagesProjectEditResponseUnion

func (r ProjectEditResponseArray) ImplementsPagesProjectEditResponseUnion()

type ProjectEditResponseEnvelope

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

func (*ProjectEditResponseEnvelope) UnmarshalJSON

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

type ProjectEditResponseEnvelopeSuccess

type ProjectEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectEditResponseEnvelopeSuccessTrue ProjectEditResponseEnvelopeSuccess = true
)

func (ProjectEditResponseEnvelopeSuccess) IsKnown

type ProjectEditResponseUnion

type ProjectEditResponseUnion interface {
	ImplementsPagesProjectEditResponseUnion()
}

Union satisfied by pages.ProjectEditResponseUnknown, pages.ProjectEditResponseArray or shared.UnionString.

type ProjectGetParams

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

type ProjectGetResponseEnvelope

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

func (*ProjectGetResponseEnvelope) UnmarshalJSON

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

type ProjectGetResponseEnvelopeSuccess

type ProjectGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectGetResponseEnvelopeSuccessTrue ProjectGetResponseEnvelopeSuccess = true
)

func (ProjectGetResponseEnvelopeSuccess) IsKnown

type ProjectListParams

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

type ProjectNewParams

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

func (ProjectNewParams) MarshalJSON

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

type ProjectNewResponseArray

type ProjectNewResponseArray []interface{}

func (ProjectNewResponseArray) ImplementsPagesProjectNewResponseUnion

func (r ProjectNewResponseArray) ImplementsPagesProjectNewResponseUnion()

type ProjectNewResponseEnvelope

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

func (*ProjectNewResponseEnvelope) UnmarshalJSON

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

type ProjectNewResponseEnvelopeSuccess

type ProjectNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectNewResponseEnvelopeSuccessTrue ProjectNewResponseEnvelopeSuccess = true
)

func (ProjectNewResponseEnvelopeSuccess) IsKnown

type ProjectNewResponseUnion

type ProjectNewResponseUnion interface {
	ImplementsPagesProjectNewResponseUnion()
}

Union satisfied by pages.ProjectNewResponseUnknown, pages.ProjectNewResponseArray or shared.UnionString.

type ProjectParam

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

func (ProjectParam) MarshalJSON

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

type ProjectPurgeBuildCacheParams

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

type ProjectPurgeBuildCacheResponse

type ProjectPurgeBuildCacheResponse = interface{}

type 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, params 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 *ProjectEditResponseUnion, 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

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type Stage

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

The status of the deployment.

func (*Stage) UnmarshalJSON

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

type StageParam

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

The status of the deployment.

func (StageParam) MarshalJSON

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

Jump to

Keyboard shortcuts

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