Documentation
¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CNIDeleteParams
- type CNIGetParams
- type CNIGetResponse
- type CNIGetResponseBGP
- type CNIGetResponseMagic
- type CNIListParams
- type CNIListResponse
- type CNIListResponseItem
- type CNIListResponseItemsBGP
- type CNIListResponseItemsMagic
- type CNINewParams
- type CNINewParamsBGP
- type CNINewParamsMagic
- type CNINewResponse
- type CNINewResponseBGP
- type CNINewResponseMagic
- type CNIService
- func (r *CNIService) Delete(ctx context.Context, cni string, body CNIDeleteParams, ...) (err error)
- func (r *CNIService) Get(ctx context.Context, cni string, query CNIGetParams, ...) (res *CNIGetResponse, err error)
- func (r *CNIService) List(ctx context.Context, params CNIListParams, opts ...option.RequestOption) (res *CNIListResponse, err error)
- func (r *CNIService) New(ctx context.Context, params CNINewParams, opts ...option.RequestOption) (res *CNINewResponse, err error)
- func (r *CNIService) Update(ctx context.Context, cni string, params CNIUpdateParams, ...) (res *CNIUpdateResponse, err error)
- type CNIUpdateParams
- type CNIUpdateParamsBGP
- type CNIUpdateParamsMagic
- type CNIUpdateResponse
- type CNIUpdateResponseBGP
- type CNIUpdateResponseMagic
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ErrorDataSource
- type InterconnectDeleteParams
- type InterconnectGetParams
- type InterconnectGetResponse
- type InterconnectGetResponseNscInterconnectGcpPartnerBody
- type InterconnectGetResponseNscInterconnectPhysicalBody
- type InterconnectGetResponseNscInterconnectPhysicalBodyFacility
- type InterconnectGetResponseUnion
- type InterconnectLOAParams
- type InterconnectListParams
- type InterconnectListResponse
- type InterconnectListResponseItem
- type InterconnectListResponseItemsNscInterconnectGcpPartnerBody
- type InterconnectListResponseItemsNscInterconnectPhysicalBody
- type InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility
- type InterconnectListResponseItemsUnion
- type InterconnectNewParams
- type InterconnectNewParamsBody
- type InterconnectNewParamsBodyBandwidth
- type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody
- type InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth
- type InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody
- type InterconnectNewParamsBodyUnion
- type InterconnectNewResponse
- type InterconnectNewResponseNscInterconnectGcpPartnerBody
- type InterconnectNewResponseNscInterconnectPhysicalBody
- type InterconnectNewResponseNscInterconnectPhysicalBodyFacility
- type InterconnectNewResponseUnion
- type InterconnectService
- func (r *InterconnectService) Delete(ctx context.Context, icon string, body InterconnectDeleteParams, ...) (err error)
- func (r *InterconnectService) Get(ctx context.Context, icon string, query InterconnectGetParams, ...) (res *InterconnectGetResponse, err error)
- func (r *InterconnectService) LOA(ctx context.Context, icon string, query InterconnectLOAParams, ...) (err error)
- func (r *InterconnectService) List(ctx context.Context, params InterconnectListParams, ...) (res *InterconnectListResponse, err error)
- func (r *InterconnectService) New(ctx context.Context, params InterconnectNewParams, ...) (res *InterconnectNewResponse, err error)
- func (r *InterconnectService) Status(ctx context.Context, icon string, query InterconnectStatusParams, ...) (res *InterconnectStatusResponse, err error)
- type InterconnectStatusParams
- type InterconnectStatusResponse
- type InterconnectStatusResponseDown
- type InterconnectStatusResponseDownState
- type InterconnectStatusResponseHealthy
- type InterconnectStatusResponseHealthyState
- type InterconnectStatusResponsePending
- type InterconnectStatusResponsePendingState
- type InterconnectStatusResponseState
- type InterconnectStatusResponseUnhealthy
- type InterconnectStatusResponseUnhealthyState
- type InterconnectStatusResponseUnion
- type Member
- type MemberPoliciesAccess
- type MemberPoliciesPermissionGroup
- type MemberPoliciesPermissionGroupsMeta
- type MemberPoliciesResourceGroup
- type MemberPoliciesResourceGroupsMeta
- type MemberPoliciesResourceGroupsScope
- type MemberPoliciesResourceGroupsScopeObject
- type MemberPolicy
- type MemberStatus
- type MemberUser
- type NetworkInterconnectService
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RatePlan
- type RatePlanID
- type RatePlanParam
- type ResponseInfo
- type ResponseInfoSource
- type Role
- type RoleParam
- type RolePermissions
- type RolePermissionsParam
- type SettingGetParams
- type SettingGetResponse
- type SettingService
- type SettingUpdateParams
- type SettingUpdateResponse
- type SlotGetParams
- type SlotGetResponse
- type SlotGetResponseFacility
- type SlotListParams
- type SlotListResponse
- type SlotListResponseItem
- type SlotListResponseItemsFacility
- type SlotService
- type SortDirection
- type Subscription
- type SubscriptionFrequency
- type SubscriptionParam
- type SubscriptionState
- type Token
- type TokenCondition
- type TokenConditionCIDRList
- type TokenConditionCIDRListParam
- type TokenConditionParam
- type TokenConditionRequestIP
- type TokenConditionRequestIPParam
- type TokenParam
- type TokenPolicy
- type TokenPolicyEffect
- type TokenPolicyParam
- type TokenPolicyPermissionGroup
- type TokenPolicyPermissionGroupParam
- type TokenPolicyPermissionGroupsMeta
- type TokenPolicyPermissionGroupsMetaParam
- type TokenPolicyResourcesMap
- type TokenPolicyResourcesMapParam
- type TokenPolicyResourcesUnion
- type TokenPolicyResourcesUnionParam
- type TokenStatus
- type TokenValue
Constants ¶
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin
This is an alias to an internal value.
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare
This is an alias to an internal value.
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser
This is an alias to an internal value.
const CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateCASSLCom = shared.CertificateCASSLCom
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
This is an alias to an internal value.
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI
This is an alias to an internal value.
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel
This is an alias to an internal value.
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE
This is an alias to an internal value.
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec
This is an alias to an internal value.
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP
This is an alias to an internal value.
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector
This is an alias to an internal value.
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow
This is an alias to an internal value.
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny
This is an alias to an internal value.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const RatePlanIDBusiness = shared.RatePlanIDBusiness
This is an alias to an internal value.
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise
This is an alias to an internal value.
const RatePlanIDFree = shared.RatePlanIDFree
This is an alias to an internal value.
const RatePlanIDLite = shared.RatePlanIDLite
This is an alias to an internal value.
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness
This is an alias to an internal value.
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise
This is an alias to an internal value.
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree
This is an alias to an internal value.
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro
This is an alias to an internal value.
const RatePlanIDPro = shared.RatePlanIDPro
This is an alias to an internal value.
const RatePlanIDProPlus = shared.RatePlanIDProPlus
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
This is an alias to an internal value.
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly
This is an alias to an internal value.
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly
This is an alias to an internal value.
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly
This is an alias to an internal value.
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly
This is an alias to an internal value.
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment
This is an alias to an internal value.
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled
This is an alias to an internal value.
const SubscriptionStateExpired = shared.SubscriptionStateExpired
This is an alias to an internal value.
const SubscriptionStateFailed = shared.SubscriptionStateFailed
This is an alias to an internal value.
const SubscriptionStatePaid = shared.SubscriptionStatePaid
This is an alias to an internal value.
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned
This is an alias to an internal value.
const SubscriptionStateTrial = shared.SubscriptionStateTrial
This is an alias to an internal value.
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow
This is an alias to an internal value.
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny
This is an alias to an internal value.
const TokenStatusActive = shared.TokenStatusActive
This is an alias to an internal value.
const TokenStatusDisabled = shared.TokenStatusDisabled
This is an alias to an internal value.
const TokenStatusExpired = shared.TokenStatusExpired
This is an alias to an internal value.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type CNIDeleteParams ¶
type CNIGetParams ¶
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 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 ErrorDataSource ¶ added in v4.2.0
type ErrorDataSource = shared.ErrorDataSource
This is an alias to an internal type.
type InterconnectGetParams ¶
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 ¶
func (r InterconnectGetResponse) AsUnion() InterconnectGetResponseUnion
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"`
JSON interconnectGetResponseNscInterconnectGcpPartnerBodyJSON `json:"-"`
}
func (*InterconnectGetResponseNscInterconnectGcpPartnerBody) UnmarshalJSON ¶
func (r *InterconnectGetResponseNscInterconnectGcpPartnerBody) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *InterconnectGetResponseNscInterconnectPhysicalBodyFacility) UnmarshalJSON(data []byte) (err error)
type InterconnectGetResponseUnion ¶
type InterconnectGetResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by InterconnectGetResponseNscInterconnectPhysicalBody or InterconnectGetResponseNscInterconnectGcpPartnerBody.
type InterconnectLOAParams ¶
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 ¶
func (r InterconnectListResponseItem) AsUnion() InterconnectListResponseItemsUnion
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"`
JSON interconnectListResponseItemsNscInterconnectGcpPartnerBodyJSON `json:"-"`
}
func (*InterconnectListResponseItemsNscInterconnectGcpPartnerBody) UnmarshalJSON ¶
func (r *InterconnectListResponseItemsNscInterconnectGcpPartnerBody) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *InterconnectListResponseItemsNscInterconnectPhysicalBody) UnmarshalJSON(data []byte) (err error)
type InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility ¶
type InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility struct {
Address []string `json:"address,required"`
Name string `json:"name,required"`
JSON interconnectListResponseItemsNscInterconnectPhysicalBodyFacilityJSON `json:"-"`
}
func (*InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility) UnmarshalJSON ¶
func (r *InterconnectListResponseItemsNscInterconnectPhysicalBodyFacility) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r InterconnectNewParamsBodyBandwidth) IsKnown() bool
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 ¶
func (r InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody) MarshalJSON() (data []byte, err error)
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 ¶
func (r InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBodyBandwidth) IsKnown() bool
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 ¶
func (r InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody) MarshalJSON() (data []byte, err error)
type InterconnectNewParamsBodyUnion ¶
type InterconnectNewParamsBodyUnion interface {
// contains filtered or unexported methods
}
Satisfied by network_interconnects.InterconnectNewParamsBodyNscInterconnectCreatePhysicalBody, network_interconnects.InterconnectNewParamsBodyNscInterconnectCreateGcpPartnerBody, InterconnectNewParamsBody.
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 ¶
func (r InterconnectNewResponse) AsUnion() InterconnectNewResponseUnion
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"`
JSON interconnectNewResponseNscInterconnectGcpPartnerBodyJSON `json:"-"`
}
func (*InterconnectNewResponseNscInterconnectGcpPartnerBody) UnmarshalJSON ¶
func (r *InterconnectNewResponseNscInterconnectGcpPartnerBody) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *InterconnectNewResponseNscInterconnectPhysicalBodyFacility) UnmarshalJSON(data []byte) (err error)
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 ¶
func (r *InterconnectService) Get(ctx context.Context, icon string, query InterconnectGetParams, opts ...option.RequestOption) (res *InterconnectGetResponse, err error)
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 ¶
func (r *InterconnectService) List(ctx context.Context, params InterconnectListParams, opts ...option.RequestOption) (res *InterconnectListResponse, err error)
List existing interconnects
func (*InterconnectService) New ¶
func (r *InterconnectService) New(ctx context.Context, params InterconnectNewParams, opts ...option.RequestOption) (res *InterconnectNewResponse, err error)
Create a new interconnect
func (*InterconnectService) Status ¶
func (r *InterconnectService) Status(ctx context.Context, icon string, query InterconnectStatusParams, opts ...option.RequestOption) (res *InterconnectStatusResponse, err error)
Get the current status of an interconnect object
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 ¶
func (r InterconnectStatusResponse) AsUnion() InterconnectStatusResponseUnion
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 ¶
func (r InterconnectStatusResponseDownState) IsKnown() bool
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 ¶
func (r InterconnectStatusResponseHealthyState) IsKnown() bool
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 ¶
func (r InterconnectStatusResponsePendingState) IsKnown() bool
type InterconnectStatusResponseState ¶
type InterconnectStatusResponseState string
const ( InterconnectStatusResponseStatePending InterconnectStatusResponseState = "Pending" InterconnectStatusResponseStateDown InterconnectStatusResponseState = "Down" InterconnectStatusResponseStateUnhealthy InterconnectStatusResponseState = "Unhealthy" InterconnectStatusResponseStateHealthy InterconnectStatusResponseState = "Healthy" )
func (InterconnectStatusResponseState) IsKnown ¶
func (r InterconnectStatusResponseState) IsKnown() bool
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 ¶
func (r InterconnectStatusResponseUnhealthyState) IsKnown() bool
type InterconnectStatusResponseUnion ¶
type InterconnectStatusResponseUnion interface {
// contains filtered or unexported methods
}
Union satisfied by InterconnectStatusResponsePending, InterconnectStatusResponseDown, InterconnectStatusResponseUnhealthy or InterconnectStatusResponseHealthy.
type MemberPoliciesAccess ¶
type MemberPoliciesAccess = shared.MemberPoliciesAccess
Allow or deny operations against the resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroup ¶
type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type MemberPoliciesPermissionGroupsMeta ¶
type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type MemberPoliciesResourceGroup ¶
type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup
A group of scoped resources.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsMeta ¶
type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta
Attributes associated to the resource group.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScope ¶
type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope
A scope is a combination of scope objects which provides additional context.
This is an alias to an internal type.
type MemberPoliciesResourceGroupsScopeObject ¶
type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject
A scope object represents any resource that can have actions applied against invite.
This is an alias to an internal type.
type MemberStatus ¶
type MemberStatus = shared.MemberStatus
A member's status in the account.
This is an alias to an internal type.
type MemberUser ¶
type MemberUser = shared.MemberUser
Details of the user associated to the membership.
This is an alias to an internal type.
type 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 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 RatePlanID ¶
type RatePlanID = shared.RatePlanID
The ID of the rate plan.
This is an alias to an internal type.
type RatePlanParam ¶
type RatePlanParam = shared.RatePlanParam
The rate plan applied to the subscription.
This is an alias to an internal type.
type ResponseInfoSource ¶ added in v4.3.0
type ResponseInfoSource = shared.ResponseInfoSource
This is an alias to an internal type.
type RolePermissions ¶
type RolePermissions = shared.RolePermissions
This is an alias to an internal type.
type RolePermissionsParam ¶
type RolePermissionsParam = shared.RolePermissionsParam
This is an alias to an internal type.
type SettingGetParams ¶
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 ¶
func (r *SettingService) Get(ctx context.Context, query SettingGetParams, opts ...option.RequestOption) (res *SettingGetResponse, err error)
Get the current settings for the active account
func (*SettingService) Update ¶
func (r *SettingService) Update(ctx context.Context, params SettingUpdateParams, opts ...option.RequestOption) (res *SettingUpdateResponse, err error)
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 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 SubscriptionFrequency ¶
type SubscriptionFrequency = shared.SubscriptionFrequency
How often the subscription is renewed automatically.
This is an alias to an internal type.
type SubscriptionParam ¶
type SubscriptionParam = shared.SubscriptionParam
This is an alias to an internal type.
type SubscriptionState ¶
type SubscriptionState = shared.SubscriptionState
The state that the subscription is in.
This is an alias to an internal type.
type TokenCondition ¶
type TokenCondition = shared.TokenCondition
This is an alias to an internal type.
type TokenConditionCIDRList ¶
type TokenConditionCIDRList = shared.TokenConditionCIDRList
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionCIDRListParam ¶
type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam
IPv4/IPv6 CIDR.
This is an alias to an internal type.
type TokenConditionParam ¶
type TokenConditionParam = shared.TokenConditionParam
This is an alias to an internal type.
type TokenConditionRequestIP ¶
type TokenConditionRequestIP = shared.TokenConditionRequestIP
Client IP restrictions.
This is an alias to an internal type.
type TokenConditionRequestIPParam ¶
type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam
Client IP restrictions.
This is an alias to an internal type.
type TokenPolicyEffect ¶
type TokenPolicyEffect = shared.TokenPolicyEffect
Allow or deny operations against the resources.
This is an alias to an internal type.
type TokenPolicyParam ¶
type TokenPolicyParam = shared.TokenPolicyParam
This is an alias to an internal type.
type TokenPolicyPermissionGroup ¶
type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupParam ¶
type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam
A named group of permissions that map to a group of operations against resources.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMeta ¶
type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyPermissionGroupsMetaParam ¶
type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam
Attributes associated to the permission group.
This is an alias to an internal type.
type TokenPolicyResourcesMap ¶ added in v4.6.0
type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesMapParam ¶ added in v4.6.0
type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam
A nested permission grant for further scoping.
This is an alias to an internal type.
type TokenPolicyResourcesUnion ¶ added in v4.6.0
type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion
A simple wildcard permission, e.g., "\*".
This is an alias to an internal type.
type TokenPolicyResourcesUnionParam ¶ added in v4.6.0
type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam
A simple wildcard permission, e.g., "\*".
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.