Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConfigSrc
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type PageService
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ProjectDeleteParams
- type ProjectDeleteResponse
- type ProjectDeleteResponseEnvelope
- type ProjectDeleteResponseEnvelopeErrors
- type ProjectDeleteResponseEnvelopeErrorsSource
- type ProjectDeleteResponseEnvelopeMessages
- type ProjectDeleteResponseEnvelopeMessagesSource
- type ProjectDeleteResponseEnvelopeSuccess
- type ProjectDeploymentDeleteParams
- type ProjectDeploymentDeleteResponse
- type ProjectDeploymentDeleteResponseEnvelope
- type ProjectDeploymentDeleteResponseEnvelopeErrors
- type ProjectDeploymentDeleteResponseEnvelopeErrorsSource
- type ProjectDeploymentDeleteResponseEnvelopeMessages
- type ProjectDeploymentDeleteResponseEnvelopeMessagesSource
- type ProjectDeploymentDeleteResponseEnvelopeSuccess
- type ProjectDeploymentGetParams
- type ProjectDeploymentGetResponse
- type ProjectDeploymentGetResponseBuildConfig
- type ProjectDeploymentGetResponseDeploymentTrigger
- type ProjectDeploymentGetResponseDeploymentTriggerMetadata
- type ProjectDeploymentGetResponseDeploymentTriggerType
- type ProjectDeploymentGetResponseEnvVar
- type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentGetResponseEnvVarsType
- type ProjectDeploymentGetResponseEnvVarsUnion
- type ProjectDeploymentGetResponseEnvelope
- type ProjectDeploymentGetResponseEnvelopeErrors
- type ProjectDeploymentGetResponseEnvelopeErrorsSource
- type ProjectDeploymentGetResponseEnvelopeMessages
- type ProjectDeploymentGetResponseEnvelopeMessagesSource
- type ProjectDeploymentGetResponseEnvelopeSuccess
- type ProjectDeploymentGetResponseEnvironment
- type ProjectDeploymentGetResponseSource
- type ProjectDeploymentGetResponseSourceConfig
- type ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting
- type ProjectDeploymentGetResponseSourceType
- type ProjectDeploymentHistoryLogGetParams
- type ProjectDeploymentHistoryLogGetResponse
- type ProjectDeploymentHistoryLogGetResponseData
- type ProjectDeploymentHistoryLogGetResponseEnvelope
- type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors
- type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource
- type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages
- type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource
- type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess
- type ProjectDeploymentHistoryLogService
- type ProjectDeploymentHistoryService
- type ProjectDeploymentListParams
- type ProjectDeploymentListParamsEnv
- type ProjectDeploymentListResponse
- type ProjectDeploymentListResponseBuildConfig
- type ProjectDeploymentListResponseDeploymentTrigger
- type ProjectDeploymentListResponseDeploymentTriggerMetadata
- type ProjectDeploymentListResponseDeploymentTriggerType
- type ProjectDeploymentListResponseEnvVar
- type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentListResponseEnvVarsType
- type ProjectDeploymentListResponseEnvVarsUnion
- type ProjectDeploymentListResponseEnvironment
- type ProjectDeploymentListResponseSource
- type ProjectDeploymentListResponseSourceConfig
- type ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting
- type ProjectDeploymentListResponseSourceType
- type ProjectDeploymentNewParams
- type ProjectDeploymentNewParamsCommitDirty
- type ProjectDeploymentNewResponse
- type ProjectDeploymentNewResponseBuildConfig
- type ProjectDeploymentNewResponseDeploymentTrigger
- type ProjectDeploymentNewResponseDeploymentTriggerMetadata
- type ProjectDeploymentNewResponseDeploymentTriggerType
- type ProjectDeploymentNewResponseEnvVar
- type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentNewResponseEnvVarsType
- type ProjectDeploymentNewResponseEnvVarsUnion
- type ProjectDeploymentNewResponseEnvelope
- type ProjectDeploymentNewResponseEnvelopeErrors
- type ProjectDeploymentNewResponseEnvelopeErrorsSource
- type ProjectDeploymentNewResponseEnvelopeMessages
- type ProjectDeploymentNewResponseEnvelopeMessagesSource
- type ProjectDeploymentNewResponseEnvelopeSuccess
- type ProjectDeploymentNewResponseEnvironment
- type ProjectDeploymentNewResponseSource
- type ProjectDeploymentNewResponseSourceConfig
- type ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting
- type ProjectDeploymentNewResponseSourceType
- type ProjectDeploymentRetryParams
- type ProjectDeploymentRetryResponse
- type ProjectDeploymentRetryResponseBuildConfig
- type ProjectDeploymentRetryResponseDeploymentTrigger
- type ProjectDeploymentRetryResponseDeploymentTriggerMetadata
- type ProjectDeploymentRetryResponseDeploymentTriggerType
- type ProjectDeploymentRetryResponseEnvVar
- type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentRetryResponseEnvVarsType
- type ProjectDeploymentRetryResponseEnvVarsUnion
- type ProjectDeploymentRetryResponseEnvelope
- type ProjectDeploymentRetryResponseEnvelopeErrors
- type ProjectDeploymentRetryResponseEnvelopeErrorsSource
- type ProjectDeploymentRetryResponseEnvelopeMessages
- type ProjectDeploymentRetryResponseEnvelopeMessagesSource
- type ProjectDeploymentRetryResponseEnvelopeSuccess
- type ProjectDeploymentRetryResponseEnvironment
- type ProjectDeploymentRetryResponseSource
- type ProjectDeploymentRetryResponseSourceConfig
- type ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting
- type ProjectDeploymentRetryResponseSourceType
- type ProjectDeploymentRollbackParams
- type ProjectDeploymentRollbackResponse
- type ProjectDeploymentRollbackResponseBuildConfig
- type ProjectDeploymentRollbackResponseDeploymentTrigger
- type ProjectDeploymentRollbackResponseDeploymentTriggerMetadata
- type ProjectDeploymentRollbackResponseDeploymentTriggerType
- type ProjectDeploymentRollbackResponseEnvVar
- type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentRollbackResponseEnvVarsType
- type ProjectDeploymentRollbackResponseEnvVarsUnion
- type ProjectDeploymentRollbackResponseEnvelope
- type ProjectDeploymentRollbackResponseEnvelopeErrors
- type ProjectDeploymentRollbackResponseEnvelopeErrorsSource
- type ProjectDeploymentRollbackResponseEnvelopeMessages
- type ProjectDeploymentRollbackResponseEnvelopeMessagesSource
- type ProjectDeploymentRollbackResponseEnvelopeSuccess
- type ProjectDeploymentRollbackResponseEnvironment
- type ProjectDeploymentRollbackResponseSource
- type ProjectDeploymentRollbackResponseSourceConfig
- type ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting
- type ProjectDeploymentRollbackResponseSourceType
- type ProjectDeploymentService
- func (r *ProjectDeploymentService) Delete(ctx context.Context, projectName string, deploymentID string, ...) (res *ProjectDeploymentDeleteResponse, err error)
- func (r *ProjectDeploymentService) Get(ctx context.Context, projectName string, deploymentID string, ...) (res *ProjectDeploymentGetResponse, err error)
- func (r *ProjectDeploymentService) List(ctx context.Context, projectName string, params ProjectDeploymentListParams, ...) (res *pagination.V4PagePaginationArray[ProjectDeploymentListResponse], ...)
- func (r *ProjectDeploymentService) ListAutoPaging(ctx context.Context, projectName string, params ProjectDeploymentListParams, ...) *pagination.V4PagePaginationArrayAutoPager[ProjectDeploymentListResponse]
- func (r *ProjectDeploymentService) New(ctx context.Context, projectName string, params ProjectDeploymentNewParams, ...) (res *ProjectDeploymentNewResponse, err error)
- func (r *ProjectDeploymentService) Retry(ctx context.Context, projectName string, deploymentID string, ...) (res *ProjectDeploymentRetryResponse, err error)
- func (r *ProjectDeploymentService) Rollback(ctx context.Context, projectName string, deploymentID string, ...) (res *ProjectDeploymentRollbackResponse, err error)
- type ProjectDomainDeleteParams
- type ProjectDomainDeleteResponse
- type ProjectDomainDeleteResponseEnvelope
- type ProjectDomainDeleteResponseEnvelopeErrors
- type ProjectDomainDeleteResponseEnvelopeErrorsSource
- type ProjectDomainDeleteResponseEnvelopeMessages
- type ProjectDomainDeleteResponseEnvelopeMessagesSource
- type ProjectDomainDeleteResponseEnvelopeSuccess
- type ProjectDomainEditParams
- type ProjectDomainEditResponse
- type ProjectDomainEditResponseCertificateAuthority
- type ProjectDomainEditResponseEnvelope
- type ProjectDomainEditResponseEnvelopeErrors
- type ProjectDomainEditResponseEnvelopeErrorsSource
- type ProjectDomainEditResponseEnvelopeMessages
- type ProjectDomainEditResponseEnvelopeMessagesSource
- type ProjectDomainEditResponseEnvelopeSuccess
- type ProjectDomainEditResponseStatus
- type ProjectDomainEditResponseValidationData
- type ProjectDomainEditResponseValidationDataMethod
- type ProjectDomainEditResponseValidationDataStatus
- type ProjectDomainEditResponseVerificationData
- type ProjectDomainEditResponseVerificationDataStatus
- type ProjectDomainGetParams
- type ProjectDomainGetResponse
- type ProjectDomainGetResponseCertificateAuthority
- type ProjectDomainGetResponseEnvelope
- type ProjectDomainGetResponseEnvelopeErrors
- type ProjectDomainGetResponseEnvelopeErrorsSource
- type ProjectDomainGetResponseEnvelopeMessages
- type ProjectDomainGetResponseEnvelopeMessagesSource
- type ProjectDomainGetResponseEnvelopeSuccess
- type ProjectDomainGetResponseStatus
- type ProjectDomainGetResponseValidationData
- type ProjectDomainGetResponseValidationDataMethod
- type ProjectDomainGetResponseValidationDataStatus
- type ProjectDomainGetResponseVerificationData
- type ProjectDomainGetResponseVerificationDataStatus
- type ProjectDomainListParams
- type ProjectDomainListResponse
- type ProjectDomainListResponseCertificateAuthority
- type ProjectDomainListResponseStatus
- type ProjectDomainListResponseValidationData
- type ProjectDomainListResponseValidationDataMethod
- type ProjectDomainListResponseValidationDataStatus
- type ProjectDomainListResponseVerificationData
- type ProjectDomainListResponseVerificationDataStatus
- type ProjectDomainNewParams
- type ProjectDomainNewResponse
- type ProjectDomainNewResponseCertificateAuthority
- type ProjectDomainNewResponseEnvelope
- type ProjectDomainNewResponseEnvelopeErrors
- type ProjectDomainNewResponseEnvelopeErrorsSource
- type ProjectDomainNewResponseEnvelopeMessages
- type ProjectDomainNewResponseEnvelopeMessagesSource
- type ProjectDomainNewResponseEnvelopeSuccess
- type ProjectDomainNewResponseStatus
- type ProjectDomainNewResponseValidationData
- type ProjectDomainNewResponseValidationDataMethod
- type ProjectDomainNewResponseValidationDataStatus
- type ProjectDomainNewResponseVerificationData
- type ProjectDomainNewResponseVerificationDataStatus
- type ProjectDomainService
- func (r *ProjectDomainService) Delete(ctx context.Context, projectName string, domainName string, ...) (res *ProjectDomainDeleteResponse, err error)
- func (r *ProjectDomainService) Edit(ctx context.Context, projectName string, domainName string, ...) (res *ProjectDomainEditResponse, err error)
- func (r *ProjectDomainService) Get(ctx context.Context, projectName string, domainName string, ...) (res *ProjectDomainGetResponse, err error)
- func (r *ProjectDomainService) List(ctx context.Context, projectName string, query ProjectDomainListParams, ...) (res *pagination.SinglePage[ProjectDomainListResponse], err error)
- func (r *ProjectDomainService) ListAutoPaging(ctx context.Context, projectName string, query ProjectDomainListParams, ...) *pagination.SinglePageAutoPager[ProjectDomainListResponse]
- func (r *ProjectDomainService) New(ctx context.Context, projectName string, params ProjectDomainNewParams, ...) (res *ProjectDomainNewResponse, err error)
- type ProjectEditParams
- type ProjectEditParamsBuildConfig
- type ProjectEditParamsDeploymentConfigs
- type ProjectEditParamsDeploymentConfigsPreview
- type ProjectEditParamsDeploymentConfigsPreviewAIBindings
- type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets
- type ProjectEditParamsDeploymentConfigsPreviewBrowsers
- type ProjectEditParamsDeploymentConfigsPreviewD1Databases
- type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces
- type ProjectEditParamsDeploymentConfigsPreviewEnvVars
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType
- type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion
- type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings
- type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces
- type ProjectEditParamsDeploymentConfigsPreviewLimits
- type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates
- type ProjectEditParamsDeploymentConfigsPreviewPlacement
- type ProjectEditParamsDeploymentConfigsPreviewQueueProducers
- type ProjectEditParamsDeploymentConfigsPreviewR2Buckets
- type ProjectEditParamsDeploymentConfigsPreviewServices
- type ProjectEditParamsDeploymentConfigsPreviewUsageModel
- type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings
- type ProjectEditParamsDeploymentConfigsProduction
- type ProjectEditParamsDeploymentConfigsProductionAIBindings
- type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets
- type ProjectEditParamsDeploymentConfigsProductionBrowsers
- type ProjectEditParamsDeploymentConfigsProductionD1Databases
- type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces
- type ProjectEditParamsDeploymentConfigsProductionEnvVars
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsType
- type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion
- type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings
- type ProjectEditParamsDeploymentConfigsProductionKVNamespaces
- type ProjectEditParamsDeploymentConfigsProductionLimits
- type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates
- type ProjectEditParamsDeploymentConfigsProductionPlacement
- type ProjectEditParamsDeploymentConfigsProductionQueueProducers
- type ProjectEditParamsDeploymentConfigsProductionR2Buckets
- type ProjectEditParamsDeploymentConfigsProductionServices
- type ProjectEditParamsDeploymentConfigsProductionUsageModel
- type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings
- type ProjectEditParamsSource
- type ProjectEditParamsSourceConfig
- type ProjectEditParamsSourceConfigPreviewDeploymentSetting
- type ProjectEditParamsSourceType
- type ProjectEditResponse
- type ProjectEditResponseBuildConfig
- type ProjectEditResponseCanonicalDeployment
- type ProjectEditResponseCanonicalDeploymentBuildConfig
- type ProjectEditResponseCanonicalDeploymentDeploymentTrigger
- type ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata
- type ProjectEditResponseCanonicalDeploymentDeploymentTriggerType
- type ProjectEditResponseCanonicalDeploymentEnvVar
- type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectEditResponseCanonicalDeploymentEnvVarsType
- type ProjectEditResponseCanonicalDeploymentEnvVarsUnion
- type ProjectEditResponseCanonicalDeploymentEnvironment
- type ProjectEditResponseCanonicalDeploymentSource
- type ProjectEditResponseCanonicalDeploymentSourceConfig
- type ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectEditResponseCanonicalDeploymentSourceType
- type ProjectEditResponseDeploymentConfigs
- type ProjectEditResponseDeploymentConfigsPreview
- type ProjectEditResponseDeploymentConfigsPreviewAIBinding
- type ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset
- type ProjectEditResponseDeploymentConfigsPreviewBrowser
- type ProjectEditResponseDeploymentConfigsPreviewD1Database
- type ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace
- type ProjectEditResponseDeploymentConfigsPreviewEnvVar
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsType
- type ProjectEditResponseDeploymentConfigsPreviewEnvVarsUnion
- type ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding
- type ProjectEditResponseDeploymentConfigsPreviewKVNamespace
- type ProjectEditResponseDeploymentConfigsPreviewLimits
- type ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate
- type ProjectEditResponseDeploymentConfigsPreviewPlacement
- type ProjectEditResponseDeploymentConfigsPreviewQueueProducer
- type ProjectEditResponseDeploymentConfigsPreviewR2Bucket
- type ProjectEditResponseDeploymentConfigsPreviewService
- type ProjectEditResponseDeploymentConfigsPreviewUsageModel
- type ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding
- type ProjectEditResponseDeploymentConfigsProduction
- type ProjectEditResponseDeploymentConfigsProductionAIBinding
- type ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset
- type ProjectEditResponseDeploymentConfigsProductionBrowser
- type ProjectEditResponseDeploymentConfigsProductionD1Database
- type ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace
- type ProjectEditResponseDeploymentConfigsProductionEnvVar
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsType
- type ProjectEditResponseDeploymentConfigsProductionEnvVarsUnion
- type ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding
- type ProjectEditResponseDeploymentConfigsProductionKVNamespace
- type ProjectEditResponseDeploymentConfigsProductionLimits
- type ProjectEditResponseDeploymentConfigsProductionMTLSCertificate
- type ProjectEditResponseDeploymentConfigsProductionPlacement
- type ProjectEditResponseDeploymentConfigsProductionQueueProducer
- type ProjectEditResponseDeploymentConfigsProductionR2Bucket
- type ProjectEditResponseDeploymentConfigsProductionService
- type ProjectEditResponseDeploymentConfigsProductionUsageModel
- type ProjectEditResponseDeploymentConfigsProductionVectorizeBinding
- type ProjectEditResponseEnvelope
- type ProjectEditResponseEnvelopeErrors
- type ProjectEditResponseEnvelopeErrorsSource
- type ProjectEditResponseEnvelopeMessages
- type ProjectEditResponseEnvelopeMessagesSource
- type ProjectEditResponseEnvelopeSuccess
- type ProjectEditResponseLatestDeployment
- type ProjectEditResponseLatestDeploymentBuildConfig
- type ProjectEditResponseLatestDeploymentDeploymentTrigger
- type ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata
- type ProjectEditResponseLatestDeploymentDeploymentTriggerType
- type ProjectEditResponseLatestDeploymentEnvVar
- type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectEditResponseLatestDeploymentEnvVarsType
- type ProjectEditResponseLatestDeploymentEnvVarsUnion
- type ProjectEditResponseLatestDeploymentEnvironment
- type ProjectEditResponseLatestDeploymentSource
- type ProjectEditResponseLatestDeploymentSourceConfig
- type ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectEditResponseLatestDeploymentSourceType
- type ProjectEditResponseSource
- type ProjectEditResponseSourceConfig
- type ProjectEditResponseSourceConfigPreviewDeploymentSetting
- type ProjectEditResponseSourceType
- type ProjectGetParams
- type ProjectGetResponse
- type ProjectGetResponseBuildConfig
- type ProjectGetResponseCanonicalDeployment
- type ProjectGetResponseCanonicalDeploymentBuildConfig
- type ProjectGetResponseCanonicalDeploymentDeploymentTrigger
- type ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata
- type ProjectGetResponseCanonicalDeploymentDeploymentTriggerType
- type ProjectGetResponseCanonicalDeploymentEnvVar
- type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectGetResponseCanonicalDeploymentEnvVarsType
- type ProjectGetResponseCanonicalDeploymentEnvVarsUnion
- type ProjectGetResponseCanonicalDeploymentEnvironment
- type ProjectGetResponseCanonicalDeploymentSource
- type ProjectGetResponseCanonicalDeploymentSourceConfig
- type ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectGetResponseCanonicalDeploymentSourceType
- type ProjectGetResponseDeploymentConfigs
- type ProjectGetResponseDeploymentConfigsPreview
- type ProjectGetResponseDeploymentConfigsPreviewAIBinding
- type ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset
- type ProjectGetResponseDeploymentConfigsPreviewBrowser
- type ProjectGetResponseDeploymentConfigsPreviewD1Database
- type ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace
- type ProjectGetResponseDeploymentConfigsPreviewEnvVar
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsType
- type ProjectGetResponseDeploymentConfigsPreviewEnvVarsUnion
- type ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding
- type ProjectGetResponseDeploymentConfigsPreviewKVNamespace
- type ProjectGetResponseDeploymentConfigsPreviewLimits
- type ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate
- type ProjectGetResponseDeploymentConfigsPreviewPlacement
- type ProjectGetResponseDeploymentConfigsPreviewQueueProducer
- type ProjectGetResponseDeploymentConfigsPreviewR2Bucket
- type ProjectGetResponseDeploymentConfigsPreviewService
- type ProjectGetResponseDeploymentConfigsPreviewUsageModel
- type ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding
- type ProjectGetResponseDeploymentConfigsProduction
- type ProjectGetResponseDeploymentConfigsProductionAIBinding
- type ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset
- type ProjectGetResponseDeploymentConfigsProductionBrowser
- type ProjectGetResponseDeploymentConfigsProductionD1Database
- type ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace
- type ProjectGetResponseDeploymentConfigsProductionEnvVar
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsType
- type ProjectGetResponseDeploymentConfigsProductionEnvVarsUnion
- type ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding
- type ProjectGetResponseDeploymentConfigsProductionKVNamespace
- type ProjectGetResponseDeploymentConfigsProductionLimits
- type ProjectGetResponseDeploymentConfigsProductionMTLSCertificate
- type ProjectGetResponseDeploymentConfigsProductionPlacement
- type ProjectGetResponseDeploymentConfigsProductionQueueProducer
- type ProjectGetResponseDeploymentConfigsProductionR2Bucket
- type ProjectGetResponseDeploymentConfigsProductionService
- type ProjectGetResponseDeploymentConfigsProductionUsageModel
- type ProjectGetResponseDeploymentConfigsProductionVectorizeBinding
- type ProjectGetResponseEnvelope
- type ProjectGetResponseEnvelopeErrors
- type ProjectGetResponseEnvelopeErrorsSource
- type ProjectGetResponseEnvelopeMessages
- type ProjectGetResponseEnvelopeMessagesSource
- type ProjectGetResponseEnvelopeSuccess
- type ProjectGetResponseLatestDeployment
- type ProjectGetResponseLatestDeploymentBuildConfig
- type ProjectGetResponseLatestDeploymentDeploymentTrigger
- type ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata
- type ProjectGetResponseLatestDeploymentDeploymentTriggerType
- type ProjectGetResponseLatestDeploymentEnvVar
- type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectGetResponseLatestDeploymentEnvVarsType
- type ProjectGetResponseLatestDeploymentEnvVarsUnion
- type ProjectGetResponseLatestDeploymentEnvironment
- type ProjectGetResponseLatestDeploymentSource
- type ProjectGetResponseLatestDeploymentSourceConfig
- type ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectGetResponseLatestDeploymentSourceType
- type ProjectGetResponseSource
- type ProjectGetResponseSourceConfig
- type ProjectGetResponseSourceConfigPreviewDeploymentSetting
- type ProjectGetResponseSourceType
- type ProjectListParams
- type ProjectListResponse
- type ProjectListResponseBuildConfig
- type ProjectListResponseCanonicalDeployment
- type ProjectListResponseCanonicalDeploymentBuildConfig
- type ProjectListResponseCanonicalDeploymentDeploymentTrigger
- type ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata
- type ProjectListResponseCanonicalDeploymentDeploymentTriggerType
- type ProjectListResponseCanonicalDeploymentEnvVar
- type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectListResponseCanonicalDeploymentEnvVarsType
- type ProjectListResponseCanonicalDeploymentEnvVarsUnion
- type ProjectListResponseCanonicalDeploymentEnvironment
- type ProjectListResponseCanonicalDeploymentSource
- type ProjectListResponseCanonicalDeploymentSourceConfig
- type ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectListResponseCanonicalDeploymentSourceType
- type ProjectListResponseDeploymentConfigs
- type ProjectListResponseDeploymentConfigsPreview
- type ProjectListResponseDeploymentConfigsPreviewAIBinding
- type ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset
- type ProjectListResponseDeploymentConfigsPreviewBrowser
- type ProjectListResponseDeploymentConfigsPreviewD1Database
- type ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace
- type ProjectListResponseDeploymentConfigsPreviewEnvVar
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsType
- type ProjectListResponseDeploymentConfigsPreviewEnvVarsUnion
- type ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding
- type ProjectListResponseDeploymentConfigsPreviewKVNamespace
- type ProjectListResponseDeploymentConfigsPreviewLimits
- type ProjectListResponseDeploymentConfigsPreviewMTLSCertificate
- type ProjectListResponseDeploymentConfigsPreviewPlacement
- type ProjectListResponseDeploymentConfigsPreviewQueueProducer
- type ProjectListResponseDeploymentConfigsPreviewR2Bucket
- type ProjectListResponseDeploymentConfigsPreviewService
- type ProjectListResponseDeploymentConfigsPreviewUsageModel
- type ProjectListResponseDeploymentConfigsPreviewVectorizeBinding
- type ProjectListResponseDeploymentConfigsProduction
- type ProjectListResponseDeploymentConfigsProductionAIBinding
- type ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset
- type ProjectListResponseDeploymentConfigsProductionBrowser
- type ProjectListResponseDeploymentConfigsProductionD1Database
- type ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace
- type ProjectListResponseDeploymentConfigsProductionEnvVar
- type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectListResponseDeploymentConfigsProductionEnvVarsType
- type ProjectListResponseDeploymentConfigsProductionEnvVarsUnion
- type ProjectListResponseDeploymentConfigsProductionHyperdriveBinding
- type ProjectListResponseDeploymentConfigsProductionKVNamespace
- type ProjectListResponseDeploymentConfigsProductionLimits
- type ProjectListResponseDeploymentConfigsProductionMTLSCertificate
- type ProjectListResponseDeploymentConfigsProductionPlacement
- type ProjectListResponseDeploymentConfigsProductionQueueProducer
- type ProjectListResponseDeploymentConfigsProductionR2Bucket
- type ProjectListResponseDeploymentConfigsProductionService
- type ProjectListResponseDeploymentConfigsProductionUsageModel
- type ProjectListResponseDeploymentConfigsProductionVectorizeBinding
- type ProjectListResponseLatestDeployment
- type ProjectListResponseLatestDeploymentBuildConfig
- type ProjectListResponseLatestDeploymentDeploymentTrigger
- type ProjectListResponseLatestDeploymentDeploymentTriggerMetadata
- type ProjectListResponseLatestDeploymentDeploymentTriggerType
- type ProjectListResponseLatestDeploymentEnvVar
- type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectListResponseLatestDeploymentEnvVarsType
- type ProjectListResponseLatestDeploymentEnvVarsUnion
- type ProjectListResponseLatestDeploymentEnvironment
- type ProjectListResponseLatestDeploymentSource
- type ProjectListResponseLatestDeploymentSourceConfig
- type ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectListResponseLatestDeploymentSourceType
- type ProjectListResponseSource
- type ProjectListResponseSourceConfig
- type ProjectListResponseSourceConfigPreviewDeploymentSetting
- type ProjectListResponseSourceType
- type ProjectNewParams
- type ProjectNewParamsBuildConfig
- type ProjectNewParamsDeploymentConfigs
- type ProjectNewParamsDeploymentConfigsPreview
- type ProjectNewParamsDeploymentConfigsPreviewAIBindings
- type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets
- type ProjectNewParamsDeploymentConfigsPreviewBrowsers
- type ProjectNewParamsDeploymentConfigsPreviewD1Databases
- type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces
- type ProjectNewParamsDeploymentConfigsPreviewEnvVars
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType
- type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion
- type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings
- type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces
- type ProjectNewParamsDeploymentConfigsPreviewLimits
- type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates
- type ProjectNewParamsDeploymentConfigsPreviewPlacement
- type ProjectNewParamsDeploymentConfigsPreviewQueueProducers
- type ProjectNewParamsDeploymentConfigsPreviewR2Buckets
- type ProjectNewParamsDeploymentConfigsPreviewServices
- type ProjectNewParamsDeploymentConfigsPreviewUsageModel
- type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings
- type ProjectNewParamsDeploymentConfigsProduction
- type ProjectNewParamsDeploymentConfigsProductionAIBindings
- type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets
- type ProjectNewParamsDeploymentConfigsProductionBrowsers
- type ProjectNewParamsDeploymentConfigsProductionD1Databases
- type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces
- type ProjectNewParamsDeploymentConfigsProductionEnvVars
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsType
- type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion
- type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings
- type ProjectNewParamsDeploymentConfigsProductionKVNamespaces
- type ProjectNewParamsDeploymentConfigsProductionLimits
- type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates
- type ProjectNewParamsDeploymentConfigsProductionPlacement
- type ProjectNewParamsDeploymentConfigsProductionQueueProducers
- type ProjectNewParamsDeploymentConfigsProductionR2Buckets
- type ProjectNewParamsDeploymentConfigsProductionServices
- type ProjectNewParamsDeploymentConfigsProductionUsageModel
- type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings
- type ProjectNewParamsSource
- type ProjectNewParamsSourceConfig
- type ProjectNewParamsSourceConfigPreviewDeploymentSetting
- type ProjectNewParamsSourceType
- type ProjectNewResponse
- type ProjectNewResponseBuildConfig
- type ProjectNewResponseCanonicalDeployment
- type ProjectNewResponseCanonicalDeploymentBuildConfig
- type ProjectNewResponseCanonicalDeploymentDeploymentTrigger
- type ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata
- type ProjectNewResponseCanonicalDeploymentDeploymentTriggerType
- type ProjectNewResponseCanonicalDeploymentEnvVar
- type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectNewResponseCanonicalDeploymentEnvVarsType
- type ProjectNewResponseCanonicalDeploymentEnvVarsUnion
- type ProjectNewResponseCanonicalDeploymentEnvironment
- type ProjectNewResponseCanonicalDeploymentSource
- type ProjectNewResponseCanonicalDeploymentSourceConfig
- type ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectNewResponseCanonicalDeploymentSourceType
- type ProjectNewResponseDeploymentConfigs
- type ProjectNewResponseDeploymentConfigsPreview
- type ProjectNewResponseDeploymentConfigsPreviewAIBinding
- type ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset
- type ProjectNewResponseDeploymentConfigsPreviewBrowser
- type ProjectNewResponseDeploymentConfigsPreviewD1Database
- type ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace
- type ProjectNewResponseDeploymentConfigsPreviewEnvVar
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsType
- type ProjectNewResponseDeploymentConfigsPreviewEnvVarsUnion
- type ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding
- type ProjectNewResponseDeploymentConfigsPreviewKVNamespace
- type ProjectNewResponseDeploymentConfigsPreviewLimits
- type ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate
- type ProjectNewResponseDeploymentConfigsPreviewPlacement
- type ProjectNewResponseDeploymentConfigsPreviewQueueProducer
- type ProjectNewResponseDeploymentConfigsPreviewR2Bucket
- type ProjectNewResponseDeploymentConfigsPreviewService
- type ProjectNewResponseDeploymentConfigsPreviewUsageModel
- type ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding
- type ProjectNewResponseDeploymentConfigsProduction
- type ProjectNewResponseDeploymentConfigsProductionAIBinding
- type ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset
- type ProjectNewResponseDeploymentConfigsProductionBrowser
- type ProjectNewResponseDeploymentConfigsProductionD1Database
- type ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace
- type ProjectNewResponseDeploymentConfigsProductionEnvVar
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsType
- type ProjectNewResponseDeploymentConfigsProductionEnvVarsUnion
- type ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding
- type ProjectNewResponseDeploymentConfigsProductionKVNamespace
- type ProjectNewResponseDeploymentConfigsProductionLimits
- type ProjectNewResponseDeploymentConfigsProductionMTLSCertificate
- type ProjectNewResponseDeploymentConfigsProductionPlacement
- type ProjectNewResponseDeploymentConfigsProductionQueueProducer
- type ProjectNewResponseDeploymentConfigsProductionR2Bucket
- type ProjectNewResponseDeploymentConfigsProductionService
- type ProjectNewResponseDeploymentConfigsProductionUsageModel
- type ProjectNewResponseDeploymentConfigsProductionVectorizeBinding
- type ProjectNewResponseEnvelope
- type ProjectNewResponseEnvelopeErrors
- type ProjectNewResponseEnvelopeErrorsSource
- type ProjectNewResponseEnvelopeMessages
- type ProjectNewResponseEnvelopeMessagesSource
- type ProjectNewResponseEnvelopeSuccess
- type ProjectNewResponseLatestDeployment
- type ProjectNewResponseLatestDeploymentBuildConfig
- type ProjectNewResponseLatestDeploymentDeploymentTrigger
- type ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata
- type ProjectNewResponseLatestDeploymentDeploymentTriggerType
- type ProjectNewResponseLatestDeploymentEnvVar
- type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar
- type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType
- type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar
- type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType
- type ProjectNewResponseLatestDeploymentEnvVarsType
- type ProjectNewResponseLatestDeploymentEnvVarsUnion
- type ProjectNewResponseLatestDeploymentEnvironment
- type ProjectNewResponseLatestDeploymentSource
- type ProjectNewResponseLatestDeploymentSourceConfig
- type ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting
- type ProjectNewResponseLatestDeploymentSourceType
- type ProjectNewResponseSource
- type ProjectNewResponseSourceConfig
- type ProjectNewResponseSourceConfigPreviewDeploymentSetting
- type ProjectNewResponseSourceType
- type ProjectPurgeBuildCacheParams
- type ProjectPurgeBuildCacheResponse
- type ProjectPurgeBuildCacheResponseEnvelope
- type ProjectPurgeBuildCacheResponseEnvelopeErrors
- type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource
- type ProjectPurgeBuildCacheResponseEnvelopeMessages
- type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource
- type ProjectPurgeBuildCacheResponseEnvelopeSuccess
- type ProjectService
- func (r *ProjectService) Delete(ctx context.Context, projectName string, body ProjectDeleteParams, ...) (res *ProjectDeleteResponse, err error)
- func (r *ProjectService) Edit(ctx context.Context, projectName string, params ProjectEditParams, ...) (res *ProjectEditResponse, err error)
- func (r *ProjectService) Get(ctx context.Context, projectName string, query ProjectGetParams, ...) (res *ProjectGetResponse, err error)
- func (r *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ProjectListResponse], err error)
- func (r *ProjectService) ListAutoPaging(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ProjectListResponse]
- func (r *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (res *ProjectNewResponse, err error)
- func (r *ProjectService) PurgeBuildCache(ctx context.Context, projectName string, body ProjectPurgeBuildCacheParams, ...) (res *ProjectPurgeBuildCacheResponse, err error)
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SortDirection
- type Stage
- type StageName
- type StageStatus
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesIAMResourcesTypeObjectNested
- type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
- type TokenPolicyResourcesIAMResourcesTypeObjectString
- type TokenPolicyResourcesIAMResourcesTypeObjectStringParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare
This is an alias to an internal value.
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CertificateCA ¶
type CertificateCA = shared.CertificateCA
The Certificate Authority that will issue the certificate
This is an alias to an internal type.
type CertificateRequestType ¶
type CertificateRequestType = shared.CertificateRequestType
Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc" (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
This is an alias to an internal type.
type CloudflareTunnel ¶
type CloudflareTunnel = shared.CloudflareTunnel
A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
This is an alias to an internal type.
type CloudflareTunnelConfigSrc ¶
type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc
Indicates if this is a locally or remotely configured tunnel. If `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`, manage the tunnel on the Zero Trust dashboard.
This is an alias to an internal type.
type CloudflareTunnelConnection ¶
type CloudflareTunnelConnection = shared.CloudflareTunnelConnection
This is an alias to an internal type.
type CloudflareTunnelStatus ¶
type CloudflareTunnelStatus = shared.CloudflareTunnelStatus
The status of the tunnel. Valid values are `inactive` (tunnel has never been run), `degraded` (tunnel is active and able to serve traffic but in an unhealthy state), `healthy` (tunnel is active and able to serve traffic), or `down` (tunnel can not serve traffic as it has no connections to the Cloudflare Edge).
This is an alias to an internal type.
type CloudflareTunnelTunType ¶
type CloudflareTunnelTunType = shared.CloudflareTunnelTunType
The type of tunnel.
This is an alias to an internal type.
type ErrorDataSource ¶
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type PageService ¶
type PageService struct {
Options []option.RequestOption
Projects *ProjectService
}
PageService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPageService method instead.
func NewPageService ¶
func NewPageService(opts ...option.RequestOption) (r *PageService)
NewPageService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type PermissionGrant ¶
type PermissionGrant = shared.PermissionGrant
This is an alias to an internal type.
type PermissionGrantParam ¶
type PermissionGrantParam = shared.PermissionGrantParam
This is an alias to an internal type.
type ProjectDeleteParams ¶
type ProjectDeleteResponse ¶
type ProjectDeleteResponse = interface{}
type ProjectDeleteResponseEnvelope ¶
type ProjectDeleteResponseEnvelope struct {
Errors []ProjectDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeleteResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeleteResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success ProjectDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeSuccess ¶
type ProjectDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeleteResponseEnvelopeSuccessTrue ProjectDeleteResponseEnvelopeSuccess = true
)
func (ProjectDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeleteResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentDeleteResponse ¶
type ProjectDeploymentDeleteResponse = interface{}
type ProjectDeploymentDeleteResponseEnvelope ¶
type ProjectDeploymentDeleteResponseEnvelope struct {
Errors []ProjectDeploymentDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentDeleteResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentDeleteResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success ProjectDeploymentDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeSuccess ¶
type ProjectDeploymentDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentDeleteResponseEnvelopeSuccessTrue ProjectDeploymentDeleteResponseEnvelopeSuccess = true
)
func (ProjectDeploymentDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentDeleteResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentGetResponse ¶ added in v6.4.0
type ProjectDeploymentGetResponse struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectDeploymentGetResponseBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectDeploymentGetResponseDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentGetResponseEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectDeploymentGetResponseEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectDeploymentGetResponseSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectDeploymentGetResponseJSON `json:"-"`
}
func (*ProjectDeploymentGetResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseBuildConfig ¶ added in v6.4.0
type ProjectDeploymentGetResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectDeploymentGetResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectDeploymentGetResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseDeploymentTrigger ¶ added in v6.4.0
type ProjectDeploymentGetResponseDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectDeploymentGetResponseDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectDeploymentGetResponseDeploymentTriggerType `json:"type,required"`
JSON projectDeploymentGetResponseDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectDeploymentGetResponseDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectDeploymentGetResponseDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectDeploymentGetResponseDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectDeploymentGetResponseDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseDeploymentTriggerType ¶ added in v6.4.0
type ProjectDeploymentGetResponseDeploymentTriggerType string
What caused the deployment.
const ( ProjectDeploymentGetResponseDeploymentTriggerTypeGitHubPush ProjectDeploymentGetResponseDeploymentTriggerType = "github:push" ProjectDeploymentGetResponseDeploymentTriggerTypeADHoc ProjectDeploymentGetResponseDeploymentTriggerType = "ad_hoc" ProjectDeploymentGetResponseDeploymentTriggerTypeDeployHook ProjectDeploymentGetResponseDeploymentTriggerType = "deploy_hook" )
func (ProjectDeploymentGetResponseDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseDeploymentTriggerType) IsKnown() bool
type ProjectDeploymentGetResponseEnvVar ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVar struct {
Type ProjectDeploymentGetResponseEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentGetResponseEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentGetResponseEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseEnvVar) AsUnion() ProjectDeploymentGetResponseEnvVarsUnion
AsUnion returns a ProjectDeploymentGetResponseEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar, ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentGetResponseEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentGetResponseEnvVarsType ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsType string
const ( ProjectDeploymentGetResponseEnvVarsTypePlainText ProjectDeploymentGetResponseEnvVarsType = "plain_text" ProjectDeploymentGetResponseEnvVarsTypeSecretText ProjectDeploymentGetResponseEnvVarsType = "secret_text" )
func (ProjectDeploymentGetResponseEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseEnvVarsType) IsKnown() bool
type ProjectDeploymentGetResponseEnvVarsUnion ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentGetResponseEnvVarsPagesPlainTextEnvVar or ProjectDeploymentGetResponseEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentGetResponseEnvelope ¶
type ProjectDeploymentGetResponseEnvelope struct {
Errors []ProjectDeploymentGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentGetResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentGetResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDeploymentGetResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeSuccess ¶
type ProjectDeploymentGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentGetResponseEnvelopeSuccessTrue ProjectDeploymentGetResponseEnvelopeSuccess = true
)
func (ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentGetResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentGetResponseEnvironment ¶ added in v6.4.0
type ProjectDeploymentGetResponseEnvironment string
Type of deploy.
const ( ProjectDeploymentGetResponseEnvironmentPreview ProjectDeploymentGetResponseEnvironment = "preview" ProjectDeploymentGetResponseEnvironmentProduction ProjectDeploymentGetResponseEnvironment = "production" )
func (ProjectDeploymentGetResponseEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseEnvironment) IsKnown() bool
type ProjectDeploymentGetResponseSource ¶ added in v6.4.0
type ProjectDeploymentGetResponseSource struct {
Config ProjectDeploymentGetResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectDeploymentGetResponseSourceType `json:"type,required"`
JSON projectDeploymentGetResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectDeploymentGetResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseSourceConfig ¶ added in v6.4.0
type ProjectDeploymentGetResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectDeploymentGetResponseSourceConfigJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentGetResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSettingAll ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting = "all" ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSettingNone ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting = "none" ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSettingCustom ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectDeploymentGetResponseSourceType ¶ added in v6.4.0
type ProjectDeploymentGetResponseSourceType string
The source control management provider.
const ( ProjectDeploymentGetResponseSourceTypeGitHub ProjectDeploymentGetResponseSourceType = "github" ProjectDeploymentGetResponseSourceTypeGitlab ProjectDeploymentGetResponseSourceType = "gitlab" )
func (ProjectDeploymentGetResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentGetResponseSourceType) IsKnown() bool
type ProjectDeploymentHistoryLogGetResponse ¶
type ProjectDeploymentHistoryLogGetResponse struct {
Data []ProjectDeploymentHistoryLogGetResponseData `json:"data,required"`
IncludesContainerLogs bool `json:"includes_container_logs,required"`
Total int64 `json:"total,required"`
JSON projectDeploymentHistoryLogGetResponseJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseData ¶
type ProjectDeploymentHistoryLogGetResponseData struct {
Line string `json:"line,required"`
Ts string `json:"ts,required"`
JSON projectDeploymentHistoryLogGetResponseDataJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelope ¶
type ProjectDeploymentHistoryLogGetResponseEnvelope struct {
Errors []ProjectDeploymentHistoryLogGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentHistoryLogGetResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentHistoryLogGetResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess ¶
type ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentHistoryLogGetResponseEnvelopeSuccessTrue ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess = true
)
func (ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentHistoryLogService ¶
type ProjectDeploymentHistoryLogService struct {
Options []option.RequestOption
}
ProjectDeploymentHistoryLogService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectDeploymentHistoryLogService method instead.
func NewProjectDeploymentHistoryLogService ¶
func NewProjectDeploymentHistoryLogService(opts ...option.RequestOption) (r *ProjectDeploymentHistoryLogService)
NewProjectDeploymentHistoryLogService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ProjectDeploymentHistoryLogService) Get ¶
func (r *ProjectDeploymentHistoryLogService) Get(ctx context.Context, projectName string, deploymentID string, query ProjectDeploymentHistoryLogGetParams, opts ...option.RequestOption) (res *ProjectDeploymentHistoryLogGetResponse, err error)
Fetch deployment logs for a project.
type ProjectDeploymentHistoryService ¶
type ProjectDeploymentHistoryService struct {
Options []option.RequestOption
Logs *ProjectDeploymentHistoryLogService
}
ProjectDeploymentHistoryService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectDeploymentHistoryService method instead.
func NewProjectDeploymentHistoryService ¶
func NewProjectDeploymentHistoryService(opts ...option.RequestOption) (r *ProjectDeploymentHistoryService)
NewProjectDeploymentHistoryService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
type ProjectDeploymentListParams ¶
type ProjectDeploymentListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// What type of deployments to fetch.
Env param.Field[ProjectDeploymentListParamsEnv] `query:"env"`
// Which page of deployments to fetch.
Page param.Field[int64] `query:"page"`
// How many deployments to return per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (ProjectDeploymentListParams) URLQuery ¶
func (r ProjectDeploymentListParams) URLQuery() (v url.Values)
URLQuery serializes ProjectDeploymentListParams's query parameters as `url.Values`.
type ProjectDeploymentListParamsEnv ¶
type ProjectDeploymentListParamsEnv string
What type of deployments to fetch.
const ( ProjectDeploymentListParamsEnvProduction ProjectDeploymentListParamsEnv = "production" ProjectDeploymentListParamsEnvPreview ProjectDeploymentListParamsEnv = "preview" )
func (ProjectDeploymentListParamsEnv) IsKnown ¶
func (r ProjectDeploymentListParamsEnv) IsKnown() bool
type ProjectDeploymentListResponse ¶ added in v6.4.0
type ProjectDeploymentListResponse struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectDeploymentListResponseBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectDeploymentListResponseDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentListResponseEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectDeploymentListResponseEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectDeploymentListResponseSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectDeploymentListResponseJSON `json:"-"`
}
func (*ProjectDeploymentListResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseBuildConfig ¶ added in v6.4.0
type ProjectDeploymentListResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectDeploymentListResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectDeploymentListResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseDeploymentTrigger ¶ added in v6.4.0
type ProjectDeploymentListResponseDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectDeploymentListResponseDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectDeploymentListResponseDeploymentTriggerType `json:"type,required"`
JSON projectDeploymentListResponseDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectDeploymentListResponseDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectDeploymentListResponseDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectDeploymentListResponseDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectDeploymentListResponseDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseDeploymentTriggerType ¶ added in v6.4.0
type ProjectDeploymentListResponseDeploymentTriggerType string
What caused the deployment.
const ( ProjectDeploymentListResponseDeploymentTriggerTypeGitHubPush ProjectDeploymentListResponseDeploymentTriggerType = "github:push" ProjectDeploymentListResponseDeploymentTriggerTypeADHoc ProjectDeploymentListResponseDeploymentTriggerType = "ad_hoc" ProjectDeploymentListResponseDeploymentTriggerTypeDeployHook ProjectDeploymentListResponseDeploymentTriggerType = "deploy_hook" )
func (ProjectDeploymentListResponseDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseDeploymentTriggerType) IsKnown() bool
type ProjectDeploymentListResponseEnvVar ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVar struct {
Type ProjectDeploymentListResponseEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentListResponseEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentListResponseEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectDeploymentListResponseEnvVar) AsUnion() ProjectDeploymentListResponseEnvVarsUnion
AsUnion returns a ProjectDeploymentListResponseEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar, ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentListResponseEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentListResponseEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectDeploymentListResponseEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentListResponseEnvVarsType ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsType string
const ( ProjectDeploymentListResponseEnvVarsTypePlainText ProjectDeploymentListResponseEnvVarsType = "plain_text" ProjectDeploymentListResponseEnvVarsTypeSecretText ProjectDeploymentListResponseEnvVarsType = "secret_text" )
func (ProjectDeploymentListResponseEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseEnvVarsType) IsKnown() bool
type ProjectDeploymentListResponseEnvVarsUnion ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentListResponseEnvVarsPagesPlainTextEnvVar or ProjectDeploymentListResponseEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentListResponseEnvironment ¶ added in v6.4.0
type ProjectDeploymentListResponseEnvironment string
Type of deploy.
const ( ProjectDeploymentListResponseEnvironmentPreview ProjectDeploymentListResponseEnvironment = "preview" ProjectDeploymentListResponseEnvironmentProduction ProjectDeploymentListResponseEnvironment = "production" )
func (ProjectDeploymentListResponseEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseEnvironment) IsKnown() bool
type ProjectDeploymentListResponseSource ¶ added in v6.4.0
type ProjectDeploymentListResponseSource struct {
Config ProjectDeploymentListResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectDeploymentListResponseSourceType `json:"type,required"`
JSON projectDeploymentListResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectDeploymentListResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseSourceConfig ¶ added in v6.4.0
type ProjectDeploymentListResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectDeploymentListResponseSourceConfigJSON `json:"-"`
}
func (*ProjectDeploymentListResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentListResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectDeploymentListResponseSourceConfigPreviewDeploymentSettingAll ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting = "all" ProjectDeploymentListResponseSourceConfigPreviewDeploymentSettingNone ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting = "none" ProjectDeploymentListResponseSourceConfigPreviewDeploymentSettingCustom ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectDeploymentListResponseSourceType ¶ added in v6.4.0
type ProjectDeploymentListResponseSourceType string
The source control management provider.
const ( ProjectDeploymentListResponseSourceTypeGitHub ProjectDeploymentListResponseSourceType = "github" ProjectDeploymentListResponseSourceTypeGitlab ProjectDeploymentListResponseSourceType = "gitlab" )
func (ProjectDeploymentListResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentListResponseSourceType) IsKnown() bool
type ProjectDeploymentNewParams ¶
type ProjectDeploymentNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Headers configuration file for the deployment.
Headers param.Field[io.Reader] `json:"_headers" format:"binary"`
// Redirects configuration file for the deployment.
Redirects param.Field[io.Reader] `json:"_redirects" format:"binary"`
// Routes configuration file defining routing rules.
RoutesJson param.Field[io.Reader] `json:"_routes.json" format:"binary"`
// Worker bundle file in multipart/form-data format. Mutually exclusive with
// `_worker.js`. Cannot specify both `_worker.js` and `_worker.bundle` in the same
// request. Maximum size: 25 MiB.
WorkerBundle param.Field[io.Reader] `json:"_worker.bundle" format:"binary"`
// Worker JavaScript file. Mutually exclusive with `_worker.bundle`. Cannot specify
// both `_worker.js` and `_worker.bundle` in the same request.
WorkerJS param.Field[io.Reader] `json:"_worker.js" format:"binary"`
// The branch to build the new deployment from. The `HEAD` of the branch will be
// used. If omitted, the production branch will be used by default.
Branch param.Field[string] `json:"branch"`
// Boolean string indicating if the working directory has uncommitted changes.
CommitDirty param.Field[ProjectDeploymentNewParamsCommitDirty] `json:"commit_dirty"`
// Git commit SHA associated with this deployment.
CommitHash param.Field[string] `json:"commit_hash"`
// Git commit message associated with this deployment.
CommitMessage param.Field[string] `json:"commit_message"`
// Functions routing configuration file.
FunctionsFilepathRoutingConfigJson param.Field[io.Reader] `json:"functions-filepath-routing-config.json" format:"binary"`
// JSON string containing a manifest of files to deploy. Maps file paths to their
// content hashes. Required for direct upload deployments. Maximum 20,000 entries.
Manifest param.Field[string] `json:"manifest"`
// The build output directory path.
PagesBuildOutputDir param.Field[string] `json:"pages_build_output_dir"`
// Hash of the Wrangler configuration file used for this deployment.
WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}
func (ProjectDeploymentNewParams) MarshalMultipart ¶
func (r ProjectDeploymentNewParams) MarshalMultipart() (data []byte, contentType string, err error)
type ProjectDeploymentNewParamsCommitDirty ¶ added in v6.2.0
type ProjectDeploymentNewParamsCommitDirty string
Boolean string indicating if the working directory has uncommitted changes.
const ( ProjectDeploymentNewParamsCommitDirtyTrue ProjectDeploymentNewParamsCommitDirty = "true" ProjectDeploymentNewParamsCommitDirtyFalse ProjectDeploymentNewParamsCommitDirty = "false" )
func (ProjectDeploymentNewParamsCommitDirty) IsKnown ¶ added in v6.2.0
func (r ProjectDeploymentNewParamsCommitDirty) IsKnown() bool
type ProjectDeploymentNewResponse ¶ added in v6.4.0
type ProjectDeploymentNewResponse struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectDeploymentNewResponseBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectDeploymentNewResponseDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentNewResponseEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectDeploymentNewResponseEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectDeploymentNewResponseSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectDeploymentNewResponseJSON `json:"-"`
}
func (*ProjectDeploymentNewResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseBuildConfig ¶ added in v6.4.0
type ProjectDeploymentNewResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectDeploymentNewResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectDeploymentNewResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseDeploymentTrigger ¶ added in v6.4.0
type ProjectDeploymentNewResponseDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectDeploymentNewResponseDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectDeploymentNewResponseDeploymentTriggerType `json:"type,required"`
JSON projectDeploymentNewResponseDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectDeploymentNewResponseDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectDeploymentNewResponseDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectDeploymentNewResponseDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectDeploymentNewResponseDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseDeploymentTriggerType ¶ added in v6.4.0
type ProjectDeploymentNewResponseDeploymentTriggerType string
What caused the deployment.
const ( ProjectDeploymentNewResponseDeploymentTriggerTypeGitHubPush ProjectDeploymentNewResponseDeploymentTriggerType = "github:push" ProjectDeploymentNewResponseDeploymentTriggerTypeADHoc ProjectDeploymentNewResponseDeploymentTriggerType = "ad_hoc" ProjectDeploymentNewResponseDeploymentTriggerTypeDeployHook ProjectDeploymentNewResponseDeploymentTriggerType = "deploy_hook" )
func (ProjectDeploymentNewResponseDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseDeploymentTriggerType) IsKnown() bool
type ProjectDeploymentNewResponseEnvVar ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVar struct {
Type ProjectDeploymentNewResponseEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentNewResponseEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentNewResponseEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseEnvVar) AsUnion() ProjectDeploymentNewResponseEnvVarsUnion
AsUnion returns a ProjectDeploymentNewResponseEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar, ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentNewResponseEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentNewResponseEnvVarsType ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsType string
const ( ProjectDeploymentNewResponseEnvVarsTypePlainText ProjectDeploymentNewResponseEnvVarsType = "plain_text" ProjectDeploymentNewResponseEnvVarsTypeSecretText ProjectDeploymentNewResponseEnvVarsType = "secret_text" )
func (ProjectDeploymentNewResponseEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseEnvVarsType) IsKnown() bool
type ProjectDeploymentNewResponseEnvVarsUnion ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentNewResponseEnvVarsPagesPlainTextEnvVar or ProjectDeploymentNewResponseEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentNewResponseEnvelope ¶
type ProjectDeploymentNewResponseEnvelope struct {
Errors []ProjectDeploymentNewResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentNewResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentNewResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDeploymentNewResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentNewResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeSuccess ¶
type ProjectDeploymentNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentNewResponseEnvelopeSuccessTrue ProjectDeploymentNewResponseEnvelopeSuccess = true
)
func (ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentNewResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentNewResponseEnvironment ¶ added in v6.4.0
type ProjectDeploymentNewResponseEnvironment string
Type of deploy.
const ( ProjectDeploymentNewResponseEnvironmentPreview ProjectDeploymentNewResponseEnvironment = "preview" ProjectDeploymentNewResponseEnvironmentProduction ProjectDeploymentNewResponseEnvironment = "production" )
func (ProjectDeploymentNewResponseEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseEnvironment) IsKnown() bool
type ProjectDeploymentNewResponseSource ¶ added in v6.4.0
type ProjectDeploymentNewResponseSource struct {
Config ProjectDeploymentNewResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectDeploymentNewResponseSourceType `json:"type,required"`
JSON projectDeploymentNewResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectDeploymentNewResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseSourceConfig ¶ added in v6.4.0
type ProjectDeploymentNewResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectDeploymentNewResponseSourceConfigJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentNewResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSettingAll ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting = "all" ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSettingNone ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting = "none" ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSettingCustom ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectDeploymentNewResponseSourceType ¶ added in v6.4.0
type ProjectDeploymentNewResponseSourceType string
The source control management provider.
const ( ProjectDeploymentNewResponseSourceTypeGitHub ProjectDeploymentNewResponseSourceType = "github" ProjectDeploymentNewResponseSourceTypeGitlab ProjectDeploymentNewResponseSourceType = "gitlab" )
func (ProjectDeploymentNewResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentNewResponseSourceType) IsKnown() bool
type ProjectDeploymentRetryResponse ¶ added in v6.4.0
type ProjectDeploymentRetryResponse struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectDeploymentRetryResponseBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectDeploymentRetryResponseDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentRetryResponseEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectDeploymentRetryResponseEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectDeploymentRetryResponseSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectDeploymentRetryResponseJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseBuildConfig ¶ added in v6.4.0
type ProjectDeploymentRetryResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectDeploymentRetryResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectDeploymentRetryResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseDeploymentTrigger ¶ added in v6.4.0
type ProjectDeploymentRetryResponseDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectDeploymentRetryResponseDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectDeploymentRetryResponseDeploymentTriggerType `json:"type,required"`
JSON projectDeploymentRetryResponseDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectDeploymentRetryResponseDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectDeploymentRetryResponseDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectDeploymentRetryResponseDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectDeploymentRetryResponseDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseDeploymentTriggerType ¶ added in v6.4.0
type ProjectDeploymentRetryResponseDeploymentTriggerType string
What caused the deployment.
const ( ProjectDeploymentRetryResponseDeploymentTriggerTypeGitHubPush ProjectDeploymentRetryResponseDeploymentTriggerType = "github:push" ProjectDeploymentRetryResponseDeploymentTriggerTypeADHoc ProjectDeploymentRetryResponseDeploymentTriggerType = "ad_hoc" ProjectDeploymentRetryResponseDeploymentTriggerTypeDeployHook ProjectDeploymentRetryResponseDeploymentTriggerType = "deploy_hook" )
func (ProjectDeploymentRetryResponseDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseDeploymentTriggerType) IsKnown() bool
type ProjectDeploymentRetryResponseEnvVar ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVar struct {
Type ProjectDeploymentRetryResponseEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentRetryResponseEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentRetryResponseEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseEnvVar) AsUnion() ProjectDeploymentRetryResponseEnvVarsUnion
AsUnion returns a ProjectDeploymentRetryResponseEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar, ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentRetryResponseEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentRetryResponseEnvVarsType ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsType string
const ( ProjectDeploymentRetryResponseEnvVarsTypePlainText ProjectDeploymentRetryResponseEnvVarsType = "plain_text" ProjectDeploymentRetryResponseEnvVarsTypeSecretText ProjectDeploymentRetryResponseEnvVarsType = "secret_text" )
func (ProjectDeploymentRetryResponseEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseEnvVarsType) IsKnown() bool
type ProjectDeploymentRetryResponseEnvVarsUnion ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentRetryResponseEnvVarsPagesPlainTextEnvVar or ProjectDeploymentRetryResponseEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentRetryResponseEnvelope ¶
type ProjectDeploymentRetryResponseEnvelope struct {
Errors []ProjectDeploymentRetryResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentRetryResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentRetryResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDeploymentRetryResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentRetryResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRetryResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentRetryResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRetryResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRetryResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentRetryResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRetryResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeSuccess ¶
type ProjectDeploymentRetryResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentRetryResponseEnvelopeSuccessTrue ProjectDeploymentRetryResponseEnvelopeSuccess = true
)
func (ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentRetryResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentRetryResponseEnvironment ¶ added in v6.4.0
type ProjectDeploymentRetryResponseEnvironment string
Type of deploy.
const ( ProjectDeploymentRetryResponseEnvironmentPreview ProjectDeploymentRetryResponseEnvironment = "preview" ProjectDeploymentRetryResponseEnvironmentProduction ProjectDeploymentRetryResponseEnvironment = "production" )
func (ProjectDeploymentRetryResponseEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseEnvironment) IsKnown() bool
type ProjectDeploymentRetryResponseSource ¶ added in v6.4.0
type ProjectDeploymentRetryResponseSource struct {
Config ProjectDeploymentRetryResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectDeploymentRetryResponseSourceType `json:"type,required"`
JSON projectDeploymentRetryResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectDeploymentRetryResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseSourceConfig ¶ added in v6.4.0
type ProjectDeploymentRetryResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectDeploymentRetryResponseSourceConfigJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRetryResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSettingAll ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting = "all" ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSettingNone ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting = "none" ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSettingCustom ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectDeploymentRetryResponseSourceType ¶ added in v6.4.0
type ProjectDeploymentRetryResponseSourceType string
The source control management provider.
const ( ProjectDeploymentRetryResponseSourceTypeGitHub ProjectDeploymentRetryResponseSourceType = "github" ProjectDeploymentRetryResponseSourceTypeGitlab ProjectDeploymentRetryResponseSourceType = "gitlab" )
func (ProjectDeploymentRetryResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRetryResponseSourceType) IsKnown() bool
type ProjectDeploymentRollbackResponse ¶ added in v6.4.0
type ProjectDeploymentRollbackResponse struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectDeploymentRollbackResponseBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectDeploymentRollbackResponseDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentRollbackResponseEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectDeploymentRollbackResponseEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectDeploymentRollbackResponseSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectDeploymentRollbackResponseJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseBuildConfig ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectDeploymentRollbackResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectDeploymentRollbackResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseDeploymentTrigger ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectDeploymentRollbackResponseDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectDeploymentRollbackResponseDeploymentTriggerType `json:"type,required"`
JSON projectDeploymentRollbackResponseDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectDeploymentRollbackResponseDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectDeploymentRollbackResponseDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectDeploymentRollbackResponseDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseDeploymentTriggerType ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseDeploymentTriggerType string
What caused the deployment.
const ( ProjectDeploymentRollbackResponseDeploymentTriggerTypeGitHubPush ProjectDeploymentRollbackResponseDeploymentTriggerType = "github:push" ProjectDeploymentRollbackResponseDeploymentTriggerTypeADHoc ProjectDeploymentRollbackResponseDeploymentTriggerType = "ad_hoc" ProjectDeploymentRollbackResponseDeploymentTriggerTypeDeployHook ProjectDeploymentRollbackResponseDeploymentTriggerType = "deploy_hook" )
func (ProjectDeploymentRollbackResponseDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseDeploymentTriggerType) IsKnown() bool
type ProjectDeploymentRollbackResponseEnvVar ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVar struct {
Type ProjectDeploymentRollbackResponseEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentRollbackResponseEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentRollbackResponseEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseEnvVar) AsUnion() ProjectDeploymentRollbackResponseEnvVarsUnion
AsUnion returns a ProjectDeploymentRollbackResponseEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar, ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentRollbackResponseEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentRollbackResponseEnvVarsType ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsType string
const ( ProjectDeploymentRollbackResponseEnvVarsTypePlainText ProjectDeploymentRollbackResponseEnvVarsType = "plain_text" ProjectDeploymentRollbackResponseEnvVarsTypeSecretText ProjectDeploymentRollbackResponseEnvVarsType = "secret_text" )
func (ProjectDeploymentRollbackResponseEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseEnvVarsType) IsKnown() bool
type ProjectDeploymentRollbackResponseEnvVarsUnion ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentRollbackResponseEnvVarsPagesPlainTextEnvVar or ProjectDeploymentRollbackResponseEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentRollbackResponseEnvelope ¶
type ProjectDeploymentRollbackResponseEnvelope struct {
Errors []ProjectDeploymentRollbackResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDeploymentRollbackResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDeploymentRollbackResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDeploymentRollbackResponseEnvelopeSuccess `json:"success,required"`
JSON projectDeploymentRollbackResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRollbackResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentRollbackResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRollbackResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRollbackResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentRollbackResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRollbackResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeSuccess ¶
type ProjectDeploymentRollbackResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDeploymentRollbackResponseEnvelopeSuccessTrue ProjectDeploymentRollbackResponseEnvelopeSuccess = true
)
func (ProjectDeploymentRollbackResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDeploymentRollbackResponseEnvelopeSuccess) IsKnown() bool
type ProjectDeploymentRollbackResponseEnvironment ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseEnvironment string
Type of deploy.
const ( ProjectDeploymentRollbackResponseEnvironmentPreview ProjectDeploymentRollbackResponseEnvironment = "preview" ProjectDeploymentRollbackResponseEnvironmentProduction ProjectDeploymentRollbackResponseEnvironment = "production" )
func (ProjectDeploymentRollbackResponseEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseEnvironment) IsKnown() bool
type ProjectDeploymentRollbackResponseSource ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseSource struct {
Config ProjectDeploymentRollbackResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectDeploymentRollbackResponseSourceType `json:"type,required"`
JSON projectDeploymentRollbackResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectDeploymentRollbackResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseSourceConfig ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectDeploymentRollbackResponseSourceConfigJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDeploymentRollbackResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSettingAll ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting = "all" ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSettingNone ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting = "none" ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSettingCustom ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectDeploymentRollbackResponseSourceType ¶ added in v6.4.0
type ProjectDeploymentRollbackResponseSourceType string
The source control management provider.
const ( ProjectDeploymentRollbackResponseSourceTypeGitHub ProjectDeploymentRollbackResponseSourceType = "github" ProjectDeploymentRollbackResponseSourceTypeGitlab ProjectDeploymentRollbackResponseSourceType = "gitlab" )
func (ProjectDeploymentRollbackResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectDeploymentRollbackResponseSourceType) IsKnown() bool
type ProjectDeploymentService ¶
type ProjectDeploymentService struct {
Options []option.RequestOption
History *ProjectDeploymentHistoryService
}
ProjectDeploymentService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectDeploymentService method instead.
func NewProjectDeploymentService ¶
func NewProjectDeploymentService(opts ...option.RequestOption) (r *ProjectDeploymentService)
NewProjectDeploymentService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ProjectDeploymentService) Delete ¶
func (r *ProjectDeploymentService) Delete(ctx context.Context, projectName string, deploymentID string, body ProjectDeploymentDeleteParams, opts ...option.RequestOption) (res *ProjectDeploymentDeleteResponse, err error)
Delete a deployment.
func (*ProjectDeploymentService) Get ¶
func (r *ProjectDeploymentService) Get(ctx context.Context, projectName string, deploymentID string, query ProjectDeploymentGetParams, opts ...option.RequestOption) (res *ProjectDeploymentGetResponse, err error)
Fetch information about a deployment.
func (*ProjectDeploymentService) List ¶
func (r *ProjectDeploymentService) List(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ProjectDeploymentListResponse], err error)
Fetch a list of project deployments.
func (*ProjectDeploymentService) ListAutoPaging ¶
func (r *ProjectDeploymentService) ListAutoPaging(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ProjectDeploymentListResponse]
Fetch a list of project deployments.
func (*ProjectDeploymentService) New ¶
func (r *ProjectDeploymentService) New(ctx context.Context, projectName string, params ProjectDeploymentNewParams, opts ...option.RequestOption) (res *ProjectDeploymentNewResponse, err error)
Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.
func (*ProjectDeploymentService) Retry ¶
func (r *ProjectDeploymentService) Retry(ctx context.Context, projectName string, deploymentID string, body ProjectDeploymentRetryParams, opts ...option.RequestOption) (res *ProjectDeploymentRetryResponse, 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 *ProjectDeploymentRollbackResponse, err error)
Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.
type ProjectDomainDeleteResponse ¶
type ProjectDomainDeleteResponse = interface{}
type ProjectDomainDeleteResponseEnvelope ¶
type ProjectDomainDeleteResponseEnvelope struct {
Errors []ProjectDomainDeleteResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDomainDeleteResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDomainDeleteResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success ProjectDomainDeleteResponseEnvelopeSuccess `json:"success,required"`
JSON projectDomainDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDomainDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDomainDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDomainDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDomainDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeSuccess ¶
type ProjectDomainDeleteResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDomainDeleteResponseEnvelopeSuccessTrue ProjectDomainDeleteResponseEnvelopeSuccess = true
)
func (ProjectDomainDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDomainDeleteResponseEnvelopeSuccess) IsKnown() bool
type ProjectDomainEditParams ¶
type ProjectDomainEditResponse ¶
type ProjectDomainEditResponse struct {
ID string `json:"id,required"`
CertificateAuthority ProjectDomainEditResponseCertificateAuthority `json:"certificate_authority,required"`
CreatedOn string `json:"created_on,required"`
DomainID string `json:"domain_id,required"`
// The domain name.
Name string `json:"name,required"`
Status ProjectDomainEditResponseStatus `json:"status,required"`
ValidationData ProjectDomainEditResponseValidationData `json:"validation_data,required"`
VerificationData ProjectDomainEditResponseVerificationData `json:"verification_data,required"`
ZoneTag string `json:"zone_tag,required"`
JSON projectDomainEditResponseJSON `json:"-"`
}
func (*ProjectDomainEditResponse) UnmarshalJSON ¶
func (r *ProjectDomainEditResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseCertificateAuthority ¶
type ProjectDomainEditResponseCertificateAuthority string
const ( ProjectDomainEditResponseCertificateAuthorityGoogle ProjectDomainEditResponseCertificateAuthority = "google" ProjectDomainEditResponseCertificateAuthorityLetsEncrypt ProjectDomainEditResponseCertificateAuthority = "lets_encrypt" )
func (ProjectDomainEditResponseCertificateAuthority) IsKnown ¶
func (r ProjectDomainEditResponseCertificateAuthority) IsKnown() bool
type ProjectDomainEditResponseEnvelope ¶
type ProjectDomainEditResponseEnvelope struct {
Errors []ProjectDomainEditResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDomainEditResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDomainEditResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDomainEditResponseEnvelopeSuccess `json:"success,required"`
JSON projectDomainEditResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDomainEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainEditResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDomainEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDomainEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainEditResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDomainEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeSuccess ¶
type ProjectDomainEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDomainEditResponseEnvelopeSuccessTrue ProjectDomainEditResponseEnvelopeSuccess = true
)
func (ProjectDomainEditResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDomainEditResponseEnvelopeSuccess) IsKnown() bool
type ProjectDomainEditResponseStatus ¶
type ProjectDomainEditResponseStatus string
const ( ProjectDomainEditResponseStatusInitializing ProjectDomainEditResponseStatus = "initializing" ProjectDomainEditResponseStatusPending ProjectDomainEditResponseStatus = "pending" ProjectDomainEditResponseStatusActive ProjectDomainEditResponseStatus = "active" ProjectDomainEditResponseStatusDeactivated ProjectDomainEditResponseStatus = "deactivated" ProjectDomainEditResponseStatusBlocked ProjectDomainEditResponseStatus = "blocked" ProjectDomainEditResponseStatusError ProjectDomainEditResponseStatus = "error" )
func (ProjectDomainEditResponseStatus) IsKnown ¶
func (r ProjectDomainEditResponseStatus) IsKnown() bool
type ProjectDomainEditResponseValidationData ¶
type ProjectDomainEditResponseValidationData struct {
Method ProjectDomainEditResponseValidationDataMethod `json:"method,required"`
Status ProjectDomainEditResponseValidationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
TXTName string `json:"txt_name"`
TXTValue string `json:"txt_value"`
JSON projectDomainEditResponseValidationDataJSON `json:"-"`
}
func (*ProjectDomainEditResponseValidationData) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseValidationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseValidationDataMethod ¶
type ProjectDomainEditResponseValidationDataMethod string
const ( ProjectDomainEditResponseValidationDataMethodHTTP ProjectDomainEditResponseValidationDataMethod = "http" ProjectDomainEditResponseValidationDataMethodTXT ProjectDomainEditResponseValidationDataMethod = "txt" )
func (ProjectDomainEditResponseValidationDataMethod) IsKnown ¶
func (r ProjectDomainEditResponseValidationDataMethod) IsKnown() bool
type ProjectDomainEditResponseValidationDataStatus ¶
type ProjectDomainEditResponseValidationDataStatus string
const ( ProjectDomainEditResponseValidationDataStatusInitializing ProjectDomainEditResponseValidationDataStatus = "initializing" ProjectDomainEditResponseValidationDataStatusPending ProjectDomainEditResponseValidationDataStatus = "pending" ProjectDomainEditResponseValidationDataStatusActive ProjectDomainEditResponseValidationDataStatus = "active" ProjectDomainEditResponseValidationDataStatusDeactivated ProjectDomainEditResponseValidationDataStatus = "deactivated" ProjectDomainEditResponseValidationDataStatusError ProjectDomainEditResponseValidationDataStatus = "error" )
func (ProjectDomainEditResponseValidationDataStatus) IsKnown ¶
func (r ProjectDomainEditResponseValidationDataStatus) IsKnown() bool
type ProjectDomainEditResponseVerificationData ¶
type ProjectDomainEditResponseVerificationData struct {
Status ProjectDomainEditResponseVerificationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
JSON projectDomainEditResponseVerificationDataJSON `json:"-"`
}
func (*ProjectDomainEditResponseVerificationData) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseVerificationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseVerificationDataStatus ¶
type ProjectDomainEditResponseVerificationDataStatus string
const ( ProjectDomainEditResponseVerificationDataStatusPending ProjectDomainEditResponseVerificationDataStatus = "pending" ProjectDomainEditResponseVerificationDataStatusActive ProjectDomainEditResponseVerificationDataStatus = "active" ProjectDomainEditResponseVerificationDataStatusDeactivated ProjectDomainEditResponseVerificationDataStatus = "deactivated" ProjectDomainEditResponseVerificationDataStatusBlocked ProjectDomainEditResponseVerificationDataStatus = "blocked" ProjectDomainEditResponseVerificationDataStatusError ProjectDomainEditResponseVerificationDataStatus = "error" )
func (ProjectDomainEditResponseVerificationDataStatus) IsKnown ¶
func (r ProjectDomainEditResponseVerificationDataStatus) IsKnown() bool
type ProjectDomainGetParams ¶
type ProjectDomainGetResponse ¶
type ProjectDomainGetResponse struct {
ID string `json:"id,required"`
CertificateAuthority ProjectDomainGetResponseCertificateAuthority `json:"certificate_authority,required"`
CreatedOn string `json:"created_on,required"`
DomainID string `json:"domain_id,required"`
// The domain name.
Name string `json:"name,required"`
Status ProjectDomainGetResponseStatus `json:"status,required"`
ValidationData ProjectDomainGetResponseValidationData `json:"validation_data,required"`
VerificationData ProjectDomainGetResponseVerificationData `json:"verification_data,required"`
ZoneTag string `json:"zone_tag,required"`
JSON projectDomainGetResponseJSON `json:"-"`
}
func (*ProjectDomainGetResponse) UnmarshalJSON ¶
func (r *ProjectDomainGetResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseCertificateAuthority ¶
type ProjectDomainGetResponseCertificateAuthority string
const ( ProjectDomainGetResponseCertificateAuthorityGoogle ProjectDomainGetResponseCertificateAuthority = "google" ProjectDomainGetResponseCertificateAuthorityLetsEncrypt ProjectDomainGetResponseCertificateAuthority = "lets_encrypt" )
func (ProjectDomainGetResponseCertificateAuthority) IsKnown ¶
func (r ProjectDomainGetResponseCertificateAuthority) IsKnown() bool
type ProjectDomainGetResponseEnvelope ¶
type ProjectDomainGetResponseEnvelope struct {
Errors []ProjectDomainGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDomainGetResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDomainGetResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDomainGetResponseEnvelopeSuccess `json:"success,required"`
JSON projectDomainGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDomainGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDomainGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDomainGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDomainGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeSuccess ¶
type ProjectDomainGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDomainGetResponseEnvelopeSuccessTrue ProjectDomainGetResponseEnvelopeSuccess = true
)
func (ProjectDomainGetResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDomainGetResponseEnvelopeSuccess) IsKnown() bool
type ProjectDomainGetResponseStatus ¶
type ProjectDomainGetResponseStatus string
const ( ProjectDomainGetResponseStatusInitializing ProjectDomainGetResponseStatus = "initializing" ProjectDomainGetResponseStatusPending ProjectDomainGetResponseStatus = "pending" ProjectDomainGetResponseStatusActive ProjectDomainGetResponseStatus = "active" ProjectDomainGetResponseStatusDeactivated ProjectDomainGetResponseStatus = "deactivated" ProjectDomainGetResponseStatusBlocked ProjectDomainGetResponseStatus = "blocked" ProjectDomainGetResponseStatusError ProjectDomainGetResponseStatus = "error" )
func (ProjectDomainGetResponseStatus) IsKnown ¶
func (r ProjectDomainGetResponseStatus) IsKnown() bool
type ProjectDomainGetResponseValidationData ¶
type ProjectDomainGetResponseValidationData struct {
Method ProjectDomainGetResponseValidationDataMethod `json:"method,required"`
Status ProjectDomainGetResponseValidationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
TXTName string `json:"txt_name"`
TXTValue string `json:"txt_value"`
JSON projectDomainGetResponseValidationDataJSON `json:"-"`
}
func (*ProjectDomainGetResponseValidationData) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseValidationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseValidationDataMethod ¶
type ProjectDomainGetResponseValidationDataMethod string
const ( ProjectDomainGetResponseValidationDataMethodHTTP ProjectDomainGetResponseValidationDataMethod = "http" ProjectDomainGetResponseValidationDataMethodTXT ProjectDomainGetResponseValidationDataMethod = "txt" )
func (ProjectDomainGetResponseValidationDataMethod) IsKnown ¶
func (r ProjectDomainGetResponseValidationDataMethod) IsKnown() bool
type ProjectDomainGetResponseValidationDataStatus ¶
type ProjectDomainGetResponseValidationDataStatus string
const ( ProjectDomainGetResponseValidationDataStatusInitializing ProjectDomainGetResponseValidationDataStatus = "initializing" ProjectDomainGetResponseValidationDataStatusPending ProjectDomainGetResponseValidationDataStatus = "pending" ProjectDomainGetResponseValidationDataStatusActive ProjectDomainGetResponseValidationDataStatus = "active" ProjectDomainGetResponseValidationDataStatusDeactivated ProjectDomainGetResponseValidationDataStatus = "deactivated" ProjectDomainGetResponseValidationDataStatusError ProjectDomainGetResponseValidationDataStatus = "error" )
func (ProjectDomainGetResponseValidationDataStatus) IsKnown ¶
func (r ProjectDomainGetResponseValidationDataStatus) IsKnown() bool
type ProjectDomainGetResponseVerificationData ¶
type ProjectDomainGetResponseVerificationData struct {
Status ProjectDomainGetResponseVerificationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
JSON projectDomainGetResponseVerificationDataJSON `json:"-"`
}
func (*ProjectDomainGetResponseVerificationData) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseVerificationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseVerificationDataStatus ¶
type ProjectDomainGetResponseVerificationDataStatus string
const ( ProjectDomainGetResponseVerificationDataStatusPending ProjectDomainGetResponseVerificationDataStatus = "pending" ProjectDomainGetResponseVerificationDataStatusActive ProjectDomainGetResponseVerificationDataStatus = "active" ProjectDomainGetResponseVerificationDataStatusDeactivated ProjectDomainGetResponseVerificationDataStatus = "deactivated" ProjectDomainGetResponseVerificationDataStatusBlocked ProjectDomainGetResponseVerificationDataStatus = "blocked" ProjectDomainGetResponseVerificationDataStatusError ProjectDomainGetResponseVerificationDataStatus = "error" )
func (ProjectDomainGetResponseVerificationDataStatus) IsKnown ¶
func (r ProjectDomainGetResponseVerificationDataStatus) IsKnown() bool
type ProjectDomainListParams ¶
type ProjectDomainListResponse ¶
type ProjectDomainListResponse struct {
ID string `json:"id,required"`
CertificateAuthority ProjectDomainListResponseCertificateAuthority `json:"certificate_authority,required"`
CreatedOn string `json:"created_on,required"`
DomainID string `json:"domain_id,required"`
// The domain name.
Name string `json:"name,required"`
Status ProjectDomainListResponseStatus `json:"status,required"`
ValidationData ProjectDomainListResponseValidationData `json:"validation_data,required"`
VerificationData ProjectDomainListResponseVerificationData `json:"verification_data,required"`
ZoneTag string `json:"zone_tag,required"`
JSON projectDomainListResponseJSON `json:"-"`
}
func (*ProjectDomainListResponse) UnmarshalJSON ¶
func (r *ProjectDomainListResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDomainListResponseCertificateAuthority ¶
type ProjectDomainListResponseCertificateAuthority string
const ( ProjectDomainListResponseCertificateAuthorityGoogle ProjectDomainListResponseCertificateAuthority = "google" ProjectDomainListResponseCertificateAuthorityLetsEncrypt ProjectDomainListResponseCertificateAuthority = "lets_encrypt" )
func (ProjectDomainListResponseCertificateAuthority) IsKnown ¶
func (r ProjectDomainListResponseCertificateAuthority) IsKnown() bool
type ProjectDomainListResponseStatus ¶
type ProjectDomainListResponseStatus string
const ( ProjectDomainListResponseStatusInitializing ProjectDomainListResponseStatus = "initializing" ProjectDomainListResponseStatusPending ProjectDomainListResponseStatus = "pending" ProjectDomainListResponseStatusActive ProjectDomainListResponseStatus = "active" ProjectDomainListResponseStatusDeactivated ProjectDomainListResponseStatus = "deactivated" ProjectDomainListResponseStatusBlocked ProjectDomainListResponseStatus = "blocked" ProjectDomainListResponseStatusError ProjectDomainListResponseStatus = "error" )
func (ProjectDomainListResponseStatus) IsKnown ¶
func (r ProjectDomainListResponseStatus) IsKnown() bool
type ProjectDomainListResponseValidationData ¶
type ProjectDomainListResponseValidationData struct {
Method ProjectDomainListResponseValidationDataMethod `json:"method,required"`
Status ProjectDomainListResponseValidationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
TXTName string `json:"txt_name"`
TXTValue string `json:"txt_value"`
JSON projectDomainListResponseValidationDataJSON `json:"-"`
}
func (*ProjectDomainListResponseValidationData) UnmarshalJSON ¶
func (r *ProjectDomainListResponseValidationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainListResponseValidationDataMethod ¶
type ProjectDomainListResponseValidationDataMethod string
const ( ProjectDomainListResponseValidationDataMethodHTTP ProjectDomainListResponseValidationDataMethod = "http" ProjectDomainListResponseValidationDataMethodTXT ProjectDomainListResponseValidationDataMethod = "txt" )
func (ProjectDomainListResponseValidationDataMethod) IsKnown ¶
func (r ProjectDomainListResponseValidationDataMethod) IsKnown() bool
type ProjectDomainListResponseValidationDataStatus ¶
type ProjectDomainListResponseValidationDataStatus string
const ( ProjectDomainListResponseValidationDataStatusInitializing ProjectDomainListResponseValidationDataStatus = "initializing" ProjectDomainListResponseValidationDataStatusPending ProjectDomainListResponseValidationDataStatus = "pending" ProjectDomainListResponseValidationDataStatusActive ProjectDomainListResponseValidationDataStatus = "active" ProjectDomainListResponseValidationDataStatusDeactivated ProjectDomainListResponseValidationDataStatus = "deactivated" ProjectDomainListResponseValidationDataStatusError ProjectDomainListResponseValidationDataStatus = "error" )
func (ProjectDomainListResponseValidationDataStatus) IsKnown ¶
func (r ProjectDomainListResponseValidationDataStatus) IsKnown() bool
type ProjectDomainListResponseVerificationData ¶
type ProjectDomainListResponseVerificationData struct {
Status ProjectDomainListResponseVerificationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
JSON projectDomainListResponseVerificationDataJSON `json:"-"`
}
func (*ProjectDomainListResponseVerificationData) UnmarshalJSON ¶
func (r *ProjectDomainListResponseVerificationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainListResponseVerificationDataStatus ¶
type ProjectDomainListResponseVerificationDataStatus string
const ( ProjectDomainListResponseVerificationDataStatusPending ProjectDomainListResponseVerificationDataStatus = "pending" ProjectDomainListResponseVerificationDataStatusActive ProjectDomainListResponseVerificationDataStatus = "active" ProjectDomainListResponseVerificationDataStatusDeactivated ProjectDomainListResponseVerificationDataStatus = "deactivated" ProjectDomainListResponseVerificationDataStatusBlocked ProjectDomainListResponseVerificationDataStatus = "blocked" ProjectDomainListResponseVerificationDataStatusError ProjectDomainListResponseVerificationDataStatus = "error" )
func (ProjectDomainListResponseVerificationDataStatus) IsKnown ¶
func (r ProjectDomainListResponseVerificationDataStatus) IsKnown() bool
type ProjectDomainNewParams ¶
type ProjectDomainNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// The domain name.
Name param.Field[string] `json:"name,required"`
}
func (ProjectDomainNewParams) MarshalJSON ¶
func (r ProjectDomainNewParams) MarshalJSON() (data []byte, err error)
type ProjectDomainNewResponse ¶
type ProjectDomainNewResponse struct {
ID string `json:"id,required"`
CertificateAuthority ProjectDomainNewResponseCertificateAuthority `json:"certificate_authority,required"`
CreatedOn string `json:"created_on,required"`
DomainID string `json:"domain_id,required"`
// The domain name.
Name string `json:"name,required"`
Status ProjectDomainNewResponseStatus `json:"status,required"`
ValidationData ProjectDomainNewResponseValidationData `json:"validation_data,required"`
VerificationData ProjectDomainNewResponseVerificationData `json:"verification_data,required"`
ZoneTag string `json:"zone_tag,required"`
JSON projectDomainNewResponseJSON `json:"-"`
}
func (*ProjectDomainNewResponse) UnmarshalJSON ¶
func (r *ProjectDomainNewResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseCertificateAuthority ¶
type ProjectDomainNewResponseCertificateAuthority string
const ( ProjectDomainNewResponseCertificateAuthorityGoogle ProjectDomainNewResponseCertificateAuthority = "google" ProjectDomainNewResponseCertificateAuthorityLetsEncrypt ProjectDomainNewResponseCertificateAuthority = "lets_encrypt" )
func (ProjectDomainNewResponseCertificateAuthority) IsKnown ¶
func (r ProjectDomainNewResponseCertificateAuthority) IsKnown() bool
type ProjectDomainNewResponseEnvelope ¶
type ProjectDomainNewResponseEnvelope struct {
Errors []ProjectDomainNewResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectDomainNewResponseEnvelopeMessages `json:"messages,required"`
Result ProjectDomainNewResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectDomainNewResponseEnvelopeSuccess `json:"success,required"`
JSON projectDomainNewResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectDomainNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectDomainNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectDomainNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectDomainNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeSuccess ¶
type ProjectDomainNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectDomainNewResponseEnvelopeSuccessTrue ProjectDomainNewResponseEnvelopeSuccess = true
)
func (ProjectDomainNewResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectDomainNewResponseEnvelopeSuccess) IsKnown() bool
type ProjectDomainNewResponseStatus ¶
type ProjectDomainNewResponseStatus string
const ( ProjectDomainNewResponseStatusInitializing ProjectDomainNewResponseStatus = "initializing" ProjectDomainNewResponseStatusPending ProjectDomainNewResponseStatus = "pending" ProjectDomainNewResponseStatusActive ProjectDomainNewResponseStatus = "active" ProjectDomainNewResponseStatusDeactivated ProjectDomainNewResponseStatus = "deactivated" ProjectDomainNewResponseStatusBlocked ProjectDomainNewResponseStatus = "blocked" ProjectDomainNewResponseStatusError ProjectDomainNewResponseStatus = "error" )
func (ProjectDomainNewResponseStatus) IsKnown ¶
func (r ProjectDomainNewResponseStatus) IsKnown() bool
type ProjectDomainNewResponseValidationData ¶
type ProjectDomainNewResponseValidationData struct {
Method ProjectDomainNewResponseValidationDataMethod `json:"method,required"`
Status ProjectDomainNewResponseValidationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
TXTName string `json:"txt_name"`
TXTValue string `json:"txt_value"`
JSON projectDomainNewResponseValidationDataJSON `json:"-"`
}
func (*ProjectDomainNewResponseValidationData) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseValidationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseValidationDataMethod ¶
type ProjectDomainNewResponseValidationDataMethod string
const ( ProjectDomainNewResponseValidationDataMethodHTTP ProjectDomainNewResponseValidationDataMethod = "http" ProjectDomainNewResponseValidationDataMethodTXT ProjectDomainNewResponseValidationDataMethod = "txt" )
func (ProjectDomainNewResponseValidationDataMethod) IsKnown ¶
func (r ProjectDomainNewResponseValidationDataMethod) IsKnown() bool
type ProjectDomainNewResponseValidationDataStatus ¶
type ProjectDomainNewResponseValidationDataStatus string
const ( ProjectDomainNewResponseValidationDataStatusInitializing ProjectDomainNewResponseValidationDataStatus = "initializing" ProjectDomainNewResponseValidationDataStatusPending ProjectDomainNewResponseValidationDataStatus = "pending" ProjectDomainNewResponseValidationDataStatusActive ProjectDomainNewResponseValidationDataStatus = "active" ProjectDomainNewResponseValidationDataStatusDeactivated ProjectDomainNewResponseValidationDataStatus = "deactivated" ProjectDomainNewResponseValidationDataStatusError ProjectDomainNewResponseValidationDataStatus = "error" )
func (ProjectDomainNewResponseValidationDataStatus) IsKnown ¶
func (r ProjectDomainNewResponseValidationDataStatus) IsKnown() bool
type ProjectDomainNewResponseVerificationData ¶
type ProjectDomainNewResponseVerificationData struct {
Status ProjectDomainNewResponseVerificationDataStatus `json:"status,required"`
ErrorMessage string `json:"error_message"`
JSON projectDomainNewResponseVerificationDataJSON `json:"-"`
}
func (*ProjectDomainNewResponseVerificationData) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseVerificationData) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseVerificationDataStatus ¶
type ProjectDomainNewResponseVerificationDataStatus string
const ( ProjectDomainNewResponseVerificationDataStatusPending ProjectDomainNewResponseVerificationDataStatus = "pending" ProjectDomainNewResponseVerificationDataStatusActive ProjectDomainNewResponseVerificationDataStatus = "active" ProjectDomainNewResponseVerificationDataStatusDeactivated ProjectDomainNewResponseVerificationDataStatus = "deactivated" ProjectDomainNewResponseVerificationDataStatusBlocked ProjectDomainNewResponseVerificationDataStatus = "blocked" ProjectDomainNewResponseVerificationDataStatusError ProjectDomainNewResponseVerificationDataStatus = "error" )
func (ProjectDomainNewResponseVerificationDataStatus) IsKnown ¶
func (r ProjectDomainNewResponseVerificationDataStatus) IsKnown() bool
type ProjectDomainService ¶
type ProjectDomainService struct {
Options []option.RequestOption
}
ProjectDomainService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectDomainService method instead.
func NewProjectDomainService ¶
func NewProjectDomainService(opts ...option.RequestOption) (r *ProjectDomainService)
NewProjectDomainService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ProjectDomainService) Delete ¶
func (r *ProjectDomainService) Delete(ctx context.Context, projectName string, domainName string, body ProjectDomainDeleteParams, opts ...option.RequestOption) (res *ProjectDomainDeleteResponse, err error)
Delete a Pages project's domain.
func (*ProjectDomainService) Edit ¶
func (r *ProjectDomainService) Edit(ctx context.Context, projectName string, domainName string, 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 ¶
func (r *ProjectDomainService) List(ctx context.Context, projectName string, query ProjectDomainListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ProjectDomainListResponse], err error)
Fetch a list of all domains associated with a Pages project.
func (*ProjectDomainService) ListAutoPaging ¶
func (r *ProjectDomainService) ListAutoPaging(ctx context.Context, projectName string, query ProjectDomainListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ProjectDomainListResponse]
Fetch a list of all domains associated with a Pages project.
func (*ProjectDomainService) New ¶
func (r *ProjectDomainService) New(ctx context.Context, projectName string, params ProjectDomainNewParams, opts ...option.RequestOption) (res *ProjectDomainNewResponse, err error)
Add a new domain for the Pages project.
type ProjectEditParams ¶
type ProjectEditParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Configs for the project build process.
BuildConfig param.Field[ProjectEditParamsBuildConfig] `json:"build_config"`
// Configs for deployments in a project.
DeploymentConfigs param.Field[ProjectEditParamsDeploymentConfigs] `json:"deployment_configs"`
// Name of the project.
Name param.Field[string] `json:"name"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch param.Field[string] `json:"production_branch"`
// Configs for the project source control.
Source param.Field[ProjectEditParamsSource] `json:"source"`
}
func (ProjectEditParams) MarshalJSON ¶
func (r ProjectEditParams) MarshalJSON() (data []byte, err error)
type ProjectEditParamsBuildConfig ¶ added in v6.4.0
type ProjectEditParamsBuildConfig struct {
// Enable build caching for the project.
BuildCaching param.Field[bool] `json:"build_caching"`
// Command used to build project.
BuildCommand param.Field[string] `json:"build_command"`
// Output directory of the build.
DestinationDir param.Field[string] `json:"destination_dir"`
// Directory to run the command.
RootDir param.Field[string] `json:"root_dir"`
// The classifying tag for analytics.
WebAnalyticsTag param.Field[string] `json:"web_analytics_tag"`
// The auth token for analytics.
WebAnalyticsToken param.Field[string] `json:"web_analytics_token"`
}
Configs for the project build process.
func (ProjectEditParamsBuildConfig) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsBuildConfig) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigs ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigs struct {
// Configs for preview deploys.
Preview param.Field[ProjectEditParamsDeploymentConfigsPreview] `json:"preview"`
// Configs for production deploys.
Production param.Field[ProjectEditParamsDeploymentConfigsProduction] `json:"production"`
}
Configs for deployments in a project.
func (ProjectEditParamsDeploymentConfigs) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigs) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreview struct {
// Constellation bindings used for Pages Functions.
AIBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewAIBindings] `json:"ai_bindings"`
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewBrowsers] `json:"browsers"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
// Compatibility date used for Pages Functions.
CompatibilityDate param.Field[string] `json:"compatibility_date"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
// D1 databases used for Pages Functions.
D1Databases param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewD1Databases] `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces] `json:"durable_object_namespaces"`
// Environment variables used for builds and Pages Functions.
EnvVars param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion] `json:"env_vars"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen param.Field[bool] `json:"fail_open"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings] `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewKVNamespaces] `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits param.Field[ProjectEditParamsDeploymentConfigsPreviewLimits] `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates] `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement param.Field[ProjectEditParamsDeploymentConfigsPreviewPlacement] `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewQueueProducers] `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewR2Buckets] `json:"r2_buckets"`
// Services used for Pages Functions.
Services param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewServices] `json:"services"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel param.Field[ProjectEditParamsDeploymentConfigsPreviewUsageModel] `json:"usage_model"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings] `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}
Configs for preview deploys.
func (ProjectEditParamsDeploymentConfigsPreview) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreview) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewAIBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewAIBindings struct {
ProjectID param.Field[string] `json:"project_id,required"`
}
AI binding.
func (ProjectEditParamsDeploymentConfigsPreviewAIBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewAIBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset,required"`
}
Analytics Engine binding.
func (ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewBrowsers ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewBrowsers struct {
}
Browser binding.
func (ProjectEditParamsDeploymentConfigsPreviewBrowsers) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewBrowsers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewD1Databases ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id,required"`
}
D1 binding.
func (ProjectEditParamsDeploymentConfigsPreviewD1Databases) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewD1Databases) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
Durable Object binding.
func (ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVars ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVars struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVars) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVars) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
// Secret value.
Value param.Field[string] `json:"value,required"`
}
An encrypted environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType string
const ( ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypePlainText ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsPreviewEnvVars.
type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings struct {
ID param.Field[string] `json:"id,required"`
}
Hyperdrive binding.
func (ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
KV namespace binding.
func (ProjectEditParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms,required"`
}
Limits for Pages Functions.
func (ProjectEditParamsDeploymentConfigsPreviewLimits) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewLimits) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id,required"`
}
mTLS binding.
func (ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode,required"`
}
Placement setting used for Pages Functions.
func (ProjectEditParamsDeploymentConfigsPreviewPlacement) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewPlacement) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewQueueProducers ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name,required"`
}
Queue Producer binding.
func (ProjectEditParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewR2Buckets ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectEditParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewServices ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewServices struct {
// The Service name.
Service param.Field[string] `json:"service,required"`
// The entrypoint to bind to.
Entrypoint param.Field[string] `json:"entrypoint"`
// The Service environment.
Environment param.Field[string] `json:"environment"`
}
Service binding.
func (ProjectEditParamsDeploymentConfigsPreviewServices) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewServices) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectEditParamsDeploymentConfigsPreviewUsageModelStandard ProjectEditParamsDeploymentConfigsPreviewUsageModel = "standard" ProjectEditParamsDeploymentConfigsPreviewUsageModelBundled ProjectEditParamsDeploymentConfigsPreviewUsageModel = "bundled" ProjectEditParamsDeploymentConfigsPreviewUsageModelUnbound ProjectEditParamsDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectEditParamsDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name,required"`
}
Vectorize binding.
func (ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProduction struct {
// Constellation bindings used for Pages Functions.
AIBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionAIBindings] `json:"ai_bindings"`
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionBrowsers] `json:"browsers"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
// Compatibility date used for Pages Functions.
CompatibilityDate param.Field[string] `json:"compatibility_date"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
// D1 databases used for Pages Functions.
D1Databases param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionD1Databases] `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces] `json:"durable_object_namespaces"`
// Environment variables used for builds and Pages Functions.
EnvVars param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion] `json:"env_vars"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen param.Field[bool] `json:"fail_open"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings] `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionKVNamespaces] `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits param.Field[ProjectEditParamsDeploymentConfigsProductionLimits] `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionMTLSCertificates] `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement param.Field[ProjectEditParamsDeploymentConfigsProductionPlacement] `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionQueueProducers] `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionR2Buckets] `json:"r2_buckets"`
// Services used for Pages Functions.
Services param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionServices] `json:"services"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel param.Field[ProjectEditParamsDeploymentConfigsProductionUsageModel] `json:"usage_model"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings param.Field[map[string]ProjectEditParamsDeploymentConfigsProductionVectorizeBindings] `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}
Configs for production deploys.
func (ProjectEditParamsDeploymentConfigsProduction) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProduction) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionAIBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionAIBindings struct {
ProjectID param.Field[string] `json:"project_id,required"`
}
AI binding.
func (ProjectEditParamsDeploymentConfigsProductionAIBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionAIBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset,required"`
}
Analytics Engine binding.
func (ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionBrowsers ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionBrowsers struct {
}
Browser binding.
func (ProjectEditParamsDeploymentConfigsProductionBrowsers) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionBrowsers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionD1Databases ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id,required"`
}
D1 binding.
func (ProjectEditParamsDeploymentConfigsProductionD1Databases) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionD1Databases) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
Durable Object binding.
func (ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVars ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVars struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVars) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVars) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
// Secret value.
Value param.Field[string] `json:"value,required"`
}
An encrypted environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsType string
const ( ProjectEditParamsDeploymentConfigsProductionEnvVarsTypePlainText ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectEditParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsProductionEnvVars.
type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings struct {
ID param.Field[string] `json:"id,required"`
}
Hyperdrive binding.
func (ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionKVNamespaces ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
KV namespace binding.
func (ProjectEditParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms,required"`
}
Limits for Pages Functions.
func (ProjectEditParamsDeploymentConfigsProductionLimits) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionLimits) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id,required"`
}
mTLS binding.
func (ProjectEditParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode,required"`
}
Placement setting used for Pages Functions.
func (ProjectEditParamsDeploymentConfigsProductionPlacement) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionPlacement) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionQueueProducers ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name,required"`
}
Queue Producer binding.
func (ProjectEditParamsDeploymentConfigsProductionQueueProducers) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionR2Buckets ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectEditParamsDeploymentConfigsProductionR2Buckets) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionServices ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionServices struct {
// The Service name.
Service param.Field[string] `json:"service,required"`
// The entrypoint to bind to.
Entrypoint param.Field[string] `json:"entrypoint"`
// The Service environment.
Environment param.Field[string] `json:"environment"`
}
Service binding.
func (ProjectEditParamsDeploymentConfigsProductionServices) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionServices) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectEditParamsDeploymentConfigsProductionUsageModelStandard ProjectEditParamsDeploymentConfigsProductionUsageModel = "standard" ProjectEditParamsDeploymentConfigsProductionUsageModelBundled ProjectEditParamsDeploymentConfigsProductionUsageModel = "bundled" ProjectEditParamsDeploymentConfigsProductionUsageModelUnbound ProjectEditParamsDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectEditParamsDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings ¶ added in v6.4.0
type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name,required"`
}
Vectorize binding.
func (ProjectEditParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSource ¶ added in v6.4.0
type ProjectEditParamsSource struct {
Config param.Field[ProjectEditParamsSourceConfig] `json:"config,required"`
// The source control management provider.
Type param.Field[ProjectEditParamsSourceType] `json:"type,required"`
}
Configs for the project source control.
func (ProjectEditParamsSource) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsSource) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSourceConfig ¶ added in v6.4.0
type ProjectEditParamsSourceConfig struct {
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled param.Field[bool] `json:"deployments_enabled"`
// The owner of the repository.
Owner param.Field[string] `json:"owner"`
// The owner ID of the repository.
OwnerID param.Field[string] `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes param.Field[[]string] `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes param.Field[[]string] `json:"path_includes"`
// Whether to enable PR comments.
PrCommentsEnabled param.Field[bool] `json:"pr_comments_enabled"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes param.Field[[]string] `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes param.Field[[]string] `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting param.Field[ProjectEditParamsSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
// The production branch of the repository.
ProductionBranch param.Field[string] `json:"production_branch"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled param.Field[bool] `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID param.Field[string] `json:"repo_id"`
// The name of the repository.
RepoName param.Field[string] `json:"repo_name"`
}
func (ProjectEditParamsSourceConfig) MarshalJSON ¶ added in v6.4.0
func (r ProjectEditParamsSourceConfig) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectEditParamsSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectEditParamsSourceConfigPreviewDeploymentSettingAll ProjectEditParamsSourceConfigPreviewDeploymentSetting = "all" ProjectEditParamsSourceConfigPreviewDeploymentSettingNone ProjectEditParamsSourceConfigPreviewDeploymentSetting = "none" ProjectEditParamsSourceConfigPreviewDeploymentSettingCustom ProjectEditParamsSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectEditParamsSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectEditParamsSourceType ¶ added in v6.4.0
type ProjectEditParamsSourceType string
The source control management provider.
const ( ProjectEditParamsSourceTypeGitHub ProjectEditParamsSourceType = "github" ProjectEditParamsSourceTypeGitlab ProjectEditParamsSourceType = "gitlab" )
func (ProjectEditParamsSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectEditParamsSourceType) IsKnown() bool
type ProjectEditResponse ¶ added in v6.4.0
type ProjectEditResponse struct {
// ID of the project.
ID string `json:"id,required"`
// Most recent production deployment of the project.
CanonicalDeployment ProjectEditResponseCanonicalDeployment `json:"canonical_deployment,required,nullable"`
// When the project was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Configs for deployments in a project.
DeploymentConfigs ProjectEditResponseDeploymentConfigs `json:"deployment_configs,required"`
// Framework the project is using.
Framework string `json:"framework,required"`
// Version of the framework the project is using.
FrameworkVersion string `json:"framework_version,required"`
// Most recent deployment of the project.
LatestDeployment ProjectEditResponseLatestDeployment `json:"latest_deployment,required,nullable"`
// Name of the project.
Name string `json:"name,required"`
// Name of the preview script.
PreviewScriptName string `json:"preview_script_name,required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch string `json:"production_branch,required"`
// Name of the production script.
ProductionScriptName string `json:"production_script_name,required"`
// Whether the project uses functions.
UsesFunctions bool `json:"uses_functions,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectEditResponseBuildConfig `json:"build_config"`
// A list of associated custom domains for the project.
Domains []string `json:"domains"`
// Configs for the project source control.
Source ProjectEditResponseSource `json:"source"`
// The Cloudflare subdomain associated with the project.
Subdomain string `json:"subdomain"`
JSON projectEditResponseJSON `json:"-"`
}
func (*ProjectEditResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponse) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseBuildConfig ¶ added in v6.4.0
type ProjectEditResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectEditResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectEditResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeployment ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectEditResponseCanonicalDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectEditResponseCanonicalDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectEditResponseCanonicalDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectEditResponseCanonicalDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectEditResponseCanonicalDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectEditResponseCanonicalDeploymentJSON `json:"-"`
}
Most recent production deployment of the project.
func (*ProjectEditResponseCanonicalDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentBuildConfig ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectEditResponseCanonicalDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectEditResponseCanonicalDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectEditResponseCanonicalDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectEditResponseCanonicalDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectEditResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectEditResponseCanonicalDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectEditResponseCanonicalDeploymentDeploymentTriggerTypeGitHubPush ProjectEditResponseCanonicalDeploymentDeploymentTriggerType = "github:push" ProjectEditResponseCanonicalDeploymentDeploymentTriggerTypeADHoc ProjectEditResponseCanonicalDeploymentDeploymentTriggerType = "ad_hoc" ProjectEditResponseCanonicalDeploymentDeploymentTriggerTypeDeployHook ProjectEditResponseCanonicalDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectEditResponseCanonicalDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentEnvVar ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVar struct {
Type ProjectEditResponseCanonicalDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseCanonicalDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectEditResponseCanonicalDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentEnvVar) AsUnion() ProjectEditResponseCanonicalDeploymentEnvVarsUnion
AsUnion returns a ProjectEditResponseCanonicalDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar, ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectEditResponseCanonicalDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsType string
const ( ProjectEditResponseCanonicalDeploymentEnvVarsTypePlainText ProjectEditResponseCanonicalDeploymentEnvVarsType = "plain_text" ProjectEditResponseCanonicalDeploymentEnvVarsTypeSecretText ProjectEditResponseCanonicalDeploymentEnvVarsType = "secret_text" )
func (ProjectEditResponseCanonicalDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentEnvVarsType) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectEditResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar or ProjectEditResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectEditResponseCanonicalDeploymentEnvironment ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentEnvironment string
Type of deploy.
const ( ProjectEditResponseCanonicalDeploymentEnvironmentPreview ProjectEditResponseCanonicalDeploymentEnvironment = "preview" ProjectEditResponseCanonicalDeploymentEnvironmentProduction ProjectEditResponseCanonicalDeploymentEnvironment = "production" )
func (ProjectEditResponseCanonicalDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentEnvironment) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentSource ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentSource struct {
Config ProjectEditResponseCanonicalDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectEditResponseCanonicalDeploymentSourceType `json:"type,required"`
JSON projectEditResponseCanonicalDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectEditResponseCanonicalDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentSourceConfig ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectEditResponseCanonicalDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectEditResponseCanonicalDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseCanonicalDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingAll ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingNone ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectEditResponseCanonicalDeploymentSourceType ¶ added in v6.4.0
type ProjectEditResponseCanonicalDeploymentSourceType string
The source control management provider.
const ( ProjectEditResponseCanonicalDeploymentSourceTypeGitHub ProjectEditResponseCanonicalDeploymentSourceType = "github" ProjectEditResponseCanonicalDeploymentSourceTypeGitlab ProjectEditResponseCanonicalDeploymentSourceType = "gitlab" )
func (ProjectEditResponseCanonicalDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseCanonicalDeploymentSourceType) IsKnown() bool
type ProjectEditResponseDeploymentConfigs ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigs struct {
// Configs for preview deploys.
Preview ProjectEditResponseDeploymentConfigsPreview `json:"preview,required"`
// Configs for production deploys.
Production ProjectEditResponseDeploymentConfigsProduction `json:"production,required"`
JSON projectEditResponseDeploymentConfigsJSON `json:"-"`
}
Configs for deployments in a project.
func (*ProjectEditResponseDeploymentConfigs) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigs) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreview struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectEditResponseDeploymentConfigsPreviewEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectEditResponseDeploymentConfigsPreviewUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectEditResponseDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectEditResponseDeploymentConfigsPreviewBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectEditResponseDeploymentConfigsPreviewD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectEditResponseDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectEditResponseDeploymentConfigsPreviewLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectEditResponseDeploymentConfigsPreviewPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectEditResponseDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectEditResponseDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectEditResponseDeploymentConfigsPreviewService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectEditResponseDeploymentConfigsPreviewJSON `json:"-"`
}
Configs for preview deploys.
func (*ProjectEditResponseDeploymentConfigsPreview) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreview) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewAIBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectEditResponseDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectEditResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectEditResponseDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewBrowser ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewBrowser struct {
JSON projectEditResponseDeploymentConfigsPreviewBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectEditResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewD1Database ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectEditResponseDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectEditResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectEditResponseDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVar struct {
Type ProjectEditResponseDeploymentConfigsPreviewEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsPreviewEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectEditResponseDeploymentConfigsPreviewEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsPreviewEnvVar) AsUnion() ProjectEditResponseDeploymentConfigsPreviewEnvVarsUnion
AsUnion returns a ProjectEditResponseDeploymentConfigsPreviewEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
func (*ProjectEditResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsType string
const ( ProjectEditResponseDeploymentConfigsPreviewEnvVarsTypePlainText ProjectEditResponseDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectEditResponseDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectEditResponseDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectEditResponseDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectEditResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
type ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectEditResponseDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewKVNamespace ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectEditResponseDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectEditResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectEditResponseDeploymentConfigsPreviewLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectEditResponseDeploymentConfigsPreviewLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewLimits) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectEditResponseDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectEditResponseDeploymentConfigsPreviewPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectEditResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewQueueProducer ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectEditResponseDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectEditResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewR2Bucket ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectEditResponseDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectEditResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewService ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectEditResponseDeploymentConfigsPreviewServiceJSON `json:"-"`
}
Service binding.
func (*ProjectEditResponseDeploymentConfigsPreviewService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewService) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectEditResponseDeploymentConfigsPreviewUsageModelStandard ProjectEditResponseDeploymentConfigsPreviewUsageModel = "standard" ProjectEditResponseDeploymentConfigsPreviewUsageModelBundled ProjectEditResponseDeploymentConfigsPreviewUsageModel = "bundled" ProjectEditResponseDeploymentConfigsPreviewUsageModelUnbound ProjectEditResponseDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectEditResponseDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectEditResponseDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProduction struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectEditResponseDeploymentConfigsProductionEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectEditResponseDeploymentConfigsProductionUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectEditResponseDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectEditResponseDeploymentConfigsProductionBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectEditResponseDeploymentConfigsProductionD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectEditResponseDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectEditResponseDeploymentConfigsProductionLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectEditResponseDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectEditResponseDeploymentConfigsProductionPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectEditResponseDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectEditResponseDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectEditResponseDeploymentConfigsProductionService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectEditResponseDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectEditResponseDeploymentConfigsProductionJSON `json:"-"`
}
Configs for production deploys.
func (*ProjectEditResponseDeploymentConfigsProduction) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProduction) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionAIBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectEditResponseDeploymentConfigsProductionAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectEditResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectEditResponseDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionBrowser ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionBrowser struct {
JSON projectEditResponseDeploymentConfigsProductionBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectEditResponseDeploymentConfigsProductionBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionD1Database ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectEditResponseDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectEditResponseDeploymentConfigsProductionD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectEditResponseDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVar struct {
Type ProjectEditResponseDeploymentConfigsProductionEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsProductionEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectEditResponseDeploymentConfigsProductionEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsProductionEnvVar) AsUnion() ProjectEditResponseDeploymentConfigsProductionEnvVarsUnion
AsUnion returns a ProjectEditResponseDeploymentConfigsProductionEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
func (*ProjectEditResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
type ProjectEditResponseDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsType string
const ( ProjectEditResponseDeploymentConfigsProductionEnvVarsTypePlainText ProjectEditResponseDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectEditResponseDeploymentConfigsProductionEnvVarsTypeSecretText ProjectEditResponseDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectEditResponseDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectEditResponseDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectEditResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
type ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectEditResponseDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionKVNamespace ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectEditResponseDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectEditResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectEditResponseDeploymentConfigsProductionLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectEditResponseDeploymentConfigsProductionLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionLimits) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionMTLSCertificate ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectEditResponseDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectEditResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectEditResponseDeploymentConfigsProductionPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectEditResponseDeploymentConfigsProductionPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionQueueProducer ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectEditResponseDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectEditResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionR2Bucket ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectEditResponseDeploymentConfigsProductionR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectEditResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionService ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectEditResponseDeploymentConfigsProductionServiceJSON `json:"-"`
}
Service binding.
func (*ProjectEditResponseDeploymentConfigsProductionService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionService) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectEditResponseDeploymentConfigsProductionUsageModelStandard ProjectEditResponseDeploymentConfigsProductionUsageModel = "standard" ProjectEditResponseDeploymentConfigsProductionUsageModelBundled ProjectEditResponseDeploymentConfigsProductionUsageModel = "bundled" ProjectEditResponseDeploymentConfigsProductionUsageModelUnbound ProjectEditResponseDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectEditResponseDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectEditResponseDeploymentConfigsProductionVectorizeBinding ¶ added in v6.4.0
type ProjectEditResponseDeploymentConfigsProductionVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectEditResponseDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectEditResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(data []byte) (err error)
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 ¶ added in v6.4.0
type ProjectEditResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectEditResponseEnvelopeErrorsSource `json:"source"`
JSON projectEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectEditResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectEditResponseEnvelopeMessagesSource `json:"source"`
JSON projectEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeSuccess ¶
type ProjectEditResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectEditResponseEnvelopeSuccessTrue ProjectEditResponseEnvelopeSuccess = true
)
func (ProjectEditResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectEditResponseEnvelopeSuccess) IsKnown() bool
type ProjectEditResponseLatestDeployment ¶ added in v6.4.0
type ProjectEditResponseLatestDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectEditResponseLatestDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectEditResponseLatestDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectEditResponseLatestDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectEditResponseLatestDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectEditResponseLatestDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectEditResponseLatestDeploymentJSON `json:"-"`
}
Most recent deployment of the project.
func (*ProjectEditResponseLatestDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentBuildConfig ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectEditResponseLatestDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectEditResponseLatestDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectEditResponseLatestDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectEditResponseLatestDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectEditResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectEditResponseLatestDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectEditResponseLatestDeploymentDeploymentTriggerTypeGitHubPush ProjectEditResponseLatestDeploymentDeploymentTriggerType = "github:push" ProjectEditResponseLatestDeploymentDeploymentTriggerTypeADHoc ProjectEditResponseLatestDeploymentDeploymentTriggerType = "ad_hoc" ProjectEditResponseLatestDeploymentDeploymentTriggerTypeDeployHook ProjectEditResponseLatestDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectEditResponseLatestDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectEditResponseLatestDeploymentEnvVar ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVar struct {
Type ProjectEditResponseLatestDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseLatestDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectEditResponseLatestDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentEnvVar) AsUnion() ProjectEditResponseLatestDeploymentEnvVarsUnion
AsUnion returns a ProjectEditResponseLatestDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar, ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectEditResponseLatestDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditResponseLatestDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsType string
const ( ProjectEditResponseLatestDeploymentEnvVarsTypePlainText ProjectEditResponseLatestDeploymentEnvVarsType = "plain_text" ProjectEditResponseLatestDeploymentEnvVarsTypeSecretText ProjectEditResponseLatestDeploymentEnvVarsType = "secret_text" )
func (ProjectEditResponseLatestDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentEnvVarsType) IsKnown() bool
type ProjectEditResponseLatestDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectEditResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar or ProjectEditResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectEditResponseLatestDeploymentEnvironment ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentEnvironment string
Type of deploy.
const ( ProjectEditResponseLatestDeploymentEnvironmentPreview ProjectEditResponseLatestDeploymentEnvironment = "preview" ProjectEditResponseLatestDeploymentEnvironmentProduction ProjectEditResponseLatestDeploymentEnvironment = "production" )
func (ProjectEditResponseLatestDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentEnvironment) IsKnown() bool
type ProjectEditResponseLatestDeploymentSource ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentSource struct {
Config ProjectEditResponseLatestDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectEditResponseLatestDeploymentSourceType `json:"type,required"`
JSON projectEditResponseLatestDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectEditResponseLatestDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentSourceConfig ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectEditResponseLatestDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectEditResponseLatestDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseLatestDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSettingAll ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSettingNone ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectEditResponseLatestDeploymentSourceType ¶ added in v6.4.0
type ProjectEditResponseLatestDeploymentSourceType string
The source control management provider.
const ( ProjectEditResponseLatestDeploymentSourceTypeGitHub ProjectEditResponseLatestDeploymentSourceType = "github" ProjectEditResponseLatestDeploymentSourceTypeGitlab ProjectEditResponseLatestDeploymentSourceType = "gitlab" )
func (ProjectEditResponseLatestDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseLatestDeploymentSourceType) IsKnown() bool
type ProjectEditResponseSource ¶ added in v6.4.0
type ProjectEditResponseSource struct {
Config ProjectEditResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectEditResponseSourceType `json:"type,required"`
JSON projectEditResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectEditResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseSourceConfig ¶ added in v6.4.0
type ProjectEditResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectEditResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectEditResponseSourceConfigJSON `json:"-"`
}
func (*ProjectEditResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectEditResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectEditResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectEditResponseSourceConfigPreviewDeploymentSettingAll ProjectEditResponseSourceConfigPreviewDeploymentSetting = "all" ProjectEditResponseSourceConfigPreviewDeploymentSettingNone ProjectEditResponseSourceConfigPreviewDeploymentSetting = "none" ProjectEditResponseSourceConfigPreviewDeploymentSettingCustom ProjectEditResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectEditResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectEditResponseSourceType ¶ added in v6.4.0
type ProjectEditResponseSourceType string
The source control management provider.
const ( ProjectEditResponseSourceTypeGitHub ProjectEditResponseSourceType = "github" ProjectEditResponseSourceTypeGitlab ProjectEditResponseSourceType = "gitlab" )
func (ProjectEditResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectEditResponseSourceType) IsKnown() bool
type ProjectGetParams ¶
type ProjectGetResponse ¶ added in v6.4.0
type ProjectGetResponse struct {
// ID of the project.
ID string `json:"id,required"`
// Most recent production deployment of the project.
CanonicalDeployment ProjectGetResponseCanonicalDeployment `json:"canonical_deployment,required,nullable"`
// When the project was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Configs for deployments in a project.
DeploymentConfigs ProjectGetResponseDeploymentConfigs `json:"deployment_configs,required"`
// Framework the project is using.
Framework string `json:"framework,required"`
// Version of the framework the project is using.
FrameworkVersion string `json:"framework_version,required"`
// Most recent deployment of the project.
LatestDeployment ProjectGetResponseLatestDeployment `json:"latest_deployment,required,nullable"`
// Name of the project.
Name string `json:"name,required"`
// Name of the preview script.
PreviewScriptName string `json:"preview_script_name,required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch string `json:"production_branch,required"`
// Name of the production script.
ProductionScriptName string `json:"production_script_name,required"`
// Whether the project uses functions.
UsesFunctions bool `json:"uses_functions,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectGetResponseBuildConfig `json:"build_config"`
// A list of associated custom domains for the project.
Domains []string `json:"domains"`
// Configs for the project source control.
Source ProjectGetResponseSource `json:"source"`
// The Cloudflare subdomain associated with the project.
Subdomain string `json:"subdomain"`
JSON projectGetResponseJSON `json:"-"`
}
func (*ProjectGetResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponse) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseBuildConfig ¶ added in v6.4.0
type ProjectGetResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectGetResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectGetResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeployment ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectGetResponseCanonicalDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectGetResponseCanonicalDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectGetResponseCanonicalDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectGetResponseCanonicalDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectGetResponseCanonicalDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectGetResponseCanonicalDeploymentJSON `json:"-"`
}
Most recent production deployment of the project.
func (*ProjectGetResponseCanonicalDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentBuildConfig ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectGetResponseCanonicalDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectGetResponseCanonicalDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectGetResponseCanonicalDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectGetResponseCanonicalDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectGetResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectGetResponseCanonicalDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectGetResponseCanonicalDeploymentDeploymentTriggerTypeGitHubPush ProjectGetResponseCanonicalDeploymentDeploymentTriggerType = "github:push" ProjectGetResponseCanonicalDeploymentDeploymentTriggerTypeADHoc ProjectGetResponseCanonicalDeploymentDeploymentTriggerType = "ad_hoc" ProjectGetResponseCanonicalDeploymentDeploymentTriggerTypeDeployHook ProjectGetResponseCanonicalDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectGetResponseCanonicalDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentEnvVar ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVar struct {
Type ProjectGetResponseCanonicalDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseCanonicalDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectGetResponseCanonicalDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentEnvVar) AsUnion() ProjectGetResponseCanonicalDeploymentEnvVarsUnion
AsUnion returns a ProjectGetResponseCanonicalDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar, ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectGetResponseCanonicalDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsType string
const ( ProjectGetResponseCanonicalDeploymentEnvVarsTypePlainText ProjectGetResponseCanonicalDeploymentEnvVarsType = "plain_text" ProjectGetResponseCanonicalDeploymentEnvVarsTypeSecretText ProjectGetResponseCanonicalDeploymentEnvVarsType = "secret_text" )
func (ProjectGetResponseCanonicalDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentEnvVarsType) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectGetResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar or ProjectGetResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectGetResponseCanonicalDeploymentEnvironment ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentEnvironment string
Type of deploy.
const ( ProjectGetResponseCanonicalDeploymentEnvironmentPreview ProjectGetResponseCanonicalDeploymentEnvironment = "preview" ProjectGetResponseCanonicalDeploymentEnvironmentProduction ProjectGetResponseCanonicalDeploymentEnvironment = "production" )
func (ProjectGetResponseCanonicalDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentEnvironment) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentSource ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentSource struct {
Config ProjectGetResponseCanonicalDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectGetResponseCanonicalDeploymentSourceType `json:"type,required"`
JSON projectGetResponseCanonicalDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectGetResponseCanonicalDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentSourceConfig ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectGetResponseCanonicalDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectGetResponseCanonicalDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseCanonicalDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingAll ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingNone ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectGetResponseCanonicalDeploymentSourceType ¶ added in v6.4.0
type ProjectGetResponseCanonicalDeploymentSourceType string
The source control management provider.
const ( ProjectGetResponseCanonicalDeploymentSourceTypeGitHub ProjectGetResponseCanonicalDeploymentSourceType = "github" ProjectGetResponseCanonicalDeploymentSourceTypeGitlab ProjectGetResponseCanonicalDeploymentSourceType = "gitlab" )
func (ProjectGetResponseCanonicalDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseCanonicalDeploymentSourceType) IsKnown() bool
type ProjectGetResponseDeploymentConfigs ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigs struct {
// Configs for preview deploys.
Preview ProjectGetResponseDeploymentConfigsPreview `json:"preview,required"`
// Configs for production deploys.
Production ProjectGetResponseDeploymentConfigsProduction `json:"production,required"`
JSON projectGetResponseDeploymentConfigsJSON `json:"-"`
}
Configs for deployments in a project.
func (*ProjectGetResponseDeploymentConfigs) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigs) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreview struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectGetResponseDeploymentConfigsPreviewEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectGetResponseDeploymentConfigsPreviewUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectGetResponseDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectGetResponseDeploymentConfigsPreviewBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectGetResponseDeploymentConfigsPreviewD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectGetResponseDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectGetResponseDeploymentConfigsPreviewLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectGetResponseDeploymentConfigsPreviewPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectGetResponseDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectGetResponseDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectGetResponseDeploymentConfigsPreviewService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectGetResponseDeploymentConfigsPreviewJSON `json:"-"`
}
Configs for preview deploys.
func (*ProjectGetResponseDeploymentConfigsPreview) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreview) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewAIBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectGetResponseDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectGetResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectGetResponseDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewBrowser ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewBrowser struct {
JSON projectGetResponseDeploymentConfigsPreviewBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectGetResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewD1Database ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectGetResponseDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectGetResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectGetResponseDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVar struct {
Type ProjectGetResponseDeploymentConfigsPreviewEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsPreviewEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectGetResponseDeploymentConfigsPreviewEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsPreviewEnvVar) AsUnion() ProjectGetResponseDeploymentConfigsPreviewEnvVarsUnion
AsUnion returns a ProjectGetResponseDeploymentConfigsPreviewEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
func (*ProjectGetResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsType string
const ( ProjectGetResponseDeploymentConfigsPreviewEnvVarsTypePlainText ProjectGetResponseDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectGetResponseDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectGetResponseDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectGetResponseDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectGetResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
type ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectGetResponseDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewKVNamespace ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectGetResponseDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectGetResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectGetResponseDeploymentConfigsPreviewLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectGetResponseDeploymentConfigsPreviewLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewLimits) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectGetResponseDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectGetResponseDeploymentConfigsPreviewPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectGetResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewQueueProducer ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectGetResponseDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectGetResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewR2Bucket ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectGetResponseDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectGetResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewService ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectGetResponseDeploymentConfigsPreviewServiceJSON `json:"-"`
}
Service binding.
func (*ProjectGetResponseDeploymentConfigsPreviewService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewService) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectGetResponseDeploymentConfigsPreviewUsageModelStandard ProjectGetResponseDeploymentConfigsPreviewUsageModel = "standard" ProjectGetResponseDeploymentConfigsPreviewUsageModelBundled ProjectGetResponseDeploymentConfigsPreviewUsageModel = "bundled" ProjectGetResponseDeploymentConfigsPreviewUsageModelUnbound ProjectGetResponseDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectGetResponseDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectGetResponseDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProduction struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectGetResponseDeploymentConfigsProductionEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectGetResponseDeploymentConfigsProductionUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectGetResponseDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectGetResponseDeploymentConfigsProductionBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectGetResponseDeploymentConfigsProductionD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectGetResponseDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectGetResponseDeploymentConfigsProductionLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectGetResponseDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectGetResponseDeploymentConfigsProductionPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectGetResponseDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectGetResponseDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectGetResponseDeploymentConfigsProductionService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectGetResponseDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectGetResponseDeploymentConfigsProductionJSON `json:"-"`
}
Configs for production deploys.
func (*ProjectGetResponseDeploymentConfigsProduction) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProduction) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionAIBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectGetResponseDeploymentConfigsProductionAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectGetResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectGetResponseDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionBrowser ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionBrowser struct {
JSON projectGetResponseDeploymentConfigsProductionBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectGetResponseDeploymentConfigsProductionBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionD1Database ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectGetResponseDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectGetResponseDeploymentConfigsProductionD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectGetResponseDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVar struct {
Type ProjectGetResponseDeploymentConfigsProductionEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsProductionEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectGetResponseDeploymentConfigsProductionEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsProductionEnvVar) AsUnion() ProjectGetResponseDeploymentConfigsProductionEnvVarsUnion
AsUnion returns a ProjectGetResponseDeploymentConfigsProductionEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
func (*ProjectGetResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
type ProjectGetResponseDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsType string
const ( ProjectGetResponseDeploymentConfigsProductionEnvVarsTypePlainText ProjectGetResponseDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectGetResponseDeploymentConfigsProductionEnvVarsTypeSecretText ProjectGetResponseDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectGetResponseDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectGetResponseDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectGetResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
type ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectGetResponseDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionKVNamespace ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectGetResponseDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectGetResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectGetResponseDeploymentConfigsProductionLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectGetResponseDeploymentConfigsProductionLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionLimits) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionMTLSCertificate ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectGetResponseDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectGetResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectGetResponseDeploymentConfigsProductionPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectGetResponseDeploymentConfigsProductionPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionQueueProducer ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectGetResponseDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectGetResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionR2Bucket ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectGetResponseDeploymentConfigsProductionR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectGetResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionService ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectGetResponseDeploymentConfigsProductionServiceJSON `json:"-"`
}
Service binding.
func (*ProjectGetResponseDeploymentConfigsProductionService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionService) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectGetResponseDeploymentConfigsProductionUsageModelStandard ProjectGetResponseDeploymentConfigsProductionUsageModel = "standard" ProjectGetResponseDeploymentConfigsProductionUsageModelBundled ProjectGetResponseDeploymentConfigsProductionUsageModel = "bundled" ProjectGetResponseDeploymentConfigsProductionUsageModelUnbound ProjectGetResponseDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectGetResponseDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectGetResponseDeploymentConfigsProductionVectorizeBinding ¶ added in v6.4.0
type ProjectGetResponseDeploymentConfigsProductionVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectGetResponseDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectGetResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelope ¶
type ProjectGetResponseEnvelope struct {
Errors []ProjectGetResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectGetResponseEnvelopeMessages `json:"messages,required"`
Result ProjectGetResponse `json:"result,required"`
// Whether the API call was successful.
Success ProjectGetResponseEnvelopeSuccess `json:"success,required"`
JSON projectGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectGetResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectGetResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeSuccess ¶
type ProjectGetResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectGetResponseEnvelopeSuccessTrue ProjectGetResponseEnvelopeSuccess = true
)
func (ProjectGetResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectGetResponseEnvelopeSuccess) IsKnown() bool
type ProjectGetResponseLatestDeployment ¶ added in v6.4.0
type ProjectGetResponseLatestDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectGetResponseLatestDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectGetResponseLatestDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectGetResponseLatestDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectGetResponseLatestDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectGetResponseLatestDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectGetResponseLatestDeploymentJSON `json:"-"`
}
Most recent deployment of the project.
func (*ProjectGetResponseLatestDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentBuildConfig ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectGetResponseLatestDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectGetResponseLatestDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectGetResponseLatestDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectGetResponseLatestDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectGetResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectGetResponseLatestDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectGetResponseLatestDeploymentDeploymentTriggerTypeGitHubPush ProjectGetResponseLatestDeploymentDeploymentTriggerType = "github:push" ProjectGetResponseLatestDeploymentDeploymentTriggerTypeADHoc ProjectGetResponseLatestDeploymentDeploymentTriggerType = "ad_hoc" ProjectGetResponseLatestDeploymentDeploymentTriggerTypeDeployHook ProjectGetResponseLatestDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectGetResponseLatestDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectGetResponseLatestDeploymentEnvVar ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVar struct {
Type ProjectGetResponseLatestDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseLatestDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectGetResponseLatestDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentEnvVar) AsUnion() ProjectGetResponseLatestDeploymentEnvVarsUnion
AsUnion returns a ProjectGetResponseLatestDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar, ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectGetResponseLatestDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectGetResponseLatestDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsType string
const ( ProjectGetResponseLatestDeploymentEnvVarsTypePlainText ProjectGetResponseLatestDeploymentEnvVarsType = "plain_text" ProjectGetResponseLatestDeploymentEnvVarsTypeSecretText ProjectGetResponseLatestDeploymentEnvVarsType = "secret_text" )
func (ProjectGetResponseLatestDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentEnvVarsType) IsKnown() bool
type ProjectGetResponseLatestDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectGetResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar or ProjectGetResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectGetResponseLatestDeploymentEnvironment ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentEnvironment string
Type of deploy.
const ( ProjectGetResponseLatestDeploymentEnvironmentPreview ProjectGetResponseLatestDeploymentEnvironment = "preview" ProjectGetResponseLatestDeploymentEnvironmentProduction ProjectGetResponseLatestDeploymentEnvironment = "production" )
func (ProjectGetResponseLatestDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentEnvironment) IsKnown() bool
type ProjectGetResponseLatestDeploymentSource ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentSource struct {
Config ProjectGetResponseLatestDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectGetResponseLatestDeploymentSourceType `json:"type,required"`
JSON projectGetResponseLatestDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectGetResponseLatestDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentSourceConfig ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectGetResponseLatestDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectGetResponseLatestDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseLatestDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSettingAll ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSettingNone ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectGetResponseLatestDeploymentSourceType ¶ added in v6.4.0
type ProjectGetResponseLatestDeploymentSourceType string
The source control management provider.
const ( ProjectGetResponseLatestDeploymentSourceTypeGitHub ProjectGetResponseLatestDeploymentSourceType = "github" ProjectGetResponseLatestDeploymentSourceTypeGitlab ProjectGetResponseLatestDeploymentSourceType = "gitlab" )
func (ProjectGetResponseLatestDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseLatestDeploymentSourceType) IsKnown() bool
type ProjectGetResponseSource ¶ added in v6.4.0
type ProjectGetResponseSource struct {
Config ProjectGetResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectGetResponseSourceType `json:"type,required"`
JSON projectGetResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectGetResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseSourceConfig ¶ added in v6.4.0
type ProjectGetResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectGetResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectGetResponseSourceConfigJSON `json:"-"`
}
func (*ProjectGetResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectGetResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectGetResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectGetResponseSourceConfigPreviewDeploymentSettingAll ProjectGetResponseSourceConfigPreviewDeploymentSetting = "all" ProjectGetResponseSourceConfigPreviewDeploymentSettingNone ProjectGetResponseSourceConfigPreviewDeploymentSetting = "none" ProjectGetResponseSourceConfigPreviewDeploymentSettingCustom ProjectGetResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectGetResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectGetResponseSourceType ¶ added in v6.4.0
type ProjectGetResponseSourceType string
The source control management provider.
const ( ProjectGetResponseSourceTypeGitHub ProjectGetResponseSourceType = "github" ProjectGetResponseSourceTypeGitlab ProjectGetResponseSourceType = "gitlab" )
func (ProjectGetResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectGetResponseSourceType) IsKnown() bool
type ProjectListParams ¶
type ProjectListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Which page of projects to fetch.
Page param.Field[int64] `query:"page"`
// How many projects to return per page.
PerPage param.Field[int64] `query:"per_page"`
}
func (ProjectListParams) URLQuery ¶ added in v6.2.0
func (r ProjectListParams) URLQuery() (v url.Values)
URLQuery serializes ProjectListParams's query parameters as `url.Values`.
type ProjectListResponse ¶ added in v6.4.0
type ProjectListResponse struct {
// ID of the project.
ID string `json:"id,required"`
// Most recent production deployment of the project.
CanonicalDeployment ProjectListResponseCanonicalDeployment `json:"canonical_deployment,required,nullable"`
// When the project was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Configs for deployments in a project.
DeploymentConfigs ProjectListResponseDeploymentConfigs `json:"deployment_configs,required"`
// Framework the project is using.
Framework string `json:"framework,required"`
// Version of the framework the project is using.
FrameworkVersion string `json:"framework_version,required"`
// Most recent deployment of the project.
LatestDeployment ProjectListResponseLatestDeployment `json:"latest_deployment,required,nullable"`
// Name of the project.
Name string `json:"name,required"`
// Name of the preview script.
PreviewScriptName string `json:"preview_script_name,required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch string `json:"production_branch,required"`
// Name of the production script.
ProductionScriptName string `json:"production_script_name,required"`
// Whether the project uses functions.
UsesFunctions bool `json:"uses_functions,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectListResponseBuildConfig `json:"build_config"`
// A list of associated custom domains for the project.
Domains []string `json:"domains"`
// Configs for the project source control.
Source ProjectListResponseSource `json:"source"`
// The Cloudflare subdomain associated with the project.
Subdomain string `json:"subdomain"`
JSON projectListResponseJSON `json:"-"`
}
func (*ProjectListResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponse) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseBuildConfig ¶ added in v6.4.0
type ProjectListResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectListResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectListResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeployment ¶ added in v6.4.0
type ProjectListResponseCanonicalDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectListResponseCanonicalDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectListResponseCanonicalDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectListResponseCanonicalDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectListResponseCanonicalDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectListResponseCanonicalDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectListResponseCanonicalDeploymentJSON `json:"-"`
}
Most recent production deployment of the project.
func (*ProjectListResponseCanonicalDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentBuildConfig ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectListResponseCanonicalDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectListResponseCanonicalDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectListResponseCanonicalDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectListResponseCanonicalDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectListResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectListResponseCanonicalDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectListResponseCanonicalDeploymentDeploymentTriggerTypeGitHubPush ProjectListResponseCanonicalDeploymentDeploymentTriggerType = "github:push" ProjectListResponseCanonicalDeploymentDeploymentTriggerTypeADHoc ProjectListResponseCanonicalDeploymentDeploymentTriggerType = "ad_hoc" ProjectListResponseCanonicalDeploymentDeploymentTriggerTypeDeployHook ProjectListResponseCanonicalDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectListResponseCanonicalDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectListResponseCanonicalDeploymentEnvVar ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVar struct {
Type ProjectListResponseCanonicalDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseCanonicalDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectListResponseCanonicalDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentEnvVar) AsUnion() ProjectListResponseCanonicalDeploymentEnvVarsUnion
AsUnion returns a ProjectListResponseCanonicalDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar, ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectListResponseCanonicalDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectListResponseCanonicalDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsType string
const ( ProjectListResponseCanonicalDeploymentEnvVarsTypePlainText ProjectListResponseCanonicalDeploymentEnvVarsType = "plain_text" ProjectListResponseCanonicalDeploymentEnvVarsTypeSecretText ProjectListResponseCanonicalDeploymentEnvVarsType = "secret_text" )
func (ProjectListResponseCanonicalDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentEnvVarsType) IsKnown() bool
type ProjectListResponseCanonicalDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectListResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar or ProjectListResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectListResponseCanonicalDeploymentEnvironment ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentEnvironment string
Type of deploy.
const ( ProjectListResponseCanonicalDeploymentEnvironmentPreview ProjectListResponseCanonicalDeploymentEnvironment = "preview" ProjectListResponseCanonicalDeploymentEnvironmentProduction ProjectListResponseCanonicalDeploymentEnvironment = "production" )
func (ProjectListResponseCanonicalDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentEnvironment) IsKnown() bool
type ProjectListResponseCanonicalDeploymentSource ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentSource struct {
Config ProjectListResponseCanonicalDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectListResponseCanonicalDeploymentSourceType `json:"type,required"`
JSON projectListResponseCanonicalDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectListResponseCanonicalDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentSourceConfig ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectListResponseCanonicalDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectListResponseCanonicalDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseCanonicalDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingAll ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingNone ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectListResponseCanonicalDeploymentSourceType ¶ added in v6.4.0
type ProjectListResponseCanonicalDeploymentSourceType string
The source control management provider.
const ( ProjectListResponseCanonicalDeploymentSourceTypeGitHub ProjectListResponseCanonicalDeploymentSourceType = "github" ProjectListResponseCanonicalDeploymentSourceTypeGitlab ProjectListResponseCanonicalDeploymentSourceType = "gitlab" )
func (ProjectListResponseCanonicalDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseCanonicalDeploymentSourceType) IsKnown() bool
type ProjectListResponseDeploymentConfigs ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigs struct {
// Configs for preview deploys.
Preview ProjectListResponseDeploymentConfigsPreview `json:"preview,required"`
// Configs for production deploys.
Production ProjectListResponseDeploymentConfigsProduction `json:"production,required"`
JSON projectListResponseDeploymentConfigsJSON `json:"-"`
}
Configs for deployments in a project.
func (*ProjectListResponseDeploymentConfigs) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigs) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreview struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectListResponseDeploymentConfigsPreviewEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectListResponseDeploymentConfigsPreviewUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectListResponseDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectListResponseDeploymentConfigsPreviewBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectListResponseDeploymentConfigsPreviewD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectListResponseDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectListResponseDeploymentConfigsPreviewLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectListResponseDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectListResponseDeploymentConfigsPreviewPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectListResponseDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectListResponseDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectListResponseDeploymentConfigsPreviewService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectListResponseDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectListResponseDeploymentConfigsPreviewJSON `json:"-"`
}
Configs for preview deploys.
func (*ProjectListResponseDeploymentConfigsPreview) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreview) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewAIBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectListResponseDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectListResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectListResponseDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewBrowser ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewBrowser struct {
JSON projectListResponseDeploymentConfigsPreviewBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectListResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewD1Database ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectListResponseDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectListResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectListResponseDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVar struct {
Type ProjectListResponseDeploymentConfigsPreviewEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsPreviewEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectListResponseDeploymentConfigsPreviewEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsPreviewEnvVar) AsUnion() ProjectListResponseDeploymentConfigsPreviewEnvVarsUnion
AsUnion returns a ProjectListResponseDeploymentConfigsPreviewEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
func (*ProjectListResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectListResponseDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsType string
const ( ProjectListResponseDeploymentConfigsPreviewEnvVarsTypePlainText ProjectListResponseDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectListResponseDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectListResponseDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectListResponseDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectListResponseDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectListResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
type ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectListResponseDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewKVNamespace ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectListResponseDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectListResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectListResponseDeploymentConfigsPreviewLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectListResponseDeploymentConfigsPreviewLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewLimits) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewMTLSCertificate ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectListResponseDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectListResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectListResponseDeploymentConfigsPreviewPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectListResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewQueueProducer ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectListResponseDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectListResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewR2Bucket ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectListResponseDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectListResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewService ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectListResponseDeploymentConfigsPreviewServiceJSON `json:"-"`
}
Service binding.
func (*ProjectListResponseDeploymentConfigsPreviewService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewService) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectListResponseDeploymentConfigsPreviewUsageModelStandard ProjectListResponseDeploymentConfigsPreviewUsageModel = "standard" ProjectListResponseDeploymentConfigsPreviewUsageModelBundled ProjectListResponseDeploymentConfigsPreviewUsageModel = "bundled" ProjectListResponseDeploymentConfigsPreviewUsageModelUnbound ProjectListResponseDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectListResponseDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectListResponseDeploymentConfigsPreviewVectorizeBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsPreviewVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectListResponseDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectListResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProduction struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectListResponseDeploymentConfigsProductionEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectListResponseDeploymentConfigsProductionUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectListResponseDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectListResponseDeploymentConfigsProductionBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectListResponseDeploymentConfigsProductionD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectListResponseDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectListResponseDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectListResponseDeploymentConfigsProductionLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectListResponseDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectListResponseDeploymentConfigsProductionPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectListResponseDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectListResponseDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectListResponseDeploymentConfigsProductionService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectListResponseDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectListResponseDeploymentConfigsProductionJSON `json:"-"`
}
Configs for production deploys.
func (*ProjectListResponseDeploymentConfigsProduction) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProduction) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionAIBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectListResponseDeploymentConfigsProductionAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectListResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectListResponseDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionBrowser ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionBrowser struct {
JSON projectListResponseDeploymentConfigsProductionBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectListResponseDeploymentConfigsProductionBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionD1Database ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectListResponseDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectListResponseDeploymentConfigsProductionD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectListResponseDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVar struct {
Type ProjectListResponseDeploymentConfigsProductionEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsProductionEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectListResponseDeploymentConfigsProductionEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsProductionEnvVar) AsUnion() ProjectListResponseDeploymentConfigsProductionEnvVarsUnion
AsUnion returns a ProjectListResponseDeploymentConfigsProductionEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
func (*ProjectListResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
type ProjectListResponseDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsType string
const ( ProjectListResponseDeploymentConfigsProductionEnvVarsTypePlainText ProjectListResponseDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectListResponseDeploymentConfigsProductionEnvVarsTypeSecretText ProjectListResponseDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectListResponseDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectListResponseDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectListResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectListResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
type ProjectListResponseDeploymentConfigsProductionHyperdriveBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectListResponseDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectListResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionKVNamespace ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectListResponseDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectListResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectListResponseDeploymentConfigsProductionLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectListResponseDeploymentConfigsProductionLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionLimits) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionMTLSCertificate ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectListResponseDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectListResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectListResponseDeploymentConfigsProductionPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectListResponseDeploymentConfigsProductionPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionQueueProducer ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectListResponseDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectListResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionR2Bucket ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectListResponseDeploymentConfigsProductionR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectListResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionService ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectListResponseDeploymentConfigsProductionServiceJSON `json:"-"`
}
Service binding.
func (*ProjectListResponseDeploymentConfigsProductionService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionService) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectListResponseDeploymentConfigsProductionUsageModelStandard ProjectListResponseDeploymentConfigsProductionUsageModel = "standard" ProjectListResponseDeploymentConfigsProductionUsageModelBundled ProjectListResponseDeploymentConfigsProductionUsageModel = "bundled" ProjectListResponseDeploymentConfigsProductionUsageModelUnbound ProjectListResponseDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectListResponseDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectListResponseDeploymentConfigsProductionVectorizeBinding ¶ added in v6.4.0
type ProjectListResponseDeploymentConfigsProductionVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectListResponseDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectListResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeployment ¶ added in v6.4.0
type ProjectListResponseLatestDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectListResponseLatestDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectListResponseLatestDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectListResponseLatestDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectListResponseLatestDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectListResponseLatestDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectListResponseLatestDeploymentJSON `json:"-"`
}
Most recent deployment of the project.
func (*ProjectListResponseLatestDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentBuildConfig ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectListResponseLatestDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectListResponseLatestDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectListResponseLatestDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectListResponseLatestDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectListResponseLatestDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectListResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectListResponseLatestDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectListResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectListResponseLatestDeploymentDeploymentTriggerTypeGitHubPush ProjectListResponseLatestDeploymentDeploymentTriggerType = "github:push" ProjectListResponseLatestDeploymentDeploymentTriggerTypeADHoc ProjectListResponseLatestDeploymentDeploymentTriggerType = "ad_hoc" ProjectListResponseLatestDeploymentDeploymentTriggerTypeDeployHook ProjectListResponseLatestDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectListResponseLatestDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectListResponseLatestDeploymentEnvVar ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVar struct {
Type ProjectListResponseLatestDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseLatestDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectListResponseLatestDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentEnvVar) AsUnion() ProjectListResponseLatestDeploymentEnvVarsUnion
AsUnion returns a ProjectListResponseLatestDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar, ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectListResponseLatestDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectListResponseLatestDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsType string
const ( ProjectListResponseLatestDeploymentEnvVarsTypePlainText ProjectListResponseLatestDeploymentEnvVarsType = "plain_text" ProjectListResponseLatestDeploymentEnvVarsTypeSecretText ProjectListResponseLatestDeploymentEnvVarsType = "secret_text" )
func (ProjectListResponseLatestDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentEnvVarsType) IsKnown() bool
type ProjectListResponseLatestDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectListResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar or ProjectListResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectListResponseLatestDeploymentEnvironment ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentEnvironment string
Type of deploy.
const ( ProjectListResponseLatestDeploymentEnvironmentPreview ProjectListResponseLatestDeploymentEnvironment = "preview" ProjectListResponseLatestDeploymentEnvironmentProduction ProjectListResponseLatestDeploymentEnvironment = "production" )
func (ProjectListResponseLatestDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentEnvironment) IsKnown() bool
type ProjectListResponseLatestDeploymentSource ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentSource struct {
Config ProjectListResponseLatestDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectListResponseLatestDeploymentSourceType `json:"type,required"`
JSON projectListResponseLatestDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectListResponseLatestDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentSourceConfig ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectListResponseLatestDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectListResponseLatestDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseLatestDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSettingAll ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSettingNone ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectListResponseLatestDeploymentSourceType ¶ added in v6.4.0
type ProjectListResponseLatestDeploymentSourceType string
The source control management provider.
const ( ProjectListResponseLatestDeploymentSourceTypeGitHub ProjectListResponseLatestDeploymentSourceType = "github" ProjectListResponseLatestDeploymentSourceTypeGitlab ProjectListResponseLatestDeploymentSourceType = "gitlab" )
func (ProjectListResponseLatestDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseLatestDeploymentSourceType) IsKnown() bool
type ProjectListResponseSource ¶ added in v6.4.0
type ProjectListResponseSource struct {
Config ProjectListResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectListResponseSourceType `json:"type,required"`
JSON projectListResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectListResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseSourceConfig ¶ added in v6.4.0
type ProjectListResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectListResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectListResponseSourceConfigJSON `json:"-"`
}
func (*ProjectListResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectListResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectListResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectListResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectListResponseSourceConfigPreviewDeploymentSettingAll ProjectListResponseSourceConfigPreviewDeploymentSetting = "all" ProjectListResponseSourceConfigPreviewDeploymentSettingNone ProjectListResponseSourceConfigPreviewDeploymentSetting = "none" ProjectListResponseSourceConfigPreviewDeploymentSettingCustom ProjectListResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectListResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectListResponseSourceType ¶ added in v6.4.0
type ProjectListResponseSourceType string
The source control management provider.
const ( ProjectListResponseSourceTypeGitHub ProjectListResponseSourceType = "github" ProjectListResponseSourceTypeGitlab ProjectListResponseSourceType = "gitlab" )
func (ProjectListResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectListResponseSourceType) IsKnown() bool
type ProjectNewParams ¶
type ProjectNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id,required"`
// Name of the project.
Name param.Field[string] `json:"name,required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch param.Field[string] `json:"production_branch,required"`
// Configs for the project build process.
BuildConfig param.Field[ProjectNewParamsBuildConfig] `json:"build_config"`
// Configs for deployments in a project.
DeploymentConfigs param.Field[ProjectNewParamsDeploymentConfigs] `json:"deployment_configs"`
// Configs for the project source control.
Source param.Field[ProjectNewParamsSource] `json:"source"`
}
func (ProjectNewParams) MarshalJSON ¶
func (r ProjectNewParams) MarshalJSON() (data []byte, err error)
type ProjectNewParamsBuildConfig ¶ added in v6.4.0
type ProjectNewParamsBuildConfig struct {
// Enable build caching for the project.
BuildCaching param.Field[bool] `json:"build_caching"`
// Command used to build project.
BuildCommand param.Field[string] `json:"build_command"`
// Output directory of the build.
DestinationDir param.Field[string] `json:"destination_dir"`
// Directory to run the command.
RootDir param.Field[string] `json:"root_dir"`
// The classifying tag for analytics.
WebAnalyticsTag param.Field[string] `json:"web_analytics_tag"`
// The auth token for analytics.
WebAnalyticsToken param.Field[string] `json:"web_analytics_token"`
}
Configs for the project build process.
func (ProjectNewParamsBuildConfig) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsBuildConfig) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigs ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigs struct {
// Configs for preview deploys.
Preview param.Field[ProjectNewParamsDeploymentConfigsPreview] `json:"preview"`
// Configs for production deploys.
Production param.Field[ProjectNewParamsDeploymentConfigsProduction] `json:"production"`
}
Configs for deployments in a project.
func (ProjectNewParamsDeploymentConfigs) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigs) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreview struct {
// Constellation bindings used for Pages Functions.
AIBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewAIBindings] `json:"ai_bindings"`
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewBrowsers] `json:"browsers"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
// Compatibility date used for Pages Functions.
CompatibilityDate param.Field[string] `json:"compatibility_date"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
// D1 databases used for Pages Functions.
D1Databases param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewD1Databases] `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces] `json:"durable_object_namespaces"`
// Environment variables used for builds and Pages Functions.
EnvVars param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion] `json:"env_vars"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen param.Field[bool] `json:"fail_open"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings] `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewKVNamespaces] `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits param.Field[ProjectNewParamsDeploymentConfigsPreviewLimits] `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates] `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement param.Field[ProjectNewParamsDeploymentConfigsPreviewPlacement] `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewQueueProducers] `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewR2Buckets] `json:"r2_buckets"`
// Services used for Pages Functions.
Services param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewServices] `json:"services"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel param.Field[ProjectNewParamsDeploymentConfigsPreviewUsageModel] `json:"usage_model"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings] `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}
Configs for preview deploys.
func (ProjectNewParamsDeploymentConfigsPreview) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreview) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewAIBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewAIBindings struct {
ProjectID param.Field[string] `json:"project_id,required"`
}
AI binding.
func (ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset,required"`
}
Analytics Engine binding.
func (ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewBrowsers ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewBrowsers struct {
}
Browser binding.
func (ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewD1Databases ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id,required"`
}
D1 binding.
func (ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
Durable Object binding.
func (ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVars ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVars struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
// Secret value.
Value param.Field[string] `json:"value,required"`
}
An encrypted environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType string
const ( ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypePlainText ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsPreviewEnvVars.
type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings struct {
ID param.Field[string] `json:"id,required"`
}
Hyperdrive binding.
func (ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
KV namespace binding.
func (ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms,required"`
}
Limits for Pages Functions.
func (ProjectNewParamsDeploymentConfigsPreviewLimits) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewLimits) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id,required"`
}
mTLS binding.
func (ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode,required"`
}
Placement setting used for Pages Functions.
func (ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewQueueProducers ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name,required"`
}
Queue Producer binding.
func (ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewR2Buckets ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewServices ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewServices struct {
// The Service name.
Service param.Field[string] `json:"service,required"`
// The entrypoint to bind to.
Entrypoint param.Field[string] `json:"entrypoint"`
// The Service environment.
Environment param.Field[string] `json:"environment"`
}
Service binding.
func (ProjectNewParamsDeploymentConfigsPreviewServices) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewServices) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectNewParamsDeploymentConfigsPreviewUsageModelStandard ProjectNewParamsDeploymentConfigsPreviewUsageModel = "standard" ProjectNewParamsDeploymentConfigsPreviewUsageModelBundled ProjectNewParamsDeploymentConfigsPreviewUsageModel = "bundled" ProjectNewParamsDeploymentConfigsPreviewUsageModelUnbound ProjectNewParamsDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectNewParamsDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name,required"`
}
Vectorize binding.
func (ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProduction struct {
// Constellation bindings used for Pages Functions.
AIBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionAIBindings] `json:"ai_bindings"`
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate param.Field[bool] `json:"always_use_latest_compatibility_date"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets] `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionBrowsers] `json:"browsers"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion param.Field[int64] `json:"build_image_major_version"`
// Compatibility date used for Pages Functions.
CompatibilityDate param.Field[string] `json:"compatibility_date"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags param.Field[[]string] `json:"compatibility_flags"`
// D1 databases used for Pages Functions.
D1Databases param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionD1Databases] `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces] `json:"durable_object_namespaces"`
// Environment variables used for builds and Pages Functions.
EnvVars param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion] `json:"env_vars"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen param.Field[bool] `json:"fail_open"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings] `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionKVNamespaces] `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits param.Field[ProjectNewParamsDeploymentConfigsProductionLimits] `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionMTLSCertificates] `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement param.Field[ProjectNewParamsDeploymentConfigsProductionPlacement] `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionQueueProducers] `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionR2Buckets] `json:"r2_buckets"`
// Services used for Pages Functions.
Services param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionServices] `json:"services"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel param.Field[ProjectNewParamsDeploymentConfigsProductionUsageModel] `json:"usage_model"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings param.Field[map[string]ProjectNewParamsDeploymentConfigsProductionVectorizeBindings] `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash param.Field[string] `json:"wrangler_config_hash"`
}
Configs for production deploys.
func (ProjectNewParamsDeploymentConfigsProduction) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProduction) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionAIBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionAIBindings struct {
ProjectID param.Field[string] `json:"project_id,required"`
}
AI binding.
func (ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset,required"`
}
Analytics Engine binding.
func (ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionBrowsers ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionBrowsers struct {
}
Browser binding.
func (ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionD1Databases ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id,required"`
}
D1 binding.
func (ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
Durable Object binding.
func (ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVars ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVars struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type,required"`
// Environment variable value.
Value param.Field[string] `json:"value,required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type,required"`
// Secret value.
Value param.Field[string] `json:"value,required"`
}
An encrypted environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsType string
const ( ProjectNewParamsDeploymentConfigsProductionEnvVarsTypePlainText ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectNewParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsProductionEnvVars.
type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings struct {
ID param.Field[string] `json:"id,required"`
}
Hyperdrive binding.
func (ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionKVNamespaces ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id,required"`
}
KV namespace binding.
func (ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms,required"`
}
Limits for Pages Functions.
func (ProjectNewParamsDeploymentConfigsProductionLimits) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionLimits) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id,required"`
}
mTLS binding.
func (ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode,required"`
}
Placement setting used for Pages Functions.
func (ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionQueueProducers ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name,required"`
}
Queue Producer binding.
func (ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionR2Buckets ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionServices ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionServices struct {
// The Service name.
Service param.Field[string] `json:"service,required"`
// The entrypoint to bind to.
Entrypoint param.Field[string] `json:"entrypoint"`
// The Service environment.
Environment param.Field[string] `json:"environment"`
}
Service binding.
func (ProjectNewParamsDeploymentConfigsProductionServices) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionServices) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectNewParamsDeploymentConfigsProductionUsageModelStandard ProjectNewParamsDeploymentConfigsProductionUsageModel = "standard" ProjectNewParamsDeploymentConfigsProductionUsageModelBundled ProjectNewParamsDeploymentConfigsProductionUsageModel = "bundled" ProjectNewParamsDeploymentConfigsProductionUsageModelUnbound ProjectNewParamsDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectNewParamsDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings ¶ added in v6.4.0
type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name,required"`
}
Vectorize binding.
func (ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSource ¶ added in v6.4.0
type ProjectNewParamsSource struct {
Config param.Field[ProjectNewParamsSourceConfig] `json:"config,required"`
// The source control management provider.
Type param.Field[ProjectNewParamsSourceType] `json:"type,required"`
}
Configs for the project source control.
func (ProjectNewParamsSource) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsSource) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSourceConfig ¶ added in v6.4.0
type ProjectNewParamsSourceConfig struct {
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled param.Field[bool] `json:"deployments_enabled"`
// The owner of the repository.
Owner param.Field[string] `json:"owner"`
// The owner ID of the repository.
OwnerID param.Field[string] `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes param.Field[[]string] `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes param.Field[[]string] `json:"path_includes"`
// Whether to enable PR comments.
PrCommentsEnabled param.Field[bool] `json:"pr_comments_enabled"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes param.Field[[]string] `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes param.Field[[]string] `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting param.Field[ProjectNewParamsSourceConfigPreviewDeploymentSetting] `json:"preview_deployment_setting"`
// The production branch of the repository.
ProductionBranch param.Field[string] `json:"production_branch"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled param.Field[bool] `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID param.Field[string] `json:"repo_id"`
// The name of the repository.
RepoName param.Field[string] `json:"repo_name"`
}
func (ProjectNewParamsSourceConfig) MarshalJSON ¶ added in v6.4.0
func (r ProjectNewParamsSourceConfig) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectNewParamsSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectNewParamsSourceConfigPreviewDeploymentSettingAll ProjectNewParamsSourceConfigPreviewDeploymentSetting = "all" ProjectNewParamsSourceConfigPreviewDeploymentSettingNone ProjectNewParamsSourceConfigPreviewDeploymentSetting = "none" ProjectNewParamsSourceConfigPreviewDeploymentSettingCustom ProjectNewParamsSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectNewParamsSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectNewParamsSourceType ¶ added in v6.4.0
type ProjectNewParamsSourceType string
The source control management provider.
const ( ProjectNewParamsSourceTypeGitHub ProjectNewParamsSourceType = "github" ProjectNewParamsSourceTypeGitlab ProjectNewParamsSourceType = "gitlab" )
func (ProjectNewParamsSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectNewParamsSourceType) IsKnown() bool
type ProjectNewResponse ¶ added in v6.4.0
type ProjectNewResponse struct {
// ID of the project.
ID string `json:"id,required"`
// Most recent production deployment of the project.
CanonicalDeployment ProjectNewResponseCanonicalDeployment `json:"canonical_deployment,required,nullable"`
// When the project was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Configs for deployments in a project.
DeploymentConfigs ProjectNewResponseDeploymentConfigs `json:"deployment_configs,required"`
// Framework the project is using.
Framework string `json:"framework,required"`
// Version of the framework the project is using.
FrameworkVersion string `json:"framework_version,required"`
// Most recent deployment of the project.
LatestDeployment ProjectNewResponseLatestDeployment `json:"latest_deployment,required,nullable"`
// Name of the project.
Name string `json:"name,required"`
// Name of the preview script.
PreviewScriptName string `json:"preview_script_name,required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch string `json:"production_branch,required"`
// Name of the production script.
ProductionScriptName string `json:"production_script_name,required"`
// Whether the project uses functions.
UsesFunctions bool `json:"uses_functions,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectNewResponseBuildConfig `json:"build_config"`
// A list of associated custom domains for the project.
Domains []string `json:"domains"`
// Configs for the project source control.
Source ProjectNewResponseSource `json:"source"`
// The Cloudflare subdomain associated with the project.
Subdomain string `json:"subdomain"`
JSON projectNewResponseJSON `json:"-"`
}
func (*ProjectNewResponse) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponse) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseBuildConfig ¶ added in v6.4.0
type ProjectNewResponseBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectNewResponseBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectNewResponseBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeployment ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectNewResponseCanonicalDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectNewResponseCanonicalDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectNewResponseCanonicalDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectNewResponseCanonicalDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectNewResponseCanonicalDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectNewResponseCanonicalDeploymentJSON `json:"-"`
}
Most recent production deployment of the project.
func (*ProjectNewResponseCanonicalDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentBuildConfig ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectNewResponseCanonicalDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectNewResponseCanonicalDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectNewResponseCanonicalDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectNewResponseCanonicalDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectNewResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectNewResponseCanonicalDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectNewResponseCanonicalDeploymentDeploymentTriggerTypeGitHubPush ProjectNewResponseCanonicalDeploymentDeploymentTriggerType = "github:push" ProjectNewResponseCanonicalDeploymentDeploymentTriggerTypeADHoc ProjectNewResponseCanonicalDeploymentDeploymentTriggerType = "ad_hoc" ProjectNewResponseCanonicalDeploymentDeploymentTriggerTypeDeployHook ProjectNewResponseCanonicalDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectNewResponseCanonicalDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentEnvVar ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVar struct {
Type ProjectNewResponseCanonicalDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseCanonicalDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectNewResponseCanonicalDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentEnvVar) AsUnion() ProjectNewResponseCanonicalDeploymentEnvVarsUnion
AsUnion returns a ProjectNewResponseCanonicalDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar, ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectNewResponseCanonicalDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsType string
const ( ProjectNewResponseCanonicalDeploymentEnvVarsTypePlainText ProjectNewResponseCanonicalDeploymentEnvVarsType = "plain_text" ProjectNewResponseCanonicalDeploymentEnvVarsTypeSecretText ProjectNewResponseCanonicalDeploymentEnvVarsType = "secret_text" )
func (ProjectNewResponseCanonicalDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentEnvVarsType) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectNewResponseCanonicalDeploymentEnvVarsPagesPlainTextEnvVar or ProjectNewResponseCanonicalDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectNewResponseCanonicalDeploymentEnvironment ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentEnvironment string
Type of deploy.
const ( ProjectNewResponseCanonicalDeploymentEnvironmentPreview ProjectNewResponseCanonicalDeploymentEnvironment = "preview" ProjectNewResponseCanonicalDeploymentEnvironmentProduction ProjectNewResponseCanonicalDeploymentEnvironment = "production" )
func (ProjectNewResponseCanonicalDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentEnvironment) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentSource ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentSource struct {
Config ProjectNewResponseCanonicalDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectNewResponseCanonicalDeploymentSourceType `json:"type,required"`
JSON projectNewResponseCanonicalDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectNewResponseCanonicalDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentSourceConfig ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectNewResponseCanonicalDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectNewResponseCanonicalDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseCanonicalDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingAll ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingNone ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectNewResponseCanonicalDeploymentSourceType ¶ added in v6.4.0
type ProjectNewResponseCanonicalDeploymentSourceType string
The source control management provider.
const ( ProjectNewResponseCanonicalDeploymentSourceTypeGitHub ProjectNewResponseCanonicalDeploymentSourceType = "github" ProjectNewResponseCanonicalDeploymentSourceTypeGitlab ProjectNewResponseCanonicalDeploymentSourceType = "gitlab" )
func (ProjectNewResponseCanonicalDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseCanonicalDeploymentSourceType) IsKnown() bool
type ProjectNewResponseDeploymentConfigs ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigs struct {
// Configs for preview deploys.
Preview ProjectNewResponseDeploymentConfigsPreview `json:"preview,required"`
// Configs for production deploys.
Production ProjectNewResponseDeploymentConfigsProduction `json:"production,required"`
JSON projectNewResponseDeploymentConfigsJSON `json:"-"`
}
Configs for deployments in a project.
func (*ProjectNewResponseDeploymentConfigs) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigs) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreview ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreview struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectNewResponseDeploymentConfigsPreviewEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectNewResponseDeploymentConfigsPreviewUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectNewResponseDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectNewResponseDeploymentConfigsPreviewBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectNewResponseDeploymentConfigsPreviewD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectNewResponseDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectNewResponseDeploymentConfigsPreviewLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectNewResponseDeploymentConfigsPreviewPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectNewResponseDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectNewResponseDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectNewResponseDeploymentConfigsPreviewService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectNewResponseDeploymentConfigsPreviewJSON `json:"-"`
}
Configs for preview deploys.
func (*ProjectNewResponseDeploymentConfigsPreview) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreview) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewAIBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectNewResponseDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectNewResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectNewResponseDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewBrowser ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewBrowser struct {
JSON projectNewResponseDeploymentConfigsPreviewBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectNewResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewD1Database ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectNewResponseDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectNewResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectNewResponseDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVar struct {
Type ProjectNewResponseDeploymentConfigsPreviewEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsPreviewEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectNewResponseDeploymentConfigsPreviewEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsPreviewEnvVar) AsUnion() ProjectNewResponseDeploymentConfigsPreviewEnvVarsUnion
AsUnion returns a ProjectNewResponseDeploymentConfigsPreviewEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
func (*ProjectNewResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsType string
const ( ProjectNewResponseDeploymentConfigsPreviewEnvVarsTypePlainText ProjectNewResponseDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectNewResponseDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectNewResponseDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectNewResponseDeploymentConfigsPreviewEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsUnion ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectNewResponseDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
type ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectNewResponseDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewKVNamespace ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectNewResponseDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectNewResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewLimits ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectNewResponseDeploymentConfigsPreviewLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectNewResponseDeploymentConfigsPreviewLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewLimits) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectNewResponseDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewPlacement ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectNewResponseDeploymentConfigsPreviewPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectNewResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewQueueProducer ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectNewResponseDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectNewResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewR2Bucket ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectNewResponseDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectNewResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewService ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectNewResponseDeploymentConfigsPreviewServiceJSON `json:"-"`
}
Service binding.
func (*ProjectNewResponseDeploymentConfigsPreviewService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewService) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsPreviewUsageModel ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectNewResponseDeploymentConfigsPreviewUsageModelStandard ProjectNewResponseDeploymentConfigsPreviewUsageModel = "standard" ProjectNewResponseDeploymentConfigsPreviewUsageModelBundled ProjectNewResponseDeploymentConfigsPreviewUsageModel = "bundled" ProjectNewResponseDeploymentConfigsPreviewUsageModelUnbound ProjectNewResponseDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectNewResponseDeploymentConfigsPreviewUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectNewResponseDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProduction ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProduction struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date,required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version,required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date,required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectNewResponseDeploymentConfigsProductionEnvVar `json:"env_vars,required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open,required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectNewResponseDeploymentConfigsProductionUsageModel `json:"usage_model,required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectNewResponseDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectNewResponseDeploymentConfigsProductionBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectNewResponseDeploymentConfigsProductionD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectNewResponseDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectNewResponseDeploymentConfigsProductionLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectNewResponseDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectNewResponseDeploymentConfigsProductionPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectNewResponseDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectNewResponseDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectNewResponseDeploymentConfigsProductionService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectNewResponseDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectNewResponseDeploymentConfigsProductionJSON `json:"-"`
}
Configs for production deploys.
func (*ProjectNewResponseDeploymentConfigsProduction) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProduction) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionAIBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionAIBinding struct {
ProjectID string `json:"project_id,required"`
JSON projectNewResponseDeploymentConfigsProductionAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectNewResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset,required"`
JSON projectNewResponseDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionBrowser ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionBrowser struct {
JSON projectNewResponseDeploymentConfigsProductionBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectNewResponseDeploymentConfigsProductionBrowser) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionD1Database ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionD1Database struct {
// UUID of the D1 database.
ID string `json:"id,required"`
JSON projectNewResponseDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectNewResponseDeploymentConfigsProductionD1Database) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectNewResponseDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVar struct {
Type ProjectNewResponseDeploymentConfigsProductionEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsProductionEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectNewResponseDeploymentConfigsProductionEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsProductionEnvVar) AsUnion() ProjectNewResponseDeploymentConfigsProductionEnvVarsUnion
AsUnion returns a ProjectNewResponseDeploymentConfigsProductionEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
func (*ProjectNewResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
type ProjectNewResponseDeploymentConfigsProductionEnvVarsType ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsType string
const ( ProjectNewResponseDeploymentConfigsProductionEnvVarsTypePlainText ProjectNewResponseDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectNewResponseDeploymentConfigsProductionEnvVarsTypeSecretText ProjectNewResponseDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectNewResponseDeploymentConfigsProductionEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectNewResponseDeploymentConfigsProductionEnvVarsUnion ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectNewResponseDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
type ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding struct {
ID string `json:"id,required"`
JSON projectNewResponseDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionKVNamespace ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id,required"`
JSON projectNewResponseDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectNewResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionLimits ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms,required"`
JSON projectNewResponseDeploymentConfigsProductionLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectNewResponseDeploymentConfigsProductionLimits) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionLimits) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionMTLSCertificate ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionMTLSCertificate struct {
CertificateID string `json:"certificate_id,required"`
JSON projectNewResponseDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectNewResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionPlacement ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode string `json:"mode,required"`
JSON projectNewResponseDeploymentConfigsProductionPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectNewResponseDeploymentConfigsProductionPlacement) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionQueueProducer ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionQueueProducer struct {
// Name of the Queue.
Name string `json:"name,required"`
JSON projectNewResponseDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectNewResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionR2Bucket ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name,required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction,nullable"`
JSON projectNewResponseDeploymentConfigsProductionR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectNewResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionService ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionService struct {
// The Service environment.
Environment string `json:"environment,required"`
// The Service name.
Service string `json:"service,required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint,nullable"`
JSON projectNewResponseDeploymentConfigsProductionServiceJSON `json:"-"`
}
Service binding.
func (*ProjectNewResponseDeploymentConfigsProductionService) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionService) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseDeploymentConfigsProductionUsageModel ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectNewResponseDeploymentConfigsProductionUsageModelStandard ProjectNewResponseDeploymentConfigsProductionUsageModel = "standard" ProjectNewResponseDeploymentConfigsProductionUsageModelBundled ProjectNewResponseDeploymentConfigsProductionUsageModel = "bundled" ProjectNewResponseDeploymentConfigsProductionUsageModelUnbound ProjectNewResponseDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectNewResponseDeploymentConfigsProductionUsageModel) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectNewResponseDeploymentConfigsProductionVectorizeBinding ¶ added in v6.4.0
type ProjectNewResponseDeploymentConfigsProductionVectorizeBinding struct {
IndexName string `json:"index_name,required"`
JSON projectNewResponseDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectNewResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(data []byte) (err error)
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 ¶ added in v6.4.0
type ProjectNewResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectNewResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeSuccess ¶
type ProjectNewResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectNewResponseEnvelopeSuccessTrue ProjectNewResponseEnvelopeSuccess = true
)
func (ProjectNewResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectNewResponseEnvelopeSuccess) IsKnown() bool
type ProjectNewResponseLatestDeployment ¶ added in v6.4.0
type ProjectNewResponseLatestDeployment struct {
// Id of the deployment.
ID string `json:"id,required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases,required,nullable"`
// Configs for the project build process.
BuildConfig ProjectNewResponseLatestDeploymentBuildConfig `json:"build_config,required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on,required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger ProjectNewResponseLatestDeploymentDeploymentTrigger `json:"deployment_trigger,required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectNewResponseLatestDeploymentEnvVar `json:"env_vars,required,nullable"`
// Type of deploy.
Environment ProjectNewResponseLatestDeploymentEnvironment `json:"environment,required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped,required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage,required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on,required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id,required"`
// Name of the project.
ProjectName string `json:"project_name,required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id,required"`
// Configs for the project source control.
Source ProjectNewResponseLatestDeploymentSource `json:"source,required"`
// List of past stages.
Stages []Stage `json:"stages,required"`
// The live URL to view this deployment.
URL string `json:"url,required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions,nullable"`
JSON projectNewResponseLatestDeploymentJSON `json:"-"`
}
Most recent deployment of the project.
func (*ProjectNewResponseLatestDeployment) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeployment) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentBuildConfig ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag,required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token,required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching,nullable"`
// Command used to build project.
BuildCommand string `json:"build_command,nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir,nullable"`
// Directory to run the command.
RootDir string `json:"root_dir,nullable"`
JSON projectNewResponseLatestDeploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectNewResponseLatestDeploymentBuildConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentDeploymentTrigger ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata `json:"metadata,required"`
// What caused the deployment.
Type ProjectNewResponseLatestDeploymentDeploymentTriggerType `json:"type,required"`
JSON projectNewResponseLatestDeploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*ProjectNewResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch,required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty,required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash,required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message,required"`
JSON projectNewResponseLatestDeploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentDeploymentTriggerType ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentDeploymentTriggerType string
What caused the deployment.
const ( ProjectNewResponseLatestDeploymentDeploymentTriggerTypeGitHubPush ProjectNewResponseLatestDeploymentDeploymentTriggerType = "github:push" ProjectNewResponseLatestDeploymentDeploymentTriggerTypeADHoc ProjectNewResponseLatestDeploymentDeploymentTriggerType = "ad_hoc" ProjectNewResponseLatestDeploymentDeploymentTriggerTypeDeployHook ProjectNewResponseLatestDeploymentDeploymentTriggerType = "deploy_hook" )
func (ProjectNewResponseLatestDeploymentDeploymentTriggerType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentDeploymentTriggerType) IsKnown() bool
type ProjectNewResponseLatestDeploymentEnvVar ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVar struct {
Type ProjectNewResponseLatestDeploymentEnvVarsType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseLatestDeploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectNewResponseLatestDeploymentEnvVar) AsUnion ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentEnvVar) AsUnion() ProjectNewResponseLatestDeploymentEnvVarsUnion
AsUnion returns a ProjectNewResponseLatestDeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar, ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
func (*ProjectNewResponseLatestDeploymentEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar struct {
Type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType `json:"type,required"`
// Environment variable value.
Value string `json:"value,required"`
JSON projectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar struct {
Type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType `json:"type,required"`
// Secret value.
Value string `json:"value,required"`
JSON projectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewResponseLatestDeploymentEnvVarsType ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsType string
const ( ProjectNewResponseLatestDeploymentEnvVarsTypePlainText ProjectNewResponseLatestDeploymentEnvVarsType = "plain_text" ProjectNewResponseLatestDeploymentEnvVarsTypeSecretText ProjectNewResponseLatestDeploymentEnvVarsType = "secret_text" )
func (ProjectNewResponseLatestDeploymentEnvVarsType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentEnvVarsType) IsKnown() bool
type ProjectNewResponseLatestDeploymentEnvVarsUnion ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectNewResponseLatestDeploymentEnvVarsPagesPlainTextEnvVar or ProjectNewResponseLatestDeploymentEnvVarsPagesSecretTextEnvVar.
type ProjectNewResponseLatestDeploymentEnvironment ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentEnvironment string
Type of deploy.
const ( ProjectNewResponseLatestDeploymentEnvironmentPreview ProjectNewResponseLatestDeploymentEnvironment = "preview" ProjectNewResponseLatestDeploymentEnvironmentProduction ProjectNewResponseLatestDeploymentEnvironment = "production" )
func (ProjectNewResponseLatestDeploymentEnvironment) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentEnvironment) IsKnown() bool
type ProjectNewResponseLatestDeploymentSource ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentSource struct {
Config ProjectNewResponseLatestDeploymentSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectNewResponseLatestDeploymentSourceType `json:"type,required"`
JSON projectNewResponseLatestDeploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectNewResponseLatestDeploymentSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentSourceConfig ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectNewResponseLatestDeploymentSourceConfigJSON `json:"-"`
}
func (*ProjectNewResponseLatestDeploymentSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseLatestDeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSettingAll ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "all" ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSettingNone ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "none" ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSettingCustom ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectNewResponseLatestDeploymentSourceType ¶ added in v6.4.0
type ProjectNewResponseLatestDeploymentSourceType string
The source control management provider.
const ( ProjectNewResponseLatestDeploymentSourceTypeGitHub ProjectNewResponseLatestDeploymentSourceType = "github" ProjectNewResponseLatestDeploymentSourceTypeGitlab ProjectNewResponseLatestDeploymentSourceType = "gitlab" )
func (ProjectNewResponseLatestDeploymentSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseLatestDeploymentSourceType) IsKnown() bool
type ProjectNewResponseSource ¶ added in v6.4.0
type ProjectNewResponseSource struct {
Config ProjectNewResponseSourceConfig `json:"config,required"`
// The source control management provider.
Type ProjectNewResponseSourceType `json:"type,required"`
JSON projectNewResponseSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectNewResponseSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseSourceConfig ¶ added in v6.4.0
type ProjectNewResponseSourceConfig struct {
// The owner of the repository.
Owner string `json:"owner,required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled,required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch,required"`
// The name of the repository.
RepoName string `json:"repo_name,required"`
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled"`
// The owner ID of the repository.
OwnerID string `json:"owner_id"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectNewResponseSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled"`
// The ID of the repository.
RepoID string `json:"repo_id"`
JSON projectNewResponseSourceConfigJSON `json:"-"`
}
func (*ProjectNewResponseSourceConfig) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectNewResponseSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseSourceConfigPreviewDeploymentSetting ¶ added in v6.4.0
type ProjectNewResponseSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectNewResponseSourceConfigPreviewDeploymentSettingAll ProjectNewResponseSourceConfigPreviewDeploymentSetting = "all" ProjectNewResponseSourceConfigPreviewDeploymentSettingNone ProjectNewResponseSourceConfigPreviewDeploymentSetting = "none" ProjectNewResponseSourceConfigPreviewDeploymentSettingCustom ProjectNewResponseSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectNewResponseSourceConfigPreviewDeploymentSetting) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectNewResponseSourceType ¶ added in v6.4.0
type ProjectNewResponseSourceType string
The source control management provider.
const ( ProjectNewResponseSourceTypeGitHub ProjectNewResponseSourceType = "github" ProjectNewResponseSourceTypeGitlab ProjectNewResponseSourceType = "gitlab" )
func (ProjectNewResponseSourceType) IsKnown ¶ added in v6.4.0
func (r ProjectNewResponseSourceType) IsKnown() bool
type ProjectPurgeBuildCacheResponse ¶
type ProjectPurgeBuildCacheResponse = interface{}
type ProjectPurgeBuildCacheResponseEnvelope ¶
type ProjectPurgeBuildCacheResponseEnvelope struct {
Errors []ProjectPurgeBuildCacheResponseEnvelopeErrors `json:"errors,required"`
Messages []ProjectPurgeBuildCacheResponseEnvelopeMessages `json:"messages,required"`
Result ProjectPurgeBuildCacheResponse `json:"result,required,nullable"`
// Whether the API call was successful.
Success ProjectPurgeBuildCacheResponseEnvelopeSuccess `json:"success,required"`
JSON projectPurgeBuildCacheResponseEnvelopeJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectPurgeBuildCacheResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeErrors ¶ added in v6.4.0
type ProjectPurgeBuildCacheResponseEnvelopeErrors struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectPurgeBuildCacheResponseEnvelopeErrorsSource `json:"source"`
JSON projectPurgeBuildCacheResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeErrors) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectPurgeBuildCacheResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource ¶ added in v6.4.0
type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectPurgeBuildCacheResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeErrorsSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectPurgeBuildCacheResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeMessages ¶ added in v6.4.0
type ProjectPurgeBuildCacheResponseEnvelopeMessages struct {
Code int64 `json:"code,required"`
Message string `json:"message,required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectPurgeBuildCacheResponseEnvelopeMessagesSource `json:"source"`
JSON projectPurgeBuildCacheResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeMessages) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectPurgeBuildCacheResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource ¶ added in v6.4.0
type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectPurgeBuildCacheResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeMessagesSource) UnmarshalJSON ¶ added in v6.4.0
func (r *ProjectPurgeBuildCacheResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeSuccess ¶
type ProjectPurgeBuildCacheResponseEnvelopeSuccess bool
Whether the API call was successful.
const (
ProjectPurgeBuildCacheResponseEnvelopeSuccessTrue ProjectPurgeBuildCacheResponseEnvelopeSuccess = true
)
func (ProjectPurgeBuildCacheResponseEnvelopeSuccess) IsKnown ¶
func (r ProjectPurgeBuildCacheResponseEnvelopeSuccess) IsKnown() bool
type ProjectService ¶
type ProjectService struct {
Options []option.RequestOption
Deployments *ProjectDeploymentService
Domains *ProjectDomainService
}
ProjectService contains methods and other services that help with interacting with the cloudflare API.
Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewProjectService method instead.
func NewProjectService ¶
func NewProjectService(opts ...option.RequestOption) (r *ProjectService)
NewProjectService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.
func (*ProjectService) Delete ¶
func (r *ProjectService) Delete(ctx context.Context, projectName string, body ProjectDeleteParams, opts ...option.RequestOption) (res *ProjectDeleteResponse, err error)
Delete a project by name.
func (*ProjectService) Edit ¶
func (r *ProjectService) Edit(ctx context.Context, projectName string, params ProjectEditParams, opts ...option.RequestOption) (res *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 *ProjectGetResponse, err error)
Fetch a project by name.
func (*ProjectService) List ¶
func (r *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[ProjectListResponse], err error)
Fetch a list of all user projects.
func (*ProjectService) ListAutoPaging ¶
func (r *ProjectService) ListAutoPaging(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[ProjectListResponse]
Fetch a list of all user projects.
func (*ProjectService) New ¶
func (r *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (res *ProjectNewResponse, err error)
Create a new project.
func (*ProjectService) PurgeBuildCache ¶
func (r *ProjectService) PurgeBuildCache(ctx context.Context, projectName string, body ProjectPurgeBuildCacheParams, opts ...option.RequestOption) (res *ProjectPurgeBuildCacheResponse, err error)
Purge all cached build artifacts for a Pages project
type RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.
type Stage ¶
type Stage struct {
// When the stage ended.
EndedOn time.Time `json:"ended_on,required,nullable" format:"date-time"`
// The current build stage.
Name StageName `json:"name,required"`
// When the stage started.
StartedOn time.Time `json:"started_on,required,nullable" format:"date-time"`
// State of the current stage.
Status StageStatus `json:"status,required"`
JSON stageJSON `json:"-"`
}
The status of the deployment.
func (*Stage) UnmarshalJSON ¶
type StageStatus ¶
type StageStatus string
State of the current stage.
const ( StageStatusSuccess StageStatus = "success" StageStatusIdle StageStatus = "idle" StageStatusActive StageStatus = "active" StageStatusFailure StageStatus = "failure" StageStatusCanceled StageStatus = "canceled" )
func (StageStatus) IsKnown ¶
func (r StageStatus) IsKnown() bool
type SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNested ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam
Map of nested resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectString ¶
type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam ¶
type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam
Map of simple string resource permissions
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A list of resource names that the policy applies to.
This is an alias to an internal type.
type TokenStatus ¶
type TokenStatus = shared.TokenStatus
Status of the token.
This is an alias to an internal type.
type TokenValue ¶
type TokenValue = shared.TokenValue
The token value.
This is an alias to an internal type.