network_interconnects

package
v6.0.1 Latest Latest
Warning

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

Go to latest
Published: Sep 11, 2025 License: Apache-2.0 Imports: 14 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 CNIDeleteParams

type CNIDeleteParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type CNIGetParams

type CNIGetParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type CNIGetResponse

type CNIGetResponse struct {
	ID string `json:"id,required" format:"uuid"`
	// Customer account tag
	Account string `json:"account,required"`
	// Customer end of the point-to-point link
	//
	// This should always be inside the same prefix as `p2p_ip`.
	CustIP string `json:"cust_ip,required" format:"A.B.C.D/N"`
	// Interconnect identifier hosting this CNI
	Interconnect string              `json:"interconnect,required"`
	Magic        CNIGetResponseMagic `json:"magic,required"`
	// Cloudflare end of the point-to-point link
	P2pIP string             `json:"p2p_ip,required" format:"A.B.C.D/N"`
	BGP   CNIGetResponseBGP  `json:"bgp"`
	JSON  cniGetResponseJSON `json:"-"`
}

func (*CNIGetResponse) UnmarshalJSON

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

type CNIGetResponseBGP

type CNIGetResponseBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN int64 `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes []string `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key string                `json:"md5_key,nullable"`
	JSON   cniGetResponseBGPJSON `json:"-"`
}

func (*CNIGetResponseBGP) UnmarshalJSON

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

type CNIGetResponseMagic

type CNIGetResponseMagic struct {
	ConduitName string                  `json:"conduit_name,required"`
	Description string                  `json:"description,required"`
	Mtu         int64                   `json:"mtu,required"`
	JSON        cniGetResponseMagicJSON `json:"-"`
}

func (*CNIGetResponseMagic) UnmarshalJSON

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

type CNIListParams

type CNIListParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
	Cursor    param.Field[int64]  `query:"cursor"`
	Limit     param.Field[int64]  `query:"limit"`
	// If specified, only show CNIs associated with the specified slot
	Slot param.Field[string] `query:"slot"`
	// If specified, only show cnis associated with the specified tunnel id
	TunnelID param.Field[string] `query:"tunnel_id"`
}

func (CNIListParams) URLQuery

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

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

type CNIListResponse

type CNIListResponse struct {
	Items []CNIListResponseItem `json:"items,required"`
	Next  int64                 `json:"next,nullable"`
	JSON  cniListResponseJSON   `json:"-"`
}

func (*CNIListResponse) UnmarshalJSON

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

type CNIListResponseItem

type CNIListResponseItem struct {
	ID string `json:"id,required" format:"uuid"`
	// Customer account tag
	Account string `json:"account,required"`
	// Customer end of the point-to-point link
	//
	// This should always be inside the same prefix as `p2p_ip`.
	CustIP string `json:"cust_ip,required" format:"A.B.C.D/N"`
	// Interconnect identifier hosting this CNI
	Interconnect string                    `json:"interconnect,required"`
	Magic        CNIListResponseItemsMagic `json:"magic,required"`
	// Cloudflare end of the point-to-point link
	P2pIP string                  `json:"p2p_ip,required" format:"A.B.C.D/N"`
	BGP   CNIListResponseItemsBGP `json:"bgp"`
	JSON  cniListResponseItemJSON `json:"-"`
}

func (*CNIListResponseItem) UnmarshalJSON

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

type CNIListResponseItemsBGP

type CNIListResponseItemsBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN int64 `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes []string `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key string                      `json:"md5_key,nullable"`
	JSON   cniListResponseItemsBGPJSON `json:"-"`
}

func (*CNIListResponseItemsBGP) UnmarshalJSON

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

type CNIListResponseItemsMagic

type CNIListResponseItemsMagic struct {
	ConduitName string                        `json:"conduit_name,required"`
	Description string                        `json:"description,required"`
	Mtu         int64                         `json:"mtu,required"`
	JSON        cniListResponseItemsMagicJSON `json:"-"`
}

func (*CNIListResponseItemsMagic) UnmarshalJSON

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

type CNINewParams

type CNINewParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
	// Customer account tag
	Account      param.Field[string]            `json:"account,required"`
	Interconnect param.Field[string]            `json:"interconnect,required"`
	Magic        param.Field[CNINewParamsMagic] `json:"magic,required"`
	BGP          param.Field[CNINewParamsBGP]   `json:"bgp"`
}

func (CNINewParams) MarshalJSON

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

type CNINewParamsBGP

type CNINewParamsBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN param.Field[int64] `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes param.Field[[]string] `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key param.Field[string] `json:"md5_key"`
}

func (CNINewParamsBGP) MarshalJSON

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

type CNINewParamsMagic

type CNINewParamsMagic struct {
	ConduitName param.Field[string] `json:"conduit_name,required"`
	Description param.Field[string] `json:"description,required"`
	Mtu         param.Field[int64]  `json:"mtu,required"`
}

func (CNINewParamsMagic) MarshalJSON

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

type CNINewResponse

type CNINewResponse struct {
	ID string `json:"id,required" format:"uuid"`
	// Customer account tag
	Account string `json:"account,required"`
	// Customer end of the point-to-point link
	//
	// This should always be inside the same prefix as `p2p_ip`.
	CustIP string `json:"cust_ip,required" format:"A.B.C.D/N"`
	// Interconnect identifier hosting this CNI
	Interconnect string              `json:"interconnect,required"`
	Magic        CNINewResponseMagic `json:"magic,required"`
	// Cloudflare end of the point-to-point link
	P2pIP string             `json:"p2p_ip,required" format:"A.B.C.D/N"`
	BGP   CNINewResponseBGP  `json:"bgp"`
	JSON  cniNewResponseJSON `json:"-"`
}

func (*CNINewResponse) UnmarshalJSON

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

type CNINewResponseBGP

type CNINewResponseBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN int64 `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes []string `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key string                `json:"md5_key,nullable"`
	JSON   cniNewResponseBGPJSON `json:"-"`
}

func (*CNINewResponseBGP) UnmarshalJSON

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

type CNINewResponseMagic

type CNINewResponseMagic struct {
	ConduitName string                  `json:"conduit_name,required"`
	Description string                  `json:"description,required"`
	Mtu         int64                   `json:"mtu,required"`
	JSON        cniNewResponseMagicJSON `json:"-"`
}

func (*CNINewResponseMagic) UnmarshalJSON

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

type CNIService

type CNIService struct {
	Options []option.RequestOption
}

CNIService 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 NewCNIService method instead.

func NewCNIService

func NewCNIService(opts ...option.RequestOption) (r *CNIService)

NewCNIService 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 (*CNIService) Delete

func (r *CNIService) Delete(ctx context.Context, cni string, body CNIDeleteParams, opts ...option.RequestOption) (err error)

Delete a specified CNI object

func (*CNIService) Get

func (r *CNIService) Get(ctx context.Context, cni string, query CNIGetParams, opts ...option.RequestOption) (res *CNIGetResponse, err error)

Get information about a CNI object

func (*CNIService) List

func (r *CNIService) List(ctx context.Context, params CNIListParams, opts ...option.RequestOption) (res *CNIListResponse, err error)

List existing CNI objects

func (*CNIService) New

func (r *CNIService) New(ctx context.Context, params CNINewParams, opts ...option.RequestOption) (res *CNINewResponse, err error)

Create a new CNI object

func (*CNIService) Update

func (r *CNIService) Update(ctx context.Context, cni string, params CNIUpdateParams, opts ...option.RequestOption) (res *CNIUpdateResponse, err error)

Modify stored information about a CNI object

type CNIUpdateParams

type CNIUpdateParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
	ID        param.Field[string] `json:"id,required" format:"uuid"`
	// Customer account tag
	Account param.Field[string] `json:"account,required"`
	// Customer end of the point-to-point link
	//
	// This should always be inside the same prefix as `p2p_ip`.
	CustIP param.Field[string] `json:"cust_ip,required" format:"A.B.C.D/N"`
	// Interconnect identifier hosting this CNI
	Interconnect param.Field[string]               `json:"interconnect,required"`
	Magic        param.Field[CNIUpdateParamsMagic] `json:"magic,required"`
	// Cloudflare end of the point-to-point link
	P2pIP param.Field[string]             `json:"p2p_ip,required" format:"A.B.C.D/N"`
	BGP   param.Field[CNIUpdateParamsBGP] `json:"bgp"`
}

func (CNIUpdateParams) MarshalJSON

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

type CNIUpdateParamsBGP

type CNIUpdateParamsBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN param.Field[int64] `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes param.Field[[]string] `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key param.Field[string] `json:"md5_key"`
}

func (CNIUpdateParamsBGP) MarshalJSON

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

type CNIUpdateParamsMagic

type CNIUpdateParamsMagic struct {
	ConduitName param.Field[string] `json:"conduit_name,required"`
	Description param.Field[string] `json:"description,required"`
	Mtu         param.Field[int64]  `json:"mtu,required"`
}

func (CNIUpdateParamsMagic) MarshalJSON

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

type CNIUpdateResponse

type CNIUpdateResponse struct {
	ID string `json:"id,required" format:"uuid"`
	// Customer account tag
	Account string `json:"account,required"`
	// Customer end of the point-to-point link
	//
	// This should always be inside the same prefix as `p2p_ip`.
	CustIP string `json:"cust_ip,required" format:"A.B.C.D/N"`
	// Interconnect identifier hosting this CNI
	Interconnect string                 `json:"interconnect,required"`
	Magic        CNIUpdateResponseMagic `json:"magic,required"`
	// Cloudflare end of the point-to-point link
	P2pIP string                `json:"p2p_ip,required" format:"A.B.C.D/N"`
	BGP   CNIUpdateResponseBGP  `json:"bgp"`
	JSON  cniUpdateResponseJSON `json:"-"`
}

func (*CNIUpdateResponse) UnmarshalJSON

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

type CNIUpdateResponseBGP

type CNIUpdateResponseBGP struct {
	// ASN used on the customer end of the BGP session
	CustomerASN int64 `json:"customer_asn,required"`
	// Extra set of static prefixes to advertise to the customer's end of the session
	ExtraPrefixes []string `json:"extra_prefixes,required" format:"A.B.C.D/N"`
	// MD5 key to use for session authentication.
	//
	// Note that _this is not a security measure_. MD5 is not a valid security
	// mechanism, and the key is not treated as a secret value. This is _only_
	// supported for preventing misconfiguration, not for defending against malicious
	// attacks.
	//
	// The MD5 key, if set, must be of non-zero length and consist only of the
	// following types of character:
	//
	// - ASCII alphanumerics: `[a-zA-Z0-9]`
	// - Special characters in the set `'!@#$%^&*()+[]{}<>/.,;:_-~`= \|`
	//
	// In other words, MD5 keys may contain any printable ASCII character aside from
	// newline (0x0A), quotation mark (`"`), vertical tab (0x0B), carriage return
	// (0x0D), tab (0x09), form feed (0x0C), and the question mark (`?`). Requests
	// specifying an MD5 key with one or more of these disallowed characters will be
	// rejected.
	Md5Key string                   `json:"md5_key,nullable"`
	JSON   cniUpdateResponseBGPJSON `json:"-"`
}

func (*CNIUpdateResponseBGP) UnmarshalJSON

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

type CNIUpdateResponseMagic

type CNIUpdateResponseMagic struct {
	ConduitName string                     `json:"conduit_name,required"`
	Description string                     `json:"description,required"`
	Mtu         int64                      `json:"mtu,required"`
	JSON        cniUpdateResponseMagicJSON `json:"-"`
}

func (*CNIUpdateResponseMagic) UnmarshalJSON

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

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

type InterconnectDeleteParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type InterconnectGetParams

type InterconnectGetParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type InterconnectGetResponse

type InterconnectGetResponse struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Type    string `json:"type,required"`
	// This field can have the runtime type of
	// [InterconnectGetResponseNscInterconnectPhysicalBodyFacility].
	Facility interface{} `json:"facility"`
	Owner    string      `json:"owner"`
	Region   string      `json:"region"`
	// A Cloudflare site name.
	Site   string                      `json:"site"`
	SlotID string                      `json:"slot_id" format:"uuid"`
	Speed  string                      `json:"speed"`
	JSON   interconnectGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (InterconnectGetResponse) AsUnion

AsUnion returns a InterconnectGetResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InterconnectGetResponseNscInterconnectPhysicalBody, InterconnectGetResponseNscInterconnectGcpPartnerBody.

func (*InterconnectGetResponse) UnmarshalJSON

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

type InterconnectGetResponseNscInterconnectGcpPartnerBody

type InterconnectGetResponseNscInterconnectGcpPartnerBody struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Region  string `json:"region,required"`
	Type    string `json:"type,required"`
	Owner   string `json:"owner"`
	// Bandwidth structure as visible through the customer-facing API.
	Speed InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed `json:"speed"`
	JSON  interconnectGetResponseNscInterconnectGcpPartnerBodyJSON  `json:"-"`
}

func (*InterconnectGetResponseNscInterconnectGcpPartnerBody) UnmarshalJSON

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

type InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed

type InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed string

Bandwidth structure as visible through the customer-facing API.

const (
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed50M  InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "50M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed100M InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "100M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed200M InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "200M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed300M InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "300M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed400M InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "400M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed500M InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "500M"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed1G   InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "1G"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed2G   InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "2G"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed5G   InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "5G"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed10G  InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "10G"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed20G  InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "20G"
	InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed50G  InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed = "50G"
)

func (InterconnectGetResponseNscInterconnectGcpPartnerBodySpeed) IsKnown

type InterconnectGetResponseNscInterconnectPhysicalBody

type InterconnectGetResponseNscInterconnectPhysicalBody struct {
	Account  string                                                     `json:"account,required"`
	Facility InterconnectGetResponseNscInterconnectPhysicalBodyFacility `json:"facility,required"`
	Name     string                                                     `json:"name,required"`
	// A Cloudflare site name.
	Site   string                                                 `json:"site,required"`
	SlotID string                                                 `json:"slot_id,required" format:"uuid"`
	Speed  string                                                 `json:"speed,required"`
	Type   string                                                 `json:"type,required"`
	Owner  string                                                 `json:"owner"`
	JSON   interconnectGetResponseNscInterconnectPhysicalBodyJSON `json:"-"`
}

func (*InterconnectGetResponseNscInterconnectPhysicalBody) UnmarshalJSON

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

type InterconnectGetResponseNscInterconnectPhysicalBodyFacility

type InterconnectGetResponseNscInterconnectPhysicalBodyFacility struct {
	Address []string                                                       `json:"address,required"`
	Name    string                                                         `json:"name,required"`
	JSON    interconnectGetResponseNscInterconnectPhysicalBodyFacilityJSON `json:"-"`
}

func (*InterconnectGetResponseNscInterconnectPhysicalBodyFacility) UnmarshalJSON

type InterconnectGetResponseUnion

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

Union satisfied by InterconnectGetResponseNscInterconnectPhysicalBody or InterconnectGetResponseNscInterconnectGcpPartnerBody.

type InterconnectLOAParams

type InterconnectLOAParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type InterconnectListParams

type InterconnectListParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
	Cursor    param.Field[int64]  `query:"cursor"`
	Limit     param.Field[int64]  `query:"limit"`
	// If specified, only show interconnects located at the given site
	Site param.Field[string] `query:"site"`
	// If specified, only show interconnects of the given type
	Type param.Field[string] `query:"type"`
}

func (InterconnectListParams) URLQuery

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

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

type InterconnectListResponse

type InterconnectListResponse struct {
	Items []InterconnectListResponseItem `json:"items,required"`
	Next  int64                          `json:"next,nullable"`
	JSON  interconnectListResponseJSON   `json:"-"`
}

func (*InterconnectListResponse) UnmarshalJSON

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

type InterconnectListResponseItem

type InterconnectListResponseItem struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Type    string `json:"type,required"`
	// This field can have the runtime type of
	// [InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility].
	Facility interface{} `json:"facility"`
	Owner    string      `json:"owner"`
	Region   string      `json:"region"`
	// A Cloudflare site name.
	Site   string                           `json:"site"`
	SlotID string                           `json:"slot_id" format:"uuid"`
	Speed  string                           `json:"speed"`
	JSON   interconnectListResponseItemJSON `json:"-"`
	// contains filtered or unexported fields
}

func (InterconnectListResponseItem) AsUnion

AsUnion returns a InterconnectListResponseItemsUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InterconnectListResponseItemsNscInterconnectPhysicalBody, InterconnectListResponseItemsNscInterconnectGcpPartnerBody.

func (*InterconnectListResponseItem) UnmarshalJSON

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

type InterconnectListResponseItemsNscInterconnectGcpPartnerBody

type InterconnectListResponseItemsNscInterconnectGcpPartnerBody struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Region  string `json:"region,required"`
	Type    string `json:"type,required"`
	Owner   string `json:"owner"`
	// Bandwidth structure as visible through the customer-facing API.
	Speed InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed `json:"speed"`
	JSON  interconnectListResponseItemsNscInterconnectGcpPartnerBodyJSON  `json:"-"`
}

func (*InterconnectListResponseItemsNscInterconnectGcpPartnerBody) UnmarshalJSON

type InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed

type InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed string

Bandwidth structure as visible through the customer-facing API.

const (
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed50M  InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "50M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed100M InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "100M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed200M InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "200M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed300M InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "300M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed400M InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "400M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed500M InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "500M"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed1G   InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "1G"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed2G   InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "2G"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed5G   InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "5G"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed10G  InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "10G"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed20G  InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "20G"
	InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed50G  InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed = "50G"
)

func (InterconnectListResponseItemsNscInterconnectGcpPartnerBodySpeed) IsKnown

type InterconnectListResponseItemsNscInterconnectPhysicalBody

type InterconnectListResponseItemsNscInterconnectPhysicalBody struct {
	Account  string                                                           `json:"account,required"`
	Facility InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility `json:"facility,required"`
	Name     string                                                           `json:"name,required"`
	// A Cloudflare site name.
	Site   string                                                       `json:"site,required"`
	SlotID string                                                       `json:"slot_id,required" format:"uuid"`
	Speed  string                                                       `json:"speed,required"`
	Type   string                                                       `json:"type,required"`
	Owner  string                                                       `json:"owner"`
	JSON   interconnectListResponseItemsNscInterconnectPhysicalBodyJSON `json:"-"`
}

func (*InterconnectListResponseItemsNscInterconnectPhysicalBody) UnmarshalJSON

type InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility

type InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility struct {
	Address []string                                                             `json:"address,required"`
	Name    string                                                               `json:"name,required"`
	JSON    interconnectListResponseItemsNscInterconnectPhysicalBodyFacilityJSON `json:"-"`
}

func (*InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility) UnmarshalJSON

type InterconnectListResponseItemsUnion

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

Union satisfied by InterconnectListResponseItemsNscInterconnectPhysicalBody or InterconnectListResponseItemsNscInterconnectGcpPartnerBody.

type InterconnectNewParams

type InterconnectNewParams struct {
	// Customer account tag
	AccountID param.Field[string]            `path:"account_id,required"`
	Body      InterconnectNewParamsBodyUnion `json:"body,required"`
}

func (InterconnectNewParams) MarshalJSON

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

type InterconnectNewParamsBody

type InterconnectNewParamsBody struct {
	Account param.Field[string] `json:"account,required"`
	Type    param.Field[string] `json:"type,required"`
	// Bandwidth structure as visible through the customer-facing API.
	Bandwidth param.Field[InterconnectNewParamsBodyBandwidth] `json:"bandwidth"`
	// Pairing key provided by GCP
	PairingKey param.Field[string] `json:"pairing_key"`
	SlotID     param.Field[string] `json:"slot_id" format:"uuid"`
	Speed      param.Field[string] `json:"speed"`
}

func (InterconnectNewParamsBody) MarshalJSON

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

type InterconnectNewParamsBodyBandwidth

type InterconnectNewParamsBodyBandwidth string

Bandwidth structure as visible through the customer-facing API.

const (
	InterconnectNewParamsBodyBandwidth50M  InterconnectNewParamsBodyBandwidth = "50M"
	InterconnectNewParamsBodyBandwidth100M InterconnectNewParamsBodyBandwidth = "100M"
	InterconnectNewParamsBodyBandwidth200M InterconnectNewParamsBodyBandwidth = "200M"
	InterconnectNewParamsBodyBandwidth300M InterconnectNewParamsBodyBandwidth = "300M"
	InterconnectNewParamsBodyBandwidth400M InterconnectNewParamsBodyBandwidth = "400M"
	InterconnectNewParamsBodyBandwidth500M InterconnectNewParamsBodyBandwidth = "500M"
	InterconnectNewParamsBodyBandwidth1G   InterconnectNewParamsBodyBandwidth = "1G"
	InterconnectNewParamsBodyBandwidth2G   InterconnectNewParamsBodyBandwidth = "2G"
	InterconnectNewParamsBodyBandwidth5G   InterconnectNewParamsBodyBandwidth = "5G"
	InterconnectNewParamsBodyBandwidth10G  InterconnectNewParamsBodyBandwidth = "10G"
	InterconnectNewParamsBodyBandwidth20G  InterconnectNewParamsBodyBandwidth = "20G"
	InterconnectNewParamsBodyBandwidth50G  InterconnectNewParamsBodyBandwidth = "50G"
)

func (InterconnectNewParamsBodyBandwidth) IsKnown

type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody

type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody struct {
	Account param.Field[string] `json:"account,required"`
	// Bandwidth structure as visible through the customer-facing API.
	Bandwidth param.Field[InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth] `json:"bandwidth,required"`
	// Pairing key provided by GCP
	PairingKey param.Field[string] `json:"pairing_key,required"`
	Type       param.Field[string] `json:"type,required"`
}

func (InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody) MarshalJSON

type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth

type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth string

Bandwidth structure as visible through the customer-facing API.

const (
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth50M  InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "50M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth100M InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "100M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth200M InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "200M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth300M InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "300M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth400M InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "400M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth500M InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "500M"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth1G   InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "1G"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth2G   InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "2G"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth5G   InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "5G"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth10G  InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "10G"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth20G  InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "20G"
	InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth50G  InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth = "50G"
)

func (InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth) IsKnown

type InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody

type InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody struct {
	Account param.Field[string] `json:"account,required"`
	SlotID  param.Field[string] `json:"slot_id,required" format:"uuid"`
	Type    param.Field[string] `json:"type,required"`
	Speed   param.Field[string] `json:"speed"`
}

func (InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody) MarshalJSON

type InterconnectNewResponse

type InterconnectNewResponse struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Type    string `json:"type,required"`
	// This field can have the runtime type of
	// [InterconnectNewResponseNscInterconnectPhysicalBodyFacility].
	Facility interface{} `json:"facility"`
	Owner    string      `json:"owner"`
	Region   string      `json:"region"`
	// A Cloudflare site name.
	Site   string                      `json:"site"`
	SlotID string                      `json:"slot_id" format:"uuid"`
	Speed  string                      `json:"speed"`
	JSON   interconnectNewResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (InterconnectNewResponse) AsUnion

AsUnion returns a InterconnectNewResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InterconnectNewResponseNscInterconnectPhysicalBody, InterconnectNewResponseNscInterconnectGcpPartnerBody.

func (*InterconnectNewResponse) UnmarshalJSON

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

type InterconnectNewResponseNscInterconnectGcpPartnerBody

type InterconnectNewResponseNscInterconnectGcpPartnerBody struct {
	Account string `json:"account,required"`
	Name    string `json:"name,required"`
	Region  string `json:"region,required"`
	Type    string `json:"type,required"`
	Owner   string `json:"owner"`
	// Bandwidth structure as visible through the customer-facing API.
	Speed InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed `json:"speed"`
	JSON  interconnectNewResponseNscInterconnectGcpPartnerBodyJSON  `json:"-"`
}

func (*InterconnectNewResponseNscInterconnectGcpPartnerBody) UnmarshalJSON

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

type InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed

type InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed string

Bandwidth structure as visible through the customer-facing API.

const (
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed50M  InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "50M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed100M InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "100M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed200M InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "200M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed300M InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "300M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed400M InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "400M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed500M InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "500M"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed1G   InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "1G"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed2G   InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "2G"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed5G   InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "5G"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed10G  InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "10G"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed20G  InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "20G"
	InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed50G  InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed = "50G"
)

func (InterconnectNewResponseNscInterconnectGcpPartnerBodySpeed) IsKnown

type InterconnectNewResponseNscInterconnectPhysicalBody

type InterconnectNewResponseNscInterconnectPhysicalBody struct {
	Account  string                                                     `json:"account,required"`
	Facility InterconnectNewResponseNscInterconnectPhysicalBodyFacility `json:"facility,required"`
	Name     string                                                     `json:"name,required"`
	// A Cloudflare site name.
	Site   string                                                 `json:"site,required"`
	SlotID string                                                 `json:"slot_id,required" format:"uuid"`
	Speed  string                                                 `json:"speed,required"`
	Type   string                                                 `json:"type,required"`
	Owner  string                                                 `json:"owner"`
	JSON   interconnectNewResponseNscInterconnectPhysicalBodyJSON `json:"-"`
}

func (*InterconnectNewResponseNscInterconnectPhysicalBody) UnmarshalJSON

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

type InterconnectNewResponseNscInterconnectPhysicalBodyFacility

type InterconnectNewResponseNscInterconnectPhysicalBodyFacility struct {
	Address []string                                                       `json:"address,required"`
	Name    string                                                         `json:"name,required"`
	JSON    interconnectNewResponseNscInterconnectPhysicalBodyFacilityJSON `json:"-"`
}

func (*InterconnectNewResponseNscInterconnectPhysicalBodyFacility) UnmarshalJSON

type InterconnectNewResponseUnion

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

Union satisfied by InterconnectNewResponseNscInterconnectPhysicalBody or InterconnectNewResponseNscInterconnectGcpPartnerBody.

type InterconnectService

type InterconnectService struct {
	Options []option.RequestOption
}

InterconnectService 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 NewInterconnectService method instead.

func NewInterconnectService

func NewInterconnectService(opts ...option.RequestOption) (r *InterconnectService)

NewInterconnectService 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 (*InterconnectService) Delete

func (r *InterconnectService) Delete(ctx context.Context, icon string, body InterconnectDeleteParams, opts ...option.RequestOption) (err error)

Delete an interconnect object

func (*InterconnectService) Get

Get information about an interconnect object

func (*InterconnectService) LOA

func (r *InterconnectService) LOA(ctx context.Context, icon string, query InterconnectLOAParams, opts ...option.RequestOption) (err error)

Generate the Letter of Authorization (LOA) for a given interconnect

func (*InterconnectService) List

List existing interconnects

func (*InterconnectService) New

Create a new interconnect

func (*InterconnectService) Status

Get the current status of an interconnect object

type InterconnectStatusParams

type InterconnectStatusParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type InterconnectStatusResponse

type InterconnectStatusResponse struct {
	State InterconnectStatusResponseState `json:"state,required"`
	// Diagnostic information, if available
	Reason string                         `json:"reason,nullable"`
	JSON   interconnectStatusResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (InterconnectStatusResponse) AsUnion

AsUnion returns a InterconnectStatusResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are InterconnectStatusResponsePending, InterconnectStatusResponseDown, InterconnectStatusResponseUnhealthy, InterconnectStatusResponseHealthy.

func (*InterconnectStatusResponse) UnmarshalJSON

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

type InterconnectStatusResponseDown

type InterconnectStatusResponseDown struct {
	State InterconnectStatusResponseDownState `json:"state,required"`
	// Diagnostic information, if available
	Reason string                             `json:"reason,nullable"`
	JSON   interconnectStatusResponseDownJSON `json:"-"`
}

func (*InterconnectStatusResponseDown) UnmarshalJSON

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

type InterconnectStatusResponseDownState

type InterconnectStatusResponseDownState string
const (
	InterconnectStatusResponseDownStateDown InterconnectStatusResponseDownState = "Down"
)

func (InterconnectStatusResponseDownState) IsKnown

type InterconnectStatusResponseHealthy

type InterconnectStatusResponseHealthy struct {
	State InterconnectStatusResponseHealthyState `json:"state,required"`
	JSON  interconnectStatusResponseHealthyJSON  `json:"-"`
}

func (*InterconnectStatusResponseHealthy) UnmarshalJSON

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

type InterconnectStatusResponseHealthyState

type InterconnectStatusResponseHealthyState string
const (
	InterconnectStatusResponseHealthyStateHealthy InterconnectStatusResponseHealthyState = "Healthy"
)

func (InterconnectStatusResponseHealthyState) IsKnown

type InterconnectStatusResponsePending

type InterconnectStatusResponsePending struct {
	State InterconnectStatusResponsePendingState `json:"state,required"`
	JSON  interconnectStatusResponsePendingJSON  `json:"-"`
}

func (*InterconnectStatusResponsePending) UnmarshalJSON

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

type InterconnectStatusResponsePendingState

type InterconnectStatusResponsePendingState string
const (
	InterconnectStatusResponsePendingStatePending InterconnectStatusResponsePendingState = "Pending"
)

func (InterconnectStatusResponsePendingState) IsKnown

type InterconnectStatusResponseState

type InterconnectStatusResponseState string
const (
	InterconnectStatusResponseStatePending   InterconnectStatusResponseState = "Pending"
	InterconnectStatusResponseStateDown      InterconnectStatusResponseState = "Down"
	InterconnectStatusResponseStateUnhealthy InterconnectStatusResponseState = "Unhealthy"
	InterconnectStatusResponseStateHealthy   InterconnectStatusResponseState = "Healthy"
)

func (InterconnectStatusResponseState) IsKnown

type InterconnectStatusResponseUnhealthy

type InterconnectStatusResponseUnhealthy struct {
	State InterconnectStatusResponseUnhealthyState `json:"state,required"`
	// Diagnostic information, if available
	Reason string                                  `json:"reason,nullable"`
	JSON   interconnectStatusResponseUnhealthyJSON `json:"-"`
}

func (*InterconnectStatusResponseUnhealthy) UnmarshalJSON

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

type InterconnectStatusResponseUnhealthyState

type InterconnectStatusResponseUnhealthyState string
const (
	InterconnectStatusResponseUnhealthyStateUnhealthy InterconnectStatusResponseUnhealthyState = "Unhealthy"
)

func (InterconnectStatusResponseUnhealthyState) IsKnown

type InterconnectStatusResponseUnion

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

Union satisfied by InterconnectStatusResponsePending, InterconnectStatusResponseDown, InterconnectStatusResponseUnhealthy or InterconnectStatusResponseHealthy.

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 NetworkInterconnectService

type NetworkInterconnectService struct {
	Options       []option.RequestOption
	CNIs          *CNIService
	Interconnects *InterconnectService
	Settings      *SettingService
	Slots         *SlotService
}

NetworkInterconnectService 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 NewNetworkInterconnectService method instead.

func NewNetworkInterconnectService

func NewNetworkInterconnectService(opts ...option.RequestOption) (r *NetworkInterconnectService)

NewNetworkInterconnectService 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 Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SettingGetParams

type SettingGetParams struct {
	AccountID param.Field[string] `path:"account_id,required"`
}

type SettingGetResponse

type SettingGetResponse struct {
	DefaultASN int64                  `json:"default_asn,required"`
	JSON       settingGetResponseJSON `json:"-"`
}

func (*SettingGetResponse) UnmarshalJSON

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

type SettingService

type SettingService struct {
	Options []option.RequestOption
}

SettingService 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 NewSettingService method instead.

func NewSettingService

func NewSettingService(opts ...option.RequestOption) (r *SettingService)

NewSettingService 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 (*SettingService) Get

Get the current settings for the active account

func (*SettingService) Update

Update the current settings for the active account

type SettingUpdateParams

type SettingUpdateParams struct {
	AccountID  param.Field[string] `path:"account_id,required"`
	DefaultASN param.Field[int64]  `json:"default_asn"`
}

func (SettingUpdateParams) MarshalJSON

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

type SettingUpdateResponse

type SettingUpdateResponse struct {
	DefaultASN int64                     `json:"default_asn,required"`
	JSON       settingUpdateResponseJSON `json:"-"`
}

func (*SettingUpdateResponse) UnmarshalJSON

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

type SlotGetParams

type SlotGetParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
}

type SlotGetResponse

type SlotGetResponse struct {
	// Slot ID
	ID       string                  `json:"id,required" format:"uuid"`
	Facility SlotGetResponseFacility `json:"facility,required"`
	// Whether the slot is occupied or not
	Occupied bool   `json:"occupied,required"`
	Site     string `json:"site,required"`
	Speed    string `json:"speed,required"`
	// Customer account tag
	Account string              `json:"account"`
	JSON    slotGetResponseJSON `json:"-"`
}

func (*SlotGetResponse) UnmarshalJSON

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

type SlotGetResponseFacility

type SlotGetResponseFacility struct {
	Address []string                    `json:"address,required"`
	Name    string                      `json:"name,required"`
	JSON    slotGetResponseFacilityJSON `json:"-"`
}

func (*SlotGetResponseFacility) UnmarshalJSON

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

type SlotListParams

type SlotListParams struct {
	// Customer account tag
	AccountID param.Field[string] `path:"account_id,required"`
	// If specified, only show slots with the given text in their address field
	AddressContains param.Field[string] `query:"address_contains"`
	Cursor          param.Field[int64]  `query:"cursor"`
	Limit           param.Field[int64]  `query:"limit"`
	// If specified, only show slots with a specific occupied/unoccupied state
	Occupied param.Field[bool] `query:"occupied"`
	// If specified, only show slots located at the given site
	Site param.Field[string] `query:"site"`
	// If specified, only show slots that support the given speed
	Speed param.Field[string] `query:"speed"`
}

func (SlotListParams) URLQuery

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

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

type SlotListResponse

type SlotListResponse struct {
	Items []SlotListResponseItem `json:"items,required"`
	Next  int64                  `json:"next,nullable"`
	JSON  slotListResponseJSON   `json:"-"`
}

func (*SlotListResponse) UnmarshalJSON

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

type SlotListResponseItem

type SlotListResponseItem struct {
	// Slot ID
	ID       string                        `json:"id,required" format:"uuid"`
	Facility SlotListResponseItemsFacility `json:"facility,required"`
	// Whether the slot is occupied or not
	Occupied bool   `json:"occupied,required"`
	Site     string `json:"site,required"`
	Speed    string `json:"speed,required"`
	// Customer account tag
	Account string                   `json:"account"`
	JSON    slotListResponseItemJSON `json:"-"`
}

func (*SlotListResponseItem) UnmarshalJSON

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

type SlotListResponseItemsFacility

type SlotListResponseItemsFacility struct {
	Address []string                          `json:"address,required"`
	Name    string                            `json:"name,required"`
	JSON    slotListResponseItemsFacilityJSON `json:"-"`
}

func (*SlotListResponseItemsFacility) UnmarshalJSON

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

type SlotService

type SlotService struct {
	Options []option.RequestOption
}

SlotService 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 NewSlotService method instead.

func NewSlotService

func NewSlotService(opts ...option.RequestOption) (r *SlotService)

NewSlotService 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 (*SlotService) Get

func (r *SlotService) Get(ctx context.Context, slot string, query SlotGetParams, opts ...option.RequestOption) (res *SlotGetResponse, err error)

Get information about the specified slot

func (*SlotService) List

func (r *SlotService) List(ctx context.Context, params SlotListParams, opts ...option.RequestOption) (res *SlotListResponse, err error)

Retrieve a list of all slots matching the specified parameters

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL