pages

package
v2.0.0-beta.5 Latest Latest
Warning

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

Go to latest
Published: Mar 13, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Error

type Error = apierror.Error

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 PagesDeployments

type PagesDeployments 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 PagesDeploymentsDeploymentTrigger `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 []PagesDeploymentsStage `json:"stages"`
	// The live URL to view this deployment.
	URL  string               `json:"url"`
	JSON pagesDeploymentsJSON `json:"-"`
}

func (*PagesDeployments) UnmarshalJSON

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

type PagesDeploymentsDeploymentTrigger

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

Info about what caused the deployment.

func (*PagesDeploymentsDeploymentTrigger) UnmarshalJSON

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

type PagesDeploymentsDeploymentTriggerMetadata

type PagesDeploymentsDeploymentTriggerMetadata 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          pagesDeploymentsDeploymentTriggerMetadataJSON `json:"-"`
}

Additional info about the trigger.

func (*PagesDeploymentsDeploymentTriggerMetadata) UnmarshalJSON

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

type PagesDeploymentsDeploymentTriggerMetadataParam

type PagesDeploymentsDeploymentTriggerMetadataParam struct {
}

Additional info about the trigger.

func (PagesDeploymentsDeploymentTriggerMetadataParam) MarshalJSON

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

type PagesDeploymentsDeploymentTriggerParam

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

Info about what caused the deployment.

func (PagesDeploymentsDeploymentTriggerParam) MarshalJSON

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

type PagesDeploymentsParam

type PagesDeploymentsParam struct {
}

func (PagesDeploymentsParam) MarshalJSON

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

type PagesDeploymentsStage

type PagesDeploymentsStage 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   pagesDeploymentsStageJSON `json:"-"`
}

The status of the deployment.

func (*PagesDeploymentsStage) UnmarshalJSON

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

type PagesDeploymentsStageParam

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

The status of the deployment.

func (PagesDeploymentsStageParam) MarshalJSON

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

type PagesProjects

type PagesProjects struct {
	// Id of the project.
	ID string `json:"id"`
	// Configs for the project build process.
	BuildConfig         PagesProjectsBuildConfig `json:"build_config"`
	CanonicalDeployment PagesDeployments         `json:"canonical_deployment"`
	// When the project was created.
	CreatedOn time.Time `json:"created_on" format:"date-time"`
	// Configs for deployments in a project.
	DeploymentConfigs PagesProjectsDeploymentConfigs `json:"deployment_configs"`
	// A list of associated custom domains for the project.
	Domains          []interface{}    `json:"domains"`
	LatestDeployment PagesDeployments `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      pagesProjectsJSON `json:"-"`
}

func (*PagesProjects) UnmarshalJSON

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

type PagesProjectsBuildConfig

type PagesProjectsBuildConfig 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              pagesProjectsBuildConfigJSON `json:"-"`
}

Configs for the project build process.

func (*PagesProjectsBuildConfig) UnmarshalJSON

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

type PagesProjectsDeploymentConfigs

type PagesProjectsDeploymentConfigs struct {
	// Configs for preview deploys.
	Preview PagesProjectsDeploymentConfigsPreview `json:"preview"`
	// Configs for production deploys.
	Production PagesProjectsDeploymentConfigsProduction `json:"production"`
	JSON       pagesProjectsDeploymentConfigsJSON       `json:"-"`
}

Configs for deployments in a project.

func (*PagesProjectsDeploymentConfigs) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreview

type PagesProjectsDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings PagesProjectsDeploymentConfigsPreviewAIBindings `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasets `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers PagesProjectsDeploymentConfigsPreviewBrowsers `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 PagesProjectsDeploymentConfigsPreviewD1Databases `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces PagesProjectsDeploymentConfigsPreviewDurableObjectNamespaces `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars PagesProjectsDeploymentConfigsPreviewEnvVars `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings PagesProjectsDeploymentConfigsPreviewHyperdriveBindings `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces PagesProjectsDeploymentConfigsPreviewKVNamespaces `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates PagesProjectsDeploymentConfigsPreviewMTLSCertificates `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement PagesProjectsDeploymentConfigsPreviewPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers PagesProjectsDeploymentConfigsPreviewQueueProducers `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets PagesProjectsDeploymentConfigsPreviewR2Buckets `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services PagesProjectsDeploymentConfigsPreviewServices `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings PagesProjectsDeploymentConfigsPreviewVectorizeBindings `json:"vectorize_bindings,nullable"`
	JSON              pagesProjectsDeploymentConfigsPreviewJSON              `json:"-"`
}

Configs for preview deploys.

func (*PagesProjectsDeploymentConfigsPreview) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewAIBindings

type PagesProjectsDeploymentConfigsPreviewAIBindings struct {
	// AI binding.
	AIBinding PagesProjectsDeploymentConfigsPreviewAIBindingsAIBinding `json:"AI_BINDING"`
	JSON      pagesProjectsDeploymentConfigsPreviewAIBindingsJSON      `json:"-"`
}

Constellation bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewAIBindings) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewAIBindingsAIBinding

type PagesProjectsDeploymentConfigsPreviewAIBindingsAIBinding struct {
	ProjectID interface{}                                                  `json:"project_id"`
	JSON      pagesProjectsDeploymentConfigsPreviewAIBindingsAIBindingJSON `json:"-"`
}

AI binding.

func (*PagesProjectsDeploymentConfigsPreviewAIBindingsAIBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasets

type PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding `json:"ANALYTICS_ENGINE_BINDING"`
	JSON                   pagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasetsJSON                   `json:"-"`
}

Analytics Engine bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasets) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (*PagesProjectsDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewBrowsers

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

Browser bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewBrowsers) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewD1Databases

type PagesProjectsDeploymentConfigsPreviewD1Databases struct {
	// D1 binding.
	D1Binding PagesProjectsDeploymentConfigsPreviewD1DatabasesD1Binding `json:"D1_BINDING"`
	JSON      pagesProjectsDeploymentConfigsPreviewD1DatabasesJSON      `json:"-"`
}

D1 databases used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewD1Databases) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewD1DatabasesD1Binding

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

D1 binding.

func (*PagesProjectsDeploymentConfigsPreviewD1DatabasesD1Binding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewDurableObjectNamespaces

type PagesProjectsDeploymentConfigsPreviewDurableObjectNamespaces struct {
	// Durabble Object binding.
	DoBinding PagesProjectsDeploymentConfigsPreviewDurableObjectNamespacesDoBinding `json:"DO_BINDING"`
	JSON      pagesProjectsDeploymentConfigsPreviewDurableObjectNamespacesJSON      `json:"-"`
}

Durabble Object namespaces used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewDurableObjectNamespaces) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (*PagesProjectsDeploymentConfigsPreviewDurableObjectNamespacesDoBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewEnvVars

type PagesProjectsDeploymentConfigsPreviewEnvVars struct {
	// Environment variable.
	EnvironmentVariable PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariable `json:"ENVIRONMENT_VARIABLE"`
	JSON                pagesProjectsDeploymentConfigsPreviewEnvVarsJSON                `json:"-"`
}

Environment variables for build configs.

func (*PagesProjectsDeploymentConfigsPreviewEnvVars) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariable

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

Environment variable.

func (*PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariable) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType

type PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypePlainText  PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "plain_text"
	PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypeSecretText PagesProjectsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "secret_text"
)

type PagesProjectsDeploymentConfigsPreviewHyperdriveBindings

type PagesProjectsDeploymentConfigsPreviewHyperdriveBindings struct {
	// Hyperdrive binding.
	Hyperdrive PagesProjectsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive `json:"HYPERDRIVE"`
	JSON       pagesProjectsDeploymentConfigsPreviewHyperdriveBindingsJSON       `json:"-"`
}

Hyperdrive bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewHyperdriveBindings) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive

type PagesProjectsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive struct {
	ID   string                                                                `json:"id"`
	JSON pagesProjectsDeploymentConfigsPreviewHyperdriveBindingsHyperdriveJSON `json:"-"`
}

Hyperdrive binding.

func (*PagesProjectsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewKVNamespaces

type PagesProjectsDeploymentConfigsPreviewKVNamespaces struct {
	// KV binding.
	KVBinding PagesProjectsDeploymentConfigsPreviewKVNamespacesKVBinding `json:"KV_BINDING"`
	JSON      pagesProjectsDeploymentConfigsPreviewKVNamespacesJSON      `json:"-"`
}

KV namespaces used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewKVNamespaces) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewKVNamespacesKVBinding

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

KV binding.

func (*PagesProjectsDeploymentConfigsPreviewKVNamespacesKVBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewMTLSCertificates

type PagesProjectsDeploymentConfigsPreviewMTLSCertificates struct {
	// mTLS binding.
	MTLS PagesProjectsDeploymentConfigsPreviewMTLSCertificatesMTLS `json:"MTLS"`
	JSON pagesProjectsDeploymentConfigsPreviewMTLSCertificatesJSON `json:"-"`
}

mTLS bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewMTLSCertificates) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewMTLSCertificatesMTLS

type PagesProjectsDeploymentConfigsPreviewMTLSCertificatesMTLS struct {
	CertificateID string                                                        `json:"certificate_id"`
	JSON          pagesProjectsDeploymentConfigsPreviewMTLSCertificatesMTLSJSON `json:"-"`
}

mTLS binding.

func (*PagesProjectsDeploymentConfigsPreviewMTLSCertificatesMTLS) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewPlacement

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

Placement setting used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewPlacement) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewQueueProducers

type PagesProjectsDeploymentConfigsPreviewQueueProducers struct {
	// Queue Producer binding.
	QueueProducerBinding PagesProjectsDeploymentConfigsPreviewQueueProducersQueueProducerBinding `json:"QUEUE_PRODUCER_BINDING"`
	JSON                 pagesProjectsDeploymentConfigsPreviewQueueProducersJSON                 `json:"-"`
}

Queue Producer bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewQueueProducers) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (*PagesProjectsDeploymentConfigsPreviewQueueProducersQueueProducerBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewR2Buckets

type PagesProjectsDeploymentConfigsPreviewR2Buckets struct {
	// R2 binding.
	R2Binding PagesProjectsDeploymentConfigsPreviewR2BucketsR2Binding `json:"R2_BINDING"`
	JSON      pagesProjectsDeploymentConfigsPreviewR2BucketsJSON      `json:"-"`
}

R2 buckets used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewR2Buckets) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewR2BucketsR2Binding

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

R2 binding.

func (*PagesProjectsDeploymentConfigsPreviewR2BucketsR2Binding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewServices

type PagesProjectsDeploymentConfigsPreviewServices struct {
	// Service binding.
	ServiceBinding PagesProjectsDeploymentConfigsPreviewServicesServiceBinding `json:"SERVICE_BINDING"`
	JSON           pagesProjectsDeploymentConfigsPreviewServicesJSON           `json:"-"`
}

Services used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewServices) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewServicesServiceBinding

type PagesProjectsDeploymentConfigsPreviewServicesServiceBinding struct {
	// The Service environment.
	Environment string `json:"environment"`
	// The Service name.
	Service string                                                          `json:"service"`
	JSON    pagesProjectsDeploymentConfigsPreviewServicesServiceBindingJSON `json:"-"`
}

Service binding.

func (*PagesProjectsDeploymentConfigsPreviewServicesServiceBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsPreviewVectorizeBindings

type PagesProjectsDeploymentConfigsPreviewVectorizeBindings struct {
	// Vectorize binding.
	Vectorize PagesProjectsDeploymentConfigsPreviewVectorizeBindingsVectorize `json:"VECTORIZE"`
	JSON      pagesProjectsDeploymentConfigsPreviewVectorizeBindingsJSON      `json:"-"`
}

Vectorize bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsPreviewVectorizeBindings) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsPreviewVectorizeBindingsVectorize

type PagesProjectsDeploymentConfigsPreviewVectorizeBindingsVectorize struct {
	IndexName string                                                              `json:"index_name"`
	JSON      pagesProjectsDeploymentConfigsPreviewVectorizeBindingsVectorizeJSON `json:"-"`
}

Vectorize binding.

func (*PagesProjectsDeploymentConfigsPreviewVectorizeBindingsVectorize) UnmarshalJSON

type PagesProjectsDeploymentConfigsProduction

type PagesProjectsDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings PagesProjectsDeploymentConfigsProductionAIBindings `json:"ai_bindings,nullable"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasets `json:"analytics_engine_datasets,nullable"`
	// Browser bindings used for Pages Functions.
	Browsers PagesProjectsDeploymentConfigsProductionBrowsers `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 PagesProjectsDeploymentConfigsProductionD1Databases `json:"d1_databases,nullable"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces PagesProjectsDeploymentConfigsProductionDurableObjectNamespaces `json:"durable_object_namespaces,nullable"`
	// Environment variables for build configs.
	EnvVars PagesProjectsDeploymentConfigsProductionEnvVars `json:"env_vars,nullable"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings PagesProjectsDeploymentConfigsProductionHyperdriveBindings `json:"hyperdrive_bindings,nullable"`
	// KV namespaces used for Pages Functions.
	KVNamespaces PagesProjectsDeploymentConfigsProductionKVNamespaces `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates PagesProjectsDeploymentConfigsProductionMTLSCertificates `json:"mtls_certificates,nullable"`
	// Placement setting used for Pages Functions.
	Placement PagesProjectsDeploymentConfigsProductionPlacement `json:"placement,nullable"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers PagesProjectsDeploymentConfigsProductionQueueProducers `json:"queue_producers,nullable"`
	// R2 buckets used for Pages Functions.
	R2Buckets PagesProjectsDeploymentConfigsProductionR2Buckets `json:"r2_buckets,nullable"`
	// Services used for Pages Functions.
	Services PagesProjectsDeploymentConfigsProductionServices `json:"services,nullable"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings PagesProjectsDeploymentConfigsProductionVectorizeBindings `json:"vectorize_bindings,nullable"`
	JSON              pagesProjectsDeploymentConfigsProductionJSON              `json:"-"`
}

Configs for production deploys.

func (*PagesProjectsDeploymentConfigsProduction) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionAIBindings

type PagesProjectsDeploymentConfigsProductionAIBindings struct {
	// AI binding.
	AIBinding PagesProjectsDeploymentConfigsProductionAIBindingsAIBinding `json:"AI_BINDING"`
	JSON      pagesProjectsDeploymentConfigsProductionAIBindingsJSON      `json:"-"`
}

Constellation bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionAIBindings) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionAIBindingsAIBinding

type PagesProjectsDeploymentConfigsProductionAIBindingsAIBinding struct {
	ProjectID interface{}                                                     `json:"project_id"`
	JSON      pagesProjectsDeploymentConfigsProductionAIBindingsAIBindingJSON `json:"-"`
}

AI binding.

func (*PagesProjectsDeploymentConfigsProductionAIBindingsAIBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasets

type PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasets struct {
	// Analytics Engine binding.
	AnalyticsEngineBinding PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding `json:"ANALYTICS_ENGINE_BINDING"`
	JSON                   pagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasetsJSON                   `json:"-"`
}

Analytics Engine bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasets) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (*PagesProjectsDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionBrowsers

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

Browser bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionBrowsers) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionD1Databases

type PagesProjectsDeploymentConfigsProductionD1Databases struct {
	// D1 binding.
	D1Binding PagesProjectsDeploymentConfigsProductionD1DatabasesD1Binding `json:"D1_BINDING"`
	JSON      pagesProjectsDeploymentConfigsProductionD1DatabasesJSON      `json:"-"`
}

D1 databases used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionD1Databases) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionD1DatabasesD1Binding

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

D1 binding.

func (*PagesProjectsDeploymentConfigsProductionD1DatabasesD1Binding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionDurableObjectNamespaces

type PagesProjectsDeploymentConfigsProductionDurableObjectNamespaces struct {
	// Durabble Object binding.
	DoBinding PagesProjectsDeploymentConfigsProductionDurableObjectNamespacesDoBinding `json:"DO_BINDING"`
	JSON      pagesProjectsDeploymentConfigsProductionDurableObjectNamespacesJSON      `json:"-"`
}

Durabble Object namespaces used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionDurableObjectNamespaces) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (*PagesProjectsDeploymentConfigsProductionDurableObjectNamespacesDoBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionEnvVars

type PagesProjectsDeploymentConfigsProductionEnvVars struct {
	// Environment variable.
	EnvironmentVariable PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariable `json:"ENVIRONMENT_VARIABLE"`
	JSON                pagesProjectsDeploymentConfigsProductionEnvVarsJSON                `json:"-"`
}

Environment variables for build configs.

func (*PagesProjectsDeploymentConfigsProductionEnvVars) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariable

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

Environment variable.

func (*PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariable) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableType

type PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableTypePlainText  PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "plain_text"
	PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableTypeSecretText PagesProjectsDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "secret_text"
)

type PagesProjectsDeploymentConfigsProductionHyperdriveBindings

type PagesProjectsDeploymentConfigsProductionHyperdriveBindings struct {
	// Hyperdrive binding.
	Hyperdrive PagesProjectsDeploymentConfigsProductionHyperdriveBindingsHyperdrive `json:"HYPERDRIVE"`
	JSON       pagesProjectsDeploymentConfigsProductionHyperdriveBindingsJSON       `json:"-"`
}

Hyperdrive bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionHyperdriveBindings) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionHyperdriveBindingsHyperdrive

type PagesProjectsDeploymentConfigsProductionHyperdriveBindingsHyperdrive struct {
	ID   string                                                                   `json:"id"`
	JSON pagesProjectsDeploymentConfigsProductionHyperdriveBindingsHyperdriveJSON `json:"-"`
}

Hyperdrive binding.

func (*PagesProjectsDeploymentConfigsProductionHyperdriveBindingsHyperdrive) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionKVNamespaces

type PagesProjectsDeploymentConfigsProductionKVNamespaces struct {
	// KV binding.
	KVBinding PagesProjectsDeploymentConfigsProductionKVNamespacesKVBinding `json:"KV_BINDING"`
	JSON      pagesProjectsDeploymentConfigsProductionKVNamespacesJSON      `json:"-"`
}

KV namespaces used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionKVNamespaces) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionKVNamespacesKVBinding

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

KV binding.

func (*PagesProjectsDeploymentConfigsProductionKVNamespacesKVBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionMTLSCertificates

type PagesProjectsDeploymentConfigsProductionMTLSCertificates struct {
	// mTLS binding.
	MTLS PagesProjectsDeploymentConfigsProductionMTLSCertificatesMTLS `json:"MTLS"`
	JSON pagesProjectsDeploymentConfigsProductionMTLSCertificatesJSON `json:"-"`
}

mTLS bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionMTLSCertificates) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionMTLSCertificatesMTLS

type PagesProjectsDeploymentConfigsProductionMTLSCertificatesMTLS struct {
	CertificateID string                                                           `json:"certificate_id"`
	JSON          pagesProjectsDeploymentConfigsProductionMTLSCertificatesMTLSJSON `json:"-"`
}

mTLS binding.

func (*PagesProjectsDeploymentConfigsProductionMTLSCertificatesMTLS) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionPlacement

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

Placement setting used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionPlacement) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionQueueProducers

type PagesProjectsDeploymentConfigsProductionQueueProducers struct {
	// Queue Producer binding.
	QueueProducerBinding PagesProjectsDeploymentConfigsProductionQueueProducersQueueProducerBinding `json:"QUEUE_PRODUCER_BINDING"`
	JSON                 pagesProjectsDeploymentConfigsProductionQueueProducersJSON                 `json:"-"`
}

Queue Producer bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionQueueProducers) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (*PagesProjectsDeploymentConfigsProductionQueueProducersQueueProducerBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionR2Buckets

type PagesProjectsDeploymentConfigsProductionR2Buckets struct {
	// R2 binding.
	R2Binding PagesProjectsDeploymentConfigsProductionR2BucketsR2Binding `json:"R2_BINDING"`
	JSON      pagesProjectsDeploymentConfigsProductionR2BucketsJSON      `json:"-"`
}

R2 buckets used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionR2Buckets) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionR2BucketsR2Binding

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

R2 binding.

func (*PagesProjectsDeploymentConfigsProductionR2BucketsR2Binding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionServices

type PagesProjectsDeploymentConfigsProductionServices struct {
	// Service binding.
	ServiceBinding PagesProjectsDeploymentConfigsProductionServicesServiceBinding `json:"SERVICE_BINDING"`
	JSON           pagesProjectsDeploymentConfigsProductionServicesJSON           `json:"-"`
}

Services used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionServices) UnmarshalJSON

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

type PagesProjectsDeploymentConfigsProductionServicesServiceBinding

type PagesProjectsDeploymentConfigsProductionServicesServiceBinding struct {
	// The Service environment.
	Environment string `json:"environment"`
	// The Service name.
	Service string                                                             `json:"service"`
	JSON    pagesProjectsDeploymentConfigsProductionServicesServiceBindingJSON `json:"-"`
}

Service binding.

func (*PagesProjectsDeploymentConfigsProductionServicesServiceBinding) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionVectorizeBindings

type PagesProjectsDeploymentConfigsProductionVectorizeBindings struct {
	// Vectorize binding.
	Vectorize PagesProjectsDeploymentConfigsProductionVectorizeBindingsVectorize `json:"VECTORIZE"`
	JSON      pagesProjectsDeploymentConfigsProductionVectorizeBindingsJSON      `json:"-"`
}

Vectorize bindings used for Pages Functions.

func (*PagesProjectsDeploymentConfigsProductionVectorizeBindings) UnmarshalJSON

type PagesProjectsDeploymentConfigsProductionVectorizeBindingsVectorize

type PagesProjectsDeploymentConfigsProductionVectorizeBindingsVectorize struct {
	IndexName string                                                                 `json:"index_name"`
	JSON      pagesProjectsDeploymentConfigsProductionVectorizeBindingsVectorizeJSON `json:"-"`
}

Vectorize binding.

func (*PagesProjectsDeploymentConfigsProductionVectorizeBindingsVectorize) UnmarshalJSON

type ProjectDeleteParams

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

type ProjectDeleteResponse

type ProjectDeleteResponse = interface{}

type ProjectDeploymentDeleteParams

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

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   []ProjectDeploymentGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentGetResponseEnvelopeMessages `json:"messages,required"`
	Result   PagesDeployments                               `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentGetResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentGetResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentGetResponseEnvelopeErrors

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

func (*ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentGetResponseEnvelopeMessages

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

func (*ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentGetResponseEnvelopeSuccess

type ProjectDeploymentGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentGetResponseEnvelopeSuccessTrue ProjectDeploymentGetResponseEnvelopeSuccess = true
)

type ProjectDeploymentHistoryLogGetParams

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

type ProjectDeploymentHistoryLogGetResponse

type ProjectDeploymentHistoryLogGetResponse interface {
	ImplementsPagesProjectDeploymentHistoryLogGetResponse()
}

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

type ProjectDeploymentHistoryLogGetResponseArray

type ProjectDeploymentHistoryLogGetResponseArray []interface{}

func (ProjectDeploymentHistoryLogGetResponseArray) ImplementsPagesProjectDeploymentHistoryLogGetResponse

func (r ProjectDeploymentHistoryLogGetResponseArray) ImplementsPagesProjectDeploymentHistoryLogGetResponse()

type ProjectDeploymentHistoryLogGetResponseEnvelope

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

func (*ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors

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

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages

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

func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess

type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessTrue ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = true
)

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

type ProjectDeploymentListResponseEnvelope

type ProjectDeploymentListResponseEnvelope struct {
	Errors   []ProjectDeploymentListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentListResponseEnvelopeMessages `json:"messages,required"`
	Result   []PagesDeployments                              `json:"result,required"`
	// Whether the API call was successful
	Success    ProjectDeploymentListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo ProjectDeploymentListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       projectDeploymentListResponseEnvelopeJSON       `json:"-"`
}

func (*ProjectDeploymentListResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentListResponseEnvelopeErrors

type ProjectDeploymentListResponseEnvelopeErrors struct {
	Code    int64                                           `json:"code,required"`
	Message string                                          `json:"message,required"`
	JSON    projectDeploymentListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ProjectDeploymentListResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentListResponseEnvelopeMessages

type ProjectDeploymentListResponseEnvelopeMessages struct {
	Code    int64                                             `json:"code,required"`
	Message string                                            `json:"message,required"`
	JSON    projectDeploymentListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ProjectDeploymentListResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentListResponseEnvelopeResultInfo

type ProjectDeploymentListResponseEnvelopeResultInfo struct {
	Count      interface{}                                         `json:"count"`
	Page       interface{}                                         `json:"page"`
	PerPage    interface{}                                         `json:"per_page"`
	TotalCount interface{}                                         `json:"total_count"`
	JSON       projectDeploymentListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*ProjectDeploymentListResponseEnvelopeResultInfo) UnmarshalJSON

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

type ProjectDeploymentListResponseEnvelopeSuccess

type ProjectDeploymentListResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentListResponseEnvelopeSuccessTrue ProjectDeploymentListResponseEnvelopeSuccess = true
)

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   []ProjectDeploymentNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDeploymentNewResponseEnvelopeMessages `json:"messages,required"`
	Result   PagesDeployments                               `json:"result,required"`
	// Whether the API call was successful
	Success ProjectDeploymentNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    projectDeploymentNewResponseEnvelopeJSON    `json:"-"`
}

func (*ProjectDeploymentNewResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentNewResponseEnvelopeErrors

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

func (*ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentNewResponseEnvelopeMessages

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

func (*ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentNewResponseEnvelopeSuccess

type ProjectDeploymentNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentNewResponseEnvelopeSuccessTrue ProjectDeploymentNewResponseEnvelopeSuccess = true
)

type ProjectDeploymentRetryParams

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

type ProjectDeploymentRetryResponseEnvelope

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

func (*ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentRetryResponseEnvelopeErrors

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

func (*ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentRetryResponseEnvelopeMessages

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

func (*ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentRetryResponseEnvelopeSuccess

type ProjectDeploymentRetryResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentRetryResponseEnvelopeSuccessTrue ProjectDeploymentRetryResponseEnvelopeSuccess = true
)

type ProjectDeploymentRollbackParams

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

type ProjectDeploymentRollbackResponseEnvelope

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

func (*ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON

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

type ProjectDeploymentRollbackResponseEnvelopeErrors

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

func (*ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDeploymentRollbackResponseEnvelopeMessages

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

func (*ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDeploymentRollbackResponseEnvelopeSuccess

type ProjectDeploymentRollbackResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDeploymentRollbackResponseEnvelopeSuccessTrue ProjectDeploymentRollbackResponseEnvelopeSuccess = true
)

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 *PagesDeployments, err error)

Fetch information about a deployment.

func (*ProjectDeploymentService) List

Fetch a list of project deployments.

func (*ProjectDeploymentService) New

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

func (*ProjectDeploymentService) Retry

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

Retry a previous deployment.

func (*ProjectDeploymentService) Rollback

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

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

type ProjectDomainDeleteParams

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

type ProjectDomainDeleteResponse

type ProjectDomainDeleteResponse = interface{}

type ProjectDomainEditParams

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

type ProjectDomainEditResponse

type ProjectDomainEditResponse interface {
	ImplementsPagesProjectDomainEditResponse()
}

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

type ProjectDomainEditResponseArray

type ProjectDomainEditResponseArray []interface{}

func (ProjectDomainEditResponseArray) ImplementsPagesProjectDomainEditResponse

func (r ProjectDomainEditResponseArray) ImplementsPagesProjectDomainEditResponse()

type ProjectDomainEditResponseEnvelope

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

func (*ProjectDomainEditResponseEnvelope) UnmarshalJSON

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

type ProjectDomainEditResponseEnvelopeErrors

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

func (*ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDomainEditResponseEnvelopeMessages

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

func (*ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDomainEditResponseEnvelopeSuccess

type ProjectDomainEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainEditResponseEnvelopeSuccessTrue ProjectDomainEditResponseEnvelopeSuccess = true
)

type ProjectDomainGetParams

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

type ProjectDomainGetResponse

type ProjectDomainGetResponse interface {
	ImplementsPagesProjectDomainGetResponse()
}

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

type ProjectDomainGetResponseArray

type ProjectDomainGetResponseArray []interface{}

func (ProjectDomainGetResponseArray) ImplementsPagesProjectDomainGetResponse

func (r ProjectDomainGetResponseArray) ImplementsPagesProjectDomainGetResponse()

type ProjectDomainGetResponseEnvelope

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

func (*ProjectDomainGetResponseEnvelope) UnmarshalJSON

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

type ProjectDomainGetResponseEnvelopeErrors

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

func (*ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDomainGetResponseEnvelopeMessages

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

func (*ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDomainGetResponseEnvelopeSuccess

type ProjectDomainGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainGetResponseEnvelopeSuccessTrue ProjectDomainGetResponseEnvelopeSuccess = true
)

type ProjectDomainListParams

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

type ProjectDomainListResponse

type ProjectDomainListResponse = interface{}

type ProjectDomainListResponseEnvelope

type ProjectDomainListResponseEnvelope struct {
	Errors   []ProjectDomainListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectDomainListResponseEnvelopeMessages `json:"messages,required"`
	Result   []ProjectDomainListResponse                 `json:"result,required"`
	// Whether the API call was successful
	Success    ProjectDomainListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo ProjectDomainListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       projectDomainListResponseEnvelopeJSON       `json:"-"`
}

func (*ProjectDomainListResponseEnvelope) UnmarshalJSON

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

type ProjectDomainListResponseEnvelopeErrors

type ProjectDomainListResponseEnvelopeErrors struct {
	Code    int64                                       `json:"code,required"`
	Message string                                      `json:"message,required"`
	JSON    projectDomainListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ProjectDomainListResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDomainListResponseEnvelopeMessages

type ProjectDomainListResponseEnvelopeMessages struct {
	Code    int64                                         `json:"code,required"`
	Message string                                        `json:"message,required"`
	JSON    projectDomainListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ProjectDomainListResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDomainListResponseEnvelopeResultInfo

type ProjectDomainListResponseEnvelopeResultInfo struct {
	Count      interface{}                                     `json:"count"`
	Page       interface{}                                     `json:"page"`
	PerPage    interface{}                                     `json:"per_page"`
	TotalCount interface{}                                     `json:"total_count"`
	JSON       projectDomainListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*ProjectDomainListResponseEnvelopeResultInfo) UnmarshalJSON

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

type ProjectDomainListResponseEnvelopeSuccess

type ProjectDomainListResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainListResponseEnvelopeSuccessTrue ProjectDomainListResponseEnvelopeSuccess = true
)

type ProjectDomainNewParams

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

func (ProjectDomainNewParams) MarshalJSON

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

type ProjectDomainNewResponse

type ProjectDomainNewResponse interface {
	ImplementsPagesProjectDomainNewResponse()
}

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

type ProjectDomainNewResponseArray

type ProjectDomainNewResponseArray []interface{}

func (ProjectDomainNewResponseArray) ImplementsPagesProjectDomainNewResponse

func (r ProjectDomainNewResponseArray) ImplementsPagesProjectDomainNewResponse()

type ProjectDomainNewResponseEnvelope

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

func (*ProjectDomainNewResponseEnvelope) UnmarshalJSON

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

type ProjectDomainNewResponseEnvelopeErrors

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

func (*ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectDomainNewResponseEnvelopeMessages

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

func (*ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectDomainNewResponseEnvelopeSuccess

type ProjectDomainNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectDomainNewResponseEnvelopeSuccessTrue ProjectDomainNewResponseEnvelopeSuccess = true
)

type ProjectDomainService

type ProjectDomainService struct {
	Options []option.RequestOption
}

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

func NewProjectDomainService

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

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

func (*ProjectDomainService) Delete

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

Delete a Pages project's domain.

func (*ProjectDomainService) Edit

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

Retry the validation status of a single domain.

func (*ProjectDomainService) Get

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

Fetch a single domain.

func (*ProjectDomainService) List

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

func (*ProjectDomainService) New

Add a new domain for the Pages project.

type ProjectEditParams

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

func (ProjectEditParams) MarshalJSON

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

type ProjectEditResponse

type ProjectEditResponse interface {
	ImplementsPagesProjectEditResponse()
}

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

type ProjectEditResponseArray

type ProjectEditResponseArray []interface{}

func (ProjectEditResponseArray) ImplementsPagesProjectEditResponse

func (r ProjectEditResponseArray) ImplementsPagesProjectEditResponse()

type ProjectEditResponseEnvelope

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

func (*ProjectEditResponseEnvelope) UnmarshalJSON

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

type ProjectEditResponseEnvelopeErrors

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

func (*ProjectEditResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectEditResponseEnvelopeMessages

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

func (*ProjectEditResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectEditResponseEnvelopeSuccess

type ProjectEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectEditResponseEnvelopeSuccessTrue ProjectEditResponseEnvelopeSuccess = true
)

type ProjectGetParams

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

type ProjectGetResponseEnvelope

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

func (*ProjectGetResponseEnvelope) UnmarshalJSON

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

type ProjectGetResponseEnvelopeErrors

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

func (*ProjectGetResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectGetResponseEnvelopeMessages

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

func (*ProjectGetResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectGetResponseEnvelopeSuccess

type ProjectGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectGetResponseEnvelopeSuccessTrue ProjectGetResponseEnvelopeSuccess = true
)

type ProjectListParams

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

type ProjectListResponseEnvelope

type ProjectListResponseEnvelope struct {
	Errors   []ProjectListResponseEnvelopeErrors   `json:"errors,required"`
	Messages []ProjectListResponseEnvelopeMessages `json:"messages,required"`
	Result   []PagesDeployments                    `json:"result,required"`
	// Whether the API call was successful
	Success    ProjectListResponseEnvelopeSuccess    `json:"success,required"`
	ResultInfo ProjectListResponseEnvelopeResultInfo `json:"result_info"`
	JSON       projectListResponseEnvelopeJSON       `json:"-"`
}

func (*ProjectListResponseEnvelope) UnmarshalJSON

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

type ProjectListResponseEnvelopeErrors

type ProjectListResponseEnvelopeErrors struct {
	Code    int64                                 `json:"code,required"`
	Message string                                `json:"message,required"`
	JSON    projectListResponseEnvelopeErrorsJSON `json:"-"`
}

func (*ProjectListResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectListResponseEnvelopeMessages

type ProjectListResponseEnvelopeMessages struct {
	Code    int64                                   `json:"code,required"`
	Message string                                  `json:"message,required"`
	JSON    projectListResponseEnvelopeMessagesJSON `json:"-"`
}

func (*ProjectListResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectListResponseEnvelopeResultInfo

type ProjectListResponseEnvelopeResultInfo struct {
	Count      interface{}                               `json:"count"`
	Page       interface{}                               `json:"page"`
	PerPage    interface{}                               `json:"per_page"`
	TotalCount interface{}                               `json:"total_count"`
	JSON       projectListResponseEnvelopeResultInfoJSON `json:"-"`
}

func (*ProjectListResponseEnvelopeResultInfo) UnmarshalJSON

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

type ProjectListResponseEnvelopeSuccess

type ProjectListResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectListResponseEnvelopeSuccessTrue ProjectListResponseEnvelopeSuccess = true
)

type ProjectNewParams

type ProjectNewParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Configs for the project build process.
	BuildConfig         param.Field[ProjectNewParamsBuildConfig] `json:"build_config"`
	CanonicalDeployment param.Field[PagesDeploymentsParam]       `json:"canonical_deployment"`
	// Configs for deployments in a project.
	DeploymentConfigs param.Field[ProjectNewParamsDeploymentConfigs] `json:"deployment_configs"`
	LatestDeployment  param.Field[PagesDeploymentsParam]             `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 (ProjectNewParams) MarshalJSON

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

type ProjectNewParamsBuildConfig

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

Configs for the project build process.

func (ProjectNewParamsBuildConfig) MarshalJSON

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

type ProjectNewParamsDeploymentConfigs

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

Configs for deployments in a project.

func (ProjectNewParamsDeploymentConfigs) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreview

type ProjectNewParamsDeploymentConfigsPreview struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[ProjectNewParamsDeploymentConfigsPreviewAIBindings] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[ProjectNewParamsDeploymentConfigsPreviewBrowsers] `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[ProjectNewParamsDeploymentConfigsPreviewD1Databases] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVars] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[ProjectNewParamsDeploymentConfigsPreviewKVNamespaces] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectNewParamsDeploymentConfigsPreviewPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[ProjectNewParamsDeploymentConfigsPreviewQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[ProjectNewParamsDeploymentConfigsPreviewR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[ProjectNewParamsDeploymentConfigsPreviewServices] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings] `json:"vectorize_bindings"`
}

Configs for preview deploys.

func (ProjectNewParamsDeploymentConfigsPreview) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewAIBindings

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

Constellation bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewAIBindingsAIBinding

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

AI binding.

func (ProjectNewParamsDeploymentConfigsPreviewAIBindingsAIBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets

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

Analytics Engine bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasetsAnalyticsEngineBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewBrowsers

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

Browser bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewD1Databases

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

D1 databases used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewD1DatabasesD1Binding

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

D1 binding.

func (ProjectNewParamsDeploymentConfigsPreviewD1DatabasesD1Binding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces

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

Durabble Object namespaces used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespacesDoBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewEnvVars

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

Environment variables for build configs.

func (ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariable

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

Environment variable.

func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariable) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType

type ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypePlainText  ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "plain_text"
	ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsEnvironmentVariableType = "secret_text"
)

type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings

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

Hyperdrive bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive

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

Hyperdrive binding.

func (ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindingsHyperdrive) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces

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

KV namespaces used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewKVNamespacesKVBinding

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

KV binding.

func (ProjectNewParamsDeploymentConfigsPreviewKVNamespacesKVBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates

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

mTLS bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificatesMTLS

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

mTLS binding.

func (ProjectNewParamsDeploymentConfigsPreviewMTLSCertificatesMTLS) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewPlacement

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

Placement setting used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewQueueProducers

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

Queue Producer bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (ProjectNewParamsDeploymentConfigsPreviewQueueProducersQueueProducerBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewR2Buckets

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

R2 buckets used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewR2BucketsR2Binding

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

R2 binding.

func (ProjectNewParamsDeploymentConfigsPreviewR2BucketsR2Binding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewServices

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

Services used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewServices) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsPreviewServicesServiceBinding

type ProjectNewParamsDeploymentConfigsPreviewServicesServiceBinding struct {
	// The Service environment.
	Environment param.Field[string] `json:"environment"`
	// The Service name.
	Service param.Field[string] `json:"service"`
}

Service binding.

func (ProjectNewParamsDeploymentConfigsPreviewServicesServiceBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings

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

Vectorize bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON

type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindingsVectorize

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

Vectorize binding.

func (ProjectNewParamsDeploymentConfigsPreviewVectorizeBindingsVectorize) MarshalJSON

type ProjectNewParamsDeploymentConfigsProduction

type ProjectNewParamsDeploymentConfigsProduction struct {
	// Constellation bindings used for Pages Functions.
	AIBindings param.Field[ProjectNewParamsDeploymentConfigsProductionAIBindings] `json:"ai_bindings"`
	// Analytics Engine bindings used for Pages Functions.
	AnalyticsEngineDatasets param.Field[ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
	// Browser bindings used for Pages Functions.
	Browsers param.Field[ProjectNewParamsDeploymentConfigsProductionBrowsers] `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[ProjectNewParamsDeploymentConfigsProductionD1Databases] `json:"d1_databases"`
	// Durabble Object namespaces used for Pages Functions.
	DurableObjectNamespaces param.Field[ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces] `json:"durable_object_namespaces"`
	// Environment variables for build configs.
	EnvVars param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVars] `json:"env_vars"`
	// Hyperdrive bindings used for Pages Functions.
	HyperdriveBindings param.Field[ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings] `json:"hyperdrive_bindings"`
	// KV namespaces used for Pages Functions.
	KVNamespaces param.Field[ProjectNewParamsDeploymentConfigsProductionKVNamespaces] `json:"kv_namespaces"`
	// mTLS bindings used for Pages Functions.
	MTLSCertificates param.Field[ProjectNewParamsDeploymentConfigsProductionMTLSCertificates] `json:"mtls_certificates"`
	// Placement setting used for Pages Functions.
	Placement param.Field[ProjectNewParamsDeploymentConfigsProductionPlacement] `json:"placement"`
	// Queue Producer bindings used for Pages Functions.
	QueueProducers param.Field[ProjectNewParamsDeploymentConfigsProductionQueueProducers] `json:"queue_producers"`
	// R2 buckets used for Pages Functions.
	R2Buckets param.Field[ProjectNewParamsDeploymentConfigsProductionR2Buckets] `json:"r2_buckets"`
	// Services used for Pages Functions.
	Services param.Field[ProjectNewParamsDeploymentConfigsProductionServices] `json:"services"`
	// Vectorize bindings used for Pages Functions.
	VectorizeBindings param.Field[ProjectNewParamsDeploymentConfigsProductionVectorizeBindings] `json:"vectorize_bindings"`
}

Configs for production deploys.

func (ProjectNewParamsDeploymentConfigsProduction) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionAIBindings

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

Constellation bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionAIBindingsAIBinding

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

AI binding.

func (ProjectNewParamsDeploymentConfigsProductionAIBindingsAIBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets

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

Analytics Engine bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding

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

Analytics Engine binding.

func (ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasetsAnalyticsEngineBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionBrowsers

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

Browser bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionD1Databases

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

D1 databases used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionD1DatabasesD1Binding

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

D1 binding.

func (ProjectNewParamsDeploymentConfigsProductionD1DatabasesD1Binding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces

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

Durabble Object namespaces used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespacesDoBinding

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

Durabble Object binding.

func (ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespacesDoBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionEnvVars

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

Environment variables for build configs.

func (ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariable

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

Environment variable.

func (ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariable) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableType

type ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableType string

The type of environment variable (plain text or secret)

const (
	ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableTypePlainText  ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "plain_text"
	ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsEnvironmentVariableType = "secret_text"
)

type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings

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

Hyperdrive bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindingsHyperdrive

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

Hyperdrive binding.

func (ProjectNewParamsDeploymentConfigsProductionHyperdriveBindingsHyperdrive) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionKVNamespaces

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

KV namespaces used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionKVNamespacesKVBinding

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

KV binding.

func (ProjectNewParamsDeploymentConfigsProductionKVNamespacesKVBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates

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

mTLS bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionMTLSCertificatesMTLS

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

mTLS binding.

func (ProjectNewParamsDeploymentConfigsProductionMTLSCertificatesMTLS) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionPlacement

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

Placement setting used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionQueueProducers

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

Queue Producer bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionQueueProducersQueueProducerBinding

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

Queue Producer binding.

func (ProjectNewParamsDeploymentConfigsProductionQueueProducersQueueProducerBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionR2Buckets

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

R2 buckets used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionR2BucketsR2Binding

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

R2 binding.

func (ProjectNewParamsDeploymentConfigsProductionR2BucketsR2Binding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionServices

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

Services used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionServices) MarshalJSON

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

type ProjectNewParamsDeploymentConfigsProductionServicesServiceBinding

type ProjectNewParamsDeploymentConfigsProductionServicesServiceBinding struct {
	// The Service environment.
	Environment param.Field[string] `json:"environment"`
	// The Service name.
	Service param.Field[string] `json:"service"`
}

Service binding.

func (ProjectNewParamsDeploymentConfigsProductionServicesServiceBinding) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings

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

Vectorize bindings used for Pages Functions.

func (ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON

type ProjectNewParamsDeploymentConfigsProductionVectorizeBindingsVectorize

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

Vectorize binding.

func (ProjectNewParamsDeploymentConfigsProductionVectorizeBindingsVectorize) MarshalJSON

type ProjectNewResponse

type ProjectNewResponse interface {
	ImplementsPagesProjectNewResponse()
}

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

type ProjectNewResponseArray

type ProjectNewResponseArray []interface{}

func (ProjectNewResponseArray) ImplementsPagesProjectNewResponse

func (r ProjectNewResponseArray) ImplementsPagesProjectNewResponse()

type ProjectNewResponseEnvelope

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

func (*ProjectNewResponseEnvelope) UnmarshalJSON

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

type ProjectNewResponseEnvelopeErrors

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

func (*ProjectNewResponseEnvelopeErrors) UnmarshalJSON

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

type ProjectNewResponseEnvelopeMessages

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

func (*ProjectNewResponseEnvelopeMessages) UnmarshalJSON

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

type ProjectNewResponseEnvelopeSuccess

type ProjectNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	ProjectNewResponseEnvelopeSuccessTrue ProjectNewResponseEnvelopeSuccess = true
)

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, body ProjectDeleteParams, opts ...option.RequestOption) (res *ProjectDeleteResponse, err error)

Delete a project by name.

func (*ProjectService) Edit

func (r *ProjectService) Edit(ctx context.Context, projectName string, params ProjectEditParams, opts ...option.RequestOption) (res *ProjectEditResponse, 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 *PagesProjects, err error)

Fetch a project by name.

func (*ProjectService) List

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

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

Jump to

Keyboard shortcuts

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