dls

package
v7.5.0 Latest Latest
Warning

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

 Go to latest Published: Jun 10, 2026 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source 
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source 
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source 
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source 
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source 
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source 
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source 
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source 
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source 
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source 
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source 
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source 
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source 
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source 
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source 
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source 
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source 
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source 
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source 
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source 
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source 
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source 
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source 
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source 
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source 
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source 
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source 
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source 
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source 
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source 
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source 
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source 
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source 
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source 
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN 

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam 

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog 

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction 

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor 

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType 

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner 

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource 

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA 

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate.

This is an alias to an internal type.

type CertificateRequestType 

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel 

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc 

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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

This is an alias to an internal type.

type CloudflareTunnelConnection 

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus 

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType 

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type DLSService 

type DLSService struct {
	Options          []option.RequestOption
	Regions          *RegionService
	RegionalServices *RegionalServiceService
}

DLSService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewDLSService method instead.

func NewDLSService 

func NewDLSService(opts ...option.RequestOption) (r *DLSService)

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

type Error 

type Error = apierror.Error

type ErrorData 

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource 

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member 

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess 

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup 

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta 

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup 

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta 

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope 

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject 

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy 

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus 

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser 

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission 

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant 

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam 

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan 

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID 

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam 

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type RegionGetParams 

type RegionGetParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type RegionGetResponse 

type RegionGetResponse struct {
	ID               string                `json:"id" api:"required"`
	CreatedOn        time.Time             `json:"created_on" api:"required" format:"date-time"`
	ModifiedOn       time.Time             `json:"modified_on" api:"required" format:"date-time"`
	Name             string                `json:"name" api:"required"`
	RegionKey        string                `json:"region_key" api:"required"`
	Version          int64                 `json:"version" api:"required"`
	VersionCreatedOn time.Time             `json:"version_created_on" api:"required" format:"date-time"`
	JSON             regionGetResponseJSON `json:"-"`
}

func (*RegionGetResponse) UnmarshalJSON 

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

type RegionGetResponseEnvelope 

type RegionGetResponseEnvelope struct {
	Messages []shared.ResponseInfo         `json:"messages" api:"required"`
	Result   RegionGetResponse             `json:"result" api:"required"`
	Success  bool                          `json:"success" api:"required"`
	Errors   []shared.ResponseInfo         `json:"errors"`
	JSON     regionGetResponseEnvelopeJSON `json:"-"`
}

func (*RegionGetResponseEnvelope) UnmarshalJSON 

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

type RegionListParams 

type RegionListParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Opaque token for cursor-based pagination. Omit for the first page. Pass the
	// value from a previous response to fetch the next page.
	Cursor  param.Field[string] `query:"cursor"`
	PerPage param.Field[int64]  `query:"per_page"`
	// Filter regions by type. Omit to return all regions.
	Type param.Field[RegionListParamsType] `query:"type"`
}

func (RegionListParams) URLQuery 

func (r RegionListParams) URLQuery() (v url.Values)

URLQuery serializes RegionListParams's query parameters as `url.Values`.

type RegionListParamsType 

type RegionListParamsType string

Filter regions by type. Omit to return all regions. 

const (
	RegionListParamsTypeManaged RegionListParamsType = "managed"
	RegionListParamsTypeCustom  RegionListParamsType = "custom"
)

func (RegionListParamsType) IsKnown 

func (r RegionListParamsType) IsKnown() bool

type RegionListResponse 

type RegionListResponse struct {
	ID               string                 `json:"id" api:"required"`
	CreatedOn        time.Time              `json:"created_on" api:"required" format:"date-time"`
	ModifiedOn       time.Time              `json:"modified_on" api:"required" format:"date-time"`
	Name             string                 `json:"name" api:"required"`
	RegionKey        string                 `json:"region_key" api:"required"`
	Version          int64                  `json:"version" api:"required"`
	VersionCreatedOn time.Time              `json:"version_created_on" api:"required" format:"date-time"`
	JSON             regionListResponseJSON `json:"-"`
}

func (*RegionListResponse) UnmarshalJSON 

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

type RegionService 

type RegionService struct {
	Options []option.RequestOption
}

RegionService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRegionService method instead.

func NewRegionService 

func NewRegionService(opts ...option.RequestOption) (r *RegionService)

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

func (*RegionService) Get 

func (r *RegionService) Get(ctx context.Context, regionID string, query RegionGetParams, opts ...option.RequestOption) (res *RegionGetResponse, err error)

Get a DLS region

func (*RegionService) List 

func (r *RegionService) List(ctx context.Context, params RegionListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[RegionListResponse], err error)

List DLS regions for an account

func (*RegionService) ListAutoPaging 

func (r *RegionService) ListAutoPaging(ctx context.Context, params RegionListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[RegionListResponse]

List DLS regions for an account

type RegionalServicePrefixBindingDeleteParams 

type RegionalServicePrefixBindingDeleteParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type RegionalServicePrefixBindingDeleteResponse 

type RegionalServicePrefixBindingDeleteResponse struct {
	Messages []shared.ResponseInfo                          `json:"messages" api:"required"`
	Success  bool                                           `json:"success" api:"required"`
	Errors   []shared.ResponseInfo                          `json:"errors"`
	JSON     regionalServicePrefixBindingDeleteResponseJSON `json:"-"`
}

func (*RegionalServicePrefixBindingDeleteResponse) UnmarshalJSON 

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

type RegionalServicePrefixBindingEditParams 

type RegionalServicePrefixBindingEditParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// New region key to assign (e.g., "us", "eu", "cfcanary").
	RegionKey param.Field[string] `json:"region_key" api:"required"`
}

func (RegionalServicePrefixBindingEditParams) MarshalJSON 

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

type RegionalServicePrefixBindingEditResponse 

type RegionalServicePrefixBindingEditResponse struct {
	// The ID of the binding.
	ID string `json:"id" api:"required"`
	// The CIDR that is bound.
	CIDR string `json:"cidr" api:"required"`
	// The ID of the parent prefix.
	PrefixID string `json:"prefix_id" api:"required"`
	// The region key used for the binding.
	RegionKey string                                       `json:"region_key" api:"required"`
	JSON      regionalServicePrefixBindingEditResponseJSON `json:"-"`
}

func (*RegionalServicePrefixBindingEditResponse) UnmarshalJSON 

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

type RegionalServicePrefixBindingEditResponseEnvelope 

type RegionalServicePrefixBindingEditResponseEnvelope struct {
	Messages []shared.ResponseInfo                                `json:"messages" api:"required"`
	Result   RegionalServicePrefixBindingEditResponse             `json:"result" api:"required"`
	Success  bool                                                 `json:"success" api:"required"`
	Errors   []shared.ResponseInfo                                `json:"errors"`
	JSON     regionalServicePrefixBindingEditResponseEnvelopeJSON `json:"-"`
}

func (*RegionalServicePrefixBindingEditResponseEnvelope) UnmarshalJSON 

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

type RegionalServicePrefixBindingGetParams 

type RegionalServicePrefixBindingGetParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
}

type RegionalServicePrefixBindingGetResponse 

type RegionalServicePrefixBindingGetResponse struct {
	// The ID of the binding.
	ID string `json:"id" api:"required"`
	// The CIDR that is bound.
	CIDR string `json:"cidr" api:"required"`
	// The ID of the parent prefix.
	PrefixID string `json:"prefix_id" api:"required"`
	// The region key used for the binding.
	RegionKey string                                      `json:"region_key" api:"required"`
	JSON      regionalServicePrefixBindingGetResponseJSON `json:"-"`
}

func (*RegionalServicePrefixBindingGetResponse) UnmarshalJSON 

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

type RegionalServicePrefixBindingGetResponseEnvelope 

type RegionalServicePrefixBindingGetResponseEnvelope struct {
	Messages []shared.ResponseInfo                               `json:"messages" api:"required"`
	Result   RegionalServicePrefixBindingGetResponse             `json:"result" api:"required"`
	Success  bool                                                `json:"success" api:"required"`
	Errors   []shared.ResponseInfo                               `json:"errors"`
	JSON     regionalServicePrefixBindingGetResponseEnvelopeJSON `json:"-"`
}

func (*RegionalServicePrefixBindingGetResponseEnvelope) UnmarshalJSON 

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

type RegionalServicePrefixBindingListParams 

type RegionalServicePrefixBindingListParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// Opaque token for cursor-based pagination. Omit for the first page. Pass the
	// value from a previous response to fetch the next page.
	Cursor  param.Field[string] `query:"cursor"`
	PerPage param.Field[int64]  `query:"per_page"`
}

func (RegionalServicePrefixBindingListParams) URLQuery 

func (r RegionalServicePrefixBindingListParams) URLQuery() (v url.Values)

URLQuery serializes RegionalServicePrefixBindingListParams's query parameters as `url.Values`.

type RegionalServicePrefixBindingListResponse 

type RegionalServicePrefixBindingListResponse struct {
	// The ID of the binding.
	ID string `json:"id" api:"required"`
	// The CIDR that is bound.
	CIDR string `json:"cidr" api:"required"`
	// The ID of the parent prefix.
	PrefixID string `json:"prefix_id" api:"required"`
	// The region key used for the binding.
	RegionKey string                                       `json:"region_key" api:"required"`
	JSON      regionalServicePrefixBindingListResponseJSON `json:"-"`
}

func (*RegionalServicePrefixBindingListResponse) UnmarshalJSON 

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

type RegionalServicePrefixBindingNewParams 

type RegionalServicePrefixBindingNewParams struct {
	// Identifier of a Cloudflare account.
	AccountID param.Field[string] `path:"account_id" api:"required"`
	// IP prefix in CIDR notation to bind.
	CIDR param.Field[string] `json:"cidr" api:"required"`
	// The ID of the parent IP prefix that contains the CIDR.
	PrefixID param.Field[string] `json:"prefix_id" api:"required"`
	// Region key from managed regions (e.g., "us", "eu").
	RegionKey param.Field[string] `json:"region_key" api:"required"`
}

func (RegionalServicePrefixBindingNewParams) MarshalJSON 

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

type RegionalServicePrefixBindingNewResponse 

type RegionalServicePrefixBindingNewResponse struct {
	// The ID of the binding.
	ID string `json:"id" api:"required"`
	// The CIDR that is bound.
	CIDR string `json:"cidr" api:"required"`
	// The ID of the parent prefix.
	PrefixID string `json:"prefix_id" api:"required"`
	// The region key used for the binding.
	RegionKey string                                      `json:"region_key" api:"required"`
	JSON      regionalServicePrefixBindingNewResponseJSON `json:"-"`
}

func (*RegionalServicePrefixBindingNewResponse) UnmarshalJSON 

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

type RegionalServicePrefixBindingNewResponseEnvelope 

type RegionalServicePrefixBindingNewResponseEnvelope struct {
	Messages []shared.ResponseInfo                               `json:"messages" api:"required"`
	Result   RegionalServicePrefixBindingNewResponse             `json:"result" api:"required"`
	Success  bool                                                `json:"success" api:"required"`
	Errors   []shared.ResponseInfo                               `json:"errors"`
	JSON     regionalServicePrefixBindingNewResponseEnvelopeJSON `json:"-"`
}

func (*RegionalServicePrefixBindingNewResponseEnvelope) UnmarshalJSON 

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

type RegionalServicePrefixBindingService 

type RegionalServicePrefixBindingService struct {
	Options []option.RequestOption
}

RegionalServicePrefixBindingService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRegionalServicePrefixBindingService method instead.

func NewRegionalServicePrefixBindingService 

func NewRegionalServicePrefixBindingService(opts ...option.RequestOption) (r *RegionalServicePrefixBindingService)

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

func (*RegionalServicePrefixBindingService) Delete 

func (r *RegionalServicePrefixBindingService) Delete(ctx context.Context, bindingID string, body RegionalServicePrefixBindingDeleteParams, opts ...option.RequestOption) (res *RegionalServicePrefixBindingDeleteResponse, err error)

Delete a DLS prefix binding

func (*RegionalServicePrefixBindingService) Edit 

func (r *RegionalServicePrefixBindingService) Edit(ctx context.Context, bindingID string, params RegionalServicePrefixBindingEditParams, opts ...option.RequestOption) (res *RegionalServicePrefixBindingEditResponse, err error)

Update a DLS prefix binding

func (*RegionalServicePrefixBindingService) Get 

func (r *RegionalServicePrefixBindingService) Get(ctx context.Context, bindingID string, query RegionalServicePrefixBindingGetParams, opts ...option.RequestOption) (res *RegionalServicePrefixBindingGetResponse, err error)

Get a DLS prefix binding

func (*RegionalServicePrefixBindingService) List 

func (r *RegionalServicePrefixBindingService) List(ctx context.Context, params RegionalServicePrefixBindingListParams, opts ...option.RequestOption) (res *pagination.CursorPagination[RegionalServicePrefixBindingListResponse], err error)

List DLS prefix bindings for an account

func (*RegionalServicePrefixBindingService) ListAutoPaging 

func (r *RegionalServicePrefixBindingService) ListAutoPaging(ctx context.Context, params RegionalServicePrefixBindingListParams, opts ...option.RequestOption) *pagination.CursorPaginationAutoPager[RegionalServicePrefixBindingListResponse]

List DLS prefix bindings for an account

func (*RegionalServicePrefixBindingService) New 

func (r *RegionalServicePrefixBindingService) New(ctx context.Context, params RegionalServicePrefixBindingNewParams, opts ...option.RequestOption) (res *RegionalServicePrefixBindingNewResponse, err error)

Create a DLS prefix binding

type RegionalServiceService 

type RegionalServiceService struct {
	Options        []option.RequestOption
	PrefixBindings *RegionalServicePrefixBindingService
}

RegionalServiceService contains methods and other services that help with interacting with the cloudflare API.

Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewRegionalServiceService method instead.

func NewRegionalServiceService 

func NewRegionalServiceService(opts ...option.RequestOption) (r *RegionalServiceService)

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

type ResponseInfo 

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource 

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role 

type Role = shared.Role

This is an alias to an internal type.

type RoleParam 

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions 

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam 

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection 

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription 

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency 

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam 

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState 

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token 

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition 

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList 

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam 

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam 

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP 

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam 

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam 

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy 

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect 

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam 

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup 

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam 

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta 

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam 

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested 

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam 

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString 

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam 

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion 

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam 

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus 

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue 

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Source Files

View all Source files

Jump to

Keyboard shortcuts

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