email_routing

package

v4.6.0Latest Latest

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

Go to latest Published: Jul 10, 2025 License:Apache-2.0Imports:16Imported by:1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cloudflare/cloudflare-go

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 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¶

func (*Action)UnmarshalJSON ¶

func (r *Action) UnmarshalJSON(data []byte) (errerror)

func (ActionParam)MarshalJSON ¶

func (rActionParam) MarshalJSON() (data []byte, errerror)

typeActionType ¶

type ActionTypestring

Type of supported action.

const (ActionTypeDropActionType = "drop"ActionTypeForwardActionType = "forward"ActionTypeWorkerActionType = "worker")

func (ActionType)IsKnown ¶

func (rActionType) IsKnown()bool

typeAddress ¶

type Address struct {// Destination address identifier.IDstring `json:"id"`// The date and time the destination address has been created.Createdtime.Time `json:"created" format:"date-time"`// The contact email address of the user.Emailstring `json:"email"`// The date and time the destination address was last modified.Modifiedtime.Time `json:"modified" format:"date-time"`// Destination address tag. (Deprecated, replaced by destination address// identifier)//// Deprecated: deprecatedTagstring `json:"tag"`// The date and time the destination address has been verified. Null means not// verified yet.Verifiedtime.Time   `json:"verified" format:"date-time"`JSON     addressJSON `json:"-"`}

func (*Address)UnmarshalJSON ¶

func (r *Address) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteParams ¶

type AddressDeleteParams struct {// Identifier.AccountIDparam.Field[string] `path:"account_id,required"`}

typeAddressDeleteResponseEnvelope ¶

type AddressDeleteResponseEnvelope struct {Errors   []AddressDeleteResponseEnvelopeErrors   `json:"errors,required"`Messages []AddressDeleteResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessAddressDeleteResponseEnvelopeSuccess `json:"success,required"`ResultAddress                              `json:"result"`JSON    addressDeleteResponseEnvelopeJSON    `json:"-"`}

func (*AddressDeleteResponseEnvelope)UnmarshalJSON ¶

func (r *AddressDeleteResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteResponseEnvelopeErrors ¶added inv4.3.0

type AddressDeleteResponseEnvelopeErrors struct {Codeint64                                     `json:"code,required"`Messagestring                                    `json:"message,required"`DocumentationURLstring                                    `json:"documentation_url"`SourceAddressDeleteResponseEnvelopeErrorsSource `json:"source"`JSON             addressDeleteResponseEnvelopeErrorsJSON   `json:"-"`}

func (*AddressDeleteResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *AddressDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteResponseEnvelopeErrorsSource ¶added inv4.3.0

type AddressDeleteResponseEnvelopeErrorsSource struct {Pointerstring                                        `json:"pointer"`JSON    addressDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*AddressDeleteResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteResponseEnvelopeMessages ¶added inv4.3.0

type AddressDeleteResponseEnvelopeMessages struct {Codeint64                                       `json:"code,required"`Messagestring                                      `json:"message,required"`DocumentationURLstring                                      `json:"documentation_url"`SourceAddressDeleteResponseEnvelopeMessagesSource `json:"source"`JSON             addressDeleteResponseEnvelopeMessagesJSON   `json:"-"`}

func (*AddressDeleteResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *AddressDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteResponseEnvelopeMessagesSource ¶added inv4.3.0

type AddressDeleteResponseEnvelopeMessagesSource struct {Pointerstring                                          `json:"pointer"`JSON    addressDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*AddressDeleteResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeAddressDeleteResponseEnvelopeSuccess ¶

type AddressDeleteResponseEnvelopeSuccessbool

Whether the API call was successful.

const (AddressDeleteResponseEnvelopeSuccessTrueAddressDeleteResponseEnvelopeSuccess =true)

func (AddressDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rAddressDeleteResponseEnvelopeSuccess) IsKnown()bool

typeAddressGetParams ¶

type AddressGetParams struct {// Identifier.AccountIDparam.Field[string] `path:"account_id,required"`}

typeAddressGetResponseEnvelope ¶

type AddressGetResponseEnvelope struct {Errors   []AddressGetResponseEnvelopeErrors   `json:"errors,required"`Messages []AddressGetResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessAddressGetResponseEnvelopeSuccess `json:"success,required"`ResultAddress                           `json:"result"`JSON    addressGetResponseEnvelopeJSON    `json:"-"`}

func (*AddressGetResponseEnvelope)UnmarshalJSON ¶

func (r *AddressGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeAddressGetResponseEnvelopeErrors ¶added inv4.3.0

type AddressGetResponseEnvelopeErrors struct {Codeint64                                  `json:"code,required"`Messagestring                                 `json:"message,required"`DocumentationURLstring                                 `json:"documentation_url"`SourceAddressGetResponseEnvelopeErrorsSource `json:"source"`JSON             addressGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*AddressGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *AddressGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeAddressGetResponseEnvelopeErrorsSource ¶added inv4.3.0

type AddressGetResponseEnvelopeErrorsSource struct {Pointerstring                                     `json:"pointer"`JSON    addressGetResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*AddressGetResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeAddressGetResponseEnvelopeMessages ¶added inv4.3.0

type AddressGetResponseEnvelopeMessages struct {Codeint64                                    `json:"code,required"`Messagestring                                   `json:"message,required"`DocumentationURLstring                                   `json:"documentation_url"`SourceAddressGetResponseEnvelopeMessagesSource `json:"source"`JSON             addressGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*AddressGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *AddressGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeAddressGetResponseEnvelopeMessagesSource ¶added inv4.3.0

type AddressGetResponseEnvelopeMessagesSource struct {Pointerstring                                       `json:"pointer"`JSON    addressGetResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*AddressGetResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeAddressGetResponseEnvelopeSuccess ¶

type AddressGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (AddressGetResponseEnvelopeSuccessTrueAddressGetResponseEnvelopeSuccess =true)

func (AddressGetResponseEnvelopeSuccess)IsKnown ¶

func (rAddressGetResponseEnvelopeSuccess) IsKnown()bool

typeAddressListParams ¶

type AddressListParams struct {// Identifier.AccountIDparam.Field[string] `path:"account_id,required"`// Sorts results in an ascending or descending order.Directionparam.Field[AddressListParamsDirection] `query:"direction"`// Page number of paginated results.Pageparam.Field[float64] `query:"page"`// Maximum number of results per page.PerPageparam.Field[float64] `query:"per_page"`// Filter by verified destination addresses.Verifiedparam.Field[AddressListParamsVerified] `query:"verified"`}

func (AddressListParams)URLQuery ¶

func (rAddressListParams) URLQuery() (vurl.Values)

URLQuery serializesAddressListParams's query parameters as `url.Values`.

typeAddressListParamsDirection ¶

type AddressListParamsDirectionstring

Sorts results in an ascending or descending order.

const (AddressListParamsDirectionAscAddressListParamsDirection = "asc"AddressListParamsDirectionDescAddressListParamsDirection = "desc")

func (AddressListParamsDirection)IsKnown ¶

func (rAddressListParamsDirection) IsKnown()bool

typeAddressListParamsVerified ¶

type AddressListParamsVerifiedbool

Filter by verified destination addresses.

const (AddressListParamsVerifiedTrueAddressListParamsVerified =trueAddressListParamsVerifiedFalseAddressListParamsVerified =false)

func (AddressListParamsVerified)IsKnown ¶

func (rAddressListParamsVerified) IsKnown()bool

typeAddressNewParams ¶

type AddressNewParams struct {// Identifier.AccountIDparam.Field[string] `path:"account_id,required"`// The contact email address of the user.Emailparam.Field[string] `json:"email,required"`}

func (AddressNewParams)MarshalJSON ¶

func (rAddressNewParams) MarshalJSON() (data []byte, errerror)

typeAddressNewResponseEnvelope ¶

type AddressNewResponseEnvelope struct {Errors   []AddressNewResponseEnvelopeErrors   `json:"errors,required"`Messages []AddressNewResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessAddressNewResponseEnvelopeSuccess `json:"success,required"`ResultAddress                           `json:"result"`JSON    addressNewResponseEnvelopeJSON    `json:"-"`}

func (*AddressNewResponseEnvelope)UnmarshalJSON ¶

func (r *AddressNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeAddressNewResponseEnvelopeErrors ¶added inv4.3.0

type AddressNewResponseEnvelopeErrors struct {Codeint64                                  `json:"code,required"`Messagestring                                 `json:"message,required"`DocumentationURLstring                                 `json:"documentation_url"`SourceAddressNewResponseEnvelopeErrorsSource `json:"source"`JSON             addressNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*AddressNewResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *AddressNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeAddressNewResponseEnvelopeErrorsSource ¶added inv4.3.0

type AddressNewResponseEnvelopeErrorsSource struct {Pointerstring                                     `json:"pointer"`JSON    addressNewResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*AddressNewResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeAddressNewResponseEnvelopeMessages ¶added inv4.3.0

type AddressNewResponseEnvelopeMessages struct {Codeint64                                    `json:"code,required"`Messagestring                                   `json:"message,required"`DocumentationURLstring                                   `json:"documentation_url"`SourceAddressNewResponseEnvelopeMessagesSource `json:"source"`JSON             addressNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*AddressNewResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *AddressNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeAddressNewResponseEnvelopeMessagesSource ¶added inv4.3.0

type AddressNewResponseEnvelopeMessagesSource struct {Pointerstring                                       `json:"pointer"`JSON    addressNewResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*AddressNewResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *AddressNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeAddressNewResponseEnvelopeSuccess ¶

type AddressNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (AddressNewResponseEnvelopeSuccessTrueAddressNewResponseEnvelopeSuccess =true)

func (AddressNewResponseEnvelopeSuccess)IsKnown ¶

func (rAddressNewResponseEnvelopeSuccess) IsKnown()bool

typeAddressService ¶

type AddressService struct {Options []option.RequestOption}

AddressService contains methods and other services that help with interactingwith the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewAddressService method instead.

funcNewAddressService ¶

func NewAddressService(opts ...option.RequestOption) (r *AddressService)

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

func (*AddressService)Delete ¶

func (r *AddressService) Delete(ctxcontext.Context, destinationAddressIdentifierstring, bodyAddressDeleteParams, opts ...option.RequestOption) (res *Address, errerror)

Deletes a specific destination address.

func (*AddressService)Get ¶

func (r *AddressService) Get(ctxcontext.Context, destinationAddressIdentifierstring, queryAddressGetParams, opts ...option.RequestOption) (res *Address, errerror)

Gets information for a specific destination email already created.

func (*AddressService)List ¶

func (r *AddressService) List(ctxcontext.Context, paramsAddressListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[Address], errerror)

Lists existing destination addresses.

func (*AddressService)ListAutoPaging ¶

func (r *AddressService) ListAutoPaging(ctxcontext.Context, paramsAddressListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[Address]

Lists existing destination addresses.

func (*AddressService)New ¶

func (r *AddressService) New(ctxcontext.Context, paramsAddressNewParams, opts ...option.RequestOption) (res *Address, errerror)

Create a destination address to forward your emails to. Destination addressesneed to be verified before they can be used.

typeAuditLog ¶

type AuditLog =shared.AuditLog

This is an alias to an internal type.

typeAuditLogAction ¶

type AuditLogAction =shared.AuditLogAction

This is an alias to an internal type.

typeAuditLogActor ¶

type AuditLogActor =shared.AuditLogActor

This is an alias to an internal type.

typeAuditLogActorType ¶

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.

typeAuditLogOwner ¶

type AuditLogOwner =shared.AuditLogOwner

This is an alias to an internal type.

typeAuditLogResource ¶

type AuditLogResource =shared.AuditLogResource

This is an alias to an internal type.

typeCatchAllAction ¶

type CatchAllAction struct {// Type of action for catch-all rule.TypeCatchAllActionType `json:"type,required"`Value []string           `json:"value"`JSON  catchAllActionJSON `json:"-"`}

Action for the catch-all routing rule.

func (*CatchAllAction)UnmarshalJSON ¶

func (r *CatchAllAction) UnmarshalJSON(data []byte) (errerror)

typeCatchAllActionParam ¶

type CatchAllActionParam struct {// Type of action for catch-all rule.Typeparam.Field[CatchAllActionType] `json:"type,required"`Valueparam.Field[[]string]           `json:"value"`}

Action for the catch-all routing rule.

func (CatchAllActionParam)MarshalJSON ¶

func (rCatchAllActionParam) MarshalJSON() (data []byte, errerror)

typeCatchAllActionType ¶

type CatchAllActionTypestring

Type of action for catch-all rule.

const (CatchAllActionTypeDropCatchAllActionType = "drop"CatchAllActionTypeForwardCatchAllActionType = "forward"CatchAllActionTypeWorkerCatchAllActionType = "worker")

func (CatchAllActionType)IsKnown ¶

func (rCatchAllActionType) IsKnown()bool

typeCatchAllMatcher ¶

type CatchAllMatcher struct {// Type of matcher. Default is 'all'.TypeCatchAllMatcherType `json:"type,required"`JSON catchAllMatcherJSON `json:"-"`}

Matcher for catch-all routing rule.

func (*CatchAllMatcher)UnmarshalJSON ¶

func (r *CatchAllMatcher) UnmarshalJSON(data []byte) (errerror)

typeCatchAllMatcherParam ¶

type CatchAllMatcherParam struct {// Type of matcher. Default is 'all'.Typeparam.Field[CatchAllMatcherType] `json:"type,required"`}

Matcher for catch-all routing rule.

func (CatchAllMatcherParam)MarshalJSON ¶

func (rCatchAllMatcherParam) MarshalJSON() (data []byte, errerror)

typeCatchAllMatcherType ¶

type CatchAllMatcherTypestring

Type of matcher. Default is 'all'.

const (CatchAllMatcherTypeAllCatchAllMatcherType = "all")

func (CatchAllMatcherType)IsKnown ¶

func (rCatchAllMatcherType) IsKnown()bool

typeCertificateCA ¶

type CertificateCA =shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

typeCertificateRequestType ¶

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.

typeCloudflareTunnel ¶

type CloudflareTunnel =shared.CloudflareTunnel

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

This is an alias to an internal type.

typeCloudflareTunnelConnection ¶

type CloudflareTunnelConnection =shared.CloudflareTunnelConnection

This is an alias to an internal type.

typeCloudflareTunnelStatus ¶

type CloudflareTunnelStatus =shared.CloudflareTunnelStatus

The status of the tunnel. Valid values are `inactive` (tunnel has never beenrun), `degraded` (tunnel is active and able to serve traffic but in an unhealthystate), `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.

typeCloudflareTunnelTunType ¶

type CloudflareTunnelTunType =shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

typeDNSDeleteParams ¶

type DNSDeleteParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`}

typeDNSEditParams ¶

type DNSEditParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// Domain of your zone.Nameparam.Field[string] `json:"name,required"`}

func (DNSEditParams)MarshalJSON ¶

func (rDNSEditParams) MarshalJSON() (data []byte, errerror)

typeDNSEditResponseEnvelope ¶

type DNSEditResponseEnvelope struct {Errors   []DNSEditResponseEnvelopeErrors   `json:"errors,required"`Messages []DNSEditResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessDNSEditResponseEnvelopeSuccess `json:"success,required"`ResultSettings                       `json:"result"`JSON    dnsEditResponseEnvelopeJSON    `json:"-"`}

func (*DNSEditResponseEnvelope)UnmarshalJSON ¶

func (r *DNSEditResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeDNSEditResponseEnvelopeErrors ¶added inv4.3.0

type DNSEditResponseEnvelopeErrors struct {Codeint64                               `json:"code,required"`Messagestring                              `json:"message,required"`DocumentationURLstring                              `json:"documentation_url"`SourceDNSEditResponseEnvelopeErrorsSource `json:"source"`JSON             dnsEditResponseEnvelopeErrorsJSON   `json:"-"`}

func (*DNSEditResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *DNSEditResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeDNSEditResponseEnvelopeErrorsSource ¶added inv4.3.0

type DNSEditResponseEnvelopeErrorsSource struct {Pointerstring                                  `json:"pointer"`JSON    dnsEditResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*DNSEditResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSEditResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeDNSEditResponseEnvelopeMessages ¶added inv4.3.0

type DNSEditResponseEnvelopeMessages struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceDNSEditResponseEnvelopeMessagesSource `json:"source"`JSON             dnsEditResponseEnvelopeMessagesJSON   `json:"-"`}

func (*DNSEditResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *DNSEditResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeDNSEditResponseEnvelopeMessagesSource ¶added inv4.3.0

type DNSEditResponseEnvelopeMessagesSource struct {Pointerstring                                    `json:"pointer"`JSON    dnsEditResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*DNSEditResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSEditResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeDNSEditResponseEnvelopeSuccess ¶

type DNSEditResponseEnvelopeSuccessbool

Whether the API call was successful.

const (DNSEditResponseEnvelopeSuccessTrueDNSEditResponseEnvelopeSuccess =true)

func (DNSEditResponseEnvelopeSuccess)IsKnown ¶

func (rDNSEditResponseEnvelopeSuccess) IsKnown()bool

typeDNSGetParams ¶

type DNSGetParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// Domain of your zone.Subdomainparam.Field[string] `query:"subdomain"`}

func (DNSGetParams)URLQuery ¶

func (rDNSGetParams) URLQuery() (vurl.Values)

URLQuery serializesDNSGetParams's query parameters as `url.Values`.

typeDNSGetResponse ¶

type DNSGetResponse struct {// This field can have the runtime type of// [[]DNSGetResponseEmailEmailRoutingDNSQueryResponseError],// [[]DNSGetResponseEmailDNSSettingsResponseCollectionError].Errors interface{} `json:"errors,required"`// This field can have the runtime type of// [[]DNSGetResponseEmailEmailRoutingDNSQueryResponseMessage],// [[]DNSGetResponseEmailDNSSettingsResponseCollectionMessage].Messages interface{} `json:"messages,required"`// Whether the API call was successful.SuccessDNSGetResponseSuccess `json:"success,required"`// This field can have the runtime type of// [DNSGetResponseEmailEmailRoutingDNSQueryResponseResult], [[]DNSRecord].Result interface{} `json:"result"`// This field can have the runtime type of// [DNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo],// [DNSGetResponseEmailDNSSettingsResponseCollectionResultInfo].ResultInfo interface{}        `json:"result_info"`JSON       dnsGetResponseJSON `json:"-"`// contains filtered or unexported fields}

func (DNSGetResponse)AsUnion ¶

func (rDNSGetResponse) AsUnion()DNSGetResponseUnion

AsUnion returns aDNSGetResponseUnion interface which you can cast to thespecific types for more type safety.

Possible runtime types of the union areDNSGetResponseEmailEmailRoutingDNSQueryResponse,DNSGetResponseEmailDNSSettingsResponseCollection.

func (*DNSGetResponse)UnmarshalJSON ¶

func (r *DNSGetResponse) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollection ¶

type DNSGetResponseEmailDNSSettingsResponseCollection struct {Errors   []DNSGetResponseEmailDNSSettingsResponseCollectionError   `json:"errors,required"`Messages []DNSGetResponseEmailDNSSettingsResponseCollectionMessage `json:"messages,required"`// Whether the API call was successful.SuccessDNSGetResponseEmailDNSSettingsResponseCollectionSuccess    `json:"success,required"`Result     []DNSRecord                                                `json:"result"`ResultInfoDNSGetResponseEmailDNSSettingsResponseCollectionResultInfo `json:"result_info"`JSON       dnsGetResponseEmailDNSSettingsResponseCollectionJSON       `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollection)UnmarshalJSON ¶

func (r *DNSGetResponseEmailDNSSettingsResponseCollection) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionError ¶added inv4.3.0

type DNSGetResponseEmailDNSSettingsResponseCollectionError struct {Codeint64                                                        `json:"code,required"`Messagestring                                                       `json:"message,required"`DocumentationURLstring                                                       `json:"documentation_url"`SourceDNSGetResponseEmailDNSSettingsResponseCollectionErrorsSource `json:"source"`JSON             dnsGetResponseEmailDNSSettingsResponseCollectionErrorJSON    `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollectionError)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailDNSSettingsResponseCollectionError) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionErrorsSource ¶added inv4.3.0

type DNSGetResponseEmailDNSSettingsResponseCollectionErrorsSource struct {Pointerstring                                                           `json:"pointer"`JSON    dnsGetResponseEmailDNSSettingsResponseCollectionErrorsSourceJSON `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollectionErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailDNSSettingsResponseCollectionErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionMessage ¶added inv4.3.0

type DNSGetResponseEmailDNSSettingsResponseCollectionMessage struct {Codeint64                                                          `json:"code,required"`Messagestring                                                         `json:"message,required"`DocumentationURLstring                                                         `json:"documentation_url"`SourceDNSGetResponseEmailDNSSettingsResponseCollectionMessagesSource `json:"source"`JSON             dnsGetResponseEmailDNSSettingsResponseCollectionMessageJSON    `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollectionMessage)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailDNSSettingsResponseCollectionMessage) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionMessagesSource ¶added inv4.3.0

type DNSGetResponseEmailDNSSettingsResponseCollectionMessagesSource struct {Pointerstring                                                             `json:"pointer"`JSON    dnsGetResponseEmailDNSSettingsResponseCollectionMessagesSourceJSON `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollectionMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailDNSSettingsResponseCollectionMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionResultInfo ¶

type DNSGetResponseEmailDNSSettingsResponseCollectionResultInfo struct {// Total number of results for the requested service.Countfloat64 `json:"count"`// Current page within paginated list of results.Pagefloat64 `json:"page"`// Number of results per page of results.PerPagefloat64 `json:"per_page"`// Total results available without any search parameters.TotalCountfloat64                                                        `json:"total_count"`JSON       dnsGetResponseEmailDNSSettingsResponseCollectionResultInfoJSON `json:"-"`}

func (*DNSGetResponseEmailDNSSettingsResponseCollectionResultInfo)UnmarshalJSON ¶

func (r *DNSGetResponseEmailDNSSettingsResponseCollectionResultInfo) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailDNSSettingsResponseCollectionSuccess ¶

type DNSGetResponseEmailDNSSettingsResponseCollectionSuccessbool

Whether the API call was successful.

const (DNSGetResponseEmailDNSSettingsResponseCollectionSuccessTrueDNSGetResponseEmailDNSSettingsResponseCollectionSuccess =true)

func (DNSGetResponseEmailDNSSettingsResponseCollectionSuccess)IsKnown ¶

func (rDNSGetResponseEmailDNSSettingsResponseCollectionSuccess) IsKnown()bool

typeDNSGetResponseEmailEmailRoutingDNSQueryResponse ¶

type DNSGetResponseEmailEmailRoutingDNSQueryResponse struct {Errors   []DNSGetResponseEmailEmailRoutingDNSQueryResponseError   `json:"errors,required"`Messages []DNSGetResponseEmailEmailRoutingDNSQueryResponseMessage `json:"messages,required"`// Whether the API call was successful.SuccessDNSGetResponseEmailEmailRoutingDNSQueryResponseSuccess    `json:"success,required"`ResultDNSGetResponseEmailEmailRoutingDNSQueryResponseResult     `json:"result"`ResultInfoDNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo `json:"result_info"`JSON       dnsGetResponseEmailEmailRoutingDNSQueryResponseJSON       `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponse)UnmarshalJSON ¶

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponse) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseError ¶added inv4.3.0

type DNSGetResponseEmailEmailRoutingDNSQueryResponseError struct {Codeint64                                                       `json:"code,required"`Messagestring                                                      `json:"message,required"`DocumentationURLstring                                                      `json:"documentation_url"`SourceDNSGetResponseEmailEmailRoutingDNSQueryResponseErrorsSource `json:"source"`JSON             dnsGetResponseEmailEmailRoutingDNSQueryResponseErrorJSON    `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseError)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseError) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseErrorsSource ¶added inv4.3.0

type DNSGetResponseEmailEmailRoutingDNSQueryResponseErrorsSource struct {Pointerstring                                                          `json:"pointer"`JSON    dnsGetResponseEmailEmailRoutingDNSQueryResponseErrorsSourceJSON `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseMessage ¶added inv4.3.0

type DNSGetResponseEmailEmailRoutingDNSQueryResponseMessage struct {Codeint64                                                         `json:"code,required"`Messagestring                                                        `json:"message,required"`DocumentationURLstring                                                        `json:"documentation_url"`SourceDNSGetResponseEmailEmailRoutingDNSQueryResponseMessagesSource `json:"source"`JSON             dnsGetResponseEmailEmailRoutingDNSQueryResponseMessageJSON    `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseMessage)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseMessage) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseMessagesSource ¶added inv4.3.0

type DNSGetResponseEmailEmailRoutingDNSQueryResponseMessagesSource struct {Pointerstring                                                            `json:"pointer"`JSON    dnsGetResponseEmailEmailRoutingDNSQueryResponseMessagesSourceJSON `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseResult ¶

type DNSGetResponseEmailEmailRoutingDNSQueryResponseResult struct {Errors []DNSGetResponseEmailEmailRoutingDNSQueryResponseResultError `json:"errors"`Record []DNSRecord                                                  `json:"record"`JSON   dnsGetResponseEmailEmailRoutingDNSQueryResponseResultJSON    `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseResult)UnmarshalJSON ¶

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseResult) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseResultError ¶

type DNSGetResponseEmailEmailRoutingDNSQueryResponseResultError struct {Codestring `json:"code"`// List of records needed to enable an Email Routing zone.MissingDNSRecord                                                      `json:"missing"`JSON    dnsGetResponseEmailEmailRoutingDNSQueryResponseResultErrorJSON `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseResultError)UnmarshalJSON ¶

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseResultError) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo ¶

type DNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo struct {// Total number of results for the requested service.Countfloat64 `json:"count"`// Current page within paginated list of results.Pagefloat64 `json:"page"`// Number of results per page of results.PerPagefloat64 `json:"per_page"`// Total results available without any search parameters.TotalCountfloat64                                                       `json:"total_count"`JSON       dnsGetResponseEmailEmailRoutingDNSQueryResponseResultInfoJSON `json:"-"`}

func (*DNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo)UnmarshalJSON ¶

func (r *DNSGetResponseEmailEmailRoutingDNSQueryResponseResultInfo) UnmarshalJSON(data []byte) (errerror)

typeDNSGetResponseEmailEmailRoutingDNSQueryResponseSuccess ¶

type DNSGetResponseEmailEmailRoutingDNSQueryResponseSuccessbool

Whether the API call was successful.

const (DNSGetResponseEmailEmailRoutingDNSQueryResponseSuccessTrueDNSGetResponseEmailEmailRoutingDNSQueryResponseSuccess =true)

func (DNSGetResponseEmailEmailRoutingDNSQueryResponseSuccess)IsKnown ¶

func (rDNSGetResponseEmailEmailRoutingDNSQueryResponseSuccess) IsKnown()bool

typeDNSGetResponseSuccess ¶

type DNSGetResponseSuccessbool

Whether the API call was successful.

const (DNSGetResponseSuccessTrueDNSGetResponseSuccess =true)

func (DNSGetResponseSuccess)IsKnown ¶

func (rDNSGetResponseSuccess) IsKnown()bool

typeDNSGetResponseUnion ¶

type DNSGetResponseUnion interface {// contains filtered or unexported methods}

Union satisfied byDNSGetResponseEmailEmailRoutingDNSQueryResponse orDNSGetResponseEmailDNSSettingsResponseCollection.

typeDNSNewParams ¶

type DNSNewParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// Domain of your zone.Nameparam.Field[string] `json:"name,required"`}

func (DNSNewParams)MarshalJSON ¶

func (rDNSNewParams) MarshalJSON() (data []byte, errerror)

typeDNSNewResponseEnvelope ¶

type DNSNewResponseEnvelope struct {Errors   []DNSNewResponseEnvelopeErrors   `json:"errors,required"`Messages []DNSNewResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessDNSNewResponseEnvelopeSuccess `json:"success,required"`ResultSettings                      `json:"result"`JSON    dnsNewResponseEnvelopeJSON    `json:"-"`}

func (*DNSNewResponseEnvelope)UnmarshalJSON ¶

func (r *DNSNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeDNSNewResponseEnvelopeErrors ¶added inv4.3.0

type DNSNewResponseEnvelopeErrors struct {Codeint64                              `json:"code,required"`Messagestring                             `json:"message,required"`DocumentationURLstring                             `json:"documentation_url"`SourceDNSNewResponseEnvelopeErrorsSource `json:"source"`JSON             dnsNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*DNSNewResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *DNSNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeDNSNewResponseEnvelopeErrorsSource ¶added inv4.3.0

type DNSNewResponseEnvelopeErrorsSource struct {Pointerstring                                 `json:"pointer"`JSON    dnsNewResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*DNSNewResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeDNSNewResponseEnvelopeMessages ¶added inv4.3.0

type DNSNewResponseEnvelopeMessages struct {Codeint64                                `json:"code,required"`Messagestring                               `json:"message,required"`DocumentationURLstring                               `json:"documentation_url"`SourceDNSNewResponseEnvelopeMessagesSource `json:"source"`JSON             dnsNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*DNSNewResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *DNSNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeDNSNewResponseEnvelopeMessagesSource ¶added inv4.3.0

type DNSNewResponseEnvelopeMessagesSource struct {Pointerstring                                   `json:"pointer"`JSON    dnsNewResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*DNSNewResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *DNSNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeDNSNewResponseEnvelopeSuccess ¶

type DNSNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (DNSNewResponseEnvelopeSuccessTrueDNSNewResponseEnvelopeSuccess =true)

func (DNSNewResponseEnvelopeSuccess)IsKnown ¶

func (rDNSNewResponseEnvelopeSuccess) IsKnown()bool

typeDNSRecord ¶

type DNSRecord struct {// DNS record content.Contentstring `json:"content"`// DNS record name (or @ for the zone apex).Namestring `json:"name"`// Required for MX, SRV and URI records. Unused by other record types. Records with// lower priorities are preferred.Priorityfloat64 `json:"priority"`// Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1// for 'automatic'.TTLDNSRecordTTL `json:"ttl"`// DNS record type.TypeDNSRecordType `json:"type"`JSON dnsRecordJSON `json:"-"`}

List of records needed to enable an Email Routing zone.

func (*DNSRecord)UnmarshalJSON ¶

func (r *DNSRecord) UnmarshalJSON(data []byte) (errerror)

typeDNSRecordTTL ¶

type DNSRecordTTLfloat64

Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1for 'automatic'.

const (DNSRecordTTL1DNSRecordTTL = 1)

func (DNSRecordTTL)IsKnown ¶

func (rDNSRecordTTL) IsKnown()bool

typeDNSRecordType ¶

type DNSRecordTypestring

DNS record type.

const (DNSRecordTypeADNSRecordType = "A"DNSRecordTypeAAAADNSRecordType = "AAAA"DNSRecordTypeCNAMEDNSRecordType = "CNAME"DNSRecordTypeHTTPSDNSRecordType = "HTTPS"DNSRecordTypeTXTDNSRecordType = "TXT"DNSRecordTypeSRVDNSRecordType = "SRV"DNSRecordTypeLOCDNSRecordType = "LOC"DNSRecordTypeMXDNSRecordType = "MX"DNSRecordTypeNSDNSRecordType = "NS"DNSRecordTypeCERTDNSRecordType = "CERT"DNSRecordTypeDNSKEYDNSRecordType = "DNSKEY"DNSRecordTypeDSDNSRecordType = "DS"DNSRecordTypeNAPTRDNSRecordType = "NAPTR"DNSRecordTypeSMIMEADNSRecordType = "SMIMEA"DNSRecordTypeSSHFPDNSRecordType = "SSHFP"DNSRecordTypeSVCBDNSRecordType = "SVCB"DNSRecordTypeTLSADNSRecordType = "TLSA"DNSRecordTypeURIDNSRecordType = "URI")

func (DNSRecordType)IsKnown ¶

func (rDNSRecordType) IsKnown()bool

typeDNSService ¶

type DNSService struct {Options []option.RequestOption}

DNSService contains methods and other services that help with interacting withthe cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewDNSService method instead.

funcNewDNSService ¶

func NewDNSService(opts ...option.RequestOption) (r *DNSService)

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

func (*DNSService)Delete ¶

func (r *DNSService) Delete(ctxcontext.Context, bodyDNSDeleteParams, opts ...option.RequestOption) (res *pagination.SinglePage[DNSRecord], errerror)

Disable your Email Routing zone. Also removes additional MX records previouslyrequired for Email Routing to work.

func (*DNSService)DeleteAutoPaging ¶added inv4.1.0

func (r *DNSService) DeleteAutoPaging(ctxcontext.Context, bodyDNSDeleteParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[DNSRecord]

Disable your Email Routing zone. Also removes additional MX records previouslyrequired for Email Routing to work.

func (*DNSService)Edit ¶

func (r *DNSService) Edit(ctxcontext.Context, paramsDNSEditParams, opts ...option.RequestOption) (res *Settings, errerror)

Unlock MX Records previously locked by Email Routing.

func (*DNSService)Get ¶

func (r *DNSService) Get(ctxcontext.Context, paramsDNSGetParams, opts ...option.RequestOption) (res *DNSGetResponse, errerror)

Show the DNS records needed to configure your Email Routing zone.

func (*DNSService)New ¶

func (r *DNSService) New(ctxcontext.Context, paramsDNSNewParams, opts ...option.RequestOption) (res *Settings, errerror)

Enable you Email Routing zone. Add and lock the necessary MX and SPF records.

typeEmailRoutingDisableParams ¶

type EmailRoutingDisableParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`Body   interface{}         `json:"body,required"`}

func (EmailRoutingDisableParams)MarshalJSON ¶

func (rEmailRoutingDisableParams) MarshalJSON() (data []byte, errerror)

typeEmailRoutingDisableResponseEnvelope ¶

type EmailRoutingDisableResponseEnvelope struct {Errors   []EmailRoutingDisableResponseEnvelopeErrors   `json:"errors,required"`Messages []EmailRoutingDisableResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessEmailRoutingDisableResponseEnvelopeSuccess `json:"success,required"`ResultSettings                                   `json:"result"`JSON    emailRoutingDisableResponseEnvelopeJSON    `json:"-"`}

func (*EmailRoutingDisableResponseEnvelope)UnmarshalJSON ¶

func (r *EmailRoutingDisableResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingDisableResponseEnvelopeErrors ¶added inv4.3.0

type EmailRoutingDisableResponseEnvelopeErrors struct {Codeint64                                           `json:"code,required"`Messagestring                                          `json:"message,required"`DocumentationURLstring                                          `json:"documentation_url"`SourceEmailRoutingDisableResponseEnvelopeErrorsSource `json:"source"`JSON             emailRoutingDisableResponseEnvelopeErrorsJSON   `json:"-"`}

func (*EmailRoutingDisableResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingDisableResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingDisableResponseEnvelopeErrorsSource ¶added inv4.3.0

type EmailRoutingDisableResponseEnvelopeErrorsSource struct {Pointerstring                                              `json:"pointer"`JSON    emailRoutingDisableResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*EmailRoutingDisableResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingDisableResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingDisableResponseEnvelopeMessages ¶added inv4.3.0

type EmailRoutingDisableResponseEnvelopeMessages struct {Codeint64                                             `json:"code,required"`Messagestring                                            `json:"message,required"`DocumentationURLstring                                            `json:"documentation_url"`SourceEmailRoutingDisableResponseEnvelopeMessagesSource `json:"source"`JSON             emailRoutingDisableResponseEnvelopeMessagesJSON   `json:"-"`}

func (*EmailRoutingDisableResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingDisableResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingDisableResponseEnvelopeMessagesSource ¶added inv4.3.0

type EmailRoutingDisableResponseEnvelopeMessagesSource struct {Pointerstring                                                `json:"pointer"`JSON    emailRoutingDisableResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*EmailRoutingDisableResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingDisableResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingDisableResponseEnvelopeSuccess ¶

type EmailRoutingDisableResponseEnvelopeSuccessbool

Whether the API call was successful.

const (EmailRoutingDisableResponseEnvelopeSuccessTrueEmailRoutingDisableResponseEnvelopeSuccess =true)

func (EmailRoutingDisableResponseEnvelopeSuccess)IsKnown ¶

func (rEmailRoutingDisableResponseEnvelopeSuccess) IsKnown()bool

typeEmailRoutingEnableParams ¶

type EmailRoutingEnableParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`Body   interface{}         `json:"body,required"`}

func (EmailRoutingEnableParams)MarshalJSON ¶

func (rEmailRoutingEnableParams) MarshalJSON() (data []byte, errerror)

typeEmailRoutingEnableResponseEnvelope ¶

type EmailRoutingEnableResponseEnvelope struct {Errors   []EmailRoutingEnableResponseEnvelopeErrors   `json:"errors,required"`Messages []EmailRoutingEnableResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessEmailRoutingEnableResponseEnvelopeSuccess `json:"success,required"`ResultSettings                                  `json:"result"`JSON    emailRoutingEnableResponseEnvelopeJSON    `json:"-"`}

func (*EmailRoutingEnableResponseEnvelope)UnmarshalJSON ¶

func (r *EmailRoutingEnableResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingEnableResponseEnvelopeErrors ¶added inv4.3.0

type EmailRoutingEnableResponseEnvelopeErrors struct {Codeint64                                          `json:"code,required"`Messagestring                                         `json:"message,required"`DocumentationURLstring                                         `json:"documentation_url"`SourceEmailRoutingEnableResponseEnvelopeErrorsSource `json:"source"`JSON             emailRoutingEnableResponseEnvelopeErrorsJSON   `json:"-"`}

func (*EmailRoutingEnableResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingEnableResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingEnableResponseEnvelopeErrorsSource ¶added inv4.3.0

type EmailRoutingEnableResponseEnvelopeErrorsSource struct {Pointerstring                                             `json:"pointer"`JSON    emailRoutingEnableResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*EmailRoutingEnableResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingEnableResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingEnableResponseEnvelopeMessages ¶added inv4.3.0

type EmailRoutingEnableResponseEnvelopeMessages struct {Codeint64                                            `json:"code,required"`Messagestring                                           `json:"message,required"`DocumentationURLstring                                           `json:"documentation_url"`SourceEmailRoutingEnableResponseEnvelopeMessagesSource `json:"source"`JSON             emailRoutingEnableResponseEnvelopeMessagesJSON   `json:"-"`}

func (*EmailRoutingEnableResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingEnableResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingEnableResponseEnvelopeMessagesSource ¶added inv4.3.0

type EmailRoutingEnableResponseEnvelopeMessagesSource struct {Pointerstring                                               `json:"pointer"`JSON    emailRoutingEnableResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*EmailRoutingEnableResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingEnableResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingEnableResponseEnvelopeSuccess ¶

type EmailRoutingEnableResponseEnvelopeSuccessbool

Whether the API call was successful.

const (EmailRoutingEnableResponseEnvelopeSuccessTrueEmailRoutingEnableResponseEnvelopeSuccess =true)

func (EmailRoutingEnableResponseEnvelopeSuccess)IsKnown ¶

func (rEmailRoutingEnableResponseEnvelopeSuccess) IsKnown()bool

typeEmailRoutingGetParams ¶

type EmailRoutingGetParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`}

typeEmailRoutingGetResponseEnvelope ¶

type EmailRoutingGetResponseEnvelope struct {Errors   []EmailRoutingGetResponseEnvelopeErrors   `json:"errors,required"`Messages []EmailRoutingGetResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessEmailRoutingGetResponseEnvelopeSuccess `json:"success,required"`ResultSettings                               `json:"result"`JSON    emailRoutingGetResponseEnvelopeJSON    `json:"-"`}

func (*EmailRoutingGetResponseEnvelope)UnmarshalJSON ¶

func (r *EmailRoutingGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingGetResponseEnvelopeErrors ¶added inv4.3.0

type EmailRoutingGetResponseEnvelopeErrors struct {Codeint64                                       `json:"code,required"`Messagestring                                      `json:"message,required"`DocumentationURLstring                                      `json:"documentation_url"`SourceEmailRoutingGetResponseEnvelopeErrorsSource `json:"source"`JSON             emailRoutingGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*EmailRoutingGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingGetResponseEnvelopeErrorsSource ¶added inv4.3.0

type EmailRoutingGetResponseEnvelopeErrorsSource struct {Pointerstring                                          `json:"pointer"`JSON    emailRoutingGetResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*EmailRoutingGetResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingGetResponseEnvelopeMessages ¶added inv4.3.0

type EmailRoutingGetResponseEnvelopeMessages struct {Codeint64                                         `json:"code,required"`Messagestring                                        `json:"message,required"`DocumentationURLstring                                        `json:"documentation_url"`SourceEmailRoutingGetResponseEnvelopeMessagesSource `json:"source"`JSON             emailRoutingGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*EmailRoutingGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingGetResponseEnvelopeMessagesSource ¶added inv4.3.0

type EmailRoutingGetResponseEnvelopeMessagesSource struct {Pointerstring                                            `json:"pointer"`JSON    emailRoutingGetResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*EmailRoutingGetResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *EmailRoutingGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingGetResponseEnvelopeSuccess ¶

type EmailRoutingGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (EmailRoutingGetResponseEnvelopeSuccessTrueEmailRoutingGetResponseEnvelopeSuccess =true)

func (EmailRoutingGetResponseEnvelopeSuccess)IsKnown ¶

func (rEmailRoutingGetResponseEnvelopeSuccess) IsKnown()bool

typeEmailRoutingRule ¶

type EmailRoutingRule struct {// Routing rule identifier.IDstring `json:"id"`// List actions patterns.Actions []Action `json:"actions"`// Routing rule status.EnabledEmailRoutingRuleEnabled `json:"enabled"`// Matching patterns to forward to your actions.Matchers []Matcher `json:"matchers"`// Routing rule name.Namestring `json:"name"`// Priority of the routing rule.Priorityfloat64 `json:"priority"`// Routing rule tag. (Deprecated, replaced by routing rule identifier)//// Deprecated: deprecatedTagstring               `json:"tag"`JSON emailRoutingRuleJSON `json:"-"`}

func (*EmailRoutingRule)UnmarshalJSON ¶

func (r *EmailRoutingRule) UnmarshalJSON(data []byte) (errerror)

typeEmailRoutingRuleEnabled ¶

type EmailRoutingRuleEnabledbool

Routing rule status.

const (EmailRoutingRuleEnabledTrueEmailRoutingRuleEnabled =trueEmailRoutingRuleEnabledFalseEmailRoutingRuleEnabled =false)

func (EmailRoutingRuleEnabled)IsKnown ¶

func (rEmailRoutingRuleEnabled) IsKnown()bool

typeEmailRoutingService ¶

type EmailRoutingService struct {Options   []option.RequestOptionDNS       *DNSServiceRules     *RuleServiceAddresses *AddressService}

EmailRoutingService contains methods and other services that help withinteracting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewEmailRoutingService method instead.

funcNewEmailRoutingService ¶

func NewEmailRoutingService(opts ...option.RequestOption) (r *EmailRoutingService)

NewEmailRoutingService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere is one), and before any request-specific options.

func (*EmailRoutingService)Disabledeprecated

func (r *EmailRoutingService) Disable(ctxcontext.Context, paramsEmailRoutingDisableParams, opts ...option.RequestOption) (res *Settings, errerror)

Disable your Email Routing zone. Also removes additional MX records previouslyrequired for Email Routing to work.

Deprecated: deprecated

func (*EmailRoutingService)Enabledeprecated

func (r *EmailRoutingService) Enable(ctxcontext.Context, paramsEmailRoutingEnableParams, opts ...option.RequestOption) (res *Settings, errerror)

Enable you Email Routing zone. Add and lock the necessary MX and SPF records.

Deprecated: deprecated

func (*EmailRoutingService)Get ¶

func (r *EmailRoutingService) Get(ctxcontext.Context, queryEmailRoutingGetParams, opts ...option.RequestOption) (res *Settings, errerror)

Get information about the settings for your Email Routing zone.

typeError ¶

type Error =apierror.Error

typeErrorData ¶

type ErrorData =shared.ErrorData

This is an alias to an internal type.

typeErrorDataSource ¶added inv4.2.0

type ErrorDataSource =shared.ErrorDataSource

This is an alias to an internal type.

typeMatcher ¶

type Matcher struct {// Type of matcher.TypeMatcherType `json:"type,required"`// Field for type matcher.FieldMatcherField `json:"field"`// Value for matcher.Valuestring      `json:"value"`JSON  matcherJSON `json:"-"`}

Matching pattern to forward your actions.

func (*Matcher)UnmarshalJSON ¶

func (r *Matcher) UnmarshalJSON(data []byte) (errerror)

typeMatcherField ¶

type MatcherFieldstring

Field for type matcher.

const (MatcherFieldToMatcherField = "to")

func (MatcherField)IsKnown ¶

func (rMatcherField) IsKnown()bool

typeMatcherParam ¶

type MatcherParam struct {// Type of matcher.Typeparam.Field[MatcherType] `json:"type,required"`// Field for type matcher.Fieldparam.Field[MatcherField] `json:"field"`// Value for matcher.Valueparam.Field[string] `json:"value"`}

Matching pattern to forward your actions.

func (MatcherParam)MarshalJSON ¶

func (rMatcherParam) MarshalJSON() (data []byte, errerror)

typeMatcherType ¶

type MatcherTypestring

Type of matcher.

const (MatcherTypeAllMatcherType = "all"MatcherTypeLiteralMatcherType = "literal")

func (MatcherType)IsKnown ¶

func (rMatcherType) IsKnown()bool

typeMember ¶

type Member =shared.Member

This is an alias to an internal type.

typeMemberPoliciesAccess ¶

type MemberPoliciesAccess =shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup =shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta =shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup =shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta =shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope =shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject =shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

typeMemberPolicy ¶

type MemberPolicy =shared.MemberPolicy

This is an alias to an internal type.

typeMemberStatus ¶

type MemberStatus =shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

typeMemberUser ¶

type MemberUser =shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

typePermission ¶

type Permission =shared.Permission

This is an alias to an internal type.

typePermissionGrant ¶

type PermissionGrant =shared.PermissionGrant

This is an alias to an internal type.

typePermissionGrantParam ¶

type PermissionGrantParam =shared.PermissionGrantParam

This is an alias to an internal type.

typeRatePlan ¶

type RatePlan =shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

typeRatePlanID ¶added inv4.1.0

type RatePlanID =shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

typeRatePlanParam ¶

type RatePlanParam =shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

typeResponseInfo ¶

type ResponseInfo =shared.ResponseInfo

This is an alias to an internal type.

typeResponseInfoSource ¶added inv4.3.0

type ResponseInfoSource =shared.ResponseInfoSource

This is an alias to an internal type.

typeRole ¶

type Role =shared.Role

This is an alias to an internal type.

typeRoleParam ¶

type RoleParam =shared.RoleParam

This is an alias to an internal type.

typeRolePermissions ¶

type RolePermissions =shared.RolePermissions

This is an alias to an internal type.

typeRolePermissionsParam ¶

type RolePermissionsParam =shared.RolePermissionsParam

This is an alias to an internal type.

typeRuleCatchAllGetParams ¶

type RuleCatchAllGetParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`}

typeRuleCatchAllGetResponse ¶

type RuleCatchAllGetResponse struct {// Routing rule identifier.IDstring `json:"id"`// List actions for the catch-all routing rule.Actions []CatchAllAction `json:"actions"`// Routing rule status.EnabledRuleCatchAllGetResponseEnabled `json:"enabled"`// List of matchers for the catch-all routing rule.Matchers []CatchAllMatcher `json:"matchers"`// Routing rule name.Namestring `json:"name"`// Routing rule tag. (Deprecated, replaced by routing rule identifier)//// Deprecated: deprecatedTagstring                      `json:"tag"`JSON ruleCatchAllGetResponseJSON `json:"-"`}

func (*RuleCatchAllGetResponse)UnmarshalJSON ¶

func (r *RuleCatchAllGetResponse) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnabled ¶

type RuleCatchAllGetResponseEnabledbool

Routing rule status.

const (RuleCatchAllGetResponseEnabledTrueRuleCatchAllGetResponseEnabled =trueRuleCatchAllGetResponseEnabledFalseRuleCatchAllGetResponseEnabled =false)

func (RuleCatchAllGetResponseEnabled)IsKnown ¶

func (rRuleCatchAllGetResponseEnabled) IsKnown()bool

typeRuleCatchAllGetResponseEnvelope ¶

type RuleCatchAllGetResponseEnvelope struct {Errors   []RuleCatchAllGetResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleCatchAllGetResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleCatchAllGetResponseEnvelopeSuccess `json:"success,required"`ResultRuleCatchAllGetResponse                `json:"result"`JSON    ruleCatchAllGetResponseEnvelopeJSON    `json:"-"`}

func (*RuleCatchAllGetResponseEnvelope)UnmarshalJSON ¶

func (r *RuleCatchAllGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnvelopeErrors ¶added inv4.3.0

type RuleCatchAllGetResponseEnvelopeErrors struct {Codeint64                                       `json:"code,required"`Messagestring                                      `json:"message,required"`DocumentationURLstring                                      `json:"documentation_url"`SourceRuleCatchAllGetResponseEnvelopeErrorsSource `json:"source"`JSON             ruleCatchAllGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleCatchAllGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleCatchAllGetResponseEnvelopeErrorsSource struct {Pointerstring                                          `json:"pointer"`JSON    ruleCatchAllGetResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleCatchAllGetResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnvelopeMessages ¶added inv4.3.0

type RuleCatchAllGetResponseEnvelopeMessages struct {Codeint64                                         `json:"code,required"`Messagestring                                        `json:"message,required"`DocumentationURLstring                                        `json:"documentation_url"`SourceRuleCatchAllGetResponseEnvelopeMessagesSource `json:"source"`JSON             ruleCatchAllGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleCatchAllGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleCatchAllGetResponseEnvelopeMessagesSource struct {Pointerstring                                            `json:"pointer"`JSON    ruleCatchAllGetResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleCatchAllGetResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllGetResponseEnvelopeSuccess ¶

type RuleCatchAllGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleCatchAllGetResponseEnvelopeSuccessTrueRuleCatchAllGetResponseEnvelopeSuccess =true)

func (RuleCatchAllGetResponseEnvelopeSuccess)IsKnown ¶

func (rRuleCatchAllGetResponseEnvelopeSuccess) IsKnown()bool

typeRuleCatchAllService ¶

type RuleCatchAllService struct {Options []option.RequestOption}

RuleCatchAllService contains methods and other services that help withinteracting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewRuleCatchAllService method instead.

funcNewRuleCatchAllService ¶

func NewRuleCatchAllService(opts ...option.RequestOption) (r *RuleCatchAllService)

NewRuleCatchAllService generates a new service that applies the given options toeach request. These options are applied after the parent client's options (ifthere is one), and before any request-specific options.

func (*RuleCatchAllService)Get ¶

func (r *RuleCatchAllService) Get(ctxcontext.Context, queryRuleCatchAllGetParams, opts ...option.RequestOption) (res *RuleCatchAllGetResponse, errerror)

Get information on the default catch-all routing rule.

func (*RuleCatchAllService)Update ¶

func (r *RuleCatchAllService) Update(ctxcontext.Context, paramsRuleCatchAllUpdateParams, opts ...option.RequestOption) (res *RuleCatchAllUpdateResponse, errerror)

Enable or disable catch-all routing rule, or change action to forward tospecific destination address.

typeRuleCatchAllUpdateParams ¶

type RuleCatchAllUpdateParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// List actions for the catch-all routing rule.Actionsparam.Field[[]CatchAllActionParam] `json:"actions,required"`// List of matchers for the catch-all routing rule.Matchersparam.Field[[]CatchAllMatcherParam] `json:"matchers,required"`// Routing rule status.Enabledparam.Field[RuleCatchAllUpdateParamsEnabled] `json:"enabled"`// Routing rule name.Nameparam.Field[string] `json:"name"`}

func (RuleCatchAllUpdateParams)MarshalJSON ¶

func (rRuleCatchAllUpdateParams) MarshalJSON() (data []byte, errerror)

typeRuleCatchAllUpdateParamsEnabled ¶

type RuleCatchAllUpdateParamsEnabledbool

Routing rule status.

const (RuleCatchAllUpdateParamsEnabledTrueRuleCatchAllUpdateParamsEnabled =trueRuleCatchAllUpdateParamsEnabledFalseRuleCatchAllUpdateParamsEnabled =false)

func (RuleCatchAllUpdateParamsEnabled)IsKnown ¶

func (rRuleCatchAllUpdateParamsEnabled) IsKnown()bool

typeRuleCatchAllUpdateResponse ¶

type RuleCatchAllUpdateResponse struct {// Routing rule identifier.IDstring `json:"id"`// List actions for the catch-all routing rule.Actions []CatchAllAction `json:"actions"`// Routing rule status.EnabledRuleCatchAllUpdateResponseEnabled `json:"enabled"`// List of matchers for the catch-all routing rule.Matchers []CatchAllMatcher `json:"matchers"`// Routing rule name.Namestring `json:"name"`// Routing rule tag. (Deprecated, replaced by routing rule identifier)//// Deprecated: deprecatedTagstring                         `json:"tag"`JSON ruleCatchAllUpdateResponseJSON `json:"-"`}

func (*RuleCatchAllUpdateResponse)UnmarshalJSON ¶

func (r *RuleCatchAllUpdateResponse) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnabled ¶

type RuleCatchAllUpdateResponseEnabledbool

Routing rule status.

const (RuleCatchAllUpdateResponseEnabledTrueRuleCatchAllUpdateResponseEnabled =trueRuleCatchAllUpdateResponseEnabledFalseRuleCatchAllUpdateResponseEnabled =false)

func (RuleCatchAllUpdateResponseEnabled)IsKnown ¶

func (rRuleCatchAllUpdateResponseEnabled) IsKnown()bool

typeRuleCatchAllUpdateResponseEnvelope ¶

type RuleCatchAllUpdateResponseEnvelope struct {Errors   []RuleCatchAllUpdateResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleCatchAllUpdateResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleCatchAllUpdateResponseEnvelopeSuccess `json:"success,required"`ResultRuleCatchAllUpdateResponse                `json:"result"`JSON    ruleCatchAllUpdateResponseEnvelopeJSON    `json:"-"`}

func (*RuleCatchAllUpdateResponseEnvelope)UnmarshalJSON ¶

func (r *RuleCatchAllUpdateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnvelopeErrors ¶added inv4.3.0

type RuleCatchAllUpdateResponseEnvelopeErrors struct {Codeint64                                          `json:"code,required"`Messagestring                                         `json:"message,required"`DocumentationURLstring                                         `json:"documentation_url"`SourceRuleCatchAllUpdateResponseEnvelopeErrorsSource `json:"source"`JSON             ruleCatchAllUpdateResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleCatchAllUpdateResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleCatchAllUpdateResponseEnvelopeErrorsSource struct {Pointerstring                                             `json:"pointer"`JSON    ruleCatchAllUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleCatchAllUpdateResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnvelopeMessages ¶added inv4.3.0

type RuleCatchAllUpdateResponseEnvelopeMessages struct {Codeint64                                            `json:"code,required"`Messagestring                                           `json:"message,required"`DocumentationURLstring                                           `json:"documentation_url"`SourceRuleCatchAllUpdateResponseEnvelopeMessagesSource `json:"source"`JSON             ruleCatchAllUpdateResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleCatchAllUpdateResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleCatchAllUpdateResponseEnvelopeMessagesSource struct {Pointerstring                                               `json:"pointer"`JSON    ruleCatchAllUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleCatchAllUpdateResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleCatchAllUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleCatchAllUpdateResponseEnvelopeSuccess ¶

type RuleCatchAllUpdateResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleCatchAllUpdateResponseEnvelopeSuccessTrueRuleCatchAllUpdateResponseEnvelopeSuccess =true)

func (RuleCatchAllUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rRuleCatchAllUpdateResponseEnvelopeSuccess) IsKnown()bool

typeRuleDeleteParams ¶

type RuleDeleteParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`}

typeRuleDeleteResponseEnvelope ¶

type RuleDeleteResponseEnvelope struct {Errors   []RuleDeleteResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleDeleteResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleDeleteResponseEnvelopeSuccess `json:"success,required"`ResultEmailRoutingRule                  `json:"result"`JSON    ruleDeleteResponseEnvelopeJSON    `json:"-"`}

func (*RuleDeleteResponseEnvelope)UnmarshalJSON ¶

func (r *RuleDeleteResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseEnvelopeErrors ¶added inv4.3.0

type RuleDeleteResponseEnvelopeErrors struct {Codeint64                                  `json:"code,required"`Messagestring                                 `json:"message,required"`DocumentationURLstring                                 `json:"documentation_url"`SourceRuleDeleteResponseEnvelopeErrorsSource `json:"source"`JSON             ruleDeleteResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleDeleteResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleDeleteResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleDeleteResponseEnvelopeErrorsSource struct {Pointerstring                                     `json:"pointer"`JSON    ruleDeleteResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleDeleteResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleDeleteResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseEnvelopeMessages ¶added inv4.3.0

type RuleDeleteResponseEnvelopeMessages struct {Codeint64                                    `json:"code,required"`Messagestring                                   `json:"message,required"`DocumentationURLstring                                   `json:"documentation_url"`SourceRuleDeleteResponseEnvelopeMessagesSource `json:"source"`JSON             ruleDeleteResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleDeleteResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleDeleteResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleDeleteResponseEnvelopeMessagesSource struct {Pointerstring                                       `json:"pointer"`JSON    ruleDeleteResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleDeleteResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleDeleteResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleDeleteResponseEnvelopeSuccess ¶

type RuleDeleteResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleDeleteResponseEnvelopeSuccessTrueRuleDeleteResponseEnvelopeSuccess =true)

func (RuleDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rRuleDeleteResponseEnvelopeSuccess) IsKnown()bool

typeRuleGetParams ¶

type RuleGetParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`}

typeRuleGetResponseEnvelope ¶

type RuleGetResponseEnvelope struct {Errors   []RuleGetResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleGetResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleGetResponseEnvelopeSuccess `json:"success,required"`ResultEmailRoutingRule               `json:"result"`JSON    ruleGetResponseEnvelopeJSON    `json:"-"`}

func (*RuleGetResponseEnvelope)UnmarshalJSON ¶

func (r *RuleGetResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleGetResponseEnvelopeErrors ¶added inv4.3.0

type RuleGetResponseEnvelopeErrors struct {Codeint64                               `json:"code,required"`Messagestring                              `json:"message,required"`DocumentationURLstring                              `json:"documentation_url"`SourceRuleGetResponseEnvelopeErrorsSource `json:"source"`JSON             ruleGetResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleGetResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleGetResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleGetResponseEnvelopeErrorsSource struct {Pointerstring                                  `json:"pointer"`JSON    ruleGetResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleGetResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleGetResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleGetResponseEnvelopeMessages ¶added inv4.3.0

type RuleGetResponseEnvelopeMessages struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceRuleGetResponseEnvelopeMessagesSource `json:"source"`JSON             ruleGetResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleGetResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleGetResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleGetResponseEnvelopeMessagesSource struct {Pointerstring                                    `json:"pointer"`JSON    ruleGetResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleGetResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleGetResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleGetResponseEnvelopeSuccess ¶

type RuleGetResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleGetResponseEnvelopeSuccessTrueRuleGetResponseEnvelopeSuccess =true)

func (RuleGetResponseEnvelopeSuccess)IsKnown ¶

func (rRuleGetResponseEnvelopeSuccess) IsKnown()bool

typeRuleListParams ¶

type RuleListParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// Filter by enabled routing rules.Enabledparam.Field[RuleListParamsEnabled] `query:"enabled"`// Page number of paginated results.Pageparam.Field[float64] `query:"page"`// Maximum number of results per page.PerPageparam.Field[float64] `query:"per_page"`}

func (RuleListParams)URLQuery ¶

func (rRuleListParams) URLQuery() (vurl.Values)

URLQuery serializesRuleListParams's query parameters as `url.Values`.

typeRuleListParamsEnabled ¶

type RuleListParamsEnabledbool

Filter by enabled routing rules.

const (RuleListParamsEnabledTrueRuleListParamsEnabled =trueRuleListParamsEnabledFalseRuleListParamsEnabled =false)

func (RuleListParamsEnabled)IsKnown ¶

func (rRuleListParamsEnabled) IsKnown()bool

typeRuleNewParams ¶

type RuleNewParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// List actions patterns.Actionsparam.Field[[]ActionParam] `json:"actions,required"`// Matching patterns to forward to your actions.Matchersparam.Field[[]MatcherParam] `json:"matchers,required"`// Routing rule status.Enabledparam.Field[RuleNewParamsEnabled] `json:"enabled"`// Routing rule name.Nameparam.Field[string] `json:"name"`// Priority of the routing rule.Priorityparam.Field[float64] `json:"priority"`}

func (RuleNewParams)MarshalJSON ¶

func (rRuleNewParams) MarshalJSON() (data []byte, errerror)

typeRuleNewParamsEnabled ¶

type RuleNewParamsEnabledbool

Routing rule status.

const (RuleNewParamsEnabledTrueRuleNewParamsEnabled =trueRuleNewParamsEnabledFalseRuleNewParamsEnabled =false)

func (RuleNewParamsEnabled)IsKnown ¶

func (rRuleNewParamsEnabled) IsKnown()bool

typeRuleNewResponseEnvelope ¶

type RuleNewResponseEnvelope struct {Errors   []RuleNewResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleNewResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleNewResponseEnvelopeSuccess `json:"success,required"`ResultEmailRoutingRule               `json:"result"`JSON    ruleNewResponseEnvelopeJSON    `json:"-"`}

func (*RuleNewResponseEnvelope)UnmarshalJSON ¶

func (r *RuleNewResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleNewResponseEnvelopeErrors ¶added inv4.3.0

type RuleNewResponseEnvelopeErrors struct {Codeint64                               `json:"code,required"`Messagestring                              `json:"message,required"`DocumentationURLstring                              `json:"documentation_url"`SourceRuleNewResponseEnvelopeErrorsSource `json:"source"`JSON             ruleNewResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleNewResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleNewResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleNewResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleNewResponseEnvelopeErrorsSource struct {Pointerstring                                  `json:"pointer"`JSON    ruleNewResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleNewResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleNewResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleNewResponseEnvelopeMessages ¶added inv4.3.0

type RuleNewResponseEnvelopeMessages struct {Codeint64                                 `json:"code,required"`Messagestring                                `json:"message,required"`DocumentationURLstring                                `json:"documentation_url"`SourceRuleNewResponseEnvelopeMessagesSource `json:"source"`JSON             ruleNewResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleNewResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleNewResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleNewResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleNewResponseEnvelopeMessagesSource struct {Pointerstring                                    `json:"pointer"`JSON    ruleNewResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleNewResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleNewResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleNewResponseEnvelopeSuccess ¶

type RuleNewResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleNewResponseEnvelopeSuccessTrueRuleNewResponseEnvelopeSuccess =true)

func (RuleNewResponseEnvelopeSuccess)IsKnown ¶

func (rRuleNewResponseEnvelopeSuccess) IsKnown()bool

typeRuleService ¶

type RuleService struct {Options   []option.RequestOptionCatchAlls *RuleCatchAllService}

RuleService contains methods and other services that help with interacting withthe cloudflare API.

Note, unlike clients, this service does not read variables from the environmentautomatically. You should not instantiate this service directly, and instead usetheNewRuleService method instead.

funcNewRuleService ¶

func NewRuleService(opts ...option.RequestOption) (r *RuleService)

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

func (*RuleService)Delete ¶

func (r *RuleService) Delete(ctxcontext.Context, ruleIdentifierstring, bodyRuleDeleteParams, opts ...option.RequestOption) (res *EmailRoutingRule, errerror)

Delete a specific routing rule.

func (*RuleService)Get ¶

func (r *RuleService) Get(ctxcontext.Context, ruleIdentifierstring, queryRuleGetParams, opts ...option.RequestOption) (res *EmailRoutingRule, errerror)

Get information for a specific routing rule already created.

func (*RuleService)List ¶

func (r *RuleService) List(ctxcontext.Context, paramsRuleListParams, opts ...option.RequestOption) (res *pagination.V4PagePaginationArray[EmailRoutingRule], errerror)

Lists existing routing rules.

func (*RuleService)ListAutoPaging ¶

func (r *RuleService) ListAutoPaging(ctxcontext.Context, paramsRuleListParams, opts ...option.RequestOption) *pagination.V4PagePaginationArrayAutoPager[EmailRoutingRule]

Lists existing routing rules.

func (*RuleService)New ¶

func (r *RuleService) New(ctxcontext.Context, paramsRuleNewParams, opts ...option.RequestOption) (res *EmailRoutingRule, errerror)

Rules consist of a set of criteria for matching emails (such as an email beingsent to a specific custom email address) plus a set of actions to take on theemail (like forwarding it to a specific destination address).

func (*RuleService)Update ¶

func (r *RuleService) Update(ctxcontext.Context, ruleIdentifierstring, paramsRuleUpdateParams, opts ...option.RequestOption) (res *EmailRoutingRule, errerror)

Update actions and matches, or enable/disable specific routing rules.

typeRuleUpdateParams ¶

type RuleUpdateParams struct {// Identifier.ZoneIDparam.Field[string] `path:"zone_id,required"`// List actions patterns.Actionsparam.Field[[]ActionParam] `json:"actions,required"`// Matching patterns to forward to your actions.Matchersparam.Field[[]MatcherParam] `json:"matchers,required"`// Routing rule status.Enabledparam.Field[RuleUpdateParamsEnabled] `json:"enabled"`// Routing rule name.Nameparam.Field[string] `json:"name"`// Priority of the routing rule.Priorityparam.Field[float64] `json:"priority"`}

func (RuleUpdateParams)MarshalJSON ¶

func (rRuleUpdateParams) MarshalJSON() (data []byte, errerror)

typeRuleUpdateParamsEnabled ¶

type RuleUpdateParamsEnabledbool

Routing rule status.

const (RuleUpdateParamsEnabledTrueRuleUpdateParamsEnabled =trueRuleUpdateParamsEnabledFalseRuleUpdateParamsEnabled =false)

func (RuleUpdateParamsEnabled)IsKnown ¶

func (rRuleUpdateParamsEnabled) IsKnown()bool

typeRuleUpdateResponseEnvelope ¶

type RuleUpdateResponseEnvelope struct {Errors   []RuleUpdateResponseEnvelopeErrors   `json:"errors,required"`Messages []RuleUpdateResponseEnvelopeMessages `json:"messages,required"`// Whether the API call was successful.SuccessRuleUpdateResponseEnvelopeSuccess `json:"success,required"`ResultEmailRoutingRule                  `json:"result"`JSON    ruleUpdateResponseEnvelopeJSON    `json:"-"`}

func (*RuleUpdateResponseEnvelope)UnmarshalJSON ¶

func (r *RuleUpdateResponseEnvelope) UnmarshalJSON(data []byte) (errerror)

typeRuleUpdateResponseEnvelopeErrors ¶added inv4.3.0

type RuleUpdateResponseEnvelopeErrors struct {Codeint64                                  `json:"code,required"`Messagestring                                 `json:"message,required"`DocumentationURLstring                                 `json:"documentation_url"`SourceRuleUpdateResponseEnvelopeErrorsSource `json:"source"`JSON             ruleUpdateResponseEnvelopeErrorsJSON   `json:"-"`}

func (*RuleUpdateResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

func (r *RuleUpdateResponseEnvelopeErrors) UnmarshalJSON(data []byte) (errerror)

typeRuleUpdateResponseEnvelopeErrorsSource ¶added inv4.3.0

type RuleUpdateResponseEnvelopeErrorsSource struct {Pointerstring                                     `json:"pointer"`JSON    ruleUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`}

func (*RuleUpdateResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleUpdateResponseEnvelopeErrorsSource) UnmarshalJSON(data []byte) (errerror)

typeRuleUpdateResponseEnvelopeMessages ¶added inv4.3.0

type RuleUpdateResponseEnvelopeMessages struct {Codeint64                                    `json:"code,required"`Messagestring                                   `json:"message,required"`DocumentationURLstring                                   `json:"documentation_url"`SourceRuleUpdateResponseEnvelopeMessagesSource `json:"source"`JSON             ruleUpdateResponseEnvelopeMessagesJSON   `json:"-"`}

func (*RuleUpdateResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

func (r *RuleUpdateResponseEnvelopeMessages) UnmarshalJSON(data []byte) (errerror)

typeRuleUpdateResponseEnvelopeMessagesSource ¶added inv4.3.0

type RuleUpdateResponseEnvelopeMessagesSource struct {Pointerstring                                       `json:"pointer"`JSON    ruleUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`}

func (*RuleUpdateResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

func (r *RuleUpdateResponseEnvelopeMessagesSource) UnmarshalJSON(data []byte) (errerror)

typeRuleUpdateResponseEnvelopeSuccess ¶

type RuleUpdateResponseEnvelopeSuccessbool

Whether the API call was successful.

const (RuleUpdateResponseEnvelopeSuccessTrueRuleUpdateResponseEnvelopeSuccess =true)

func (RuleUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rRuleUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSettings ¶

type Settings struct {// Email Routing settings identifier.IDstring `json:"id,required"`// State of the zone settings for Email Routing.EnabledSettingsEnabled `json:"enabled,required"`// Domain of your zone.Namestring `json:"name,required"`// The date and time the settings have been created.Createdtime.Time `json:"created" format:"date-time"`// The date and time the settings have been modified.Modifiedtime.Time `json:"modified" format:"date-time"`// Flag to check if the user skipped the configuration wizard.SkipWizardSettingsSkipWizard `json:"skip_wizard"`// Show the state of your account, and the type or configuration error.StatusSettingsStatus `json:"status"`// Email Routing settings tag. (Deprecated, replaced by Email Routing settings// identifier)//// Deprecated: deprecatedTagstring       `json:"tag"`JSON settingsJSON `json:"-"`}

func (*Settings)UnmarshalJSON ¶

func (r *Settings) UnmarshalJSON(data []byte) (errerror)

typeSettingsEnabled ¶

type SettingsEnabledbool

State of the zone settings for Email Routing.

const (SettingsEnabledTrueSettingsEnabled =trueSettingsEnabledFalseSettingsEnabled =false)

func (SettingsEnabled)IsKnown ¶

func (rSettingsEnabled) IsKnown()bool

typeSettingsSkipWizard ¶

type SettingsSkipWizardbool

Flag to check if the user skipped the configuration wizard.

const (SettingsSkipWizardTrueSettingsSkipWizard =trueSettingsSkipWizardFalseSettingsSkipWizard =false)

func (SettingsSkipWizard)IsKnown ¶

func (rSettingsSkipWizard) IsKnown()bool

typeSettingsStatus ¶

type SettingsStatusstring

Show the state of your account, and the type or configuration error.

const (SettingsStatusReadySettingsStatus = "ready"SettingsStatusUnconfiguredSettingsStatus = "unconfigured"SettingsStatusMisconfiguredSettingsStatus = "misconfigured"SettingsStatusMisconfiguredLockedSettingsStatus = "misconfigured/locked"SettingsStatusUnlockedSettingsStatus = "unlocked")

func (SettingsStatus)IsKnown ¶

func (rSettingsStatus) IsKnown()bool

typeSortDirection ¶

type SortDirection =shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

typeSubscription ¶

type Subscription =shared.Subscription

This is an alias to an internal type.

typeSubscriptionFrequency ¶

type SubscriptionFrequency =shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

typeSubscriptionParam ¶

type SubscriptionParam =shared.SubscriptionParam

This is an alias to an internal type.

typeSubscriptionState ¶

type SubscriptionState =shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

typeToken ¶

type Token =shared.Token

This is an alias to an internal type.

typeTokenCondition ¶

type TokenCondition =shared.TokenCondition

This is an alias to an internal type.

typeTokenConditionCIDRList ¶

type TokenConditionCIDRList =shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam =shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionParam ¶

type TokenConditionParam =shared.TokenConditionParam

This is an alias to an internal type.

typeTokenConditionRequestIP ¶

type TokenConditionRequestIP =shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

typeTokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam =shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

typeTokenParam ¶

type TokenParam =shared.TokenParam

This is an alias to an internal type.

typeTokenPolicy ¶

type TokenPolicy =shared.TokenPolicy

This is an alias to an internal type.

typeTokenPolicyEffect ¶

type TokenPolicyEffect =shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

typeTokenPolicyParam ¶

type TokenPolicyParam =shared.TokenPolicyParam

This is an alias to an internal type.

typeTokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup =shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam =shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations againstresources.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta =shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam =shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyResourcesMap ¶added inv4.6.0

type TokenPolicyResourcesMap =shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesMapParam ¶added inv4.6.0

type TokenPolicyResourcesMapParam =shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesUnion ¶added inv4.6.0

type TokenPolicyResourcesUnion =shared.TokenPolicyResourcesUnion

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenPolicyResourcesUnionParam ¶added inv4.6.0

type TokenPolicyResourcesUnionParam =shared.TokenPolicyResourcesUnionParam

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

typeTokenStatus ¶

type TokenStatus =shared.TokenStatus

Status of the token.

This is an alias to an internal type.

typeTokenValue ¶

type TokenValue =shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files¶

View all Source files

?	: This menu
/	: Search site
f orF	: Jump to
y orY	: Canonical URL

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Index¶

Constants¶

Variables¶

Functions¶

Types¶

typeASN¶

typeASNParam¶

typeAction¶

func (*Action)UnmarshalJSON¶

typeActionParam¶

func (ActionParam)MarshalJSON¶

typeActionType¶

func (ActionType)IsKnown¶

typeAddress¶

func (*Address)UnmarshalJSON¶

typeAddressDeleteParams¶

typeAddressDeleteResponseEnvelope¶

func (*AddressDeleteResponseEnvelope)UnmarshalJSON¶

typeAddressDeleteResponseEnvelopeErrors¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeErrors)UnmarshalJSON¶added inv4.3.0

typeAddressDeleteResponseEnvelopeErrorsSource¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeErrorsSource)UnmarshalJSON¶added inv4.3.0

typeAddressDeleteResponseEnvelopeMessages¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeMessages)UnmarshalJSON¶added inv4.3.0

typeAddressDeleteResponseEnvelopeMessagesSource¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeMessagesSource)UnmarshalJSON¶added inv4.3.0

typeAddressDeleteResponseEnvelopeSuccess¶

func (AddressDeleteResponseEnvelopeSuccess)IsKnown¶

typeAddressGetParams¶

typeAddressGetResponseEnvelope¶

func (*AddressGetResponseEnvelope)UnmarshalJSON¶

typeAddressGetResponseEnvelopeErrors¶added inv4.3.0

func (*AddressGetResponseEnvelopeErrors)UnmarshalJSON¶added inv4.3.0

typeAddressGetResponseEnvelopeErrorsSource¶added inv4.3.0

func (*AddressGetResponseEnvelopeErrorsSource)UnmarshalJSON¶added inv4.3.0

typeAddressGetResponseEnvelopeMessages¶added inv4.3.0

func (*AddressGetResponseEnvelopeMessages)UnmarshalJSON¶added inv4.3.0

typeAddressGetResponseEnvelopeMessagesSource¶added inv4.3.0

func (*AddressGetResponseEnvelopeMessagesSource)UnmarshalJSON¶added inv4.3.0

typeAddressGetResponseEnvelopeSuccess¶

func (AddressGetResponseEnvelopeSuccess)IsKnown¶

typeAddressListParams¶

func (AddressListParams)URLQuery¶

typeAddressListParamsDirection¶

func (AddressListParamsDirection)IsKnown¶

typeAddressListParamsVerified¶

func (AddressListParamsVerified)IsKnown¶

typeAddressNewParams¶

func (AddressNewParams)MarshalJSON¶

typeAddressNewResponseEnvelope¶

func (*AddressNewResponseEnvelope)UnmarshalJSON¶

typeAddressNewResponseEnvelopeErrors¶added inv4.3.0

func (*AddressNewResponseEnvelopeErrors)UnmarshalJSON¶added inv4.3.0

typeAddressNewResponseEnvelopeErrorsSource¶added inv4.3.0

func (*AddressNewResponseEnvelopeErrorsSource)UnmarshalJSON¶added inv4.3.0

typeAddressNewResponseEnvelopeMessages¶added inv4.3.0

func (*AddressNewResponseEnvelopeMessages)UnmarshalJSON¶added inv4.3.0

typeAddressNewResponseEnvelopeMessagesSource¶added inv4.3.0

func (*AddressNewResponseEnvelopeMessagesSource)UnmarshalJSON¶added inv4.3.0

typeAddressNewResponseEnvelopeSuccess¶

func (AddressNewResponseEnvelopeSuccess)IsKnown¶

typeAddressService¶

funcNewAddressService¶

func (*AddressService)Delete¶

func (*AddressService)Get¶

func (*AddressService)List¶

func (*AddressService)ListAutoPaging¶

func (*AddressService)New¶

typeAuditLog¶

typeAuditLogAction¶

typeAuditLogActor¶

typeAuditLogActorType¶

typeAuditLogOwner¶

typeAuditLogResource¶

typeCatchAllAction¶

Documentation ¶

typeASN ¶

typeASNParam ¶

typeAction ¶

func (*Action)UnmarshalJSON ¶

typeActionParam ¶

func (ActionParam)MarshalJSON ¶

typeActionType ¶

func (ActionType)IsKnown ¶

typeAddress ¶

func (*Address)UnmarshalJSON ¶

typeAddressDeleteParams ¶

typeAddressDeleteResponseEnvelope ¶

func (*AddressDeleteResponseEnvelope)UnmarshalJSON ¶

typeAddressDeleteResponseEnvelopeErrors ¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

typeAddressDeleteResponseEnvelopeErrorsSource ¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

typeAddressDeleteResponseEnvelopeMessages ¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

typeAddressDeleteResponseEnvelopeMessagesSource ¶added inv4.3.0

func (*AddressDeleteResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

typeAddressDeleteResponseEnvelopeSuccess ¶

func (AddressDeleteResponseEnvelopeSuccess)IsKnown ¶

typeAddressGetParams ¶

typeAddressGetResponseEnvelope ¶

func (*AddressGetResponseEnvelope)UnmarshalJSON ¶

typeAddressGetResponseEnvelopeErrors ¶added inv4.3.0

func (*AddressGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

typeAddressGetResponseEnvelopeErrorsSource ¶added inv4.3.0

func (*AddressGetResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

typeAddressGetResponseEnvelopeMessages ¶added inv4.3.0

func (*AddressGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

typeAddressGetResponseEnvelopeMessagesSource ¶added inv4.3.0

func (*AddressGetResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

typeAddressGetResponseEnvelopeSuccess ¶

func (AddressGetResponseEnvelopeSuccess)IsKnown ¶

typeAddressListParams ¶

func (AddressListParams)URLQuery ¶

typeAddressListParamsDirection ¶

func (AddressListParamsDirection)IsKnown ¶

typeAddressListParamsVerified ¶

func (AddressListParamsVerified)IsKnown ¶

typeAddressNewParams ¶

func (AddressNewParams)MarshalJSON ¶

typeAddressNewResponseEnvelope ¶

func (*AddressNewResponseEnvelope)UnmarshalJSON ¶

typeAddressNewResponseEnvelopeErrors ¶added inv4.3.0

func (*AddressNewResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.3.0

typeAddressNewResponseEnvelopeErrorsSource ¶added inv4.3.0

func (*AddressNewResponseEnvelopeErrorsSource)UnmarshalJSON ¶added inv4.3.0

typeAddressNewResponseEnvelopeMessages ¶added inv4.3.0

func (*AddressNewResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.3.0

typeAddressNewResponseEnvelopeMessagesSource ¶added inv4.3.0

func (*AddressNewResponseEnvelopeMessagesSource)UnmarshalJSON ¶added inv4.3.0

typeAddressNewResponseEnvelopeSuccess ¶

func (AddressNewResponseEnvelopeSuccess)IsKnown ¶

typeAddressService ¶

funcNewAddressService ¶

func (*AddressService)Delete ¶

func (*AddressService)Get ¶

func (*AddressService)List ¶

func (*AddressService)ListAutoPaging ¶

func (*AddressService)New ¶

typeAuditLog ¶

typeAuditLogAction ¶

typeAuditLogActor ¶

typeAuditLogActorType ¶

typeAuditLogOwner ¶

typeAuditLogResource ¶

typeCatchAllAction ¶

func (*CatchAllAction)UnmarshalJSON ¶

typeCatchAllActionParam ¶

func (CatchAllActionParam)MarshalJSON ¶

typeCatchAllActionType ¶

func (CatchAllActionType)IsKnown ¶

typeCatchAllMatcher ¶

func (*CatchAllMatcher)UnmarshalJSON ¶

typeCatchAllMatcherParam ¶

func (CatchAllMatcherParam)MarshalJSON ¶