custom_pages

package
v6.3.0 Latest Latest
Warning

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

 Go to latest Published: Nov 20, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type CustomPageGetParams 

type CustomPageGetParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type CustomPageGetParamsIdentifier 

type CustomPageGetParamsIdentifier string

Error Page Types 

const (
	CustomPageGetParamsIdentifier1000Errors       CustomPageGetParamsIdentifier = "1000_errors"
	CustomPageGetParamsIdentifier500Errors        CustomPageGetParamsIdentifier = "500_errors"
	CustomPageGetParamsIdentifierBasicChallenge   CustomPageGetParamsIdentifier = "basic_challenge"
	CustomPageGetParamsIdentifierCountryChallenge CustomPageGetParamsIdentifier = "country_challenge"
	CustomPageGetParamsIdentifierIPBlock          CustomPageGetParamsIdentifier = "ip_block"
	CustomPageGetParamsIdentifierManagedChallenge CustomPageGetParamsIdentifier = "managed_challenge"
	CustomPageGetParamsIdentifierRatelimitBlock   CustomPageGetParamsIdentifier = "ratelimit_block"
	CustomPageGetParamsIdentifierUnderAttack      CustomPageGetParamsIdentifier = "under_attack"
	CustomPageGetParamsIdentifierWAFBlock         CustomPageGetParamsIdentifier = "waf_block"
)

func (CustomPageGetParamsIdentifier) IsKnown 

func (r CustomPageGetParamsIdentifier) IsKnown() bool

type CustomPageGetResponse 

type CustomPageGetResponse struct {
	ID             string    `json:"id"`
	CreatedOn      time.Time `json:"created_on" format:"date-time"`
	Description    string    `json:"description"`
	ModifiedOn     time.Time `json:"modified_on" format:"date-time"`
	PreviewTarget  string    `json:"preview_target"`
	RequiredTokens []string  `json:"required_tokens"`
	// The custom page state.
	State CustomPageGetResponseState `json:"state"`
	// The URL associated with the custom page.
	URL  string                    `json:"url" format:"uri"`
	JSON customPageGetResponseJSON `json:"-"`
}

func (*CustomPageGetResponse) UnmarshalJSON 

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

type CustomPageGetResponseEnvelope 

type CustomPageGetResponseEnvelope struct {
	Errors   []CustomPageGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomPageGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success CustomPageGetResponseEnvelopeSuccess `json:"success,required"`
	Result  CustomPageGetResponse                `json:"result"`
	JSON    customPageGetResponseEnvelopeJSON    `json:"-"`
}

func (*CustomPageGetResponseEnvelope) UnmarshalJSON 

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

type CustomPageGetResponseEnvelopeErrors 

type CustomPageGetResponseEnvelopeErrors struct {
	Code             int64                                     `json:"code,required"`
	Message          string                                    `json:"message,required"`
	DocumentationURL string                                    `json:"documentation_url"`
	Source           CustomPageGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             customPageGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*CustomPageGetResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomPageGetResponseEnvelopeErrorsSource 

type CustomPageGetResponseEnvelopeErrorsSource struct {
	Pointer string                                        `json:"pointer"`
	JSON    customPageGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*CustomPageGetResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type CustomPageGetResponseEnvelopeMessages 

type CustomPageGetResponseEnvelopeMessages struct {
	Code             int64                                       `json:"code,required"`
	Message          string                                      `json:"message,required"`
	DocumentationURL string                                      `json:"documentation_url"`
	Source           CustomPageGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             customPageGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*CustomPageGetResponseEnvelopeMessages) UnmarshalJSON 

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

type CustomPageGetResponseEnvelopeMessagesSource 

type CustomPageGetResponseEnvelopeMessagesSource struct {
	Pointer string                                          `json:"pointer"`
	JSON    customPageGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*CustomPageGetResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type CustomPageGetResponseEnvelopeSuccess 

type CustomPageGetResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	CustomPageGetResponseEnvelopeSuccessTrue CustomPageGetResponseEnvelopeSuccess = true
)

func (CustomPageGetResponseEnvelopeSuccess) IsKnown 

func (r CustomPageGetResponseEnvelopeSuccess) IsKnown() bool

type CustomPageGetResponseState 

type CustomPageGetResponseState string

The custom page state. 

const (
	CustomPageGetResponseStateDefault    CustomPageGetResponseState = "default"
	CustomPageGetResponseStateCustomized CustomPageGetResponseState = "customized"
)

func (CustomPageGetResponseState) IsKnown 

func (r CustomPageGetResponseState) IsKnown() bool

type CustomPageListParams 

type CustomPageListParams struct {
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

type CustomPageListResponse 

type CustomPageListResponse struct {
	ID             string    `json:"id"`
	CreatedOn      time.Time `json:"created_on" format:"date-time"`
	Description    string    `json:"description"`
	ModifiedOn     time.Time `json:"modified_on" format:"date-time"`
	PreviewTarget  string    `json:"preview_target"`
	RequiredTokens []string  `json:"required_tokens"`
	// The custom page state.
	State CustomPageListResponseState `json:"state"`
	// The URL associated with the custom page.
	URL  string                     `json:"url" format:"uri"`
	JSON customPageListResponseJSON `json:"-"`
}

func (*CustomPageListResponse) UnmarshalJSON 

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

type CustomPageListResponseState 

type CustomPageListResponseState string

The custom page state. 

const (
	CustomPageListResponseStateDefault    CustomPageListResponseState = "default"
	CustomPageListResponseStateCustomized CustomPageListResponseState = "customized"
)

func (CustomPageListResponseState) IsKnown 

func (r CustomPageListResponseState) IsKnown() bool

type CustomPageService 

type CustomPageService struct {
	Options []option.RequestOption
}

CustomPageService 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 NewCustomPageService method instead.

func NewCustomPageService 

func NewCustomPageService(opts ...option.RequestOption) (r *CustomPageService)

NewCustomPageService 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 (*CustomPageService) Get 

func (r *CustomPageService) Get(ctx context.Context, identifier CustomPageGetParamsIdentifier, query CustomPageGetParams, opts ...option.RequestOption) (res *CustomPageGetResponse, err error)

Fetches the details of a custom page.

func (*CustomPageService) List 

func (r *CustomPageService) List(ctx context.Context, query CustomPageListParams, opts ...option.RequestOption) (res *pagination.SinglePage[CustomPageListResponse], err error)

Fetches all the custom pages.

func (*CustomPageService) ListAutoPaging 

func (r *CustomPageService) ListAutoPaging(ctx context.Context, query CustomPageListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[CustomPageListResponse]

Fetches all the custom pages.

func (*CustomPageService) Update 

func (r *CustomPageService) Update(ctx context.Context, identifier CustomPageUpdateParamsIdentifier, params CustomPageUpdateParams, opts ...option.RequestOption) (res *CustomPageUpdateResponse, err error)

Updates the configuration of an existing custom page.

type CustomPageUpdateParams 

type CustomPageUpdateParams struct {
	// The custom page state.
	State param.Field[CustomPageUpdateParamsState] `json:"state,required"`
	// The URL associated with the custom page.
	URL param.Field[string] `json:"url,required" format:"uri"`
	// The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.
	AccountID param.Field[string] `path:"account_id"`
	// The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.
	ZoneID param.Field[string] `path:"zone_id"`
}

func (CustomPageUpdateParams) MarshalJSON 

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

type CustomPageUpdateParamsIdentifier 

type CustomPageUpdateParamsIdentifier string

Error Page Types 

const (
	CustomPageUpdateParamsIdentifier1000Errors       CustomPageUpdateParamsIdentifier = "1000_errors"
	CustomPageUpdateParamsIdentifier500Errors        CustomPageUpdateParamsIdentifier = "500_errors"
	CustomPageUpdateParamsIdentifierBasicChallenge   CustomPageUpdateParamsIdentifier = "basic_challenge"
	CustomPageUpdateParamsIdentifierCountryChallenge CustomPageUpdateParamsIdentifier = "country_challenge"
	CustomPageUpdateParamsIdentifierIPBlock          CustomPageUpdateParamsIdentifier = "ip_block"
	CustomPageUpdateParamsIdentifierManagedChallenge CustomPageUpdateParamsIdentifier = "managed_challenge"
	CustomPageUpdateParamsIdentifierRatelimitBlock   CustomPageUpdateParamsIdentifier = "ratelimit_block"
	CustomPageUpdateParamsIdentifierUnderAttack      CustomPageUpdateParamsIdentifier = "under_attack"
	CustomPageUpdateParamsIdentifierWAFBlock         CustomPageUpdateParamsIdentifier = "waf_block"
)

func (CustomPageUpdateParamsIdentifier) IsKnown 

func (r CustomPageUpdateParamsIdentifier) IsKnown() bool

type CustomPageUpdateParamsState 

type CustomPageUpdateParamsState string

The custom page state. 

const (
	CustomPageUpdateParamsStateDefault    CustomPageUpdateParamsState = "default"
	CustomPageUpdateParamsStateCustomized CustomPageUpdateParamsState = "customized"
)

func (CustomPageUpdateParamsState) IsKnown 

func (r CustomPageUpdateParamsState) IsKnown() bool

type CustomPageUpdateResponse 

type CustomPageUpdateResponse struct {
	ID             string    `json:"id"`
	CreatedOn      time.Time `json:"created_on" format:"date-time"`
	Description    string    `json:"description"`
	ModifiedOn     time.Time `json:"modified_on" format:"date-time"`
	PreviewTarget  string    `json:"preview_target"`
	RequiredTokens []string  `json:"required_tokens"`
	// The custom page state.
	State CustomPageUpdateResponseState `json:"state"`
	// The URL associated with the custom page.
	URL  string                       `json:"url" format:"uri"`
	JSON customPageUpdateResponseJSON `json:"-"`
}

func (*CustomPageUpdateResponse) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelope 

type CustomPageUpdateResponseEnvelope struct {
	Errors   []CustomPageUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []CustomPageUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success CustomPageUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  CustomPageUpdateResponse                `json:"result"`
	JSON    customPageUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*CustomPageUpdateResponseEnvelope) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelopeErrors 

type CustomPageUpdateResponseEnvelopeErrors struct {
	Code             int64                                        `json:"code,required"`
	Message          string                                       `json:"message,required"`
	DocumentationURL string                                       `json:"documentation_url"`
	Source           CustomPageUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             customPageUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*CustomPageUpdateResponseEnvelopeErrors) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelopeErrorsSource 

type CustomPageUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                           `json:"pointer"`
	JSON    customPageUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*CustomPageUpdateResponseEnvelopeErrorsSource) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelopeMessages 

type CustomPageUpdateResponseEnvelopeMessages struct {
	Code             int64                                          `json:"code,required"`
	Message          string                                         `json:"message,required"`
	DocumentationURL string                                         `json:"documentation_url"`
	Source           CustomPageUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             customPageUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*CustomPageUpdateResponseEnvelopeMessages) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelopeMessagesSource 

type CustomPageUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                             `json:"pointer"`
	JSON    customPageUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*CustomPageUpdateResponseEnvelopeMessagesSource) UnmarshalJSON 

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

type CustomPageUpdateResponseEnvelopeSuccess 

type CustomPageUpdateResponseEnvelopeSuccess bool

Whether the API call was successful. 

const (
	CustomPageUpdateResponseEnvelopeSuccessTrue CustomPageUpdateResponseEnvelopeSuccess = true
)

func (CustomPageUpdateResponseEnvelopeSuccess) IsKnown 

func (r CustomPageUpdateResponseEnvelopeSuccess) IsKnown() bool

type CustomPageUpdateResponseState 

type CustomPageUpdateResponseState string

The custom page state. 

const (
	CustomPageUpdateResponseStateDefault    CustomPageUpdateResponseState = "default"
	CustomPageUpdateResponseStateCustomized CustomPageUpdateResponseState = "customized"
)

func (CustomPageUpdateResponseState) IsKnown 

func (r CustomPageUpdateResponseState) IsKnown() bool

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.