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 Deployment
- type DeploymentBuildConfig
- type DeploymentDeploymentTrigger
- type DeploymentDeploymentTriggerMetadata
- type DeploymentDeploymentTriggerType
- type DeploymentEnvVar
- type DeploymentEnvVarsPagesPlainTextEnvVar
- type DeploymentEnvVarsPagesPlainTextEnvVarType
- type DeploymentEnvVarsPagesSecretTextEnvVar
- type DeploymentEnvVarsPagesSecretTextEnvVarType
- type DeploymentEnvVarsType
- type DeploymentEnvVarsUnion
- type DeploymentEnvironment
- type DeploymentSource
- type DeploymentSourceConfig
- type DeploymentSourceConfigPreviewDeploymentSetting
- type DeploymentSourceType
- 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 Project
- type ProjectBuildConfig
- type ProjectDeleteParams
- type ProjectDeleteResponse
- type ProjectDeleteResponseEnvelope
- type ProjectDeleteResponseEnvelopeErrors
- type ProjectDeleteResponseEnvelopeErrorsSource
- type ProjectDeleteResponseEnvelopeMessages
- type ProjectDeleteResponseEnvelopeMessagesSource
- type ProjectDeleteResponseEnvelopeSuccess
- type ProjectDeploymentConfigs
- type ProjectDeploymentConfigsPreview
- type ProjectDeploymentConfigsPreviewAIBinding
- type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset
- type ProjectDeploymentConfigsPreviewBrowser
- type ProjectDeploymentConfigsPreviewD1Database
- type ProjectDeploymentConfigsPreviewDurableObjectNamespace
- type ProjectDeploymentConfigsPreviewEnvVar
- type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentConfigsPreviewEnvVarsType
- type ProjectDeploymentConfigsPreviewEnvVarsUnion
- type ProjectDeploymentConfigsPreviewHyperdriveBinding
- type ProjectDeploymentConfigsPreviewKVNamespace
- type ProjectDeploymentConfigsPreviewLimits
- type ProjectDeploymentConfigsPreviewMTLSCertificate
- type ProjectDeploymentConfigsPreviewPlacement
- type ProjectDeploymentConfigsPreviewQueueProducer
- type ProjectDeploymentConfigsPreviewR2Bucket
- type ProjectDeploymentConfigsPreviewService
- type ProjectDeploymentConfigsPreviewUsageModel
- type ProjectDeploymentConfigsPreviewVectorizeBinding
- type ProjectDeploymentConfigsProduction
- type ProjectDeploymentConfigsProductionAIBinding
- type ProjectDeploymentConfigsProductionAnalyticsEngineDataset
- type ProjectDeploymentConfigsProductionBrowser
- type ProjectDeploymentConfigsProductionD1Database
- type ProjectDeploymentConfigsProductionDurableObjectNamespace
- type ProjectDeploymentConfigsProductionEnvVar
- type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar
- type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType
- type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar
- type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType
- type ProjectDeploymentConfigsProductionEnvVarsType
- type ProjectDeploymentConfigsProductionEnvVarsUnion
- type ProjectDeploymentConfigsProductionHyperdriveBinding
- type ProjectDeploymentConfigsProductionKVNamespace
- type ProjectDeploymentConfigsProductionLimits
- type ProjectDeploymentConfigsProductionMTLSCertificate
- type ProjectDeploymentConfigsProductionPlacement
- type ProjectDeploymentConfigsProductionQueueProducer
- type ProjectDeploymentConfigsProductionR2Bucket
- type ProjectDeploymentConfigsProductionService
- type ProjectDeploymentConfigsProductionUsageModel
- type ProjectDeploymentConfigsProductionVectorizeBinding
- type ProjectDeploymentDeleteParams
- type ProjectDeploymentDeleteResponse
- type ProjectDeploymentDeleteResponseEnvelope
- type ProjectDeploymentDeleteResponseEnvelopeErrors
- type ProjectDeploymentDeleteResponseEnvelopeErrorsSource
- type ProjectDeploymentDeleteResponseEnvelopeMessages
- type ProjectDeploymentDeleteResponseEnvelopeMessagesSource
- type ProjectDeploymentDeleteResponseEnvelopeSuccess
- type ProjectDeploymentGetParams
- type ProjectDeploymentGetResponseEnvelope
- type ProjectDeploymentGetResponseEnvelopeErrors
- type ProjectDeploymentGetResponseEnvelopeErrorsSource
- type ProjectDeploymentGetResponseEnvelopeMessages
- type ProjectDeploymentGetResponseEnvelopeMessagesSource
- type ProjectDeploymentGetResponseEnvelopeSuccess
- 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 ProjectDeploymentNewParams
- type ProjectDeploymentNewParamsCommitDirty
- type ProjectDeploymentNewResponseEnvelope
- type ProjectDeploymentNewResponseEnvelopeErrors
- type ProjectDeploymentNewResponseEnvelopeErrorsSource
- type ProjectDeploymentNewResponseEnvelopeMessages
- type ProjectDeploymentNewResponseEnvelopeMessagesSource
- type ProjectDeploymentNewResponseEnvelopeSuccess
- type ProjectDeploymentRetryParams
- type ProjectDeploymentRetryResponseEnvelope
- type ProjectDeploymentRetryResponseEnvelopeErrors
- type ProjectDeploymentRetryResponseEnvelopeErrorsSource
- type ProjectDeploymentRetryResponseEnvelopeMessages
- type ProjectDeploymentRetryResponseEnvelopeMessagesSource
- type ProjectDeploymentRetryResponseEnvelopeSuccess
- type ProjectDeploymentRollbackParams
- type ProjectDeploymentRollbackResponseEnvelope
- type ProjectDeploymentRollbackResponseEnvelopeErrors
- type ProjectDeploymentRollbackResponseEnvelopeErrorsSource
- type ProjectDeploymentRollbackResponseEnvelopeMessages
- type ProjectDeploymentRollbackResponseEnvelopeMessagesSource
- type ProjectDeploymentRollbackResponseEnvelopeSuccess
- 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 *Deployment, err error)
- func (r *ProjectDeploymentService) List(ctx context.Context, projectName string, params ProjectDeploymentListParams, ...) (res *pagination.V4PagePaginationArray[Deployment], err error)
- func (r *ProjectDeploymentService) ListAutoPaging(ctx context.Context, projectName string, params ProjectDeploymentListParams, ...) *pagination.V4PagePaginationArrayAutoPager[Deployment]
- func (r *ProjectDeploymentService) New(ctx context.Context, projectName string, params ProjectDeploymentNewParams, ...) (res *Deployment, err error)
- func (r *ProjectDeploymentService) Retry(ctx context.Context, projectName string, deploymentID string, ...) (res *Deployment, err error)
- func (r *ProjectDeploymentService) Rollback(ctx context.Context, projectName string, deploymentID string, ...) (res *Deployment, 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 ProjectEditResponseEnvelope
- type ProjectEditResponseEnvelopeErrors
- type ProjectEditResponseEnvelopeErrorsSource
- type ProjectEditResponseEnvelopeMessages
- type ProjectEditResponseEnvelopeMessagesSource
- type ProjectEditResponseEnvelopeSuccess
- type ProjectGetParams
- type ProjectGetResponseEnvelope
- type ProjectGetResponseEnvelopeErrors
- type ProjectGetResponseEnvelopeErrorsSource
- type ProjectGetResponseEnvelopeMessages
- type ProjectGetResponseEnvelopeMessagesSource
- type ProjectGetResponseEnvelopeSuccess
- type ProjectListParams
- 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 ProjectNewResponseEnvelope
- type ProjectNewResponseEnvelopeErrors
- type ProjectNewResponseEnvelopeErrorsSource
- type ProjectNewResponseEnvelopeMessages
- type ProjectNewResponseEnvelopeMessagesSource
- type ProjectNewResponseEnvelopeSuccess
- 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 *Project, err error)
- func (r *ProjectService) Get(ctx context.Context, projectName string, query ProjectGetParams, ...) (res *Project, err error)
- func (r *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Project], err error)
- func (r *ProjectService) ListAutoPaging(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Project]
- func (r *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (res *Project, err error)
- func (r *ProjectService) PurgeBuildCache(ctx context.Context, projectName string, body ProjectPurgeBuildCacheParams, ...) (res *ProjectPurgeBuildCacheResponse, err error)
- type ProjectSource
- type ProjectSourceConfig
- type ProjectSourceConfigPreviewDeploymentSetting
- type ProjectSourceType
- 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 Deployment ¶
type Deployment struct {
// Id of the deployment.
ID string `json:"id" api:"required"`
// A list of alias URLs pointing to this deployment.
Aliases []string `json:"aliases" api:"required,nullable"`
// Configs for the project build process.
BuildConfig DeploymentBuildConfig `json:"build_config" api:"required"`
// When the deployment was created.
CreatedOn time.Time `json:"created_on" api:"required" format:"date-time"`
// Info about what caused the deployment.
DeploymentTrigger DeploymentDeploymentTrigger `json:"deployment_trigger" api:"required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]DeploymentEnvVar `json:"env_vars" api:"required,nullable"`
// Type of deploy.
Environment DeploymentEnvironment `json:"environment" api:"required"`
// If the deployment has been skipped.
IsSkipped bool `json:"is_skipped" api:"required"`
// The status of the deployment.
LatestStage Stage `json:"latest_stage" api:"required"`
// When the deployment was last modified.
ModifiedOn time.Time `json:"modified_on" api:"required" format:"date-time"`
// Id of the project.
ProjectID string `json:"project_id" api:"required"`
// Name of the project.
ProjectName string `json:"project_name" api:"required"`
// Short Id (8 character) of the deployment.
ShortID string `json:"short_id" api:"required"`
// Configs for the project source control.
Source DeploymentSource `json:"source" api:"required"`
// List of past stages.
Stages []Stage `json:"stages" api:"required"`
// The live URL to view this deployment.
URL string `json:"url" api:"required"`
// Whether the deployment uses functions.
UsesFunctions bool `json:"uses_functions" api:"nullable"`
JSON deploymentJSON `json:"-"`
}
func (*Deployment) UnmarshalJSON ¶
func (r *Deployment) UnmarshalJSON(data []byte) (err error)
type DeploymentBuildConfig ¶
type DeploymentBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag" api:"required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token" api:"required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching" api:"nullable"`
// Command used to build project.
BuildCommand string `json:"build_command" api:"nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir" api:"nullable"`
// Directory to run the command.
RootDir string `json:"root_dir" api:"nullable"`
JSON deploymentBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*DeploymentBuildConfig) UnmarshalJSON ¶
func (r *DeploymentBuildConfig) UnmarshalJSON(data []byte) (err error)
type DeploymentDeploymentTrigger ¶
type DeploymentDeploymentTrigger struct {
// Additional info about the trigger.
Metadata DeploymentDeploymentTriggerMetadata `json:"metadata" api:"required"`
// What caused the deployment.
Type DeploymentDeploymentTriggerType `json:"type" api:"required"`
JSON deploymentDeploymentTriggerJSON `json:"-"`
}
Info about what caused the deployment.
func (*DeploymentDeploymentTrigger) UnmarshalJSON ¶
func (r *DeploymentDeploymentTrigger) UnmarshalJSON(data []byte) (err error)
type DeploymentDeploymentTriggerMetadata ¶
type DeploymentDeploymentTriggerMetadata struct {
// Where the trigger happened.
Branch string `json:"branch" api:"required"`
// Whether the deployment trigger commit was dirty.
CommitDirty bool `json:"commit_dirty" api:"required"`
// Hash of the deployment trigger commit.
CommitHash string `json:"commit_hash" api:"required"`
// Message of the deployment trigger commit.
CommitMessage string `json:"commit_message" api:"required"`
JSON deploymentDeploymentTriggerMetadataJSON `json:"-"`
}
Additional info about the trigger.
func (*DeploymentDeploymentTriggerMetadata) UnmarshalJSON ¶
func (r *DeploymentDeploymentTriggerMetadata) UnmarshalJSON(data []byte) (err error)
type DeploymentDeploymentTriggerType ¶
type DeploymentDeploymentTriggerType string
What caused the deployment.
const ( DeploymentDeploymentTriggerTypeGitHubPush DeploymentDeploymentTriggerType = "github:push" DeploymentDeploymentTriggerTypeADHoc DeploymentDeploymentTriggerType = "ad_hoc" DeploymentDeploymentTriggerTypeDeployHook DeploymentDeploymentTriggerType = "deploy_hook" )
func (DeploymentDeploymentTriggerType) IsKnown ¶
func (r DeploymentDeploymentTriggerType) IsKnown() bool
type DeploymentEnvVar ¶
type DeploymentEnvVar struct {
Type DeploymentEnvVarsType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON deploymentEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (DeploymentEnvVar) AsUnion ¶
func (r DeploymentEnvVar) AsUnion() DeploymentEnvVarsUnion
AsUnion returns a DeploymentEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are DeploymentEnvVarsPagesPlainTextEnvVar, DeploymentEnvVarsPagesSecretTextEnvVar.
func (*DeploymentEnvVar) UnmarshalJSON ¶
func (r *DeploymentEnvVar) UnmarshalJSON(data []byte) (err error)
type DeploymentEnvVarsPagesPlainTextEnvVar ¶
type DeploymentEnvVarsPagesPlainTextEnvVar struct {
Type DeploymentEnvVarsPagesPlainTextEnvVarType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON deploymentEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*DeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶
func (r *DeploymentEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type DeploymentEnvVarsPagesPlainTextEnvVarType ¶
type DeploymentEnvVarsPagesPlainTextEnvVarType string
const (
DeploymentEnvVarsPagesPlainTextEnvVarTypePlainText DeploymentEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (DeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r DeploymentEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type DeploymentEnvVarsPagesSecretTextEnvVar ¶
type DeploymentEnvVarsPagesSecretTextEnvVar struct {
Type DeploymentEnvVarsPagesSecretTextEnvVarType `json:"type" api:"required"`
// Secret value.
Value string `json:"value" api:"required"`
JSON deploymentEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*DeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶
func (r *DeploymentEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type DeploymentEnvVarsPagesSecretTextEnvVarType ¶
type DeploymentEnvVarsPagesSecretTextEnvVarType string
const (
DeploymentEnvVarsPagesSecretTextEnvVarTypeSecretText DeploymentEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (DeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r DeploymentEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type DeploymentEnvVarsType ¶
type DeploymentEnvVarsType string
const ( DeploymentEnvVarsTypePlainText DeploymentEnvVarsType = "plain_text" DeploymentEnvVarsTypeSecretText DeploymentEnvVarsType = "secret_text" )
func (DeploymentEnvVarsType) IsKnown ¶
func (r DeploymentEnvVarsType) IsKnown() bool
type DeploymentEnvVarsUnion ¶
type DeploymentEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by DeploymentEnvVarsPagesPlainTextEnvVar or DeploymentEnvVarsPagesSecretTextEnvVar.
type DeploymentEnvironment ¶
type DeploymentEnvironment string
Type of deploy.
const ( DeploymentEnvironmentPreview DeploymentEnvironment = "preview" DeploymentEnvironmentProduction DeploymentEnvironment = "production" )
func (DeploymentEnvironment) IsKnown ¶
func (r DeploymentEnvironment) IsKnown() bool
type DeploymentSource ¶
type DeploymentSource struct {
Config DeploymentSourceConfig `json:"config" api:"required"`
// The source control management provider.
Type DeploymentSourceType `json:"type" api:"required"`
JSON deploymentSourceJSON `json:"-"`
}
Configs for the project source control.
func (*DeploymentSource) UnmarshalJSON ¶
func (r *DeploymentSource) UnmarshalJSON(data []byte) (err error)
type DeploymentSourceConfig ¶
type DeploymentSourceConfig struct {
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled" api:"required"`
// The owner of the repository.
Owner string `json:"owner" api:"required"`
// The owner ID of the repository.
OwnerID string `json:"owner_id" api:"required"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes" api:"required"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes" api:"required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled" api:"required"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes" api:"required"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes" api:"required"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting DeploymentSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting" api:"required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch" api:"required"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled" api:"required"`
// The ID of the repository.
RepoID string `json:"repo_id" api:"required"`
// The name of the repository.
RepoName string `json:"repo_name" api:"required"`
JSON deploymentSourceConfigJSON `json:"-"`
}
func (*DeploymentSourceConfig) UnmarshalJSON ¶
func (r *DeploymentSourceConfig) UnmarshalJSON(data []byte) (err error)
type DeploymentSourceConfigPreviewDeploymentSetting ¶
type DeploymentSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( DeploymentSourceConfigPreviewDeploymentSettingAll DeploymentSourceConfigPreviewDeploymentSetting = "all" DeploymentSourceConfigPreviewDeploymentSettingNone DeploymentSourceConfigPreviewDeploymentSetting = "none" DeploymentSourceConfigPreviewDeploymentSettingCustom DeploymentSourceConfigPreviewDeploymentSetting = "custom" )
func (DeploymentSourceConfigPreviewDeploymentSetting) IsKnown ¶
func (r DeploymentSourceConfigPreviewDeploymentSetting) IsKnown() bool
type DeploymentSourceType ¶
type DeploymentSourceType string
The source control management provider.
const ( DeploymentSourceTypeGitHub DeploymentSourceType = "github" DeploymentSourceTypeGitlab DeploymentSourceType = "gitlab" )
func (DeploymentSourceType) IsKnown ¶
func (r DeploymentSourceType) IsKnown() bool
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 Project ¶
type Project struct {
// ID of the project.
ID string `json:"id" api:"required"`
// Most recent production deployment of the project.
CanonicalDeployment Deployment `json:"canonical_deployment" api:"required,nullable"`
// When the project was created.
CreatedOn time.Time `json:"created_on" api:"required" format:"date-time"`
// Configs for deployments in a project.
DeploymentConfigs ProjectDeploymentConfigs `json:"deployment_configs" api:"required"`
// Framework the project is using.
Framework string `json:"framework" api:"required"`
// Version of the framework the project is using.
FrameworkVersion string `json:"framework_version" api:"required"`
// Most recent deployment of the project.
LatestDeployment Deployment `json:"latest_deployment" api:"required,nullable"`
// Name of the project.
Name string `json:"name" api:"required"`
// Name of the preview script.
PreviewScriptName string `json:"preview_script_name" api:"required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch string `json:"production_branch" api:"required"`
// Name of the production script.
ProductionScriptName string `json:"production_script_name" api:"required"`
// Whether the project uses functions.
UsesFunctions bool `json:"uses_functions" api:"required,nullable"`
// Configs for the project build process.
BuildConfig ProjectBuildConfig `json:"build_config"`
// A list of associated custom domains for the project.
Domains []string `json:"domains"`
// Configs for the project source control.
Source ProjectSource `json:"source"`
// The Cloudflare subdomain associated with the project.
Subdomain string `json:"subdomain"`
JSON projectJSON `json:"-"`
}
func (*Project) UnmarshalJSON ¶
type ProjectBuildConfig ¶
type ProjectBuildConfig struct {
// The classifying tag for analytics.
WebAnalyticsTag string `json:"web_analytics_tag" api:"required,nullable"`
// The auth token for analytics.
WebAnalyticsToken string `json:"web_analytics_token" api:"required,nullable"`
// Enable build caching for the project.
BuildCaching bool `json:"build_caching" api:"nullable"`
// Command used to build project.
BuildCommand string `json:"build_command" api:"nullable"`
// Assets output directory of the build.
DestinationDir string `json:"destination_dir" api:"nullable"`
// Directory to run the command.
RootDir string `json:"root_dir" api:"nullable"`
JSON projectBuildConfigJSON `json:"-"`
}
Configs for the project build process.
func (*ProjectBuildConfig) UnmarshalJSON ¶
func (r *ProjectBuildConfig) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteParams ¶
type ProjectDeleteResponse ¶
type ProjectDeleteResponse = interface{}
type ProjectDeleteResponseEnvelope ¶
type ProjectDeleteResponseEnvelope struct {
Errors []ProjectDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDeleteResponse `json:"result" api:"required,nullable"`
// Whether the API call was successful.
Success ProjectDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeErrors ¶
type ProjectDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeErrorsSource ¶
type ProjectDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeMessages ¶
type ProjectDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeleteResponseEnvelopeMessagesSource ¶
type ProjectDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectDeploymentConfigs ¶
type ProjectDeploymentConfigs struct {
// Configs for preview deploys.
Preview ProjectDeploymentConfigsPreview `json:"preview" api:"required"`
// Configs for production deploys.
Production ProjectDeploymentConfigsProduction `json:"production" api:"required"`
JSON projectDeploymentConfigsJSON `json:"-"`
}
Configs for deployments in a project.
func (*ProjectDeploymentConfigs) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigs) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreview ¶
type ProjectDeploymentConfigsPreview struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date" api:"required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version" api:"required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date" api:"required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags" api:"required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentConfigsPreviewEnvVar `json:"env_vars" api:"required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open" api:"required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectDeploymentConfigsPreviewUsageModel `json:"usage_model" api:"required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectDeploymentConfigsPreviewAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsPreviewAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectDeploymentConfigsPreviewBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectDeploymentConfigsPreviewD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectDeploymentConfigsPreviewDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectDeploymentConfigsPreviewHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectDeploymentConfigsPreviewKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectDeploymentConfigsPreviewLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectDeploymentConfigsPreviewMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectDeploymentConfigsPreviewPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectDeploymentConfigsPreviewQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectDeploymentConfigsPreviewR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectDeploymentConfigsPreviewService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectDeploymentConfigsPreviewVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectDeploymentConfigsPreviewJSON `json:"-"`
}
Configs for preview deploys.
func (*ProjectDeploymentConfigsPreview) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreview) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewAIBinding ¶
type ProjectDeploymentConfigsPreviewAIBinding struct {
ProjectID string `json:"project_id" api:"required"`
JSON projectDeploymentConfigsPreviewAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectDeploymentConfigsPreviewAIBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset ¶
type ProjectDeploymentConfigsPreviewAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset" api:"required"`
JSON projectDeploymentConfigsPreviewAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewBrowser ¶
type ProjectDeploymentConfigsPreviewBrowser struct {
JSON projectDeploymentConfigsPreviewBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectDeploymentConfigsPreviewBrowser) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewD1Database ¶
type ProjectDeploymentConfigsPreviewD1Database struct {
// UUID of the D1 database.
ID string `json:"id" api:"required"`
JSON projectDeploymentConfigsPreviewD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectDeploymentConfigsPreviewD1Database) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewDurableObjectNamespace ¶
type ProjectDeploymentConfigsPreviewDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id" api:"required"`
JSON projectDeploymentConfigsPreviewDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewEnvVar ¶
type ProjectDeploymentConfigsPreviewEnvVar struct {
Type ProjectDeploymentConfigsPreviewEnvVarsType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsPreviewEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentConfigsPreviewEnvVar) AsUnion ¶
func (r ProjectDeploymentConfigsPreviewEnvVar) AsUnion() ProjectDeploymentConfigsPreviewEnvVarsUnion
AsUnion returns a ProjectDeploymentConfigsPreviewEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentConfigsPreviewEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶
type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶
type ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶
type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType `json:"type" api:"required"`
// Secret value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶
type ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentConfigsPreviewEnvVarsType ¶
type ProjectDeploymentConfigsPreviewEnvVarsType string
const ( ProjectDeploymentConfigsPreviewEnvVarsTypePlainText ProjectDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectDeploymentConfigsPreviewEnvVarsType) IsKnown ¶
func (r ProjectDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectDeploymentConfigsPreviewEnvVarsUnion ¶
type ProjectDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar or ProjectDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentConfigsPreviewHyperdriveBinding ¶
type ProjectDeploymentConfigsPreviewHyperdriveBinding struct {
ID string `json:"id" api:"required"`
JSON projectDeploymentConfigsPreviewHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewKVNamespace ¶
type ProjectDeploymentConfigsPreviewKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id" api:"required"`
JSON projectDeploymentConfigsPreviewKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectDeploymentConfigsPreviewKVNamespace) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewLimits ¶
type ProjectDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms" api:"required"`
JSON projectDeploymentConfigsPreviewLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectDeploymentConfigsPreviewLimits) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewLimits) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewMTLSCertificate ¶
type ProjectDeploymentConfigsPreviewMTLSCertificate struct {
CertificateID string `json:"certificate_id" api:"required"`
JSON projectDeploymentConfigsPreviewMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewPlacement ¶
type ProjectDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode string `json:"mode" api:"required"`
JSON projectDeploymentConfigsPreviewPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectDeploymentConfigsPreviewPlacement) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewQueueProducer ¶
type ProjectDeploymentConfigsPreviewQueueProducer struct {
// Name of the Queue.
Name string `json:"name" api:"required"`
JSON projectDeploymentConfigsPreviewQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectDeploymentConfigsPreviewQueueProducer) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewR2Bucket ¶
type ProjectDeploymentConfigsPreviewR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction" api:"nullable"`
JSON projectDeploymentConfigsPreviewR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectDeploymentConfigsPreviewR2Bucket) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewService ¶
type ProjectDeploymentConfigsPreviewService struct {
// The Service environment.
Environment string `json:"environment" api:"required"`
// The Service name.
Service string `json:"service" api:"required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint" api:"nullable"`
JSON projectDeploymentConfigsPreviewServiceJSON `json:"-"`
}
Service binding.
func (*ProjectDeploymentConfigsPreviewService) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewService) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsPreviewUsageModel ¶
type ProjectDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectDeploymentConfigsPreviewUsageModelStandard ProjectDeploymentConfigsPreviewUsageModel = "standard" ProjectDeploymentConfigsPreviewUsageModelBundled ProjectDeploymentConfigsPreviewUsageModel = "bundled" ProjectDeploymentConfigsPreviewUsageModelUnbound ProjectDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectDeploymentConfigsPreviewUsageModel) IsKnown ¶
func (r ProjectDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectDeploymentConfigsPreviewVectorizeBinding ¶
type ProjectDeploymentConfigsPreviewVectorizeBinding struct {
IndexName string `json:"index_name" api:"required"`
JSON projectDeploymentConfigsPreviewVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsPreviewVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProduction ¶
type ProjectDeploymentConfigsProduction struct {
// Whether to always use the latest compatibility date for Pages Functions.
AlwaysUseLatestCompatibilityDate bool `json:"always_use_latest_compatibility_date" api:"required"`
// The major version of the build image to use for Pages Functions.
BuildImageMajorVersion int64 `json:"build_image_major_version" api:"required"`
// Compatibility date used for Pages Functions.
CompatibilityDate string `json:"compatibility_date" api:"required"`
// Compatibility flags used for Pages Functions.
CompatibilityFlags []string `json:"compatibility_flags" api:"required"`
// Environment variables used for builds and Pages Functions.
EnvVars map[string]ProjectDeploymentConfigsProductionEnvVar `json:"env_vars" api:"required,nullable"`
// Whether to fail open when the deployment config cannot be applied.
FailOpen bool `json:"fail_open" api:"required"`
// The usage model for Pages Functions.
//
// Deprecated: All new projects now use the Standard usage model.
UsageModel ProjectDeploymentConfigsProductionUsageModel `json:"usage_model" api:"required"`
// Constellation bindings used for Pages Functions.
AIBindings map[string]ProjectDeploymentConfigsProductionAIBinding `json:"ai_bindings"`
// Analytics Engine bindings used for Pages Functions.
AnalyticsEngineDatasets map[string]ProjectDeploymentConfigsProductionAnalyticsEngineDataset `json:"analytics_engine_datasets"`
// Browser bindings used for Pages Functions.
Browsers map[string]ProjectDeploymentConfigsProductionBrowser `json:"browsers"`
// D1 databases used for Pages Functions.
D1Databases map[string]ProjectDeploymentConfigsProductionD1Database `json:"d1_databases"`
// Durable Object namespaces used for Pages Functions.
DurableObjectNamespaces map[string]ProjectDeploymentConfigsProductionDurableObjectNamespace `json:"durable_object_namespaces"`
// Hyperdrive bindings used for Pages Functions.
HyperdriveBindings map[string]ProjectDeploymentConfigsProductionHyperdriveBinding `json:"hyperdrive_bindings"`
// KV namespaces used for Pages Functions.
KVNamespaces map[string]ProjectDeploymentConfigsProductionKVNamespace `json:"kv_namespaces"`
// Limits for Pages Functions.
Limits ProjectDeploymentConfigsProductionLimits `json:"limits"`
// mTLS bindings used for Pages Functions.
MTLSCertificates map[string]ProjectDeploymentConfigsProductionMTLSCertificate `json:"mtls_certificates"`
// Placement setting used for Pages Functions.
Placement ProjectDeploymentConfigsProductionPlacement `json:"placement"`
// Queue Producer bindings used for Pages Functions.
QueueProducers map[string]ProjectDeploymentConfigsProductionQueueProducer `json:"queue_producers"`
// R2 buckets used for Pages Functions.
R2Buckets map[string]ProjectDeploymentConfigsProductionR2Bucket `json:"r2_buckets"`
// Services used for Pages Functions.
Services map[string]ProjectDeploymentConfigsProductionService `json:"services"`
// Vectorize bindings used for Pages Functions.
VectorizeBindings map[string]ProjectDeploymentConfigsProductionVectorizeBinding `json:"vectorize_bindings"`
// Hash of the Wrangler configuration used for the deployment.
WranglerConfigHash string `json:"wrangler_config_hash"`
JSON projectDeploymentConfigsProductionJSON `json:"-"`
}
Configs for production deploys.
func (*ProjectDeploymentConfigsProduction) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProduction) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionAIBinding ¶
type ProjectDeploymentConfigsProductionAIBinding struct {
ProjectID string `json:"project_id" api:"required"`
JSON projectDeploymentConfigsProductionAIBindingJSON `json:"-"`
}
AI binding.
func (*ProjectDeploymentConfigsProductionAIBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionAIBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionAnalyticsEngineDataset ¶
type ProjectDeploymentConfigsProductionAnalyticsEngineDataset struct {
// Name of the dataset.
Dataset string `json:"dataset" api:"required"`
JSON projectDeploymentConfigsProductionAnalyticsEngineDatasetJSON `json:"-"`
}
Analytics Engine binding.
func (*ProjectDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionAnalyticsEngineDataset) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionBrowser ¶
type ProjectDeploymentConfigsProductionBrowser struct {
JSON projectDeploymentConfigsProductionBrowserJSON `json:"-"`
}
Browser binding.
func (*ProjectDeploymentConfigsProductionBrowser) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionBrowser) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionD1Database ¶
type ProjectDeploymentConfigsProductionD1Database struct {
// UUID of the D1 database.
ID string `json:"id" api:"required"`
JSON projectDeploymentConfigsProductionD1DatabaseJSON `json:"-"`
}
D1 binding.
func (*ProjectDeploymentConfigsProductionD1Database) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionD1Database) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionDurableObjectNamespace ¶
type ProjectDeploymentConfigsProductionDurableObjectNamespace struct {
// ID of the Durable Object namespace.
NamespaceID string `json:"namespace_id" api:"required"`
JSON projectDeploymentConfigsProductionDurableObjectNamespaceJSON `json:"-"`
}
Durable Object binding.
func (*ProjectDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionDurableObjectNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionEnvVar ¶
type ProjectDeploymentConfigsProductionEnvVar struct {
Type ProjectDeploymentConfigsProductionEnvVarsType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsProductionEnvVarJSON `json:"-"`
// contains filtered or unexported fields
}
A plaintext environment variable.
func (ProjectDeploymentConfigsProductionEnvVar) AsUnion ¶
func (r ProjectDeploymentConfigsProductionEnvVar) AsUnion() ProjectDeploymentConfigsProductionEnvVarsUnion
AsUnion returns a ProjectDeploymentConfigsProductionEnvVarsUnion interface which you can cast to the specific types for more type safety.
Possible runtime types of the union are ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
func (*ProjectDeploymentConfigsProductionEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶
type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType `json:"type" api:"required"`
// Environment variable value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarJSON `json:"-"`
}
A plaintext environment variable.
func (*ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶
type ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶
type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType `json:"type" api:"required"`
// Secret value.
Value string `json:"value" api:"required"`
JSON projectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarJSON `json:"-"`
}
An encrypted environment variable.
func (*ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶
type ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectDeploymentConfigsProductionEnvVarsType ¶
type ProjectDeploymentConfigsProductionEnvVarsType string
const ( ProjectDeploymentConfigsProductionEnvVarsTypePlainText ProjectDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectDeploymentConfigsProductionEnvVarsTypeSecretText ProjectDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectDeploymentConfigsProductionEnvVarsType) IsKnown ¶
func (r ProjectDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectDeploymentConfigsProductionEnvVarsUnion ¶
type ProjectDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Union satisfied by ProjectDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar or ProjectDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar.
type ProjectDeploymentConfigsProductionHyperdriveBinding ¶
type ProjectDeploymentConfigsProductionHyperdriveBinding struct {
ID string `json:"id" api:"required"`
JSON projectDeploymentConfigsProductionHyperdriveBindingJSON `json:"-"`
}
Hyperdrive binding.
func (*ProjectDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionHyperdriveBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionKVNamespace ¶
type ProjectDeploymentConfigsProductionKVNamespace struct {
// ID of the KV namespace.
NamespaceID string `json:"namespace_id" api:"required"`
JSON projectDeploymentConfigsProductionKVNamespaceJSON `json:"-"`
}
KV namespace binding.
func (*ProjectDeploymentConfigsProductionKVNamespace) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionKVNamespace) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionLimits ¶
type ProjectDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs int64 `json:"cpu_ms" api:"required"`
JSON projectDeploymentConfigsProductionLimitsJSON `json:"-"`
}
Limits for Pages Functions.
func (*ProjectDeploymentConfigsProductionLimits) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionLimits) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionMTLSCertificate ¶
type ProjectDeploymentConfigsProductionMTLSCertificate struct {
CertificateID string `json:"certificate_id" api:"required"`
JSON projectDeploymentConfigsProductionMTLSCertificateJSON `json:"-"`
}
mTLS binding.
func (*ProjectDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionMTLSCertificate) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionPlacement ¶
type ProjectDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode string `json:"mode" api:"required"`
JSON projectDeploymentConfigsProductionPlacementJSON `json:"-"`
}
Placement setting used for Pages Functions.
func (*ProjectDeploymentConfigsProductionPlacement) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionPlacement) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionQueueProducer ¶
type ProjectDeploymentConfigsProductionQueueProducer struct {
// Name of the Queue.
Name string `json:"name" api:"required"`
JSON projectDeploymentConfigsProductionQueueProducerJSON `json:"-"`
}
Queue Producer binding.
func (*ProjectDeploymentConfigsProductionQueueProducer) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionQueueProducer) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionR2Bucket ¶
type ProjectDeploymentConfigsProductionR2Bucket struct {
// Name of the R2 bucket.
Name string `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction string `json:"jurisdiction" api:"nullable"`
JSON projectDeploymentConfigsProductionR2BucketJSON `json:"-"`
}
R2 binding.
func (*ProjectDeploymentConfigsProductionR2Bucket) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionR2Bucket) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionService ¶
type ProjectDeploymentConfigsProductionService struct {
// The Service environment.
Environment string `json:"environment" api:"required"`
// The Service name.
Service string `json:"service" api:"required"`
// The entrypoint to bind to.
Entrypoint string `json:"entrypoint" api:"nullable"`
JSON projectDeploymentConfigsProductionServiceJSON `json:"-"`
}
Service binding.
func (*ProjectDeploymentConfigsProductionService) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionService) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentConfigsProductionUsageModel ¶
type ProjectDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectDeploymentConfigsProductionUsageModelStandard ProjectDeploymentConfigsProductionUsageModel = "standard" ProjectDeploymentConfigsProductionUsageModelBundled ProjectDeploymentConfigsProductionUsageModel = "bundled" ProjectDeploymentConfigsProductionUsageModelUnbound ProjectDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectDeploymentConfigsProductionUsageModel) IsKnown ¶
func (r ProjectDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectDeploymentConfigsProductionVectorizeBinding ¶
type ProjectDeploymentConfigsProductionVectorizeBinding struct {
IndexName string `json:"index_name" api:"required"`
JSON projectDeploymentConfigsProductionVectorizeBindingJSON `json:"-"`
}
Vectorize binding.
func (*ProjectDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON ¶
func (r *ProjectDeploymentConfigsProductionVectorizeBinding) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteParams ¶
type ProjectDeploymentDeleteParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Allow deletion of aliased non-production deployments when a normal delete would
// be rejected.
Force param.Field[bool] `query:"force"`
}
func (ProjectDeploymentDeleteParams) URLQuery ¶
func (r ProjectDeploymentDeleteParams) URLQuery() (v url.Values)
URLQuery serializes ProjectDeploymentDeleteParams's query parameters as `url.Values`.
type ProjectDeploymentDeleteResponse ¶
type ProjectDeploymentDeleteResponse = interface{}
type ProjectDeploymentDeleteResponseEnvelope ¶
type ProjectDeploymentDeleteResponseEnvelope struct {
Errors []ProjectDeploymentDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDeploymentDeleteResponse `json:"result" api:"required,nullable"`
// Whether the API call was successful.
Success ProjectDeploymentDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeErrors ¶
type ProjectDeploymentDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeErrorsSource ¶
type ProjectDeploymentDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeMessages ¶
type ProjectDeploymentDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentDeleteResponseEnvelopeMessagesSource ¶
type ProjectDeploymentDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectDeploymentGetResponseEnvelope ¶
type ProjectDeploymentGetResponseEnvelope struct {
Errors []ProjectDeploymentGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentGetResponseEnvelopeMessages `json:"messages" api:"required"`
Result Deployment `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDeploymentGetResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeErrors ¶
type ProjectDeploymentGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeErrorsSource ¶
type ProjectDeploymentGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeMessages ¶
type ProjectDeploymentGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentGetResponseEnvelopeMessagesSource ¶
type ProjectDeploymentGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectDeploymentHistoryLogGetResponse ¶
type ProjectDeploymentHistoryLogGetResponse struct {
Data []ProjectDeploymentHistoryLogGetResponseData `json:"data" api:"required"`
IncludesContainerLogs bool `json:"includes_container_logs" api:"required"`
Total int64 `json:"total" api:"required"`
JSON projectDeploymentHistoryLogGetResponseJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponse) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseData ¶
type ProjectDeploymentHistoryLogGetResponseData struct {
Line string `json:"line" api:"required"`
Ts string `json:"ts" api:"required"`
JSON projectDeploymentHistoryLogGetResponseDataJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseData) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelope ¶
type ProjectDeploymentHistoryLogGetResponseEnvelope struct {
Errors []ProjectDeploymentHistoryLogGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentHistoryLogGetResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDeploymentHistoryLogGetResponse `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDeploymentHistoryLogGetResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors ¶
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource ¶
type ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages ¶
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentHistoryLogGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource ¶
type ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentHistoryLogGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentHistoryLogGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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" api:"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 ProjectDeploymentNewParams ¶
type ProjectDeploymentNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"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 ¶
type ProjectDeploymentNewParamsCommitDirty string
Boolean string indicating if the working directory has uncommitted changes.
const ( ProjectDeploymentNewParamsCommitDirtyTrue ProjectDeploymentNewParamsCommitDirty = "true" ProjectDeploymentNewParamsCommitDirtyFalse ProjectDeploymentNewParamsCommitDirty = "false" )
func (ProjectDeploymentNewParamsCommitDirty) IsKnown ¶
func (r ProjectDeploymentNewParamsCommitDirty) IsKnown() bool
type ProjectDeploymentNewResponseEnvelope ¶
type ProjectDeploymentNewResponseEnvelope struct {
Errors []ProjectDeploymentNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentNewResponseEnvelopeMessages `json:"messages" api:"required"`
Result Deployment `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDeploymentNewResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentNewResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeErrors ¶
type ProjectDeploymentNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeErrorsSource ¶
type ProjectDeploymentNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeMessages ¶
type ProjectDeploymentNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentNewResponseEnvelopeMessagesSource ¶
type ProjectDeploymentNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectDeploymentRetryResponseEnvelope ¶
type ProjectDeploymentRetryResponseEnvelope struct {
Errors []ProjectDeploymentRetryResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentRetryResponseEnvelopeMessages `json:"messages" api:"required"`
Result Deployment `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDeploymentRetryResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentRetryResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentRetryResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeErrors ¶
type ProjectDeploymentRetryResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRetryResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentRetryResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentRetryResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeErrorsSource ¶
type ProjectDeploymentRetryResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRetryResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentRetryResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeMessages ¶
type ProjectDeploymentRetryResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRetryResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentRetryResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentRetryResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRetryResponseEnvelopeMessagesSource ¶
type ProjectDeploymentRetryResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRetryResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentRetryResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectDeploymentRollbackResponseEnvelope ¶
type ProjectDeploymentRollbackResponseEnvelope struct {
Errors []ProjectDeploymentRollbackResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDeploymentRollbackResponseEnvelopeMessages `json:"messages" api:"required"`
Result Deployment `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDeploymentRollbackResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDeploymentRollbackResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDeploymentRollbackResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeErrors ¶
type ProjectDeploymentRollbackResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRollbackResponseEnvelopeErrorsSource `json:"source"`
JSON projectDeploymentRollbackResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDeploymentRollbackResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeErrorsSource ¶
type ProjectDeploymentRollbackResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRollbackResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDeploymentRollbackResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeMessages ¶
type ProjectDeploymentRollbackResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDeploymentRollbackResponseEnvelopeMessagesSource `json:"source"`
JSON projectDeploymentRollbackResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDeploymentRollbackResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDeploymentRollbackResponseEnvelopeMessagesSource ¶
type ProjectDeploymentRollbackResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDeploymentRollbackResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDeploymentRollbackResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 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, params ProjectDeploymentDeleteParams, opts ...option.RequestOption) (res *ProjectDeploymentDeleteResponse, err error)
Delete a deployment.
func (*ProjectDeploymentService) Get ¶
func (r *ProjectDeploymentService) Get(ctx context.Context, projectName string, deploymentID string, query ProjectDeploymentGetParams, opts ...option.RequestOption) (res *Deployment, err error)
Fetch information about a deployment.
func (*ProjectDeploymentService) List ¶
func (r *ProjectDeploymentService) List(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Deployment], err error)
Fetch a list of project deployments.
func (*ProjectDeploymentService) ListAutoPaging ¶
func (r *ProjectDeploymentService) ListAutoPaging(ctx context.Context, projectName string, params ProjectDeploymentListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Deployment]
Fetch a list of project deployments.
func (*ProjectDeploymentService) New ¶
func (r *ProjectDeploymentService) New(ctx context.Context, projectName string, params ProjectDeploymentNewParams, opts ...option.RequestOption) (res *Deployment, err error)
Start a new deployment from production. The repository and account must have already been authorized on the Cloudflare Pages dashboard.
func (*ProjectDeploymentService) Retry ¶
func (r *ProjectDeploymentService) Retry(ctx context.Context, projectName string, deploymentID string, body ProjectDeploymentRetryParams, opts ...option.RequestOption) (res *Deployment, err error)
Retry a previous deployment.
func (*ProjectDeploymentService) Rollback ¶
func (r *ProjectDeploymentService) Rollback(ctx context.Context, projectName string, deploymentID string, body ProjectDeploymentRollbackParams, opts ...option.RequestOption) (res *Deployment, err error)
Rollback the production deployment to a previous deployment. You can only rollback to succesful builds on production.
type ProjectDomainDeleteResponse ¶
type ProjectDomainDeleteResponse = interface{}
type ProjectDomainDeleteResponseEnvelope ¶
type ProjectDomainDeleteResponseEnvelope struct {
Errors []ProjectDomainDeleteResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectDomainDeleteResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDomainDeleteResponse `json:"result" api:"required,nullable"`
// Whether the API call was successful.
Success ProjectDomainDeleteResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDomainDeleteResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeErrors ¶
type ProjectDomainDeleteResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainDeleteResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainDeleteResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDomainDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeErrorsSource ¶
type ProjectDomainDeleteResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDomainDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeMessages ¶
type ProjectDomainDeleteResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainDeleteResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainDeleteResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDomainDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainDeleteResponseEnvelopeMessagesSource ¶
type ProjectDomainDeleteResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainDeleteResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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" api:"required"`
CertificateAuthority ProjectDomainEditResponseCertificateAuthority `json:"certificate_authority" api:"required"`
CreatedOn string `json:"created_on" api:"required"`
DomainID string `json:"domain_id" api:"required"`
// The domain name.
Name string `json:"name" api:"required"`
Status ProjectDomainEditResponseStatus `json:"status" api:"required"`
ValidationData ProjectDomainEditResponseValidationData `json:"validation_data" api:"required"`
VerificationData ProjectDomainEditResponseVerificationData `json:"verification_data" api:"required"`
ZoneTag string `json:"zone_tag" api:"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" api:"required"`
Messages []ProjectDomainEditResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDomainEditResponse `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDomainEditResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDomainEditResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeErrors ¶
type ProjectDomainEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainEditResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeErrorsSource ¶
type ProjectDomainEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeMessages ¶
type ProjectDomainEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainEditResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDomainEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainEditResponseEnvelopeMessagesSource ¶
type ProjectDomainEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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" api:"required"`
Status ProjectDomainEditResponseValidationDataStatus `json:"status" api:"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" api:"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" api:"required"`
CertificateAuthority ProjectDomainGetResponseCertificateAuthority `json:"certificate_authority" api:"required"`
CreatedOn string `json:"created_on" api:"required"`
DomainID string `json:"domain_id" api:"required"`
// The domain name.
Name string `json:"name" api:"required"`
Status ProjectDomainGetResponseStatus `json:"status" api:"required"`
ValidationData ProjectDomainGetResponseValidationData `json:"validation_data" api:"required"`
VerificationData ProjectDomainGetResponseVerificationData `json:"verification_data" api:"required"`
ZoneTag string `json:"zone_tag" api:"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" api:"required"`
Messages []ProjectDomainGetResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDomainGetResponse `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDomainGetResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDomainGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeErrors ¶
type ProjectDomainGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeErrorsSource ¶
type ProjectDomainGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeMessages ¶
type ProjectDomainGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDomainGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainGetResponseEnvelopeMessagesSource ¶
type ProjectDomainGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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" api:"required"`
Status ProjectDomainGetResponseValidationDataStatus `json:"status" api:"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" api:"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" api:"required"`
CertificateAuthority ProjectDomainListResponseCertificateAuthority `json:"certificate_authority" api:"required"`
CreatedOn string `json:"created_on" api:"required"`
DomainID string `json:"domain_id" api:"required"`
// The domain name.
Name string `json:"name" api:"required"`
Status ProjectDomainListResponseStatus `json:"status" api:"required"`
ValidationData ProjectDomainListResponseValidationData `json:"validation_data" api:"required"`
VerificationData ProjectDomainListResponseVerificationData `json:"verification_data" api:"required"`
ZoneTag string `json:"zone_tag" api:"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" api:"required"`
Status ProjectDomainListResponseValidationDataStatus `json:"status" api:"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" api:"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" api:"required"`
// The domain name.
Name param.Field[string] `json:"name" api:"required"`
}
func (ProjectDomainNewParams) MarshalJSON ¶
func (r ProjectDomainNewParams) MarshalJSON() (data []byte, err error)
type ProjectDomainNewResponse ¶
type ProjectDomainNewResponse struct {
ID string `json:"id" api:"required"`
CertificateAuthority ProjectDomainNewResponseCertificateAuthority `json:"certificate_authority" api:"required"`
CreatedOn string `json:"created_on" api:"required"`
DomainID string `json:"domain_id" api:"required"`
// The domain name.
Name string `json:"name" api:"required"`
Status ProjectDomainNewResponseStatus `json:"status" api:"required"`
ValidationData ProjectDomainNewResponseValidationData `json:"validation_data" api:"required"`
VerificationData ProjectDomainNewResponseVerificationData `json:"verification_data" api:"required"`
ZoneTag string `json:"zone_tag" api:"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" api:"required"`
Messages []ProjectDomainNewResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectDomainNewResponse `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectDomainNewResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectDomainNewResponseEnvelopeJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeErrors ¶
type ProjectDomainNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectDomainNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeErrorsSource ¶
type ProjectDomainNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectDomainNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeMessages ¶
type ProjectDomainNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectDomainNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectDomainNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectDomainNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectDomainNewResponseEnvelopeMessagesSource ¶
type ProjectDomainNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectDomainNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectDomainNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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" api:"required"`
Status ProjectDomainNewResponseValidationDataStatus `json:"status" api:"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" api:"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" api:"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 ¶
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 ¶
func (r ProjectEditParamsBuildConfig) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigs ¶
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 ¶
func (r ProjectEditParamsDeploymentConfigs) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreview ¶
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 ¶
func (r ProjectEditParamsDeploymentConfigsPreview) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewAIBindings ¶
type ProjectEditParamsDeploymentConfigsPreviewAIBindings struct {
ProjectID param.Field[string] `json:"project_id" api:"required"`
}
AI binding.
func (ProjectEditParamsDeploymentConfigsPreviewAIBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewAIBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets ¶
type ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset" api:"required"`
}
Analytics Engine binding.
func (ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewBrowsers ¶
type ProjectEditParamsDeploymentConfigsPreviewBrowsers struct {
}
Browser binding.
func (ProjectEditParamsDeploymentConfigsPreviewBrowsers) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewBrowsers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewD1Databases ¶
type ProjectEditParamsDeploymentConfigsPreviewD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id" api:"required"`
}
D1 binding.
func (ProjectEditParamsDeploymentConfigsPreviewD1Databases) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewD1Databases) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces ¶
type ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
Durable Object binding.
func (ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVars ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVars struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVars) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVars) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type" api:"required"`
// Secret value.
Value param.Field[string] `json:"value" api:"required"`
}
An encrypted environment variable.
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsType string
const ( ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypePlainText ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectEditParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectEditParamsDeploymentConfigsPreviewEnvVarsType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion ¶
type ProjectEditParamsDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsPreviewEnvVars.
type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings ¶
type ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings struct {
ID param.Field[string] `json:"id" api:"required"`
}
Hyperdrive binding.
func (ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces ¶
type ProjectEditParamsDeploymentConfigsPreviewKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
KV namespace binding.
func (ProjectEditParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewLimits ¶
type ProjectEditParamsDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms" api:"required"`
}
Limits for Pages Functions.
func (ProjectEditParamsDeploymentConfigsPreviewLimits) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewLimits) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates ¶
type ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id" api:"required"`
}
mTLS binding.
func (ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewPlacement ¶
type ProjectEditParamsDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode" api:"required"`
}
Placement setting used for Pages Functions.
func (ProjectEditParamsDeploymentConfigsPreviewPlacement) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewPlacement) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewQueueProducers ¶
type ProjectEditParamsDeploymentConfigsPreviewQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name" api:"required"`
}
Queue Producer binding.
func (ProjectEditParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewR2Buckets ¶
type ProjectEditParamsDeploymentConfigsPreviewR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectEditParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewServices ¶
type ProjectEditParamsDeploymentConfigsPreviewServices struct {
// The Service name.
Service param.Field[string] `json:"service" api:"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 ¶
func (r ProjectEditParamsDeploymentConfigsPreviewServices) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsPreviewUsageModel ¶
type ProjectEditParamsDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectEditParamsDeploymentConfigsPreviewUsageModelStandard ProjectEditParamsDeploymentConfigsPreviewUsageModel = "standard" ProjectEditParamsDeploymentConfigsPreviewUsageModelBundled ProjectEditParamsDeploymentConfigsPreviewUsageModel = "bundled" ProjectEditParamsDeploymentConfigsPreviewUsageModelUnbound ProjectEditParamsDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectEditParamsDeploymentConfigsPreviewUsageModel) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings ¶
type ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name" api:"required"`
}
Vectorize binding.
func (ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProduction ¶
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 ¶
func (r ProjectEditParamsDeploymentConfigsProduction) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionAIBindings ¶
type ProjectEditParamsDeploymentConfigsProductionAIBindings struct {
ProjectID param.Field[string] `json:"project_id" api:"required"`
}
AI binding.
func (ProjectEditParamsDeploymentConfigsProductionAIBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionAIBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets ¶
type ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset" api:"required"`
}
Analytics Engine binding.
func (ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionBrowsers ¶
type ProjectEditParamsDeploymentConfigsProductionBrowsers struct {
}
Browser binding.
func (ProjectEditParamsDeploymentConfigsProductionBrowsers) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionBrowsers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionD1Databases ¶
type ProjectEditParamsDeploymentConfigsProductionD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id" api:"required"`
}
D1 binding.
func (ProjectEditParamsDeploymentConfigsProductionD1Databases) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionD1Databases) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces ¶
type ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
Durable Object binding.
func (ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVars ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVars struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVars) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVars) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type" api:"required"`
// Secret value.
Value param.Field[string] `json:"value" api:"required"`
}
An encrypted environment variable.
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsType ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsType string
const ( ProjectEditParamsDeploymentConfigsProductionEnvVarsTypePlainText ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectEditParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectEditParamsDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectEditParamsDeploymentConfigsProductionEnvVarsType) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion ¶
type ProjectEditParamsDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectEditParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectEditParamsDeploymentConfigsProductionEnvVars.
type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings ¶
type ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings struct {
ID param.Field[string] `json:"id" api:"required"`
}
Hyperdrive binding.
func (ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionKVNamespaces ¶
type ProjectEditParamsDeploymentConfigsProductionKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
KV namespace binding.
func (ProjectEditParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionLimits ¶
type ProjectEditParamsDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms" api:"required"`
}
Limits for Pages Functions.
func (ProjectEditParamsDeploymentConfigsProductionLimits) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionLimits) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates ¶
type ProjectEditParamsDeploymentConfigsProductionMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id" api:"required"`
}
mTLS binding.
func (ProjectEditParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionPlacement ¶
type ProjectEditParamsDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode" api:"required"`
}
Placement setting used for Pages Functions.
func (ProjectEditParamsDeploymentConfigsProductionPlacement) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionPlacement) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionQueueProducers ¶
type ProjectEditParamsDeploymentConfigsProductionQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name" api:"required"`
}
Queue Producer binding.
func (ProjectEditParamsDeploymentConfigsProductionQueueProducers) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionR2Buckets ¶
type ProjectEditParamsDeploymentConfigsProductionR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectEditParamsDeploymentConfigsProductionR2Buckets) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionServices ¶
type ProjectEditParamsDeploymentConfigsProductionServices struct {
// The Service name.
Service param.Field[string] `json:"service" api:"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 ¶
func (r ProjectEditParamsDeploymentConfigsProductionServices) MarshalJSON() (data []byte, err error)
type ProjectEditParamsDeploymentConfigsProductionUsageModel ¶
type ProjectEditParamsDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectEditParamsDeploymentConfigsProductionUsageModelStandard ProjectEditParamsDeploymentConfigsProductionUsageModel = "standard" ProjectEditParamsDeploymentConfigsProductionUsageModelBundled ProjectEditParamsDeploymentConfigsProductionUsageModel = "bundled" ProjectEditParamsDeploymentConfigsProductionUsageModelUnbound ProjectEditParamsDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectEditParamsDeploymentConfigsProductionUsageModel) IsKnown ¶
func (r ProjectEditParamsDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings ¶
type ProjectEditParamsDeploymentConfigsProductionVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name" api:"required"`
}
Vectorize binding.
func (ProjectEditParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON ¶
func (r ProjectEditParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSource ¶
type ProjectEditParamsSource struct {
Config param.Field[ProjectEditParamsSourceConfig] `json:"config" api:"required"`
// The source control management provider.
Type param.Field[ProjectEditParamsSourceType] `json:"type" api:"required"`
}
Configs for the project source control.
func (ProjectEditParamsSource) MarshalJSON ¶
func (r ProjectEditParamsSource) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSourceConfig ¶
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 ¶
func (r ProjectEditParamsSourceConfig) MarshalJSON() (data []byte, err error)
type ProjectEditParamsSourceConfigPreviewDeploymentSetting ¶
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 ¶
func (r ProjectEditParamsSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectEditParamsSourceType ¶
type ProjectEditParamsSourceType string
The source control management provider.
const ( ProjectEditParamsSourceTypeGitHub ProjectEditParamsSourceType = "github" ProjectEditParamsSourceTypeGitlab ProjectEditParamsSourceType = "gitlab" )
func (ProjectEditParamsSourceType) IsKnown ¶
func (r ProjectEditParamsSourceType) IsKnown() bool
type ProjectEditResponseEnvelope ¶
type ProjectEditResponseEnvelope struct {
Errors []ProjectEditResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectEditResponseEnvelopeMessages `json:"messages" api:"required"`
Result Project `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectEditResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectEditResponseEnvelopeJSON `json:"-"`
}
func (*ProjectEditResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectEditResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeErrors ¶
type ProjectEditResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectEditResponseEnvelopeErrorsSource `json:"source"`
JSON projectEditResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeErrorsSource ¶
type ProjectEditResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectEditResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeMessages ¶
type ProjectEditResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectEditResponseEnvelopeMessagesSource `json:"source"`
JSON projectEditResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectEditResponseEnvelopeMessagesSource ¶
type ProjectEditResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectEditResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectEditResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectGetParams ¶
type ProjectGetResponseEnvelope ¶
type ProjectGetResponseEnvelope struct {
Errors []ProjectGetResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectGetResponseEnvelopeMessages `json:"messages" api:"required"`
Result Project `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectGetResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectGetResponseEnvelopeJSON `json:"-"`
}
func (*ProjectGetResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeErrors ¶
type ProjectGetResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectGetResponseEnvelopeErrorsSource `json:"source"`
JSON projectGetResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeErrorsSource ¶
type ProjectGetResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeMessages ¶
type ProjectGetResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectGetResponseEnvelopeMessagesSource `json:"source"`
JSON projectGetResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectGetResponseEnvelopeMessagesSource ¶
type ProjectGetResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectGetResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectListParams ¶
type ProjectListParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"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 ¶
func (r ProjectListParams) URLQuery() (v url.Values)
URLQuery serializes ProjectListParams's query parameters as `url.Values`.
type ProjectNewParams ¶
type ProjectNewParams struct {
// Identifier.
AccountID param.Field[string] `path:"account_id" api:"required"`
// Name of the project.
Name param.Field[string] `json:"name" api:"required"`
// Production branch of the project. Used to identify production deployments.
ProductionBranch param.Field[string] `json:"production_branch" api:"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 ¶
type ProjectNewParamsBuildConfig struct {
// Enable build caching for the project.
BuildCaching param.Field[bool] `json:"build_caching"`
// Command used to build project.
BuildCommand param.Field[string] `json:"build_command"`
// Output directory of the build.
DestinationDir param.Field[string] `json:"destination_dir"`
// Directory to run the command.
RootDir param.Field[string] `json:"root_dir"`
// The classifying tag for analytics.
WebAnalyticsTag param.Field[string] `json:"web_analytics_tag"`
// The auth token for analytics.
WebAnalyticsToken param.Field[string] `json:"web_analytics_token"`
}
Configs for the project build process.
func (ProjectNewParamsBuildConfig) MarshalJSON ¶
func (r ProjectNewParamsBuildConfig) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigs ¶
type ProjectNewParamsDeploymentConfigs struct {
// Configs for preview deploys.
Preview param.Field[ProjectNewParamsDeploymentConfigsPreview] `json:"preview"`
// Configs for production deploys.
Production param.Field[ProjectNewParamsDeploymentConfigsProduction] `json:"production"`
}
Configs for deployments in a project.
func (ProjectNewParamsDeploymentConfigs) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigs) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreview ¶
type ProjectNewParamsDeploymentConfigsPreview struct {
// Constellation bindings used for Pages Functions.
AIBindings param.Field[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 ¶
func (r ProjectNewParamsDeploymentConfigsPreview) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewAIBindings ¶
type ProjectNewParamsDeploymentConfigsPreviewAIBindings struct {
ProjectID param.Field[string] `json:"project_id" api:"required"`
}
AI binding.
func (ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewAIBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets ¶
type ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset" api:"required"`
}
Analytics Engine binding.
func (ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewBrowsers ¶
type ProjectNewParamsDeploymentConfigsPreviewBrowsers struct {
}
Browser binding.
func (ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewBrowsers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewD1Databases ¶
type ProjectNewParamsDeploymentConfigsPreviewD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id" api:"required"`
}
D1 binding.
func (ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewD1Databases) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces ¶
type ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
Durable Object binding.
func (ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVars ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVars struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVars) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType] `json:"type" api:"required"`
// Secret value.
Value param.Field[string] `json:"value" api:"required"`
}
An encrypted environment variable.
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsType string
const ( ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypePlainText ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "plain_text" ProjectNewParamsDeploymentConfigsPreviewEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsPreviewEnvVarsType = "secret_text" )
func (ProjectNewParamsDeploymentConfigsPreviewEnvVarsType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsPreviewEnvVarsType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion ¶
type ProjectNewParamsDeploymentConfigsPreviewEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsPreviewEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsPreviewEnvVars.
type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings ¶
type ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings struct {
ID param.Field[string] `json:"id" api:"required"`
}
Hyperdrive binding.
func (ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces ¶
type ProjectNewParamsDeploymentConfigsPreviewKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
KV namespace binding.
func (ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewLimits ¶
type ProjectNewParamsDeploymentConfigsPreviewLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms" api:"required"`
}
Limits for Pages Functions.
func (ProjectNewParamsDeploymentConfigsPreviewLimits) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewLimits) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates ¶
type ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id" api:"required"`
}
mTLS binding.
func (ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewPlacement ¶
type ProjectNewParamsDeploymentConfigsPreviewPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode" api:"required"`
}
Placement setting used for Pages Functions.
func (ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewPlacement) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewQueueProducers ¶
type ProjectNewParamsDeploymentConfigsPreviewQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name" api:"required"`
}
Queue Producer binding.
func (ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewR2Buckets ¶
type ProjectNewParamsDeploymentConfigsPreviewR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewServices ¶
type ProjectNewParamsDeploymentConfigsPreviewServices struct {
// The Service name.
Service param.Field[string] `json:"service" api:"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 ¶
func (r ProjectNewParamsDeploymentConfigsPreviewServices) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsPreviewUsageModel ¶
type ProjectNewParamsDeploymentConfigsPreviewUsageModel string
The usage model for Pages Functions.
const ( ProjectNewParamsDeploymentConfigsPreviewUsageModelStandard ProjectNewParamsDeploymentConfigsPreviewUsageModel = "standard" ProjectNewParamsDeploymentConfigsPreviewUsageModelBundled ProjectNewParamsDeploymentConfigsPreviewUsageModel = "bundled" ProjectNewParamsDeploymentConfigsPreviewUsageModelUnbound ProjectNewParamsDeploymentConfigsPreviewUsageModel = "unbound" )
func (ProjectNewParamsDeploymentConfigsPreviewUsageModel) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsPreviewUsageModel) IsKnown() bool
type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings ¶
type ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name" api:"required"`
}
Vectorize binding.
func (ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsPreviewVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProduction ¶
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 ¶
func (r ProjectNewParamsDeploymentConfigsProduction) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionAIBindings ¶
type ProjectNewParamsDeploymentConfigsProductionAIBindings struct {
ProjectID param.Field[string] `json:"project_id" api:"required"`
}
AI binding.
func (ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionAIBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets ¶
type ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets struct {
// Name of the dataset.
Dataset param.Field[string] `json:"dataset" api:"required"`
}
Analytics Engine binding.
func (ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionAnalyticsEngineDatasets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionBrowsers ¶
type ProjectNewParamsDeploymentConfigsProductionBrowsers struct {
}
Browser binding.
func (ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionBrowsers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionD1Databases ¶
type ProjectNewParamsDeploymentConfigsProductionD1Databases struct {
// UUID of the D1 database.
ID param.Field[string] `json:"id" api:"required"`
}
D1 binding.
func (ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionD1Databases) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces ¶
type ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces struct {
// ID of the Durable Object namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
Durable Object binding.
func (ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionDurableObjectNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVars ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVars struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVars) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType] `json:"type" api:"required"`
// Environment variable value.
Value param.Field[string] `json:"value" api:"required"`
}
A plaintext environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarTypePlainText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType = "plain_text"
)
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar struct {
Type param.Field[ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType] `json:"type" api:"required"`
// Secret value.
Value param.Field[string] `json:"value" api:"required"`
}
An encrypted environment variable.
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType string
const (
ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType = "secret_text"
)
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVarType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsType ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsType string
const ( ProjectNewParamsDeploymentConfigsProductionEnvVarsTypePlainText ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "plain_text" ProjectNewParamsDeploymentConfigsProductionEnvVarsTypeSecretText ProjectNewParamsDeploymentConfigsProductionEnvVarsType = "secret_text" )
func (ProjectNewParamsDeploymentConfigsProductionEnvVarsType) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsProductionEnvVarsType) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion ¶
type ProjectNewParamsDeploymentConfigsProductionEnvVarsUnion interface {
// contains filtered or unexported methods
}
A plaintext environment variable.
Satisfied by pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesPlainTextEnvVar, pages.ProjectNewParamsDeploymentConfigsProductionEnvVarsPagesSecretTextEnvVar, ProjectNewParamsDeploymentConfigsProductionEnvVars.
type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings ¶
type ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings struct {
ID param.Field[string] `json:"id" api:"required"`
}
Hyperdrive binding.
func (ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionHyperdriveBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionKVNamespaces ¶
type ProjectNewParamsDeploymentConfigsProductionKVNamespaces struct {
// ID of the KV namespace.
NamespaceID param.Field[string] `json:"namespace_id" api:"required"`
}
KV namespace binding.
func (ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionKVNamespaces) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionLimits ¶
type ProjectNewParamsDeploymentConfigsProductionLimits struct {
// CPU time limit in milliseconds.
CPUMs param.Field[int64] `json:"cpu_ms" api:"required"`
}
Limits for Pages Functions.
func (ProjectNewParamsDeploymentConfigsProductionLimits) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionLimits) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates ¶
type ProjectNewParamsDeploymentConfigsProductionMTLSCertificates struct {
CertificateID param.Field[string] `json:"certificate_id" api:"required"`
}
mTLS binding.
func (ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionMTLSCertificates) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionPlacement ¶
type ProjectNewParamsDeploymentConfigsProductionPlacement struct {
// Placement mode.
Mode param.Field[string] `json:"mode" api:"required"`
}
Placement setting used for Pages Functions.
func (ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionPlacement) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionQueueProducers ¶
type ProjectNewParamsDeploymentConfigsProductionQueueProducers struct {
// Name of the Queue.
Name param.Field[string] `json:"name" api:"required"`
}
Queue Producer binding.
func (ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionQueueProducers) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionR2Buckets ¶
type ProjectNewParamsDeploymentConfigsProductionR2Buckets struct {
// Name of the R2 bucket.
Name param.Field[string] `json:"name" api:"required"`
// Jurisdiction of the R2 bucket.
Jurisdiction param.Field[string] `json:"jurisdiction"`
}
R2 binding.
func (ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionR2Buckets) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionServices ¶
type ProjectNewParamsDeploymentConfigsProductionServices struct {
// The Service name.
Service param.Field[string] `json:"service" api:"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 ¶
func (r ProjectNewParamsDeploymentConfigsProductionServices) MarshalJSON() (data []byte, err error)
type ProjectNewParamsDeploymentConfigsProductionUsageModel ¶
type ProjectNewParamsDeploymentConfigsProductionUsageModel string
The usage model for Pages Functions.
const ( ProjectNewParamsDeploymentConfigsProductionUsageModelStandard ProjectNewParamsDeploymentConfigsProductionUsageModel = "standard" ProjectNewParamsDeploymentConfigsProductionUsageModelBundled ProjectNewParamsDeploymentConfigsProductionUsageModel = "bundled" ProjectNewParamsDeploymentConfigsProductionUsageModelUnbound ProjectNewParamsDeploymentConfigsProductionUsageModel = "unbound" )
func (ProjectNewParamsDeploymentConfigsProductionUsageModel) IsKnown ¶
func (r ProjectNewParamsDeploymentConfigsProductionUsageModel) IsKnown() bool
type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings ¶
type ProjectNewParamsDeploymentConfigsProductionVectorizeBindings struct {
IndexName param.Field[string] `json:"index_name" api:"required"`
}
Vectorize binding.
func (ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON ¶
func (r ProjectNewParamsDeploymentConfigsProductionVectorizeBindings) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSource ¶
type ProjectNewParamsSource struct {
Config param.Field[ProjectNewParamsSourceConfig] `json:"config" api:"required"`
// The source control management provider.
Type param.Field[ProjectNewParamsSourceType] `json:"type" api:"required"`
}
Configs for the project source control.
func (ProjectNewParamsSource) MarshalJSON ¶
func (r ProjectNewParamsSource) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSourceConfig ¶
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 ¶
func (r ProjectNewParamsSourceConfig) MarshalJSON() (data []byte, err error)
type ProjectNewParamsSourceConfigPreviewDeploymentSetting ¶
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 ¶
func (r ProjectNewParamsSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectNewParamsSourceType ¶
type ProjectNewParamsSourceType string
The source control management provider.
const ( ProjectNewParamsSourceTypeGitHub ProjectNewParamsSourceType = "github" ProjectNewParamsSourceTypeGitlab ProjectNewParamsSourceType = "gitlab" )
func (ProjectNewParamsSourceType) IsKnown ¶
func (r ProjectNewParamsSourceType) IsKnown() bool
type ProjectNewResponseEnvelope ¶
type ProjectNewResponseEnvelope struct {
Errors []ProjectNewResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectNewResponseEnvelopeMessages `json:"messages" api:"required"`
Result Project `json:"result" api:"required"`
// Whether the API call was successful.
Success ProjectNewResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectNewResponseEnvelopeJSON `json:"-"`
}
func (*ProjectNewResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectNewResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeErrors ¶
type ProjectNewResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectNewResponseEnvelopeErrorsSource `json:"source"`
JSON projectNewResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeErrorsSource ¶
type ProjectNewResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeMessages ¶
type ProjectNewResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectNewResponseEnvelopeMessagesSource `json:"source"`
JSON projectNewResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectNewResponseEnvelopeMessagesSource ¶
type ProjectNewResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectNewResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 ProjectPurgeBuildCacheResponse ¶
type ProjectPurgeBuildCacheResponse = interface{}
type ProjectPurgeBuildCacheResponseEnvelope ¶
type ProjectPurgeBuildCacheResponseEnvelope struct {
Errors []ProjectPurgeBuildCacheResponseEnvelopeErrors `json:"errors" api:"required"`
Messages []ProjectPurgeBuildCacheResponseEnvelopeMessages `json:"messages" api:"required"`
Result ProjectPurgeBuildCacheResponse `json:"result" api:"required,nullable"`
// Whether the API call was successful.
Success ProjectPurgeBuildCacheResponseEnvelopeSuccess `json:"success" api:"required"`
JSON projectPurgeBuildCacheResponseEnvelopeJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelope) UnmarshalJSON ¶
func (r *ProjectPurgeBuildCacheResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeErrors ¶
type ProjectPurgeBuildCacheResponseEnvelopeErrors struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectPurgeBuildCacheResponseEnvelopeErrorsSource `json:"source"`
JSON projectPurgeBuildCacheResponseEnvelopeErrorsJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeErrors) UnmarshalJSON ¶
func (r *ProjectPurgeBuildCacheResponseEnvelopeErrors) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource ¶
type ProjectPurgeBuildCacheResponseEnvelopeErrorsSource struct {
Pointer string `json:"pointer"`
JSON projectPurgeBuildCacheResponseEnvelopeErrorsSourceJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeErrorsSource) UnmarshalJSON ¶
func (r *ProjectPurgeBuildCacheResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeMessages ¶
type ProjectPurgeBuildCacheResponseEnvelopeMessages struct {
Code int64 `json:"code" api:"required"`
Message string `json:"message" api:"required"`
DocumentationURL string `json:"documentation_url"`
Source ProjectPurgeBuildCacheResponseEnvelopeMessagesSource `json:"source"`
JSON projectPurgeBuildCacheResponseEnvelopeMessagesJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeMessages) UnmarshalJSON ¶
func (r *ProjectPurgeBuildCacheResponseEnvelopeMessages) UnmarshalJSON(data []byte) (err error)
type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource ¶
type ProjectPurgeBuildCacheResponseEnvelopeMessagesSource struct {
Pointer string `json:"pointer"`
JSON projectPurgeBuildCacheResponseEnvelopeMessagesSourceJSON `json:"-"`
}
func (*ProjectPurgeBuildCacheResponseEnvelopeMessagesSource) UnmarshalJSON ¶
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 *Project, err error)
Set new attributes for an existing project. Modify environment variables. To delete an environment variable, set the key to null.
func (*ProjectService) Get ¶
func (r *ProjectService) Get(ctx context.Context, projectName string, query ProjectGetParams, opts ...option.RequestOption) (res *Project, err error)
Fetch a project by name.
func (*ProjectService) List ¶
func (r *ProjectService) List(ctx context.Context, params ProjectListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Project], 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[Project]
Fetch a list of all user projects.
func (*ProjectService) New ¶
func (r *ProjectService) New(ctx context.Context, params ProjectNewParams, opts ...option.RequestOption) (res *Project, err error)
Create a new project.
func (*ProjectService) PurgeBuildCache ¶
func (r *ProjectService) PurgeBuildCache(ctx context.Context, projectName string, body ProjectPurgeBuildCacheParams, opts ...option.RequestOption) (res *ProjectPurgeBuildCacheResponse, err error)
Purge all cached build artifacts for a Pages project
type ProjectSource ¶
type ProjectSource struct {
Config ProjectSourceConfig `json:"config" api:"required"`
// The source control management provider.
Type ProjectSourceType `json:"type" api:"required"`
JSON projectSourceJSON `json:"-"`
}
Configs for the project source control.
func (*ProjectSource) UnmarshalJSON ¶
func (r *ProjectSource) UnmarshalJSON(data []byte) (err error)
type ProjectSourceConfig ¶
type ProjectSourceConfig struct {
// Whether to enable automatic deployments when pushing to the source repository.
// When disabled, no deployments (production or preview) will be triggered
// automatically.
//
// Deprecated: Use `production_deployments_enabled` and
// `preview_deployment_setting` for more granular control.
DeploymentsEnabled bool `json:"deployments_enabled" api:"required"`
// The owner of the repository.
Owner string `json:"owner" api:"required"`
// The owner ID of the repository.
OwnerID string `json:"owner_id" api:"required"`
// A list of paths that should be excluded from triggering a preview deployment.
// Wildcard syntax (`*`) is supported.
PathExcludes []string `json:"path_excludes" api:"required"`
// A list of paths that should be watched to trigger a preview deployment. Wildcard
// syntax (`*`) is supported.
PathIncludes []string `json:"path_includes" api:"required"`
// Whether to enable PR comments.
PrCommentsEnabled bool `json:"pr_comments_enabled" api:"required"`
// A list of branches that should not trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchExcludes []string `json:"preview_branch_excludes" api:"required"`
// A list of branches that should trigger a preview deployment. Wildcard syntax
// (`*`) is supported. Must be used with `preview_deployment_setting` set to
// `custom`.
PreviewBranchIncludes []string `json:"preview_branch_includes" api:"required"`
// Controls whether commits to preview branches trigger a preview deployment.
PreviewDeploymentSetting ProjectSourceConfigPreviewDeploymentSetting `json:"preview_deployment_setting" api:"required"`
// The production branch of the repository.
ProductionBranch string `json:"production_branch" api:"required"`
// Whether to trigger a production deployment on commits to the production branch.
ProductionDeploymentsEnabled bool `json:"production_deployments_enabled" api:"required"`
// The ID of the repository.
RepoID string `json:"repo_id" api:"required"`
// The name of the repository.
RepoName string `json:"repo_name" api:"required"`
JSON projectSourceConfigJSON `json:"-"`
}
func (*ProjectSourceConfig) UnmarshalJSON ¶
func (r *ProjectSourceConfig) UnmarshalJSON(data []byte) (err error)
type ProjectSourceConfigPreviewDeploymentSetting ¶
type ProjectSourceConfigPreviewDeploymentSetting string
Controls whether commits to preview branches trigger a preview deployment.
const ( ProjectSourceConfigPreviewDeploymentSettingAll ProjectSourceConfigPreviewDeploymentSetting = "all" ProjectSourceConfigPreviewDeploymentSettingNone ProjectSourceConfigPreviewDeploymentSetting = "none" ProjectSourceConfigPreviewDeploymentSettingCustom ProjectSourceConfigPreviewDeploymentSetting = "custom" )
func (ProjectSourceConfigPreviewDeploymentSetting) IsKnown ¶
func (r ProjectSourceConfigPreviewDeploymentSetting) IsKnown() bool
type ProjectSourceType ¶
type ProjectSourceType string
The source control management provider.
const ( ProjectSourceTypeGitHub ProjectSourceType = "github" ProjectSourceTypeGitlab ProjectSourceType = "gitlab" )
func (ProjectSourceType) IsKnown ¶
func (r ProjectSourceType) IsKnown() bool
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" api:"required,nullable" format:"date-time"`
// The current build stage.
Name StageName `json:"name" api:"required"`
// When the stage started.
StartedOn time.Time `json:"started_on" api:"required,nullable" format:"date-time"`
// State of the current stage.
Status StageStatus `json:"status" api:"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.