magic_transit

package

v4.6.0Latest Latest

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

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

Details

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

Repository

github.com/cloudflare/cloudflare-go

Documentation ¶

Index¶

Constants¶

View Source

const AuditLogActorTypeAdmin =shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source

const AuditLogActorTypeCloudflare =shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source

const AuditLogActorTypeUser =shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source

const CertificateCADigicert =shared.CertificateCADigicert

This is an alias to an internal value.

View Source

const CertificateCAGoogle =shared.CertificateCAGoogle

This is an alias to an internal value.

View Source

const CertificateCALetsEncrypt =shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source

const CertificateCASSLCom =shared.CertificateCASSLCom

This is an alias to an internal value.

View Source

const CertificateRequestTypeKeylessCertificate =shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source

const CertificateRequestTypeOriginECC =shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source

const CertificateRequestTypeOriginRSA =shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source

const CloudflareTunnelStatusDegraded =shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source

const CloudflareTunnelStatusDown =shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source

const CloudflareTunnelStatusHealthy =shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source

const CloudflareTunnelStatusInactive =shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeCNI =shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeCfdTunnel =shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeGRE =shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeIPSec =shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeMagic =shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeWARP =shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source

const CloudflareTunnelTunTypeWARPConnector =shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source

const MemberPoliciesAccessAllow =shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source

const MemberPoliciesAccessDeny =shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source

const MemberStatusAccepted =shared.MemberStatusAccepted

This is an alias to an internal value.

View Source

const MemberStatusPending =shared.MemberStatusPending

This is an alias to an internal value.

View Source

const RatePlanIDBusiness =shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source

const RatePlanIDEnterprise =shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source

const RatePlanIDFree =shared.RatePlanIDFree

This is an alias to an internal value.

View Source

const RatePlanIDLite =shared.RatePlanIDLite

This is an alias to an internal value.

View Source

const RatePlanIDPartnersBusiness =shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source

const RatePlanIDPartnersEnterprise =shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source

const RatePlanIDPartnersFree =shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source

const RatePlanIDPartnersPro =shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source

const RatePlanIDPro =shared.RatePlanIDPro

This is an alias to an internal value.

View Source

const RatePlanIDProPlus =shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source

const SortDirectionAsc =shared.SortDirectionAsc

This is an alias to an internal value.

View Source

const SortDirectionDesc =shared.SortDirectionDesc

This is an alias to an internal value.

View Source

const SubscriptionFrequencyMonthly =shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source

const SubscriptionFrequencyQuarterly =shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source

const SubscriptionFrequencyWeekly =shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source

const SubscriptionFrequencyYearly =shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source

const SubscriptionStateAwaitingPayment =shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source

const SubscriptionStateCancelled =shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source

const SubscriptionStateExpired =shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source

const SubscriptionStateFailed =shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source

const SubscriptionStatePaid =shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source

const SubscriptionStateProvisioned =shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source

const SubscriptionStateTrial =shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source

const TokenPolicyEffectAllow =shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source

const TokenPolicyEffectDeny =shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source

const TokenStatusActive =shared.TokenStatusActive

This is an alias to an internal value.

View Source

const TokenStatusDisabled =shared.TokenStatusDisabled

This is an alias to an internal value.

View Source

const TokenStatusExpired =shared.TokenStatusExpired

This is an alias to an internal value.

Variables¶

This section is empty.

Functions¶

This section is empty.

Types¶

typeACL ¶

type ACL struct {// IdentifierIDstring `json:"id"`// Description for the ACL.Descriptionstring `json:"description"`// The desired forwarding action for this ACL policy. If set to "false", the policy// will forward traffic to Cloudflare. If set to "true", the policy will forward// traffic locally on the Magic Connector. If not included in request, will default// to false.ForwardLocallybool             `json:"forward_locally"`LAN1ACLConfiguration `json:"lan_1"`LAN2ACLConfiguration `json:"lan_2"`// The name of the ACL.Namestring            `json:"name"`Protocols []AllowedProtocol `json:"protocols"`// The desired traffic direction for this ACL policy. If set to "false", the policy// will allow bidirectional traffic. If set to "true", the policy will only allow// traffic in one direction. If not included in request, will default to false.Unidirectionalbool    `json:"unidirectional"`JSON           aclJSON `json:"-"`}

Bidirectional ACL policy for network traffic within a site.

func (*ACL)UnmarshalJSON ¶

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

typeACLConfiguration ¶

type ACLConfiguration struct {// The identifier for the LAN you want to create an ACL policy with.LANIDstring `json:"lan_id,required"`// The name of the LAN based on the provided lan_id.LANNamestring `json:"lan_name"`// Array of port ranges on the provided LAN that will be included in the ACL. If no// ports or port rangess are provided, communication on any port on this LAN is// allowed.PortRanges []string `json:"port_ranges"`// Array of ports on the provided LAN that will be included in the ACL. If no ports// or port ranges are provided, communication on any port on this LAN is allowed.Ports []int64 `json:"ports"`// Array of subnet IPs within the LAN that will be included in the ACL. If no// subnets are provided, communication on any subnets on this LAN are allowed.Subnets []Subnet             `json:"subnets"`JSON    aclConfigurationJSON `json:"-"`}

func (*ACLConfiguration)UnmarshalJSON ¶

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

typeACLConfigurationParam ¶

type ACLConfigurationParam struct {// The identifier for the LAN you want to create an ACL policy with.LANIDparam.Field[string] `json:"lan_id,required"`// The name of the LAN based on the provided lan_id.LANNameparam.Field[string] `json:"lan_name"`// Array of port ranges on the provided LAN that will be included in the ACL. If no// ports or port rangess are provided, communication on any port on this LAN is// allowed.PortRangesparam.Field[[]string] `json:"port_ranges"`// Array of ports on the provided LAN that will be included in the ACL. If no ports// or port ranges are provided, communication on any port on this LAN is allowed.Portsparam.Field[[]int64] `json:"ports"`// Array of subnet IPs within the LAN that will be included in the ACL. If no// subnets are provided, communication on any subnets on this LAN are allowed.Subnetsparam.Field[[]SubnetParam] `json:"subnets"`}

func (ACLConfigurationParam)MarshalJSON ¶

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

typeAllowedProtocol ¶

type AllowedProtocolstring

Array of allowed communication protocols between configured LANs. If noprotocols are provided, all protocols are allowed.

const (AllowedProtocolTCPAllowedProtocol = "tcp"AllowedProtocolUdpAllowedProtocol = "udp"AllowedProtocolIcmpAllowedProtocol = "icmp")

func (AllowedProtocol)IsKnown ¶

func (rAllowedProtocol) IsKnown()bool

typeAppDeleteParams ¶

type AppDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

func (*AppDeleteResponse)UnmarshalJSON ¶

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

typeAppDeleteResponseEnvelope ¶

type AppDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Custom app defined for an account.ResultAppDeleteResponse `json:"result,required,nullable"`// Whether the API call was successfulSuccessAppDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    appDeleteResponseEnvelopeJSON    `json:"-"`}

func (*AppDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeAppDeleteResponseEnvelopeSuccess ¶

type AppDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (AppDeleteResponseEnvelopeSuccessTrueAppDeleteResponseEnvelopeSuccess =true)

func (AppDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rAppDeleteResponseEnvelopeSuccess) IsKnown()bool

typeAppEditParams ¶added inv4.3.0

type AppEditParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// FQDNs to associate with traffic decisions.Hostnamesparam.Field[[]string] `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnetsparam.Field[[]string] `json:"ip_subnets"`// Display name for the app.Nameparam.Field[string] `json:"name"`// Category of the app.Typeparam.Field[string] `json:"type"`}

func (AppEditParams)MarshalJSON ¶added inv4.3.0

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

typeAppEditResponse ¶added inv4.3.0

type AppEditResponse struct {// Magic account app ID.AccountAppIDstring `json:"account_app_id,required"`// FQDNs to associate with traffic decisions.Hostnames []string `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnets []string `json:"ip_subnets"`// Display name for the app.Namestring `json:"name"`// Category of the app.Typestring              `json:"type"`JSON appEditResponseJSON `json:"-"`}

Custom app defined for an account.

func (*AppEditResponse)UnmarshalJSON ¶added inv4.3.0

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

typeAppEditResponseEnvelope ¶added inv4.3.0

type AppEditResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Custom app defined for an account.ResultAppEditResponse `json:"result,required,nullable"`// Whether the API call was successfulSuccessAppEditResponseEnvelopeSuccess `json:"success,required"`JSON    appEditResponseEnvelopeJSON    `json:"-"`}

func (*AppEditResponseEnvelope)UnmarshalJSON ¶added inv4.3.0

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

typeAppEditResponseEnvelopeSuccess ¶added inv4.3.0

type AppEditResponseEnvelopeSuccessbool

Whether the API call was successful

const (AppEditResponseEnvelopeSuccessTrueAppEditResponseEnvelopeSuccess =true)

func (AppEditResponseEnvelopeSuccess)IsKnown ¶added inv4.3.0

func (rAppEditResponseEnvelopeSuccess) IsKnown()bool

typeAppListParams ¶

type AppListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeAppListResponse ¶

type AppListResponse struct {// Magic account app ID.AccountAppIDstring `json:"account_app_id"`// This field can have the runtime type of [[]string].Hostnames interface{} `json:"hostnames"`// This field can have the runtime type of [[]string].IPSubnets interface{} `json:"ip_subnets"`// Managed app ID.ManagedAppIDstring `json:"managed_app_id"`// Display name for the app.Namestring `json:"name"`// Category of the app.Typestring              `json:"type"`JSON appListResponseJSON `json:"-"`// contains filtered or unexported fields}

Collection of Hostnames and/or IP Subnets to associate with traffic decisions.

func (AppListResponse)AsUnion ¶

func (rAppListResponse) AsUnion()AppListResponseUnion

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

Possible runtime types of the union areAppListResponseMagicAccountApp,AppListResponseMagicManagedApp.

func (*AppListResponse)UnmarshalJSON ¶

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

typeAppListResponseMagicAccountApp ¶

type AppListResponseMagicAccountApp struct {// Magic account app ID.AccountAppIDstring `json:"account_app_id,required"`// FQDNs to associate with traffic decisions.Hostnames []string `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnets []string `json:"ip_subnets"`// Display name for the app.Namestring `json:"name"`// Category of the app.Typestring                             `json:"type"`JSON appListResponseMagicAccountAppJSON `json:"-"`}

Custom app defined for an account.

func (*AppListResponseMagicAccountApp)UnmarshalJSON ¶

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

typeAppListResponseMagicManagedApp ¶

type AppListResponseMagicManagedApp struct {// Managed app ID.ManagedAppIDstring `json:"managed_app_id,required"`// FQDNs to associate with traffic decisions.Hostnames []string `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnets []string `json:"ip_subnets"`// Display name for the app.Namestring `json:"name"`// Category of the app.Typestring                             `json:"type"`JSON appListResponseMagicManagedAppJSON `json:"-"`}

Managed app defined by Cloudflare.

func (*AppListResponseMagicManagedApp)UnmarshalJSON ¶

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

typeAppListResponseUnion ¶

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

Collection of Hostnames and/or IP Subnets to associate with traffic decisions.

Union satisfied byAppListResponseMagicAccountApp orAppListResponseMagicManagedApp.

typeAppNewParams ¶

type AppNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// Display name for the app.Nameparam.Field[string] `json:"name,required"`// Category of the app.Typeparam.Field[string] `json:"type,required"`// FQDNs to associate with traffic decisions.Hostnamesparam.Field[[]string] `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnetsparam.Field[[]string] `json:"ip_subnets"`}

func (AppNewParams)MarshalJSON ¶

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

func (*AppNewResponse)UnmarshalJSON ¶

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

typeAppNewResponseEnvelope ¶

type AppNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Custom app defined for an account.ResultAppNewResponse `json:"result,required,nullable"`// Whether the API call was successfulSuccessAppNewResponseEnvelopeSuccess `json:"success,required"`JSON    appNewResponseEnvelopeJSON    `json:"-"`}

func (*AppNewResponseEnvelope)UnmarshalJSON ¶

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

typeAppNewResponseEnvelopeSuccess ¶

type AppNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (AppNewResponseEnvelopeSuccessTrueAppNewResponseEnvelopeSuccess =true)

func (AppNewResponseEnvelopeSuccess)IsKnown ¶

func (rAppNewResponseEnvelopeSuccess) IsKnown()bool

typeAppService ¶

type AppService struct {Options []option.RequestOption}

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

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

funcNewAppService ¶

func NewAppService(opts ...option.RequestOption) (r *AppService)

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

func (*AppService)Delete ¶

func (r *AppService) Delete(ctxcontext.Context, accountAppIDstring, bodyAppDeleteParams, opts ...option.RequestOption) (res *AppDeleteResponse, errerror)

Deletes specific Account App.

func (*AppService)Edit ¶added inv4.3.0

func (r *AppService) Edit(ctxcontext.Context, accountAppIDstring, paramsAppEditParams, opts ...option.RequestOption) (res *AppEditResponse, errerror)

Updates an Account App

func (*AppService)List ¶

func (r *AppService) List(ctxcontext.Context, queryAppListParams, opts ...option.RequestOption) (res *pagination.SinglePage[AppListResponse], errerror)

Lists Apps associated with an account.

func (*AppService)ListAutoPaging ¶

func (r *AppService) ListAutoPaging(ctxcontext.Context, queryAppListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[AppListResponse]

Lists Apps associated with an account.

func (*AppService)New ¶

func (r *AppService) New(ctxcontext.Context, paramsAppNewParams, opts ...option.RequestOption) (res *AppNewResponse, errerror)

Creates a new App for an account

func (*AppService)Update ¶

func (r *AppService) Update(ctxcontext.Context, accountAppIDstring, paramsAppUpdateParams, opts ...option.RequestOption) (res *AppUpdateResponse, errerror)

Updates an Account App

typeAppUpdateParams ¶

type AppUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// FQDNs to associate with traffic decisions.Hostnamesparam.Field[[]string] `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnetsparam.Field[[]string] `json:"ip_subnets"`// Display name for the app.Nameparam.Field[string] `json:"name"`// Category of the app.Typeparam.Field[string] `json:"type"`}

func (AppUpdateParams)MarshalJSON ¶

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

typeAppUpdateResponse ¶

type AppUpdateResponse struct {// Magic account app ID.AccountAppIDstring `json:"account_app_id,required"`// FQDNs to associate with traffic decisions.Hostnames []string `json:"hostnames"`// IPv4 CIDRs to associate with traffic decisions. (IPv6 CIDRs are currently// unsupported)IPSubnets []string `json:"ip_subnets"`// Display name for the app.Namestring `json:"name"`// Category of the app.Typestring                `json:"type"`JSON appUpdateResponseJSON `json:"-"`}

Custom app defined for an account.

func (*AppUpdateResponse)UnmarshalJSON ¶

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

typeAppUpdateResponseEnvelope ¶

type AppUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Custom app defined for an account.ResultAppUpdateResponse `json:"result,required,nullable"`// Whether the API call was successfulSuccessAppUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    appUpdateResponseEnvelopeJSON    `json:"-"`}

func (*AppUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeAppUpdateResponseEnvelopeSuccess ¶

type AppUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (AppUpdateResponseEnvelopeSuccessTrueAppUpdateResponseEnvelopeSuccess =true)

func (AppUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rAppUpdateResponseEnvelopeSuccess) IsKnown()bool

typeAuditLog ¶

type AuditLog =shared.AuditLog

This is an alias to an internal type.

typeAuditLogAction ¶

type AuditLogAction =shared.AuditLogAction

This is an alias to an internal type.

typeAuditLogActor ¶

type AuditLogActor =shared.AuditLogActor

This is an alias to an internal type.

typeAuditLogActorType ¶

type AuditLogActorType =shared.AuditLogActorType

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

This is an alias to an internal type.

typeAuditLogOwner ¶

type AuditLogOwner =shared.AuditLogOwner

This is an alias to an internal type.

typeAuditLogResource ¶

type AuditLogResource =shared.AuditLogResource

This is an alias to an internal type.

typeCertificateCA ¶

type CertificateCA =shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

typeCertificateRequestType ¶

type CertificateRequestType =shared.CertificateRequestType

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

This is an alias to an internal type.

typeCfInterconnectBulkUpdateParams ¶

type CfInterconnectBulkUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Body              interface{}         `json:"body,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

func (CfInterconnectBulkUpdateParams)MarshalJSON ¶

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

typeCfInterconnectBulkUpdateResponse ¶

type CfInterconnectBulkUpdateResponse struct {Modifiedbool                                                   `json:"modified"`ModifiedInterconnects []CfInterconnectBulkUpdateResponseModifiedInterconnect `json:"modified_interconnects"`JSON                  cfInterconnectBulkUpdateResponseJSON                   `json:"-"`}

func (*CfInterconnectBulkUpdateResponse)UnmarshalJSON ¶

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

typeCfInterconnectBulkUpdateResponseEnvelope ¶

type CfInterconnectBulkUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo            `json:"errors,required"`Messages []shared.ResponseInfo            `json:"messages,required"`ResultCfInterconnectBulkUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessCfInterconnectBulkUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    cfInterconnectBulkUpdateResponseEnvelopeJSON    `json:"-"`}

func (*CfInterconnectBulkUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeCfInterconnectBulkUpdateResponseEnvelopeSuccess ¶

type CfInterconnectBulkUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (CfInterconnectBulkUpdateResponseEnvelopeSuccessTrueCfInterconnectBulkUpdateResponseEnvelopeSuccess =true)

func (CfInterconnectBulkUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rCfInterconnectBulkUpdateResponseEnvelopeSuccess) IsKnown()bool

typeCfInterconnectBulkUpdateResponseModifiedInterconnect ¶

type CfInterconnectBulkUpdateResponseModifiedInterconnect struct {// IdentifierIDstring `json:"id"`// The name of the interconnect. The name cannot share a name with other tunnels.ColoNamestring `json:"colo_name"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the interconnect.Descriptionstring `json:"description"`// The configuration specific to GRE interconnects.GRECfInterconnectBulkUpdateResponseModifiedInterconnectsGRE `json:"gre"`HealthCheckHealthCheck                                              `json:"health_check"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum// value is 576.Mtuint64 `json:"mtu"`// The name of the interconnect. The name cannot share a name with other tunnels.Namestring                                                   `json:"name"`JSON cfInterconnectBulkUpdateResponseModifiedInterconnectJSON `json:"-"`}

func (*CfInterconnectBulkUpdateResponseModifiedInterconnect)UnmarshalJSON ¶

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

typeCfInterconnectBulkUpdateResponseModifiedInterconnectsGRE ¶

type CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE struct {// The IP address assigned to the Cloudflare side of the GRE tunnel created as part// of the Interconnect.CloudflareEndpointstring                                                       `json:"cloudflare_endpoint"`JSON               cfInterconnectBulkUpdateResponseModifiedInterconnectsGREJSON `json:"-"`}

The configuration specific to GRE interconnects.

func (*CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE)UnmarshalJSON ¶

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

typeCfInterconnectGetParams ¶

type CfInterconnectGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeCfInterconnectGetResponse ¶

type CfInterconnectGetResponse struct {InterconnectCfInterconnectGetResponseInterconnect `json:"interconnect"`JSON         cfInterconnectGetResponseJSON         `json:"-"`}

func (*CfInterconnectGetResponse)UnmarshalJSON ¶

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

typeCfInterconnectGetResponseEnvelope ¶

type CfInterconnectGetResponseEnvelope struct {Errors   []shared.ResponseInfo     `json:"errors,required"`Messages []shared.ResponseInfo     `json:"messages,required"`ResultCfInterconnectGetResponse `json:"result,required"`// Whether the API call was successfulSuccessCfInterconnectGetResponseEnvelopeSuccess `json:"success,required"`JSON    cfInterconnectGetResponseEnvelopeJSON    `json:"-"`}

func (*CfInterconnectGetResponseEnvelope)UnmarshalJSON ¶

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

typeCfInterconnectGetResponseEnvelopeSuccess ¶

type CfInterconnectGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (CfInterconnectGetResponseEnvelopeSuccessTrueCfInterconnectGetResponseEnvelopeSuccess =true)

func (CfInterconnectGetResponseEnvelopeSuccess)IsKnown ¶

func (rCfInterconnectGetResponseEnvelopeSuccess) IsKnown()bool

typeCfInterconnectGetResponseInterconnect ¶

type CfInterconnectGetResponseInterconnect struct {// IdentifierIDstring `json:"id"`// The name of the interconnect. The name cannot share a name with other tunnels.ColoNamestring `json:"colo_name"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the interconnect.Descriptionstring `json:"description"`// The configuration specific to GRE interconnects.GRECfInterconnectGetResponseInterconnectGRE `json:"gre"`HealthCheckHealthCheck                              `json:"health_check"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum// value is 576.Mtuint64 `json:"mtu"`// The name of the interconnect. The name cannot share a name with other tunnels.Namestring                                    `json:"name"`JSON cfInterconnectGetResponseInterconnectJSON `json:"-"`}

func (*CfInterconnectGetResponseInterconnect)UnmarshalJSON ¶

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

typeCfInterconnectGetResponseInterconnectGRE ¶

type CfInterconnectGetResponseInterconnectGRE struct {// The IP address assigned to the Cloudflare side of the GRE tunnel created as part// of the Interconnect.CloudflareEndpointstring                                       `json:"cloudflare_endpoint"`JSON               cfInterconnectGetResponseInterconnectGREJSON `json:"-"`}

The configuration specific to GRE interconnects.

func (*CfInterconnectGetResponseInterconnectGRE)UnmarshalJSON ¶

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

typeCfInterconnectListParams ¶

type CfInterconnectListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeCfInterconnectListResponse ¶

type CfInterconnectListResponse struct {Interconnects []CfInterconnectListResponseInterconnect `json:"interconnects"`JSON          cfInterconnectListResponseJSON           `json:"-"`}

func (*CfInterconnectListResponse)UnmarshalJSON ¶

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

typeCfInterconnectListResponseEnvelope ¶

type CfInterconnectListResponseEnvelope struct {Errors   []shared.ResponseInfo      `json:"errors,required"`Messages []shared.ResponseInfo      `json:"messages,required"`ResultCfInterconnectListResponse `json:"result,required"`// Whether the API call was successfulSuccessCfInterconnectListResponseEnvelopeSuccess `json:"success,required"`JSON    cfInterconnectListResponseEnvelopeJSON    `json:"-"`}

func (*CfInterconnectListResponseEnvelope)UnmarshalJSON ¶

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

typeCfInterconnectListResponseEnvelopeSuccess ¶

type CfInterconnectListResponseEnvelopeSuccessbool

Whether the API call was successful

const (CfInterconnectListResponseEnvelopeSuccessTrueCfInterconnectListResponseEnvelopeSuccess =true)

func (CfInterconnectListResponseEnvelopeSuccess)IsKnown ¶

func (rCfInterconnectListResponseEnvelopeSuccess) IsKnown()bool

typeCfInterconnectListResponseInterconnect ¶

type CfInterconnectListResponseInterconnect struct {// IdentifierIDstring `json:"id"`// The name of the interconnect. The name cannot share a name with other tunnels.ColoNamestring `json:"colo_name"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the interconnect.Descriptionstring `json:"description"`// The configuration specific to GRE interconnects.GRECfInterconnectListResponseInterconnectsGRE `json:"gre"`HealthCheckHealthCheck                                `json:"health_check"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum// value is 576.Mtuint64 `json:"mtu"`// The name of the interconnect. The name cannot share a name with other tunnels.Namestring                                     `json:"name"`JSON cfInterconnectListResponseInterconnectJSON `json:"-"`}

func (*CfInterconnectListResponseInterconnect)UnmarshalJSON ¶

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

typeCfInterconnectListResponseInterconnectsGRE ¶

type CfInterconnectListResponseInterconnectsGRE struct {// The IP address assigned to the Cloudflare side of the GRE tunnel created as part// of the Interconnect.CloudflareEndpointstring                                         `json:"cloudflare_endpoint"`JSON               cfInterconnectListResponseInterconnectsGREJSON `json:"-"`}

The configuration specific to GRE interconnects.

func (*CfInterconnectListResponseInterconnectsGRE)UnmarshalJSON ¶

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

typeCfInterconnectService ¶

type CfInterconnectService struct {Options []option.RequestOption}

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

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

funcNewCfInterconnectService ¶

func NewCfInterconnectService(opts ...option.RequestOption) (r *CfInterconnectService)

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

func (*CfInterconnectService)BulkUpdate ¶

func (r *CfInterconnectService) BulkUpdate(ctxcontext.Context, paramsCfInterconnectBulkUpdateParams, opts ...option.RequestOption) (res *CfInterconnectBulkUpdateResponse, errerror)

Updates multiple interconnects associated with an account. Use`?validate_only=true` as an optional query parameter to only run validationwithout persisting changes.

func (*CfInterconnectService)Get ¶

func (r *CfInterconnectService) Get(ctxcontext.Context, cfInterconnectIDstring, paramsCfInterconnectGetParams, opts ...option.RequestOption) (res *CfInterconnectGetResponse, errerror)

Lists details for a specific interconnect.

func (*CfInterconnectService)List ¶

func (r *CfInterconnectService) List(ctxcontext.Context, paramsCfInterconnectListParams, opts ...option.RequestOption) (res *CfInterconnectListResponse, errerror)

Lists interconnects associated with an account.

func (*CfInterconnectService)Update ¶

func (r *CfInterconnectService) Update(ctxcontext.Context, cfInterconnectIDstring, paramsCfInterconnectUpdateParams, opts ...option.RequestOption) (res *CfInterconnectUpdateResponse, errerror)

Updates a specific interconnect associated with an account. Use`?validate_only=true` as an optional query parameter to only run validationwithout persisting changes.

typeCfInterconnectUpdateParams ¶

type CfInterconnectUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// An optional description of the interconnect.Descriptionparam.Field[string] `json:"description"`// The configuration specific to GRE interconnects.GREparam.Field[CfInterconnectUpdateParamsGRE] `json:"gre"`HealthCheckparam.Field[HealthCheckParam]              `json:"health_check"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressparam.Field[string] `json:"interface_address"`// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum// value is 576.Mtuparam.Field[int64] `json:"mtu"`XMagicNewHcTargetparam.Field[bool]  `header:"x-magic-new-hc-target"`}

func (CfInterconnectUpdateParams)MarshalJSON ¶

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

typeCfInterconnectUpdateParamsGRE ¶

type CfInterconnectUpdateParamsGRE struct {// The IP address assigned to the Cloudflare side of the GRE tunnel created as part// of the Interconnect.CloudflareEndpointparam.Field[string] `json:"cloudflare_endpoint"`}

The configuration specific to GRE interconnects.

func (CfInterconnectUpdateParamsGRE)MarshalJSON ¶

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

typeCfInterconnectUpdateResponse ¶

type CfInterconnectUpdateResponse struct {Modifiedbool                                             `json:"modified"`ModifiedInterconnectCfInterconnectUpdateResponseModifiedInterconnect `json:"modified_interconnect"`JSON                 cfInterconnectUpdateResponseJSON                 `json:"-"`}

func (*CfInterconnectUpdateResponse)UnmarshalJSON ¶

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

typeCfInterconnectUpdateResponseEnvelope ¶

type CfInterconnectUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo        `json:"errors,required"`Messages []shared.ResponseInfo        `json:"messages,required"`ResultCfInterconnectUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessCfInterconnectUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    cfInterconnectUpdateResponseEnvelopeJSON    `json:"-"`}

func (*CfInterconnectUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeCfInterconnectUpdateResponseEnvelopeSuccess ¶

type CfInterconnectUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (CfInterconnectUpdateResponseEnvelopeSuccessTrueCfInterconnectUpdateResponseEnvelopeSuccess =true)

func (CfInterconnectUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rCfInterconnectUpdateResponseEnvelopeSuccess) IsKnown()bool

typeCfInterconnectUpdateResponseModifiedInterconnect ¶

type CfInterconnectUpdateResponseModifiedInterconnect struct {// IdentifierIDstring `json:"id"`// The name of the interconnect. The name cannot share a name with other tunnels.ColoNamestring `json:"colo_name"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the interconnect.Descriptionstring `json:"description"`// The configuration specific to GRE interconnects.GRECfInterconnectUpdateResponseModifiedInterconnectGRE `json:"gre"`HealthCheckHealthCheck                                         `json:"health_check"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The Maximum Transmission Unit (MTU) in bytes for the interconnect. The minimum// value is 576.Mtuint64 `json:"mtu"`// The name of the interconnect. The name cannot share a name with other tunnels.Namestring                                               `json:"name"`JSON cfInterconnectUpdateResponseModifiedInterconnectJSON `json:"-"`}

func (*CfInterconnectUpdateResponseModifiedInterconnect)UnmarshalJSON ¶

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

typeCfInterconnectUpdateResponseModifiedInterconnectGRE ¶

type CfInterconnectUpdateResponseModifiedInterconnectGRE struct {// The IP address assigned to the Cloudflare side of the GRE tunnel created as part// of the Interconnect.CloudflareEndpointstring                                                  `json:"cloudflare_endpoint"`JSON               cfInterconnectUpdateResponseModifiedInterconnectGREJSON `json:"-"`}

The configuration specific to GRE interconnects.

func (*CfInterconnectUpdateResponseModifiedInterconnectGRE)UnmarshalJSON ¶

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

typeCloudflareTunnel ¶

type CloudflareTunnel =shared.CloudflareTunnel

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

This is an alias to an internal type.

typeCloudflareTunnelConnection ¶

type CloudflareTunnelConnection =shared.CloudflareTunnelConnection

This is an alias to an internal type.

typeCloudflareTunnelStatus ¶

type CloudflareTunnelStatus =shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

typeCloudflareTunnelTunType ¶

type CloudflareTunnelTunType =shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

typeConnectorDeleteParams ¶added inv4.6.0

type ConnectorDeleteParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorDeleteResponse ¶added inv4.6.0

type ConnectorDeleteResponse struct {IDstring                        `json:"id,required"`Activatedbool                          `json:"activated,required"`InterruptWindowDurationHoursfloat64                       `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                       `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                        `json:"last_updated,required"`Notesstring                        `json:"notes,required"`Timezonestring                        `json:"timezone,required"`DeviceConnectorDeleteResponseDevice `json:"device"`LastHeartbeatstring                        `json:"last_heartbeat"`LastSeenVersionstring                        `json:"last_seen_version"`JSON                         connectorDeleteResponseJSON   `json:"-"`}

func (*ConnectorDeleteResponse)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorDeleteResponseDevice ¶added inv4.6.0

type ConnectorDeleteResponseDevice struct {IDstring                            `json:"id,required"`SerialNumberstring                            `json:"serial_number"`JSON         connectorDeleteResponseDeviceJSON `json:"-"`}

func (*ConnectorDeleteResponseDevice)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorDeleteResponseEnvelope ¶added inv4.6.0

type ConnectorDeleteResponseEnvelope struct {Errors   []ConnectorDeleteResponseEnvelopeErrors   `json:"errors,required"`Messages []ConnectorDeleteResponseEnvelopeMessages `json:"messages,required"`ResultConnectorDeleteResponse                   `json:"result,required"`Successbool                                      `json:"success,required"`JSON     connectorDeleteResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorDeleteResponseEnvelope)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorDeleteResponseEnvelopeErrors ¶added inv4.6.0

type ConnectorDeleteResponseEnvelopeErrors struct {Codefloat64                                   `json:"code,required"`Messagestring                                    `json:"message,required"`JSON    connectorDeleteResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorDeleteResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorDeleteResponseEnvelopeMessages ¶added inv4.6.0

type ConnectorDeleteResponseEnvelopeMessages struct {Codefloat64                                     `json:"code,required"`Messagestring                                      `json:"message,required"`JSON    connectorDeleteResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorDeleteResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorEditParams ¶

type ConnectorEditParams struct {// Account identifierAccountIDparam.Field[string]  `path:"account_id,required"`Activatedparam.Field[bool]    `json:"activated"`InterruptWindowDurationHoursparam.Field[float64] `json:"interrupt_window_duration_hours"`InterruptWindowHourOfDayparam.Field[float64] `json:"interrupt_window_hour_of_day"`Notesparam.Field[string]  `json:"notes"`Timezoneparam.Field[string]  `json:"timezone"`}

func (ConnectorEditParams)MarshalJSON ¶

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

typeConnectorEditResponse ¶

type ConnectorEditResponse struct {IDstring                      `json:"id,required"`Activatedbool                        `json:"activated,required"`InterruptWindowDurationHoursfloat64                     `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                     `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                      `json:"last_updated,required"`Notesstring                      `json:"notes,required"`Timezonestring                      `json:"timezone,required"`DeviceConnectorEditResponseDevice `json:"device"`LastHeartbeatstring                      `json:"last_heartbeat"`LastSeenVersionstring                      `json:"last_seen_version"`JSON                         connectorEditResponseJSON   `json:"-"`}

func (*ConnectorEditResponse)UnmarshalJSON ¶

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

typeConnectorEditResponseDevice ¶

type ConnectorEditResponseDevice struct {IDstring                          `json:"id,required"`SerialNumberstring                          `json:"serial_number"`JSON         connectorEditResponseDeviceJSON `json:"-"`}

func (*ConnectorEditResponseDevice)UnmarshalJSON ¶

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

typeConnectorEditResponseEnvelope ¶

type ConnectorEditResponseEnvelope struct {Errors   []ConnectorEditResponseEnvelopeErrors   `json:"errors,required"`Messages []ConnectorEditResponseEnvelopeMessages `json:"messages,required"`ResultConnectorEditResponse                   `json:"result,required"`Successbool                                    `json:"success,required"`JSON     connectorEditResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorEditResponseEnvelope)UnmarshalJSON ¶

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

typeConnectorEditResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorEditResponseEnvelopeErrors struct {Codefloat64                                 `json:"code,required"`Messagestring                                  `json:"message,required"`JSON    connectorEditResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorEditResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEditResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorEditResponseEnvelopeMessages struct {Codefloat64                                   `json:"code,required"`Messagestring                                    `json:"message,required"`JSON    connectorEditResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorEditResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetParams ¶added inv4.2.0

type ConnectorEventGetParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorEventGetResponse ¶added inv4.2.0

type ConnectorEventGetResponse struct {EConnectorEventGetResponseE `json:"e,required"`// Sequence number, used to order events with the same timestampNfloat64 `json:"n,required"`// Time the Event was recorded (seconds since the Unix epoch)Tfloat64                       `json:"t,required"`JSON connectorEventGetResponseJSON `json:"-"`}

Recorded Event

func (*ConnectorEventGetResponse)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseE ¶added inv4.2.0

type ConnectorEventGetResponseE struct {// Initialized processKConnectorEventGetResponseEK `json:"k,required"`// Location of upgrade bundleURLstring                         `json:"url"`JSON connectorEventGetResponseEJSON `json:"-"`// contains filtered or unexported fields}

func (ConnectorEventGetResponseE)AsUnion ¶added inv4.2.0

func (rConnectorEventGetResponseE) AsUnion()ConnectorEventGetResponseEUnion

AsUnion returns aConnectorEventGetResponseEUnion interface which you can castto the specific types for more type safety.

func (*ConnectorEventGetResponseE)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEConfigureCloudflaredTunnel ¶added inv4.2.0

type ConnectorEventGetResponseEConfigureCloudflaredTunnel struct {// Configured Cloudflared tunnelKConnectorEventGetResponseEConfigureCloudflaredTunnelK    `json:"k,required"`JSON connectorEventGetResponseEConfigureCloudflaredTunnelJSON `json:"-"`}

func (*ConnectorEventGetResponseEConfigureCloudflaredTunnel)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEConfigureCloudflaredTunnelK ¶added inv4.2.0

type ConnectorEventGetResponseEConfigureCloudflaredTunnelKstring

Configured Cloudflared tunnel

const (ConnectorEventGetResponseEConfigureCloudflaredTunnelKConfigureCloudflaredTunnelConnectorEventGetResponseEConfigureCloudflaredTunnelK = "ConfigureCloudflaredTunnel")

func (ConnectorEventGetResponseEConfigureCloudflaredTunnelK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEConfigureCloudflaredTunnelK) IsKnown()bool

typeConnectorEventGetResponseEFinishAttestationFailure ¶added inv4.2.0

type ConnectorEventGetResponseEFinishAttestationFailure struct {// Failed attestationKConnectorEventGetResponseEFinishAttestationFailureK    `json:"k,required"`JSON connectorEventGetResponseEFinishAttestationFailureJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishAttestationFailure)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishAttestationFailureK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishAttestationFailureKstring

Failed attestation

const (ConnectorEventGetResponseEFinishAttestationFailureKFinishAttestationFailureConnectorEventGetResponseEFinishAttestationFailureK = "FinishAttestationFailure")

func (ConnectorEventGetResponseEFinishAttestationFailureK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishAttestationFailureK) IsKnown()bool

typeConnectorEventGetResponseEFinishAttestationSuccess ¶added inv4.2.0

type ConnectorEventGetResponseEFinishAttestationSuccess struct {// Finished attestationKConnectorEventGetResponseEFinishAttestationSuccessK    `json:"k,required"`JSON connectorEventGetResponseEFinishAttestationSuccessJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishAttestationSuccess)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishAttestationSuccessK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishAttestationSuccessKstring

Finished attestation

const (ConnectorEventGetResponseEFinishAttestationSuccessKFinishAttestationSuccessConnectorEventGetResponseEFinishAttestationSuccessK = "FinishAttestationSuccess")

func (ConnectorEventGetResponseEFinishAttestationSuccessK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishAttestationSuccessK) IsKnown()bool

typeConnectorEventGetResponseEFinishRotateCryptKeyFailure ¶added inv4.2.0

type ConnectorEventGetResponseEFinishRotateCryptKeyFailure struct {// Failed crypt key rotationKConnectorEventGetResponseEFinishRotateCryptKeyFailureK    `json:"k,required"`JSON connectorEventGetResponseEFinishRotateCryptKeyFailureJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishRotateCryptKeyFailure)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishRotateCryptKeyFailureK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishRotateCryptKeyFailureKstring

Failed crypt key rotation

const (ConnectorEventGetResponseEFinishRotateCryptKeyFailureKFinishRotateCryptKeyFailureConnectorEventGetResponseEFinishRotateCryptKeyFailureK = "FinishRotateCryptKeyFailure")

func (ConnectorEventGetResponseEFinishRotateCryptKeyFailureK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishRotateCryptKeyFailureK) IsKnown()bool

typeConnectorEventGetResponseEFinishRotateCryptKeySuccess ¶added inv4.2.0

type ConnectorEventGetResponseEFinishRotateCryptKeySuccess struct {// Finished crypt key rotationKConnectorEventGetResponseEFinishRotateCryptKeySuccessK    `json:"k,required"`JSON connectorEventGetResponseEFinishRotateCryptKeySuccessJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishRotateCryptKeySuccess)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishRotateCryptKeySuccessK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishRotateCryptKeySuccessKstring

Finished crypt key rotation

const (ConnectorEventGetResponseEFinishRotateCryptKeySuccessKFinishRotateCryptKeySuccessConnectorEventGetResponseEFinishRotateCryptKeySuccessK = "FinishRotateCryptKeySuccess")

func (ConnectorEventGetResponseEFinishRotateCryptKeySuccessK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishRotateCryptKeySuccessK) IsKnown()bool

typeConnectorEventGetResponseEFinishRotatePkiFailure ¶added inv4.4.0

type ConnectorEventGetResponseEFinishRotatePkiFailure struct {// Failed PKI rotationKConnectorEventGetResponseEFinishRotatePkiFailureK    `json:"k,required"`JSON connectorEventGetResponseEFinishRotatePkiFailureJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishRotatePkiFailure)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventGetResponseEFinishRotatePkiFailureK ¶added inv4.4.0

type ConnectorEventGetResponseEFinishRotatePkiFailureKstring

Failed PKI rotation

const (ConnectorEventGetResponseEFinishRotatePkiFailureKFinishRotatePkiFailureConnectorEventGetResponseEFinishRotatePkiFailureK = "FinishRotatePkiFailure")

func (ConnectorEventGetResponseEFinishRotatePkiFailureK)IsKnown ¶added inv4.4.0

func (rConnectorEventGetResponseEFinishRotatePkiFailureK) IsKnown()bool

typeConnectorEventGetResponseEFinishRotatePkiSuccess ¶added inv4.4.0

type ConnectorEventGetResponseEFinishRotatePkiSuccess struct {// Finished PKI rotationKConnectorEventGetResponseEFinishRotatePkiSuccessK    `json:"k,required"`JSON connectorEventGetResponseEFinishRotatePkiSuccessJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishRotatePkiSuccess)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventGetResponseEFinishRotatePkiSuccessK ¶added inv4.4.0

type ConnectorEventGetResponseEFinishRotatePkiSuccessKstring

Finished PKI rotation

const (ConnectorEventGetResponseEFinishRotatePkiSuccessKFinishRotatePkiSuccessConnectorEventGetResponseEFinishRotatePkiSuccessK = "FinishRotatePkiSuccess")

func (ConnectorEventGetResponseEFinishRotatePkiSuccessK)IsKnown ¶added inv4.4.0

func (rConnectorEventGetResponseEFinishRotatePkiSuccessK) IsKnown()bool

typeConnectorEventGetResponseEFinishUpgradeFailure ¶added inv4.2.0

type ConnectorEventGetResponseEFinishUpgradeFailure struct {// Failed upgradeKConnectorEventGetResponseEFinishUpgradeFailureK    `json:"k,required"`JSON connectorEventGetResponseEFinishUpgradeFailureJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishUpgradeFailure)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishUpgradeFailureK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishUpgradeFailureKstring

Failed upgrade

const (ConnectorEventGetResponseEFinishUpgradeFailureKFinishUpgradeFailureConnectorEventGetResponseEFinishUpgradeFailureK = "FinishUpgradeFailure")

func (ConnectorEventGetResponseEFinishUpgradeFailureK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishUpgradeFailureK) IsKnown()bool

typeConnectorEventGetResponseEFinishUpgradeSuccess ¶added inv4.2.0

type ConnectorEventGetResponseEFinishUpgradeSuccess struct {// Finished upgradeKConnectorEventGetResponseEFinishUpgradeSuccessK    `json:"k,required"`JSON connectorEventGetResponseEFinishUpgradeSuccessJSON `json:"-"`}

func (*ConnectorEventGetResponseEFinishUpgradeSuccess)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEFinishUpgradeSuccessK ¶added inv4.2.0

type ConnectorEventGetResponseEFinishUpgradeSuccessKstring

Finished upgrade

const (ConnectorEventGetResponseEFinishUpgradeSuccessKFinishUpgradeSuccessConnectorEventGetResponseEFinishUpgradeSuccessK = "FinishUpgradeSuccess")

func (ConnectorEventGetResponseEFinishUpgradeSuccessK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEFinishUpgradeSuccessK) IsKnown()bool

typeConnectorEventGetResponseEInit ¶added inv4.2.0

type ConnectorEventGetResponseEInit struct {// Initialized processKConnectorEventGetResponseEInitK    `json:"k,required"`JSON connectorEventGetResponseEInitJSON `json:"-"`}

func (*ConnectorEventGetResponseEInit)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEInitK ¶added inv4.2.0

type ConnectorEventGetResponseEInitKstring

Initialized process

const (ConnectorEventGetResponseEInitKInitConnectorEventGetResponseEInitK = "Init")

func (ConnectorEventGetResponseEInitK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEInitK) IsKnown()bool

typeConnectorEventGetResponseEK ¶added inv4.2.0

type ConnectorEventGetResponseEKstring

Initialized process

const (ConnectorEventGetResponseEKInitConnectorEventGetResponseEK = "Init"ConnectorEventGetResponseEKLeaveConnectorEventGetResponseEK = "Leave"ConnectorEventGetResponseEKStartAttestationConnectorEventGetResponseEK = "StartAttestation"ConnectorEventGetResponseEKFinishAttestationSuccessConnectorEventGetResponseEK = "FinishAttestationSuccess"ConnectorEventGetResponseEKFinishAttestationFailureConnectorEventGetResponseEK = "FinishAttestationFailure"ConnectorEventGetResponseEKStartRotateCryptKeyConnectorEventGetResponseEK = "StartRotateCryptKey"ConnectorEventGetResponseEKFinishRotateCryptKeySuccessConnectorEventGetResponseEK = "FinishRotateCryptKeySuccess"ConnectorEventGetResponseEKFinishRotateCryptKeyFailureConnectorEventGetResponseEK = "FinishRotateCryptKeyFailure"ConnectorEventGetResponseEKStartRotatePkiConnectorEventGetResponseEK = "StartRotatePki"ConnectorEventGetResponseEKFinishRotatePkiSuccessConnectorEventGetResponseEK = "FinishRotatePkiSuccess"ConnectorEventGetResponseEKFinishRotatePkiFailureConnectorEventGetResponseEK = "FinishRotatePkiFailure"ConnectorEventGetResponseEKStartUpgradeConnectorEventGetResponseEK = "StartUpgrade"ConnectorEventGetResponseEKFinishUpgradeSuccessConnectorEventGetResponseEK = "FinishUpgradeSuccess"ConnectorEventGetResponseEKFinishUpgradeFailureConnectorEventGetResponseEK = "FinishUpgradeFailure"ConnectorEventGetResponseEKReconcileConnectorEventGetResponseEK = "Reconcile"ConnectorEventGetResponseEKConfigureCloudflaredTunnelConnectorEventGetResponseEK = "ConfigureCloudflaredTunnel")

func (ConnectorEventGetResponseEK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEK) IsKnown()bool

typeConnectorEventGetResponseELeave ¶added inv4.2.0

type ConnectorEventGetResponseELeave struct {// Stopped processKConnectorEventGetResponseELeaveK    `json:"k,required"`JSON connectorEventGetResponseELeaveJSON `json:"-"`}

func (*ConnectorEventGetResponseELeave)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseELeaveK ¶added inv4.2.0

type ConnectorEventGetResponseELeaveKstring

Stopped process

const (ConnectorEventGetResponseELeaveKLeaveConnectorEventGetResponseELeaveK = "Leave")

func (ConnectorEventGetResponseELeaveK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseELeaveK) IsKnown()bool

typeConnectorEventGetResponseEReconcile ¶added inv4.2.0

type ConnectorEventGetResponseEReconcile struct {// ReconciledKConnectorEventGetResponseEReconcileK    `json:"k,required"`JSON connectorEventGetResponseEReconcileJSON `json:"-"`}

func (*ConnectorEventGetResponseEReconcile)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEReconcileK ¶added inv4.2.0

type ConnectorEventGetResponseEReconcileKstring

Reconciled

const (ConnectorEventGetResponseEReconcileKReconcileConnectorEventGetResponseEReconcileK = "Reconcile")

func (ConnectorEventGetResponseEReconcileK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEReconcileK) IsKnown()bool

typeConnectorEventGetResponseEStartAttestation ¶added inv4.2.0

type ConnectorEventGetResponseEStartAttestation struct {// Started attestationKConnectorEventGetResponseEStartAttestationK    `json:"k,required"`JSON connectorEventGetResponseEStartAttestationJSON `json:"-"`}

func (*ConnectorEventGetResponseEStartAttestation)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEStartAttestationK ¶added inv4.2.0

type ConnectorEventGetResponseEStartAttestationKstring

Started attestation

const (ConnectorEventGetResponseEStartAttestationKStartAttestationConnectorEventGetResponseEStartAttestationK = "StartAttestation")

func (ConnectorEventGetResponseEStartAttestationK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEStartAttestationK) IsKnown()bool

typeConnectorEventGetResponseEStartRotateCryptKey ¶added inv4.2.0

type ConnectorEventGetResponseEStartRotateCryptKey struct {// Started crypt key rotationKConnectorEventGetResponseEStartRotateCryptKeyK    `json:"k,required"`JSON connectorEventGetResponseEStartRotateCryptKeyJSON `json:"-"`}

func (*ConnectorEventGetResponseEStartRotateCryptKey)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEStartRotateCryptKeyK ¶added inv4.2.0

type ConnectorEventGetResponseEStartRotateCryptKeyKstring

Started crypt key rotation

const (ConnectorEventGetResponseEStartRotateCryptKeyKStartRotateCryptKeyConnectorEventGetResponseEStartRotateCryptKeyK = "StartRotateCryptKey")

func (ConnectorEventGetResponseEStartRotateCryptKeyK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEStartRotateCryptKeyK) IsKnown()bool

typeConnectorEventGetResponseEStartRotatePki ¶added inv4.4.0

type ConnectorEventGetResponseEStartRotatePki struct {// Started PKI rotationKConnectorEventGetResponseEStartRotatePkiK    `json:"k,required"`JSON connectorEventGetResponseEStartRotatePkiJSON `json:"-"`}

func (*ConnectorEventGetResponseEStartRotatePki)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventGetResponseEStartRotatePkiK ¶added inv4.4.0

type ConnectorEventGetResponseEStartRotatePkiKstring

Started PKI rotation

const (ConnectorEventGetResponseEStartRotatePkiKStartRotatePkiConnectorEventGetResponseEStartRotatePkiK = "StartRotatePki")

func (ConnectorEventGetResponseEStartRotatePkiK)IsKnown ¶added inv4.4.0

func (rConnectorEventGetResponseEStartRotatePkiK) IsKnown()bool

typeConnectorEventGetResponseEStartUpgrade ¶added inv4.2.0

type ConnectorEventGetResponseEStartUpgrade struct {// Started upgradeKConnectorEventGetResponseEStartUpgradeK `json:"k,required"`// Location of upgrade bundleURLstring                                     `json:"url,required"`JSON connectorEventGetResponseEStartUpgradeJSON `json:"-"`}

func (*ConnectorEventGetResponseEStartUpgrade)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEStartUpgradeK ¶added inv4.2.0

type ConnectorEventGetResponseEStartUpgradeKstring

Started upgrade

const (ConnectorEventGetResponseEStartUpgradeKStartUpgradeConnectorEventGetResponseEStartUpgradeK = "StartUpgrade")

func (ConnectorEventGetResponseEStartUpgradeK)IsKnown ¶added inv4.2.0

func (rConnectorEventGetResponseEStartUpgradeK) IsKnown()bool

typeConnectorEventGetResponseEUnion ¶added inv4.2.0

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

typeConnectorEventGetResponseEnvelope ¶added inv4.2.0

type ConnectorEventGetResponseEnvelope struct {// Recorded EventResultConnectorEventGetResponse                   `json:"result,required"`Successbool                                        `json:"success,required"`Errors   []ConnectorEventGetResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorEventGetResponseEnvelopeMessages `json:"messages"`JSON     connectorEventGetResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorEventGetResponseEnvelope)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorEventGetResponseEnvelopeErrors struct {Codefloat64                                     `json:"code,required"`Messagestring                                      `json:"message,required"`JSON    connectorEventGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorEventGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventGetResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorEventGetResponseEnvelopeMessages struct {Codefloat64                                       `json:"code,required"`Messagestring                                        `json:"message,required"`JSON    connectorEventGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorEventGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventLatestListParams ¶added inv4.4.0

type ConnectorEventLatestListParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorEventLatestListResponse ¶added inv4.4.0

type ConnectorEventLatestListResponse struct {Countfloat64                                `json:"count,required"`Items []ConnectorEventLatestListResponseItem `json:"items,required"`JSON  connectorEventLatestListResponseJSON   `json:"-"`}

func (*ConnectorEventLatestListResponse)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseEnvelope ¶added inv4.4.0

type ConnectorEventLatestListResponseEnvelope struct {ResultConnectorEventLatestListResponse                   `json:"result,required"`Successbool                                               `json:"success,required"`Errors   []ConnectorEventLatestListResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorEventLatestListResponseEnvelopeMessages `json:"messages"`JSON     connectorEventLatestListResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorEventLatestListResponseEnvelope)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseEnvelopeErrors ¶added inv4.4.0

type ConnectorEventLatestListResponseEnvelopeErrors struct {Codefloat64                                            `json:"code,required"`Messagestring                                             `json:"message,required"`JSON    connectorEventLatestListResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorEventLatestListResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseEnvelopeMessages ¶added inv4.4.0

type ConnectorEventLatestListResponseEnvelopeMessages struct {Codefloat64                                              `json:"code,required"`Messagestring                                               `json:"message,required"`JSON    connectorEventLatestListResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorEventLatestListResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItem ¶added inv4.4.0

type ConnectorEventLatestListResponseItem struct {EConnectorEventLatestListResponseItemsE `json:"e,required"`// Sequence number, used to order events with the same timestampNfloat64 `json:"n,required"`// Time the Event was recorded (seconds since the Unix epoch)Tfloat64                                  `json:"t,required"`JSON connectorEventLatestListResponseItemJSON `json:"-"`}

Recorded Event

func (*ConnectorEventLatestListResponseItem)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsE ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsE struct {// Initialized processKConnectorEventLatestListResponseItemsEK `json:"k,required"`// Location of upgrade bundleURLstring                                     `json:"url"`JSON connectorEventLatestListResponseItemsEJSON `json:"-"`// contains filtered or unexported fields}

func (ConnectorEventLatestListResponseItemsE)AsUnion ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsE) AsUnion()ConnectorEventLatestListResponseItemsEUnion

AsUnion returns aConnectorEventLatestListResponseItemsEUnion interface whichyou can cast to the specific types for more type safety.

func (*ConnectorEventLatestListResponseItemsE)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel struct {// Configured Cloudflared tunnelKConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEConfigureCloudflaredTunnelJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnel)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelKstring

Configured Cloudflared tunnel

const (ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelKConfigureCloudflaredTunnelConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK = "ConfigureCloudflaredTunnel")

func (ConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEConfigureCloudflaredTunnelK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishAttestationFailure ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishAttestationFailure struct {// Failed attestationKConnectorEventLatestListResponseItemsEFinishAttestationFailureK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishAttestationFailureJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishAttestationFailure)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishAttestationFailureK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishAttestationFailureKstring

Failed attestation

const (ConnectorEventLatestListResponseItemsEFinishAttestationFailureKFinishAttestationFailureConnectorEventLatestListResponseItemsEFinishAttestationFailureK = "FinishAttestationFailure")

func (ConnectorEventLatestListResponseItemsEFinishAttestationFailureK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishAttestationFailureK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishAttestationSuccess ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishAttestationSuccess struct {// Finished attestationKConnectorEventLatestListResponseItemsEFinishAttestationSuccessK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishAttestationSuccessJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishAttestationSuccess)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishAttestationSuccessK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishAttestationSuccessKstring

Finished attestation

const (ConnectorEventLatestListResponseItemsEFinishAttestationSuccessKFinishAttestationSuccessConnectorEventLatestListResponseItemsEFinishAttestationSuccessK = "FinishAttestationSuccess")

func (ConnectorEventLatestListResponseItemsEFinishAttestationSuccessK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishAttestationSuccessK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure struct {// Failed crypt key rotationKConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailure)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureKstring

Failed crypt key rotation

const (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureKFinishRotateCryptKeyFailureConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK = "FinishRotateCryptKeyFailure")

func (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishRotateCryptKeyFailureK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess struct {// Finished crypt key rotationKConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccess)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessKstring

Finished crypt key rotation

const (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessKFinishRotateCryptKeySuccessConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK = "FinishRotateCryptKeySuccess")

func (ConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishRotateCryptKeySuccessK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishRotatePkiFailure ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure struct {// Failed PKI rotationKConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishRotatePkiFailureJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishRotatePkiFailure)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureKstring

Failed PKI rotation

const (ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureKFinishRotatePkiFailureConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK = "FinishRotatePkiFailure")

func (ConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishRotatePkiFailureK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess struct {// Finished PKI rotationKConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishRotatePkiSuccessJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccess)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessKstring

Finished PKI rotation

const (ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessKFinishRotatePkiSuccessConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK = "FinishRotatePkiSuccess")

func (ConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishRotatePkiSuccessK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishUpgradeFailure ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishUpgradeFailure struct {// Failed upgradeKConnectorEventLatestListResponseItemsEFinishUpgradeFailureK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishUpgradeFailureJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishUpgradeFailure)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishUpgradeFailureK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishUpgradeFailureKstring

Failed upgrade

const (ConnectorEventLatestListResponseItemsEFinishUpgradeFailureKFinishUpgradeFailureConnectorEventLatestListResponseItemsEFinishUpgradeFailureK = "FinishUpgradeFailure")

func (ConnectorEventLatestListResponseItemsEFinishUpgradeFailureK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishUpgradeFailureK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEFinishUpgradeSuccess ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess struct {// Finished upgradeKConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEFinishUpgradeSuccessJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEFinishUpgradeSuccess)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessKstring

Finished upgrade

const (ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessKFinishUpgradeSuccessConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK = "FinishUpgradeSuccess")

func (ConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEFinishUpgradeSuccessK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEInit ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEInit struct {// Initialized processKConnectorEventLatestListResponseItemsEInitK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEInitJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEInit)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEInitK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEInitKstring

Initialized process

const (ConnectorEventLatestListResponseItemsEInitKInitConnectorEventLatestListResponseItemsEInitK = "Init")

func (ConnectorEventLatestListResponseItemsEInitK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEInitK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEKstring

Initialized process

const (ConnectorEventLatestListResponseItemsEKInitConnectorEventLatestListResponseItemsEK = "Init"ConnectorEventLatestListResponseItemsEKLeaveConnectorEventLatestListResponseItemsEK = "Leave"ConnectorEventLatestListResponseItemsEKStartAttestationConnectorEventLatestListResponseItemsEK = "StartAttestation"ConnectorEventLatestListResponseItemsEKFinishAttestationSuccessConnectorEventLatestListResponseItemsEK = "FinishAttestationSuccess"ConnectorEventLatestListResponseItemsEKFinishAttestationFailureConnectorEventLatestListResponseItemsEK = "FinishAttestationFailure"ConnectorEventLatestListResponseItemsEKStartRotateCryptKeyConnectorEventLatestListResponseItemsEK = "StartRotateCryptKey"ConnectorEventLatestListResponseItemsEKFinishRotateCryptKeySuccessConnectorEventLatestListResponseItemsEK = "FinishRotateCryptKeySuccess"ConnectorEventLatestListResponseItemsEKFinishRotateCryptKeyFailureConnectorEventLatestListResponseItemsEK = "FinishRotateCryptKeyFailure"ConnectorEventLatestListResponseItemsEKStartRotatePkiConnectorEventLatestListResponseItemsEK = "StartRotatePki"ConnectorEventLatestListResponseItemsEKFinishRotatePkiSuccessConnectorEventLatestListResponseItemsEK = "FinishRotatePkiSuccess"ConnectorEventLatestListResponseItemsEKFinishRotatePkiFailureConnectorEventLatestListResponseItemsEK = "FinishRotatePkiFailure"ConnectorEventLatestListResponseItemsEKStartUpgradeConnectorEventLatestListResponseItemsEK = "StartUpgrade"ConnectorEventLatestListResponseItemsEKFinishUpgradeSuccessConnectorEventLatestListResponseItemsEK = "FinishUpgradeSuccess"ConnectorEventLatestListResponseItemsEKFinishUpgradeFailureConnectorEventLatestListResponseItemsEK = "FinishUpgradeFailure"ConnectorEventLatestListResponseItemsEKReconcileConnectorEventLatestListResponseItemsEK = "Reconcile"ConnectorEventLatestListResponseItemsEKConfigureCloudflaredTunnelConnectorEventLatestListResponseItemsEK = "ConfigureCloudflaredTunnel")

func (ConnectorEventLatestListResponseItemsEK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEK) IsKnown()bool

typeConnectorEventLatestListResponseItemsELeave ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsELeave struct {// Stopped processKConnectorEventLatestListResponseItemsELeaveK    `json:"k,required"`JSON connectorEventLatestListResponseItemsELeaveJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsELeave)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsELeaveK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsELeaveKstring

Stopped process

const (ConnectorEventLatestListResponseItemsELeaveKLeaveConnectorEventLatestListResponseItemsELeaveK = "Leave")

func (ConnectorEventLatestListResponseItemsELeaveK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsELeaveK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEReconcile ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEReconcile struct {// ReconciledKConnectorEventLatestListResponseItemsEReconcileK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEReconcileJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEReconcile)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEReconcileK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEReconcileKstring

Reconciled

const (ConnectorEventLatestListResponseItemsEReconcileKReconcileConnectorEventLatestListResponseItemsEReconcileK = "Reconcile")

func (ConnectorEventLatestListResponseItemsEReconcileK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEReconcileK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEStartAttestation ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartAttestation struct {// Started attestationKConnectorEventLatestListResponseItemsEStartAttestationK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEStartAttestationJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEStartAttestation)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEStartAttestationK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartAttestationKstring

Started attestation

const (ConnectorEventLatestListResponseItemsEStartAttestationKStartAttestationConnectorEventLatestListResponseItemsEStartAttestationK = "StartAttestation")

func (ConnectorEventLatestListResponseItemsEStartAttestationK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEStartAttestationK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEStartRotateCryptKey ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartRotateCryptKey struct {// Started crypt key rotationKConnectorEventLatestListResponseItemsEStartRotateCryptKeyK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEStartRotateCryptKeyJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEStartRotateCryptKey)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEStartRotateCryptKeyK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartRotateCryptKeyKstring

Started crypt key rotation

const (ConnectorEventLatestListResponseItemsEStartRotateCryptKeyKStartRotateCryptKeyConnectorEventLatestListResponseItemsEStartRotateCryptKeyK = "StartRotateCryptKey")

func (ConnectorEventLatestListResponseItemsEStartRotateCryptKeyK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEStartRotateCryptKeyK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEStartRotatePki ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartRotatePki struct {// Started PKI rotationKConnectorEventLatestListResponseItemsEStartRotatePkiK    `json:"k,required"`JSON connectorEventLatestListResponseItemsEStartRotatePkiJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEStartRotatePki)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEStartRotatePkiK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartRotatePkiKstring

Started PKI rotation

const (ConnectorEventLatestListResponseItemsEStartRotatePkiKStartRotatePkiConnectorEventLatestListResponseItemsEStartRotatePkiK = "StartRotatePki")

func (ConnectorEventLatestListResponseItemsEStartRotatePkiK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEStartRotatePkiK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEStartUpgrade ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartUpgrade struct {// Started upgradeKConnectorEventLatestListResponseItemsEStartUpgradeK `json:"k,required"`// Location of upgrade bundleURLstring                                                 `json:"url,required"`JSON connectorEventLatestListResponseItemsEStartUpgradeJSON `json:"-"`}

func (*ConnectorEventLatestListResponseItemsEStartUpgrade)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorEventLatestListResponseItemsEStartUpgradeK ¶added inv4.4.0

type ConnectorEventLatestListResponseItemsEStartUpgradeKstring

Started upgrade

const (ConnectorEventLatestListResponseItemsEStartUpgradeKStartUpgradeConnectorEventLatestListResponseItemsEStartUpgradeK = "StartUpgrade")

func (ConnectorEventLatestListResponseItemsEStartUpgradeK)IsKnown ¶added inv4.4.0

func (rConnectorEventLatestListResponseItemsEStartUpgradeK) IsKnown()bool

typeConnectorEventLatestListResponseItemsEUnion ¶added inv4.4.0

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

typeConnectorEventLatestService ¶added inv4.4.0

type ConnectorEventLatestService struct {Options []option.RequestOption}

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

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

funcNewConnectorEventLatestService ¶added inv4.4.0

func NewConnectorEventLatestService(opts ...option.RequestOption) (r *ConnectorEventLatestService)

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

func (*ConnectorEventLatestService)List ¶added inv4.4.0

func (r *ConnectorEventLatestService) List(ctxcontext.Context, connectorIDstring, queryConnectorEventLatestListParams, opts ...option.RequestOption) (res *ConnectorEventLatestListResponse, errerror)

Get latest Events

typeConnectorEventListParams ¶added inv4.2.0

type ConnectorEventListParams struct {// Account identifierAccountIDparam.Field[string]  `path:"account_id,required"`Fromparam.Field[float64] `query:"from,required"`Toparam.Field[float64] `query:"to,required"`Cursorparam.Field[string]  `query:"cursor"`Limitparam.Field[float64] `query:"limit"`}

func (ConnectorEventListParams)URLQuery ¶added inv4.2.0

func (rConnectorEventListParams) URLQuery() (vurl.Values)

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

typeConnectorEventListResponse ¶added inv4.2.0

type ConnectorEventListResponse struct {Countfloat64                          `json:"count,required"`Items  []ConnectorEventListResponseItem `json:"items,required"`Cursorstring                           `json:"cursor"`JSON   connectorEventListResponseJSON   `json:"-"`}

func (*ConnectorEventListResponse)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventListResponseEnvelope ¶added inv4.2.0

type ConnectorEventListResponseEnvelope struct {ResultConnectorEventListResponse                   `json:"result,required"`Successbool                                         `json:"success,required"`Errors   []ConnectorEventListResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorEventListResponseEnvelopeMessages `json:"messages"`JSON     connectorEventListResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorEventListResponseEnvelope)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventListResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorEventListResponseEnvelopeErrors struct {Codefloat64                                      `json:"code,required"`Messagestring                                       `json:"message,required"`JSON    connectorEventListResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorEventListResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventListResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorEventListResponseEnvelopeMessages struct {Codefloat64                                        `json:"code,required"`Messagestring                                         `json:"message,required"`JSON    connectorEventListResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorEventListResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventListResponseItem ¶added inv4.2.0

type ConnectorEventListResponseItem struct {// Time the Event was collected (seconds since the Unix epoch)Afloat64 `json:"a,required"`// KindKstring `json:"k,required"`// Sequence number, used to order events with the same timestampNfloat64 `json:"n,required"`// Time the Event was recorded (seconds since the Unix epoch)Tfloat64                            `json:"t,required"`JSON connectorEventListResponseItemJSON `json:"-"`}

func (*ConnectorEventListResponseItem)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorEventService ¶added inv4.2.0

type ConnectorEventService struct {Options []option.RequestOptionLatest  *ConnectorEventLatestService}

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

funcNewConnectorEventService ¶added inv4.2.0

func NewConnectorEventService(opts ...option.RequestOption) (r *ConnectorEventService)

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

func (*ConnectorEventService)Get ¶added inv4.2.0

func (r *ConnectorEventService) Get(ctxcontext.Context, connectorIDstring, eventTfloat64, eventNfloat64, queryConnectorEventGetParams, opts ...option.RequestOption) (res *ConnectorEventGetResponse, errerror)

Get Event

func (*ConnectorEventService)List ¶added inv4.2.0

func (r *ConnectorEventService) List(ctxcontext.Context, connectorIDstring, paramsConnectorEventListParams, opts ...option.RequestOption) (res *ConnectorEventListResponse, errerror)

List Events

typeConnectorGetParams ¶

type ConnectorGetParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorGetResponse ¶

type ConnectorGetResponse struct {IDstring                     `json:"id,required"`Activatedbool                       `json:"activated,required"`InterruptWindowDurationHoursfloat64                    `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                    `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                     `json:"last_updated,required"`Notesstring                     `json:"notes,required"`Timezonestring                     `json:"timezone,required"`DeviceConnectorGetResponseDevice `json:"device"`LastHeartbeatstring                     `json:"last_heartbeat"`LastSeenVersionstring                     `json:"last_seen_version"`JSON                         connectorGetResponseJSON   `json:"-"`}

func (*ConnectorGetResponse)UnmarshalJSON ¶

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

typeConnectorGetResponseDevice ¶

type ConnectorGetResponseDevice struct {IDstring                         `json:"id,required"`SerialNumberstring                         `json:"serial_number"`JSON         connectorGetResponseDeviceJSON `json:"-"`}

func (*ConnectorGetResponseDevice)UnmarshalJSON ¶

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

typeConnectorGetResponseEnvelope ¶

type ConnectorGetResponseEnvelope struct {Errors   []ConnectorGetResponseEnvelopeErrors   `json:"errors,required"`Messages []ConnectorGetResponseEnvelopeMessages `json:"messages,required"`ResultConnectorGetResponse                   `json:"result,required"`Successbool                                   `json:"success,required"`JSON     connectorGetResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorGetResponseEnvelope)UnmarshalJSON ¶

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

typeConnectorGetResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorGetResponseEnvelopeErrors struct {Codefloat64                                `json:"code,required"`Messagestring                                 `json:"message,required"`JSON    connectorGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorGetResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorGetResponseEnvelopeMessages struct {Codefloat64                                  `json:"code,required"`Messagestring                                   `json:"message,required"`JSON    connectorGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorListParams ¶

type ConnectorListParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorListResponse ¶

type ConnectorListResponse struct {IDstring                      `json:"id,required"`Activatedbool                        `json:"activated,required"`InterruptWindowDurationHoursfloat64                     `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                     `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                      `json:"last_updated,required"`Notesstring                      `json:"notes,required"`Timezonestring                      `json:"timezone,required"`DeviceConnectorListResponseDevice `json:"device"`LastHeartbeatstring                      `json:"last_heartbeat"`LastSeenVersionstring                      `json:"last_seen_version"`JSON                         connectorListResponseJSON   `json:"-"`}

func (*ConnectorListResponse)UnmarshalJSON ¶

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

typeConnectorListResponseDevice ¶

type ConnectorListResponseDevice struct {IDstring                          `json:"id,required"`SerialNumberstring                          `json:"serial_number"`JSON         connectorListResponseDeviceJSON `json:"-"`}

func (*ConnectorListResponseDevice)UnmarshalJSON ¶

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

typeConnectorNewParams ¶added inv4.6.0

type ConnectorNewParams struct {// Account identifierAccountIDparam.Field[string]                   `path:"account_id,required"`Deviceparam.Field[ConnectorNewParamsDevice] `json:"device,required"`Activatedparam.Field[bool]                     `json:"activated"`InterruptWindowDurationHoursparam.Field[float64]                  `json:"interrupt_window_duration_hours"`InterruptWindowHourOfDayparam.Field[float64]                  `json:"interrupt_window_hour_of_day"`Notesparam.Field[string]                   `json:"notes"`Timezoneparam.Field[string]                   `json:"timezone"`}

func (ConnectorNewParams)MarshalJSON ¶added inv4.6.0

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

typeConnectorNewParamsDevice ¶added inv4.6.0

type ConnectorNewParamsDevice struct {IDparam.Field[string] `json:"id"`SerialNumberparam.Field[string] `json:"serial_number"`}

func (ConnectorNewParamsDevice)MarshalJSON ¶added inv4.6.0

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

typeConnectorNewResponse ¶added inv4.6.0

type ConnectorNewResponse struct {IDstring                     `json:"id,required"`Activatedbool                       `json:"activated,required"`InterruptWindowDurationHoursfloat64                    `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                    `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                     `json:"last_updated,required"`Notesstring                     `json:"notes,required"`Timezonestring                     `json:"timezone,required"`DeviceConnectorNewResponseDevice `json:"device"`LastHeartbeatstring                     `json:"last_heartbeat"`LastSeenVersionstring                     `json:"last_seen_version"`JSON                         connectorNewResponseJSON   `json:"-"`}

func (*ConnectorNewResponse)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorNewResponseDevice ¶added inv4.6.0

type ConnectorNewResponseDevice struct {IDstring                         `json:"id,required"`SerialNumberstring                         `json:"serial_number"`JSON         connectorNewResponseDeviceJSON `json:"-"`}

func (*ConnectorNewResponseDevice)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorNewResponseEnvelope ¶added inv4.6.0

type ConnectorNewResponseEnvelope struct {Errors   []ConnectorNewResponseEnvelopeErrors   `json:"errors,required"`Messages []ConnectorNewResponseEnvelopeMessages `json:"messages,required"`ResultConnectorNewResponse                   `json:"result,required"`Successbool                                   `json:"success,required"`JSON     connectorNewResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorNewResponseEnvelope)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorNewResponseEnvelopeErrors ¶added inv4.6.0

type ConnectorNewResponseEnvelopeErrors struct {Codefloat64                                `json:"code,required"`Messagestring                                 `json:"message,required"`JSON    connectorNewResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorNewResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorNewResponseEnvelopeMessages ¶added inv4.6.0

type ConnectorNewResponseEnvelopeMessages struct {Codefloat64                                  `json:"code,required"`Messagestring                                   `json:"message,required"`JSON    connectorNewResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorNewResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.6.0

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

typeConnectorService ¶

type ConnectorService struct {Options   []option.RequestOptionEvents    *ConnectorEventServiceSnapshots *ConnectorSnapshotService}

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

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

funcNewConnectorService ¶

func NewConnectorService(opts ...option.RequestOption) (r *ConnectorService)

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

func (*ConnectorService)Delete ¶added inv4.6.0

func (r *ConnectorService) Delete(ctxcontext.Context, connectorIDstring, bodyConnectorDeleteParams, opts ...option.RequestOption) (res *ConnectorDeleteResponse, errerror)

Remove a connector from your account

func (*ConnectorService)Edit ¶

func (r *ConnectorService) Edit(ctxcontext.Context, connectorIDstring, paramsConnectorEditParams, opts ...option.RequestOption) (res *ConnectorEditResponse, errerror)

Edit Connector to update specific properties

func (*ConnectorService)Get ¶

func (r *ConnectorService) Get(ctxcontext.Context, connectorIDstring, queryConnectorGetParams, opts ...option.RequestOption) (res *ConnectorGetResponse, errerror)

Fetch Connector

func (*ConnectorService)List ¶

func (r *ConnectorService) List(ctxcontext.Context, queryConnectorListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ConnectorListResponse], errerror)

List Connectors

func (*ConnectorService)ListAutoPaging ¶

func (r *ConnectorService) ListAutoPaging(ctxcontext.Context, queryConnectorListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ConnectorListResponse]

List Connectors

func (*ConnectorService)New ¶added inv4.6.0

func (r *ConnectorService) New(ctxcontext.Context, paramsConnectorNewParams, opts ...option.RequestOption) (res *ConnectorNewResponse, errerror)

Add a connector to your account

func (*ConnectorService)Update ¶

func (r *ConnectorService) Update(ctxcontext.Context, connectorIDstring, paramsConnectorUpdateParams, opts ...option.RequestOption) (res *ConnectorUpdateResponse, errerror)

Replace Connector

typeConnectorSnapshotGetParams ¶added inv4.2.0

type ConnectorSnapshotGetParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorSnapshotGetResponse ¶added inv4.2.0

type ConnectorSnapshotGetResponse struct {// Count of failures to reclaim spaceCountReclaimFailuresfloat64 `json:"count_reclaim_failures,required"`// Count of reclaimed pathsCountReclaimedPathsfloat64 `json:"count_reclaimed_paths,required"`// Count of failed snapshot recordingsCountRecordFailedfloat64 `json:"count_record_failed,required"`// Count of failed snapshot transmissionsCountTransmitFailuresfloat64 `json:"count_transmit_failures,required"`// Time the Snapshot was recorded (seconds since the Unix epoch)Tfloat64 `json:"t,required"`// VersionVstring `json:"v,required"`// Count of processors/coresCPUCountfloat64 `json:"cpu_count"`// Percentage of time over a 10 second window that tasks were stalledCPUPressure10sfloat64 `json:"cpu_pressure_10s"`// Percentage of time over a 5 minute window that tasks were stalledCPUPressure300sfloat64 `json:"cpu_pressure_300s"`// Percentage of time over a 1 minute window that tasks were stalledCPUPressure60sfloat64 `json:"cpu_pressure_60s"`// Total stall time (microseconds)CPUPressureTotalUsfloat64 `json:"cpu_pressure_total_us"`// Time spent running a virtual CPU or guest OS (milliseconds)CPUTimeGuestMsfloat64 `json:"cpu_time_guest_ms"`// Time spent running a niced guest (milliseconds)CPUTimeGuestNiceMsfloat64 `json:"cpu_time_guest_nice_ms"`// Time spent in idle state (milliseconds)CPUTimeIdleMsfloat64 `json:"cpu_time_idle_ms"`// Time spent wait for I/O to complete (milliseconds)CPUTimeIowaitMsfloat64 `json:"cpu_time_iowait_ms"`// Time spent servicing interrupts (milliseconds)CPUTimeIrqMsfloat64 `json:"cpu_time_irq_ms"`// Time spent in low-priority user mode (milliseconds)CPUTimeNiceMsfloat64 `json:"cpu_time_nice_ms"`// Time spent servicing softirqs (milliseconds)CPUTimeSoftirqMsfloat64 `json:"cpu_time_softirq_ms"`// Time stolen (milliseconds)CPUTimeStealMsfloat64 `json:"cpu_time_steal_ms"`// Time spent in system mode (milliseconds)CPUTimeSystemMsfloat64 `json:"cpu_time_system_ms"`// Time spent in user mode (milliseconds)CPUTimeUserMsfloat64                                 `json:"cpu_time_user_ms"`DHCPLeases    []ConnectorSnapshotGetResponseDHCPLease `json:"dhcp_leases"`Disks         []ConnectorSnapshotGetResponseDisk      `json:"disks"`// Name of high availability stateHaStatestring `json:"ha_state"`// Numeric value associated with high availability state (0 = disabled, 1 = active,// 2 = standby, 3 = stopped, 4 = fault)HaValuefloat64                                 `json:"ha_value"`Interfaces []ConnectorSnapshotGetResponseInterface `json:"interfaces"`// Percentage of time over a 10 second window that all tasks were stalledIoPressureFull10sfloat64 `json:"io_pressure_full_10s"`// Percentage of time over a 5 minute window that all tasks were stalledIoPressureFull300sfloat64 `json:"io_pressure_full_300s"`// Percentage of time over a 1 minute window that all tasks were stalledIoPressureFull60sfloat64 `json:"io_pressure_full_60s"`// Total stall time (microseconds)IoPressureFullTotalUsfloat64 `json:"io_pressure_full_total_us"`// Percentage of time over a 10 second window that some tasks were stalledIoPressureSome10sfloat64 `json:"io_pressure_some_10s"`// Percentage of time over a 3 minute window that some tasks were stalledIoPressureSome300sfloat64 `json:"io_pressure_some_300s"`// Percentage of time over a 1 minute window that some tasks were stalledIoPressureSome60sfloat64 `json:"io_pressure_some_60s"`// Total stall time (microseconds)IoPressureSomeTotalUsfloat64 `json:"io_pressure_some_total_us"`// Boot time (seconds since Unix epoch)KernelBtimefloat64 `json:"kernel_btime"`// Number of context switches that the system underwentKernelCtxtfloat64 `json:"kernel_ctxt"`// Number of forks since bootKernelProcessesfloat64 `json:"kernel_processes"`// Number of processes blocked waiting for I/OKernelProcessesBlockedfloat64 `json:"kernel_processes_blocked"`// Number of processes in runnable stateKernelProcessesRunningfloat64 `json:"kernel_processes_running"`// The fifteen-minute load averageLoadAverage15mfloat64 `json:"load_average_15m"`// The one-minute load averageLoadAverage1mfloat64 `json:"load_average_1m"`// The five-minute load averageLoadAverage5mfloat64 `json:"load_average_5m"`// Number of currently runnable kernel scheduling entitiesLoadAverageCurfloat64 `json:"load_average_cur"`// Number of kernel scheduling entities that currently exist on the systemLoadAverageMaxfloat64 `json:"load_average_max"`// Memory that has been used more recentlyMemoryActiveBytesfloat64 `json:"memory_active_bytes"`// Non-file backed huge pages mapped into user-space page tablesMemoryAnonHugepagesBytesfloat64 `json:"memory_anon_hugepages_bytes"`// Non-file backed pages mapped into user-space page tablesMemoryAnonPagesBytesfloat64 `json:"memory_anon_pages_bytes"`// Estimate of how much memory is available for starting new applicationsMemoryAvailableBytesfloat64 `json:"memory_available_bytes"`// Memory used for block device bounce buffersMemoryBounceBytesfloat64 `json:"memory_bounce_bytes"`// Relatively temporary storage for raw disk blocksMemoryBuffersBytesfloat64 `json:"memory_buffers_bytes"`// In-memory cache for files read from the diskMemoryCachedBytesfloat64 `json:"memory_cached_bytes"`// Free CMA (Contiguous Memory Allocator) pagesMemoryCmaFreeBytesfloat64 `json:"memory_cma_free_bytes"`// Total CMA (Contiguous Memory Allocator) pagesMemoryCmaTotalBytesfloat64 `json:"memory_cma_total_bytes"`// Total amount of memory currently available to be allocated on the systemMemoryCommitLimitBytesfloat64 `json:"memory_commit_limit_bytes"`// Amount of memory presently allocated on the systemMemoryCommittedAsBytesfloat64 `json:"memory_committed_as_bytes"`// Memory which is waiting to get written back to the diskMemoryDirtyBytesfloat64 `json:"memory_dirty_bytes"`// The sum of LowFree and HighFreeMemoryFreeBytesfloat64 `json:"memory_free_bytes"`// Amount of free highmemMemoryHighFreeBytesfloat64 `json:"memory_high_free_bytes"`// Total amount of highmemMemoryHighTotalBytesfloat64 `json:"memory_high_total_bytes"`// The number of huge pages in the pool that are not yet allocatedMemoryHugepagesFreefloat64 `json:"memory_hugepages_free"`// Number of huge pages for which a commitment has been made, but no allocation has// yet been madeMemoryHugepagesRsvdfloat64 `json:"memory_hugepages_rsvd"`// Number of huge pages in the pool above the thresholdMemoryHugepagesSurpfloat64 `json:"memory_hugepages_surp"`// The size of the pool of huge pagesMemoryHugepagesTotalfloat64 `json:"memory_hugepages_total"`// The size of huge pagesMemoryHugepagesizeBytesfloat64 `json:"memory_hugepagesize_bytes"`// Memory which has been less recently usedMemoryInactiveBytesfloat64 `json:"memory_inactive_bytes"`// Kernel allocations that the kernel will attempt to reclaim under memory pressureMemoryKReclaimableBytesfloat64 `json:"memory_k_reclaimable_bytes"`// Amount of memory allocated to kernel stacksMemoryKernelStackBytesfloat64 `json:"memory_kernel_stack_bytes"`// Amount of free lowmemMemoryLowFreeBytesfloat64 `json:"memory_low_free_bytes"`// Total amount of lowmemMemoryLowTotalBytesfloat64 `json:"memory_low_total_bytes"`// Files which have been mapped into memoryMemoryMappedBytesfloat64 `json:"memory_mapped_bytes"`// Amount of memory dedicated to the lowest level of page tablesMemoryPageTablesBytesfloat64 `json:"memory_page_tables_bytes"`// Memory allocated to the per-cpu alloctor used to back per-cpu allocationsMemoryPerCPUBytesfloat64 `json:"memory_per_cpu_bytes"`// Percentage of time over a 10 second window that all tasks were stalledMemoryPressureFull10sfloat64 `json:"memory_pressure_full_10s"`// Percentage of time over a 5 minute window that all tasks were stalledMemoryPressureFull300sfloat64 `json:"memory_pressure_full_300s"`// Percentage of time over a 1 minute window that all tasks were stalledMemoryPressureFull60sfloat64 `json:"memory_pressure_full_60s"`// Total stall time (microseconds)MemoryPressureFullTotalUsfloat64 `json:"memory_pressure_full_total_us"`// Percentage of time over a 10 second window that some tasks were stalledMemoryPressureSome10sfloat64 `json:"memory_pressure_some_10s"`// Percentage of time over a 5 minute window that some tasks were stalledMemoryPressureSome300sfloat64 `json:"memory_pressure_some_300s"`// Percentage of time over a 1 minute window that some tasks were stalledMemoryPressureSome60sfloat64 `json:"memory_pressure_some_60s"`// Total stall time (microseconds)MemoryPressureSomeTotalUsfloat64 `json:"memory_pressure_some_total_us"`// Part of slab that can be reclaimed on memory pressureMemorySReclaimableBytesfloat64 `json:"memory_s_reclaimable_bytes"`// Part of slab that cannot be reclaimed on memory pressureMemorySUnreclaimBytesfloat64 `json:"memory_s_unreclaim_bytes"`// Amount of memory dedicated to the lowest level of page tablesMemorySecondaryPageTablesBytesfloat64 `json:"memory_secondary_page_tables_bytes"`// Amount of memory consumed by tmpfsMemoryShmemBytesfloat64 `json:"memory_shmem_bytes"`// Memory used by shmem and tmpfs, allocated with huge pagesMemoryShmemHugepagesBytesfloat64 `json:"memory_shmem_hugepages_bytes"`// Shared memory mapped into user space with huge pagesMemoryShmemPmdMappedBytesfloat64 `json:"memory_shmem_pmd_mapped_bytes"`// In-kernel data structures cacheMemorySlabBytesfloat64 `json:"memory_slab_bytes"`// Memory swapped out and back in while still in swap fileMemorySwapCachedBytesfloat64 `json:"memory_swap_cached_bytes"`// Amount of swap space that is currently unusedMemorySwapFreeBytesfloat64 `json:"memory_swap_free_bytes"`// Total amount of swap space availableMemorySwapTotalBytesfloat64 `json:"memory_swap_total_bytes"`// Total usable RAMMemoryTotalBytesfloat64 `json:"memory_total_bytes"`// Largest contiguous block of vmalloc area which is freeMemoryVmallocChunkBytesfloat64 `json:"memory_vmalloc_chunk_bytes"`// Total size of vmalloc memory areaMemoryVmallocTotalBytesfloat64 `json:"memory_vmalloc_total_bytes"`// Amount of vmalloc area which is usedMemoryVmallocUsedBytesfloat64 `json:"memory_vmalloc_used_bytes"`// Memory which is actively being written back to the diskMemoryWritebackBytesfloat64 `json:"memory_writeback_bytes"`// Memory used by FUSE for temporary writeback buffersMemoryWritebackTmpBytesfloat64 `json:"memory_writeback_tmp_bytes"`// Memory consumed by the zswap backend, compressedMemoryZSwapBytesfloat64 `json:"memory_z_swap_bytes"`// Amount of anonymous memory stored in zswap, uncompressedMemoryZSwappedBytesfloat64                              `json:"memory_z_swapped_bytes"`Mounts              []ConnectorSnapshotGetResponseMount  `json:"mounts"`Netdevs             []ConnectorSnapshotGetResponseNetdev `json:"netdevs"`// Number of ICMP Address Mask Reply messages receivedSnmpIcmpInAddrMaskRepsfloat64 `json:"snmp_icmp_in_addr_mask_reps"`// Number of ICMP Address Mask Request messages receivedSnmpIcmpInAddrMasksfloat64 `json:"snmp_icmp_in_addr_masks"`// Number of ICMP messages received with bad checksumsSnmpIcmpInCsumErrorsfloat64 `json:"snmp_icmp_in_csum_errors"`// Number of ICMP Destination Unreachable messages receivedSnmpIcmpInDestUnreachsfloat64 `json:"snmp_icmp_in_dest_unreachs"`// Number of ICMP Echo Reply messages receivedSnmpIcmpInEchoRepsfloat64 `json:"snmp_icmp_in_echo_reps"`// Number of ICMP Echo (request) messages receivedSnmpIcmpInEchosfloat64 `json:"snmp_icmp_in_echos"`// Number of ICMP messages received with ICMP-specific errorsSnmpIcmpInErrorsfloat64 `json:"snmp_icmp_in_errors"`// Number of ICMP messages receivedSnmpIcmpInMsgsfloat64 `json:"snmp_icmp_in_msgs"`// Number of ICMP Parameter Problem messages receivedSnmpIcmpInParmProbsfloat64 `json:"snmp_icmp_in_parm_probs"`// Number of ICMP Redirect messages receivedSnmpIcmpInRedirectsfloat64 `json:"snmp_icmp_in_redirects"`// Number of ICMP Source Quench messages receivedSnmpIcmpInSrcQuenchsfloat64 `json:"snmp_icmp_in_src_quenchs"`// Number of ICMP Time Exceeded messages receivedSnmpIcmpInTimeExcdsfloat64 `json:"snmp_icmp_in_time_excds"`// Number of ICMP Address Mask Request messages receivedSnmpIcmpInTimestampRepsfloat64 `json:"snmp_icmp_in_timestamp_reps"`// Number of ICMP Timestamp (request) messages receivedSnmpIcmpInTimestampsfloat64 `json:"snmp_icmp_in_timestamps"`// Number of ICMP Address Mask Reply messages sentSnmpIcmpOutAddrMaskRepsfloat64 `json:"snmp_icmp_out_addr_mask_reps"`// Number of ICMP Address Mask Request messages sentSnmpIcmpOutAddrMasksfloat64 `json:"snmp_icmp_out_addr_masks"`// Number of ICMP Destination Unreachable messages sentSnmpIcmpOutDestUnreachsfloat64 `json:"snmp_icmp_out_dest_unreachs"`// Number of ICMP Echo Reply messages sentSnmpIcmpOutEchoRepsfloat64 `json:"snmp_icmp_out_echo_reps"`// Number of ICMP Echo (request) messages sentSnmpIcmpOutEchosfloat64 `json:"snmp_icmp_out_echos"`// Number of ICMP messages which this entity did not send due to ICMP-specific// errorsSnmpIcmpOutErrorsfloat64 `json:"snmp_icmp_out_errors"`// Number of ICMP messages attempted to sendSnmpIcmpOutMsgsfloat64 `json:"snmp_icmp_out_msgs"`// Number of ICMP Parameter Problem messages sentSnmpIcmpOutParmProbsfloat64 `json:"snmp_icmp_out_parm_probs"`// Number of ICMP Redirect messages sentSnmpIcmpOutRedirectsfloat64 `json:"snmp_icmp_out_redirects"`// Number of ICMP Source Quench messages sentSnmpIcmpOutSrcQuenchsfloat64 `json:"snmp_icmp_out_src_quenchs"`// Number of ICMP Time Exceeded messages sentSnmpIcmpOutTimeExcdsfloat64 `json:"snmp_icmp_out_time_excds"`// Number of ICMP Timestamp Reply messages sentSnmpIcmpOutTimestampRepsfloat64 `json:"snmp_icmp_out_timestamp_reps"`// Number of ICMP Timestamp (request) messages sentSnmpIcmpOutTimestampsfloat64 `json:"snmp_icmp_out_timestamps"`// Default value of the Time-To-Live field of the IP headerSnmpIPDefaultTTLfloat64 `json:"snmp_ip_default_ttl"`// Number of datagrams forwarded to their final destinationSnmpIPForwDatagramsfloat64 `json:"snmp_ip_forw_datagrams"`// Set when acting as an IP gatewaySnmpIPForwardingEnabledbool `json:"snmp_ip_forwarding_enabled"`// Number of datagrams generated by fragmentationSnmpIPFragCreatesfloat64 `json:"snmp_ip_frag_creates"`// Number of datagrams discarded because fragmentation failedSnmpIPFragFailsfloat64 `json:"snmp_ip_frag_fails"`// Number of datagrams successfully fragmentedSnmpIPFragOksfloat64 `json:"snmp_ip_frag_oks"`// Number of input datagrams discarded due to errors in the IP addressSnmpIPInAddrErrorsfloat64 `json:"snmp_ip_in_addr_errors"`// Number of input datagrams successfully delivered to IP user-protocolsSnmpIPInDeliversfloat64 `json:"snmp_ip_in_delivers"`// Number of input datagrams otherwise discardedSnmpIPInDiscardsfloat64 `json:"snmp_ip_in_discards"`// Number of input datagrams discarded due to errors in the IP headerSnmpIPInHdrErrorsfloat64 `json:"snmp_ip_in_hdr_errors"`// Number of input datagrams received from interfacesSnmpIPInReceivesfloat64 `json:"snmp_ip_in_receives"`// Number of input datagrams discarded due unknown or unsupported protocolSnmpIPInUnknownProtosfloat64 `json:"snmp_ip_in_unknown_protos"`// Number of output datagrams otherwise discardedSnmpIPOutDiscardsfloat64 `json:"snmp_ip_out_discards"`// Number of output datagrams discarded because no route matchedSnmpIPOutNoRoutesfloat64 `json:"snmp_ip_out_no_routes"`// Number of datagrams supplied for transmissionSnmpIPOutRequestsfloat64 `json:"snmp_ip_out_requests"`// Number of failures detected by the reassembly algorithmSnmpIPReasmFailsfloat64 `json:"snmp_ip_reasm_fails"`// Number of datagrams successfully reassembledSnmpIPReasmOksfloat64 `json:"snmp_ip_reasm_oks"`// Number of fragments received which needed to be reassembledSnmpIPReasmReqdsfloat64 `json:"snmp_ip_reasm_reqds"`// Number of seconds fragments are held while awaiting reassemblySnmpIPReasmTimeoutfloat64 `json:"snmp_ip_reasm_timeout"`// Number of times TCP transitions to SYN-SENT from CLOSEDSnmpTCPActiveOpensfloat64 `json:"snmp_tcp_active_opens"`// Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus// transitions to LISTEN from SYN-RCVDSnmpTCPAttemptFailsfloat64 `json:"snmp_tcp_attempt_fails"`// Number of TCP connections in ESTABLISHED or CLOSE-WAITSnmpTCPCurrEstabfloat64 `json:"snmp_tcp_curr_estab"`// Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAITSnmpTCPEstabResetsfloat64 `json:"snmp_tcp_estab_resets"`// Number of TCP segments received with checksum errorsSnmpTCPInCsumErrorsfloat64 `json:"snmp_tcp_in_csum_errors"`// Number of TCP segments received in errorSnmpTCPInErrsfloat64 `json:"snmp_tcp_in_errs"`// Number of TCP segments receivedSnmpTCPInSegsfloat64 `json:"snmp_tcp_in_segs"`// Limit on the total number of TCP connectionsSnmpTCPMaxConnfloat64 `json:"snmp_tcp_max_conn"`// Number of TCP segments sent with RST flagSnmpTCPOutRstsfloat64 `json:"snmp_tcp_out_rsts"`// Number of TCP segments sentSnmpTCPOutSegsfloat64 `json:"snmp_tcp_out_segs"`// Number of times TCP transitions to SYN-RCVD from LISTENSnmpTCPPassiveOpensfloat64 `json:"snmp_tcp_passive_opens"`// Number of TCP segments retransmittedSnmpTCPRetransSegsfloat64 `json:"snmp_tcp_retrans_segs"`// Maximum value permitted by a TCP implementation for the retransmission timeout// (milliseconds)SnmpTCPRtoMaxfloat64 `json:"snmp_tcp_rto_max"`// Minimum value permitted by a TCP implementation for the retransmission timeout// (milliseconds)SnmpTCPRtoMinfloat64 `json:"snmp_tcp_rto_min"`// Number of UDP datagrams delivered to UDP applicationsSnmpUdpInDatagramsfloat64 `json:"snmp_udp_in_datagrams"`// Number of UDP datagrams failed to be delivered for reasons other than lack of// application at the destination portSnmpUdpInErrorsfloat64 `json:"snmp_udp_in_errors"`// Number of UDP datagrams received for which there was not application at the// destination portSnmpUdpNoPortsfloat64 `json:"snmp_udp_no_ports"`// Number of UDP datagrams sentSnmpUdpOutDatagramsfloat64 `json:"snmp_udp_out_datagrams"`// Boottime of the system (seconds since the Unix epoch)SystemBootTimeSfloat64                               `json:"system_boot_time_s"`Thermals        []ConnectorSnapshotGetResponseThermal `json:"thermals"`Tunnels         []ConnectorSnapshotGetResponseTunnel  `json:"tunnels"`// Sum of how much time each core has spent idleUptimeIdleMsfloat64 `json:"uptime_idle_ms"`// Uptime of the system, including time spent in suspendUptimeTotalMsfloat64                          `json:"uptime_total_ms"`JSON          connectorSnapshotGetResponseJSON `json:"-"`}

Snapshot

func (*ConnectorSnapshotGetResponse)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseDHCPLease ¶added inv4.3.0

type ConnectorSnapshotGetResponseDHCPLease struct {// Client ID of the device the IP Address was leased toClientIDstring `json:"client_id,required"`// Expiry time of the DHCP lease (seconds since the Unix epoch)ExpiryTimefloat64 `json:"expiry_time,required"`// Hostname of the device the IP Address was leased toHostnamestring `json:"hostname,required"`// Name of the network interfaceInterfaceNamestring `json:"interface_name,required"`// IP Address that was leasedIPAddressstring `json:"ip_address,required"`// MAC Address of the device the IP Address was leased toMacAddressstring `json:"mac_address,required"`// Connector identifierConnectorIDstring                                    `json:"connector_id"`JSON        connectorSnapshotGetResponseDHCPLeaseJSON `json:"-"`}

Snapshot DHCP lease

func (*ConnectorSnapshotGetResponseDHCPLease)UnmarshalJSON ¶added inv4.3.0

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

typeConnectorSnapshotGetResponseDisk ¶added inv4.2.0

type ConnectorSnapshotGetResponseDisk struct {// I/Os currently in progressInProgressfloat64 `json:"in_progress,required"`// Device major numberMajorfloat64 `json:"major,required"`// Reads mergedMergedfloat64 `json:"merged,required"`// Device minor numberMinorfloat64 `json:"minor,required"`// Device nameNamestring `json:"name,required"`// Reads completed successfullyReadsfloat64 `json:"reads,required"`// Sectors read successfullySectorsReadfloat64 `json:"sectors_read,required"`// Sectors written successfullySectorsWrittenfloat64 `json:"sectors_written,required"`// Time spent doing I/Os (milliseconds)TimeInProgressMsfloat64 `json:"time_in_progress_ms,required"`// Time spent reading (milliseconds)TimeReadingMsfloat64 `json:"time_reading_ms,required"`// Time spent writing (milliseconds)TimeWritingMsfloat64 `json:"time_writing_ms,required"`// Weighted time spent doing I/Os (milliseconds)WeightedTimeInProgressMsfloat64 `json:"weighted_time_in_progress_ms,required"`// Writes completedWritesfloat64 `json:"writes,required"`// Writes mergedWritesMergedfloat64 `json:"writes_merged,required"`// Connector identifierConnectorIDstring `json:"connector_id"`// Discards completed successfullyDiscardsfloat64 `json:"discards"`// Discards mergedDiscardsMergedfloat64 `json:"discards_merged"`// Flushes completed successfullyFlushesfloat64 `json:"flushes"`// Sectors discardedSectorsDiscardedfloat64 `json:"sectors_discarded"`// Time spent discarding (milliseconds)TimeDiscardingMsfloat64 `json:"time_discarding_ms"`// Time spent flushing (milliseconds)TimeFlushingMsfloat64                              `json:"time_flushing_ms"`JSON           connectorSnapshotGetResponseDiskJSON `json:"-"`}

Snapshot Disk

func (*ConnectorSnapshotGetResponseDisk)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseEnvelope ¶added inv4.2.0

type ConnectorSnapshotGetResponseEnvelope struct {// SnapshotResultConnectorSnapshotGetResponse                   `json:"result,required"`Successbool                                           `json:"success,required"`Errors   []ConnectorSnapshotGetResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorSnapshotGetResponseEnvelopeMessages `json:"messages"`JSON     connectorSnapshotGetResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorSnapshotGetResponseEnvelope)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorSnapshotGetResponseEnvelopeErrors struct {Codefloat64                                        `json:"code,required"`Messagestring                                         `json:"message,required"`JSON    connectorSnapshotGetResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorSnapshotGetResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorSnapshotGetResponseEnvelopeMessages struct {Codefloat64                                          `json:"code,required"`Messagestring                                           `json:"message,required"`JSON    connectorSnapshotGetResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorSnapshotGetResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseInterface ¶added inv4.3.0

type ConnectorSnapshotGetResponseInterface struct {// Name of the network interfaceNamestring `json:"name,required"`// UP/DOWN state of the network interfaceOperstatestring `json:"operstate,required"`// Connector identifierConnectorIDstring                                            `json:"connector_id"`IPAddresses []ConnectorSnapshotGetResponseInterfacesIPAddress `json:"ip_addresses"`// Speed of the network interface (bits per second)Speedfloat64                                   `json:"speed"`JSON  connectorSnapshotGetResponseInterfaceJSON `json:"-"`}

Snapshot Interface

func (*ConnectorSnapshotGetResponseInterface)UnmarshalJSON ¶added inv4.3.0

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

typeConnectorSnapshotGetResponseInterfacesIPAddress ¶added inv4.3.0

type ConnectorSnapshotGetResponseInterfacesIPAddress struct {// Name of the network interfaceInterfaceNamestring `json:"interface_name,required"`// IP address of the network interfaceIPAddressstring `json:"ip_address,required"`// Connector identifierConnectorIDstring                                              `json:"connector_id"`JSON        connectorSnapshotGetResponseInterfacesIPAddressJSON `json:"-"`}

Snapshot Interface Address

func (*ConnectorSnapshotGetResponseInterfacesIPAddress)UnmarshalJSON ¶added inv4.3.0

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

typeConnectorSnapshotGetResponseMount ¶added inv4.2.0

type ConnectorSnapshotGetResponseMount struct {// File system on disk (EXT4, NTFS, etc.)FileSystemstring `json:"file_system,required"`// Kind of disk (HDD, SSD, etc.)Kindstring `json:"kind,required"`// Path where disk is mountedMountPointstring `json:"mount_point,required"`// Name of the disk mountNamestring `json:"name,required"`// Available disk size (bytes)AvailableBytesfloat64 `json:"available_bytes"`// Connector identifierConnectorIDstring `json:"connector_id"`// Determines whether the disk is read-onlyIsReadOnlybool `json:"is_read_only"`// Determines whether the disk is removableIsRemovablebool `json:"is_removable"`// Total disk size (bytes)TotalBytesfloat64                               `json:"total_bytes"`JSON       connectorSnapshotGetResponseMountJSON `json:"-"`}

Snapshot Mount

func (*ConnectorSnapshotGetResponseMount)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseNetdev ¶added inv4.2.0

type ConnectorSnapshotGetResponseNetdev struct {// Name of the network deviceNamestring `json:"name,required"`// Total bytes receivedRecvBytesfloat64 `json:"recv_bytes,required"`// Compressed packets receivedRecvCompressedfloat64 `json:"recv_compressed,required"`// Packets droppedRecvDropfloat64 `json:"recv_drop,required"`// Bad packets receivedRecvErrsfloat64 `json:"recv_errs,required"`// FIFO overrunsRecvFifofloat64 `json:"recv_fifo,required"`// Frame alignment errorsRecvFramefloat64 `json:"recv_frame,required"`// Multicast packets receivedRecvMulticastfloat64 `json:"recv_multicast,required"`// Total packets receivedRecvPacketsfloat64 `json:"recv_packets,required"`// Total bytes transmittedSentBytesfloat64 `json:"sent_bytes,required"`// Number of packets not sent due to carrier errorsSentCarrierfloat64 `json:"sent_carrier,required"`// Number of collisionsSentCollsfloat64 `json:"sent_colls,required"`// Number of compressed packets transmittedSentCompressedfloat64 `json:"sent_compressed,required"`// Number of packets dropped during transmissionSentDropfloat64 `json:"sent_drop,required"`// Number of transmission errorsSentErrsfloat64 `json:"sent_errs,required"`// FIFO overrunsSentFifofloat64 `json:"sent_fifo,required"`// Total packets transmittedSentPacketsfloat64 `json:"sent_packets,required"`// Connector identifierConnectorIDstring                                 `json:"connector_id"`JSON        connectorSnapshotGetResponseNetdevJSON `json:"-"`}

Snapshot Netdev

func (*ConnectorSnapshotGetResponseNetdev)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseThermal ¶added inv4.2.0

type ConnectorSnapshotGetResponseThermal struct {// Sensor identifier for the componentLabelstring `json:"label,required"`// Connector identifierConnectorIDstring `json:"connector_id"`// Critical failure temperature of the component (degrees Celsius)CriticalCelciusfloat64 `json:"critical_celcius"`// Current temperature of the component (degrees Celsius)CurrentCelciusfloat64 `json:"current_celcius"`// Maximum temperature of the component (degrees Celsius)MaxCelciusfloat64                                 `json:"max_celcius"`JSON       connectorSnapshotGetResponseThermalJSON `json:"-"`}

Snapshot Thermal

func (*ConnectorSnapshotGetResponseThermal)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotGetResponseTunnel ¶added inv4.3.0

type ConnectorSnapshotGetResponseTunnel struct {// Name of tunnel health state (unknown, healthy, degraded, down)HealthStatestring `json:"health_state,required"`// Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 =// degraded, 3 = down)HealthValuefloat64 `json:"health_value,required"`// The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.)InterfaceNamestring `json:"interface_name,required"`// Tunnel identifierTunnelIDstring `json:"tunnel_id,required"`// Connector identifierConnectorIDstring                                 `json:"connector_id"`JSON        connectorSnapshotGetResponseTunnelJSON `json:"-"`}

Snapshot Tunnels

func (*ConnectorSnapshotGetResponseTunnel)UnmarshalJSON ¶added inv4.3.0

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

typeConnectorSnapshotLatestListParams ¶added inv4.4.0

type ConnectorSnapshotLatestListParams struct {// Account identifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeConnectorSnapshotLatestListResponse ¶added inv4.4.0

type ConnectorSnapshotLatestListResponse struct {Countfloat64                                   `json:"count,required"`Items []ConnectorSnapshotLatestListResponseItem `json:"items,required"`JSON  connectorSnapshotLatestListResponseJSON   `json:"-"`}

func (*ConnectorSnapshotLatestListResponse)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseEnvelope ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseEnvelope struct {ResultConnectorSnapshotLatestListResponse                   `json:"result,required"`Successbool                                                  `json:"success,required"`Errors   []ConnectorSnapshotLatestListResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorSnapshotLatestListResponseEnvelopeMessages `json:"messages"`JSON     connectorSnapshotLatestListResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorSnapshotLatestListResponseEnvelope)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseEnvelopeErrors ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseEnvelopeErrors struct {Codefloat64                                               `json:"code,required"`Messagestring                                                `json:"message,required"`JSON    connectorSnapshotLatestListResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorSnapshotLatestListResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseEnvelopeMessages ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseEnvelopeMessages struct {Codefloat64                                                 `json:"code,required"`Messagestring                                                  `json:"message,required"`JSON    connectorSnapshotLatestListResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorSnapshotLatestListResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItem ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItem struct {// Count of failures to reclaim spaceCountReclaimFailuresfloat64 `json:"count_reclaim_failures,required"`// Count of reclaimed pathsCountReclaimedPathsfloat64 `json:"count_reclaimed_paths,required"`// Count of failed snapshot recordingsCountRecordFailedfloat64 `json:"count_record_failed,required"`// Count of failed snapshot transmissionsCountTransmitFailuresfloat64 `json:"count_transmit_failures,required"`// Time the Snapshot was recorded (seconds since the Unix epoch)Tfloat64 `json:"t,required"`// VersionVstring `json:"v,required"`// Count of processors/coresCPUCountfloat64 `json:"cpu_count"`// Percentage of time over a 10 second window that tasks were stalledCPUPressure10sfloat64 `json:"cpu_pressure_10s"`// Percentage of time over a 5 minute window that tasks were stalledCPUPressure300sfloat64 `json:"cpu_pressure_300s"`// Percentage of time over a 1 minute window that tasks were stalledCPUPressure60sfloat64 `json:"cpu_pressure_60s"`// Total stall time (microseconds)CPUPressureTotalUsfloat64 `json:"cpu_pressure_total_us"`// Time spent running a virtual CPU or guest OS (milliseconds)CPUTimeGuestMsfloat64 `json:"cpu_time_guest_ms"`// Time spent running a niced guest (milliseconds)CPUTimeGuestNiceMsfloat64 `json:"cpu_time_guest_nice_ms"`// Time spent in idle state (milliseconds)CPUTimeIdleMsfloat64 `json:"cpu_time_idle_ms"`// Time spent wait for I/O to complete (milliseconds)CPUTimeIowaitMsfloat64 `json:"cpu_time_iowait_ms"`// Time spent servicing interrupts (milliseconds)CPUTimeIrqMsfloat64 `json:"cpu_time_irq_ms"`// Time spent in low-priority user mode (milliseconds)CPUTimeNiceMsfloat64 `json:"cpu_time_nice_ms"`// Time spent servicing softirqs (milliseconds)CPUTimeSoftirqMsfloat64 `json:"cpu_time_softirq_ms"`// Time stolen (milliseconds)CPUTimeStealMsfloat64 `json:"cpu_time_steal_ms"`// Time spent in system mode (milliseconds)CPUTimeSystemMsfloat64 `json:"cpu_time_system_ms"`// Time spent in user mode (milliseconds)CPUTimeUserMsfloat64                                             `json:"cpu_time_user_ms"`DHCPLeases    []ConnectorSnapshotLatestListResponseItemsDHCPLease `json:"dhcp_leases"`Disks         []ConnectorSnapshotLatestListResponseItemsDisk      `json:"disks"`// Name of high availability stateHaStatestring `json:"ha_state"`// Numeric value associated with high availability state (0 = disabled, 1 = active,// 2 = standby, 3 = stopped, 4 = fault)HaValuefloat64                                             `json:"ha_value"`Interfaces []ConnectorSnapshotLatestListResponseItemsInterface `json:"interfaces"`// Percentage of time over a 10 second window that all tasks were stalledIoPressureFull10sfloat64 `json:"io_pressure_full_10s"`// Percentage of time over a 5 minute window that all tasks were stalledIoPressureFull300sfloat64 `json:"io_pressure_full_300s"`// Percentage of time over a 1 minute window that all tasks were stalledIoPressureFull60sfloat64 `json:"io_pressure_full_60s"`// Total stall time (microseconds)IoPressureFullTotalUsfloat64 `json:"io_pressure_full_total_us"`// Percentage of time over a 10 second window that some tasks were stalledIoPressureSome10sfloat64 `json:"io_pressure_some_10s"`// Percentage of time over a 3 minute window that some tasks were stalledIoPressureSome300sfloat64 `json:"io_pressure_some_300s"`// Percentage of time over a 1 minute window that some tasks were stalledIoPressureSome60sfloat64 `json:"io_pressure_some_60s"`// Total stall time (microseconds)IoPressureSomeTotalUsfloat64 `json:"io_pressure_some_total_us"`// Boot time (seconds since Unix epoch)KernelBtimefloat64 `json:"kernel_btime"`// Number of context switches that the system underwentKernelCtxtfloat64 `json:"kernel_ctxt"`// Number of forks since bootKernelProcessesfloat64 `json:"kernel_processes"`// Number of processes blocked waiting for I/OKernelProcessesBlockedfloat64 `json:"kernel_processes_blocked"`// Number of processes in runnable stateKernelProcessesRunningfloat64 `json:"kernel_processes_running"`// The fifteen-minute load averageLoadAverage15mfloat64 `json:"load_average_15m"`// The one-minute load averageLoadAverage1mfloat64 `json:"load_average_1m"`// The five-minute load averageLoadAverage5mfloat64 `json:"load_average_5m"`// Number of currently runnable kernel scheduling entitiesLoadAverageCurfloat64 `json:"load_average_cur"`// Number of kernel scheduling entities that currently exist on the systemLoadAverageMaxfloat64 `json:"load_average_max"`// Memory that has been used more recentlyMemoryActiveBytesfloat64 `json:"memory_active_bytes"`// Non-file backed huge pages mapped into user-space page tablesMemoryAnonHugepagesBytesfloat64 `json:"memory_anon_hugepages_bytes"`// Non-file backed pages mapped into user-space page tablesMemoryAnonPagesBytesfloat64 `json:"memory_anon_pages_bytes"`// Estimate of how much memory is available for starting new applicationsMemoryAvailableBytesfloat64 `json:"memory_available_bytes"`// Memory used for block device bounce buffersMemoryBounceBytesfloat64 `json:"memory_bounce_bytes"`// Relatively temporary storage for raw disk blocksMemoryBuffersBytesfloat64 `json:"memory_buffers_bytes"`// In-memory cache for files read from the diskMemoryCachedBytesfloat64 `json:"memory_cached_bytes"`// Free CMA (Contiguous Memory Allocator) pagesMemoryCmaFreeBytesfloat64 `json:"memory_cma_free_bytes"`// Total CMA (Contiguous Memory Allocator) pagesMemoryCmaTotalBytesfloat64 `json:"memory_cma_total_bytes"`// Total amount of memory currently available to be allocated on the systemMemoryCommitLimitBytesfloat64 `json:"memory_commit_limit_bytes"`// Amount of memory presently allocated on the systemMemoryCommittedAsBytesfloat64 `json:"memory_committed_as_bytes"`// Memory which is waiting to get written back to the diskMemoryDirtyBytesfloat64 `json:"memory_dirty_bytes"`// The sum of LowFree and HighFreeMemoryFreeBytesfloat64 `json:"memory_free_bytes"`// Amount of free highmemMemoryHighFreeBytesfloat64 `json:"memory_high_free_bytes"`// Total amount of highmemMemoryHighTotalBytesfloat64 `json:"memory_high_total_bytes"`// The number of huge pages in the pool that are not yet allocatedMemoryHugepagesFreefloat64 `json:"memory_hugepages_free"`// Number of huge pages for which a commitment has been made, but no allocation has// yet been madeMemoryHugepagesRsvdfloat64 `json:"memory_hugepages_rsvd"`// Number of huge pages in the pool above the thresholdMemoryHugepagesSurpfloat64 `json:"memory_hugepages_surp"`// The size of the pool of huge pagesMemoryHugepagesTotalfloat64 `json:"memory_hugepages_total"`// The size of huge pagesMemoryHugepagesizeBytesfloat64 `json:"memory_hugepagesize_bytes"`// Memory which has been less recently usedMemoryInactiveBytesfloat64 `json:"memory_inactive_bytes"`// Kernel allocations that the kernel will attempt to reclaim under memory pressureMemoryKReclaimableBytesfloat64 `json:"memory_k_reclaimable_bytes"`// Amount of memory allocated to kernel stacksMemoryKernelStackBytesfloat64 `json:"memory_kernel_stack_bytes"`// Amount of free lowmemMemoryLowFreeBytesfloat64 `json:"memory_low_free_bytes"`// Total amount of lowmemMemoryLowTotalBytesfloat64 `json:"memory_low_total_bytes"`// Files which have been mapped into memoryMemoryMappedBytesfloat64 `json:"memory_mapped_bytes"`// Amount of memory dedicated to the lowest level of page tablesMemoryPageTablesBytesfloat64 `json:"memory_page_tables_bytes"`// Memory allocated to the per-cpu alloctor used to back per-cpu allocationsMemoryPerCPUBytesfloat64 `json:"memory_per_cpu_bytes"`// Percentage of time over a 10 second window that all tasks were stalledMemoryPressureFull10sfloat64 `json:"memory_pressure_full_10s"`// Percentage of time over a 5 minute window that all tasks were stalledMemoryPressureFull300sfloat64 `json:"memory_pressure_full_300s"`// Percentage of time over a 1 minute window that all tasks were stalledMemoryPressureFull60sfloat64 `json:"memory_pressure_full_60s"`// Total stall time (microseconds)MemoryPressureFullTotalUsfloat64 `json:"memory_pressure_full_total_us"`// Percentage of time over a 10 second window that some tasks were stalledMemoryPressureSome10sfloat64 `json:"memory_pressure_some_10s"`// Percentage of time over a 5 minute window that some tasks were stalledMemoryPressureSome300sfloat64 `json:"memory_pressure_some_300s"`// Percentage of time over a 1 minute window that some tasks were stalledMemoryPressureSome60sfloat64 `json:"memory_pressure_some_60s"`// Total stall time (microseconds)MemoryPressureSomeTotalUsfloat64 `json:"memory_pressure_some_total_us"`// Part of slab that can be reclaimed on memory pressureMemorySReclaimableBytesfloat64 `json:"memory_s_reclaimable_bytes"`// Part of slab that cannot be reclaimed on memory pressureMemorySUnreclaimBytesfloat64 `json:"memory_s_unreclaim_bytes"`// Amount of memory dedicated to the lowest level of page tablesMemorySecondaryPageTablesBytesfloat64 `json:"memory_secondary_page_tables_bytes"`// Amount of memory consumed by tmpfsMemoryShmemBytesfloat64 `json:"memory_shmem_bytes"`// Memory used by shmem and tmpfs, allocated with huge pagesMemoryShmemHugepagesBytesfloat64 `json:"memory_shmem_hugepages_bytes"`// Shared memory mapped into user space with huge pagesMemoryShmemPmdMappedBytesfloat64 `json:"memory_shmem_pmd_mapped_bytes"`// In-kernel data structures cacheMemorySlabBytesfloat64 `json:"memory_slab_bytes"`// Memory swapped out and back in while still in swap fileMemorySwapCachedBytesfloat64 `json:"memory_swap_cached_bytes"`// Amount of swap space that is currently unusedMemorySwapFreeBytesfloat64 `json:"memory_swap_free_bytes"`// Total amount of swap space availableMemorySwapTotalBytesfloat64 `json:"memory_swap_total_bytes"`// Total usable RAMMemoryTotalBytesfloat64 `json:"memory_total_bytes"`// Largest contiguous block of vmalloc area which is freeMemoryVmallocChunkBytesfloat64 `json:"memory_vmalloc_chunk_bytes"`// Total size of vmalloc memory areaMemoryVmallocTotalBytesfloat64 `json:"memory_vmalloc_total_bytes"`// Amount of vmalloc area which is usedMemoryVmallocUsedBytesfloat64 `json:"memory_vmalloc_used_bytes"`// Memory which is actively being written back to the diskMemoryWritebackBytesfloat64 `json:"memory_writeback_bytes"`// Memory used by FUSE for temporary writeback buffersMemoryWritebackTmpBytesfloat64 `json:"memory_writeback_tmp_bytes"`// Memory consumed by the zswap backend, compressedMemoryZSwapBytesfloat64 `json:"memory_z_swap_bytes"`// Amount of anonymous memory stored in zswap, uncompressedMemoryZSwappedBytesfloat64                                          `json:"memory_z_swapped_bytes"`Mounts              []ConnectorSnapshotLatestListResponseItemsMount  `json:"mounts"`Netdevs             []ConnectorSnapshotLatestListResponseItemsNetdev `json:"netdevs"`// Number of ICMP Address Mask Reply messages receivedSnmpIcmpInAddrMaskRepsfloat64 `json:"snmp_icmp_in_addr_mask_reps"`// Number of ICMP Address Mask Request messages receivedSnmpIcmpInAddrMasksfloat64 `json:"snmp_icmp_in_addr_masks"`// Number of ICMP messages received with bad checksumsSnmpIcmpInCsumErrorsfloat64 `json:"snmp_icmp_in_csum_errors"`// Number of ICMP Destination Unreachable messages receivedSnmpIcmpInDestUnreachsfloat64 `json:"snmp_icmp_in_dest_unreachs"`// Number of ICMP Echo Reply messages receivedSnmpIcmpInEchoRepsfloat64 `json:"snmp_icmp_in_echo_reps"`// Number of ICMP Echo (request) messages receivedSnmpIcmpInEchosfloat64 `json:"snmp_icmp_in_echos"`// Number of ICMP messages received with ICMP-specific errorsSnmpIcmpInErrorsfloat64 `json:"snmp_icmp_in_errors"`// Number of ICMP messages receivedSnmpIcmpInMsgsfloat64 `json:"snmp_icmp_in_msgs"`// Number of ICMP Parameter Problem messages receivedSnmpIcmpInParmProbsfloat64 `json:"snmp_icmp_in_parm_probs"`// Number of ICMP Redirect messages receivedSnmpIcmpInRedirectsfloat64 `json:"snmp_icmp_in_redirects"`// Number of ICMP Source Quench messages receivedSnmpIcmpInSrcQuenchsfloat64 `json:"snmp_icmp_in_src_quenchs"`// Number of ICMP Time Exceeded messages receivedSnmpIcmpInTimeExcdsfloat64 `json:"snmp_icmp_in_time_excds"`// Number of ICMP Address Mask Request messages receivedSnmpIcmpInTimestampRepsfloat64 `json:"snmp_icmp_in_timestamp_reps"`// Number of ICMP Timestamp (request) messages receivedSnmpIcmpInTimestampsfloat64 `json:"snmp_icmp_in_timestamps"`// Number of ICMP Address Mask Reply messages sentSnmpIcmpOutAddrMaskRepsfloat64 `json:"snmp_icmp_out_addr_mask_reps"`// Number of ICMP Address Mask Request messages sentSnmpIcmpOutAddrMasksfloat64 `json:"snmp_icmp_out_addr_masks"`// Number of ICMP Destination Unreachable messages sentSnmpIcmpOutDestUnreachsfloat64 `json:"snmp_icmp_out_dest_unreachs"`// Number of ICMP Echo Reply messages sentSnmpIcmpOutEchoRepsfloat64 `json:"snmp_icmp_out_echo_reps"`// Number of ICMP Echo (request) messages sentSnmpIcmpOutEchosfloat64 `json:"snmp_icmp_out_echos"`// Number of ICMP messages which this entity did not send due to ICMP-specific// errorsSnmpIcmpOutErrorsfloat64 `json:"snmp_icmp_out_errors"`// Number of ICMP messages attempted to sendSnmpIcmpOutMsgsfloat64 `json:"snmp_icmp_out_msgs"`// Number of ICMP Parameter Problem messages sentSnmpIcmpOutParmProbsfloat64 `json:"snmp_icmp_out_parm_probs"`// Number of ICMP Redirect messages sentSnmpIcmpOutRedirectsfloat64 `json:"snmp_icmp_out_redirects"`// Number of ICMP Source Quench messages sentSnmpIcmpOutSrcQuenchsfloat64 `json:"snmp_icmp_out_src_quenchs"`// Number of ICMP Time Exceeded messages sentSnmpIcmpOutTimeExcdsfloat64 `json:"snmp_icmp_out_time_excds"`// Number of ICMP Timestamp Reply messages sentSnmpIcmpOutTimestampRepsfloat64 `json:"snmp_icmp_out_timestamp_reps"`// Number of ICMP Timestamp (request) messages sentSnmpIcmpOutTimestampsfloat64 `json:"snmp_icmp_out_timestamps"`// Default value of the Time-To-Live field of the IP headerSnmpIPDefaultTTLfloat64 `json:"snmp_ip_default_ttl"`// Number of datagrams forwarded to their final destinationSnmpIPForwDatagramsfloat64 `json:"snmp_ip_forw_datagrams"`// Set when acting as an IP gatewaySnmpIPForwardingEnabledbool `json:"snmp_ip_forwarding_enabled"`// Number of datagrams generated by fragmentationSnmpIPFragCreatesfloat64 `json:"snmp_ip_frag_creates"`// Number of datagrams discarded because fragmentation failedSnmpIPFragFailsfloat64 `json:"snmp_ip_frag_fails"`// Number of datagrams successfully fragmentedSnmpIPFragOksfloat64 `json:"snmp_ip_frag_oks"`// Number of input datagrams discarded due to errors in the IP addressSnmpIPInAddrErrorsfloat64 `json:"snmp_ip_in_addr_errors"`// Number of input datagrams successfully delivered to IP user-protocolsSnmpIPInDeliversfloat64 `json:"snmp_ip_in_delivers"`// Number of input datagrams otherwise discardedSnmpIPInDiscardsfloat64 `json:"snmp_ip_in_discards"`// Number of input datagrams discarded due to errors in the IP headerSnmpIPInHdrErrorsfloat64 `json:"snmp_ip_in_hdr_errors"`// Number of input datagrams received from interfacesSnmpIPInReceivesfloat64 `json:"snmp_ip_in_receives"`// Number of input datagrams discarded due unknown or unsupported protocolSnmpIPInUnknownProtosfloat64 `json:"snmp_ip_in_unknown_protos"`// Number of output datagrams otherwise discardedSnmpIPOutDiscardsfloat64 `json:"snmp_ip_out_discards"`// Number of output datagrams discarded because no route matchedSnmpIPOutNoRoutesfloat64 `json:"snmp_ip_out_no_routes"`// Number of datagrams supplied for transmissionSnmpIPOutRequestsfloat64 `json:"snmp_ip_out_requests"`// Number of failures detected by the reassembly algorithmSnmpIPReasmFailsfloat64 `json:"snmp_ip_reasm_fails"`// Number of datagrams successfully reassembledSnmpIPReasmOksfloat64 `json:"snmp_ip_reasm_oks"`// Number of fragments received which needed to be reassembledSnmpIPReasmReqdsfloat64 `json:"snmp_ip_reasm_reqds"`// Number of seconds fragments are held while awaiting reassemblySnmpIPReasmTimeoutfloat64 `json:"snmp_ip_reasm_timeout"`// Number of times TCP transitions to SYN-SENT from CLOSEDSnmpTCPActiveOpensfloat64 `json:"snmp_tcp_active_opens"`// Number of times TCP transitions to CLOSED from SYN-SENT or SYN-RCVD, plus// transitions to LISTEN from SYN-RCVDSnmpTCPAttemptFailsfloat64 `json:"snmp_tcp_attempt_fails"`// Number of TCP connections in ESTABLISHED or CLOSE-WAITSnmpTCPCurrEstabfloat64 `json:"snmp_tcp_curr_estab"`// Number of times TCP transitions to CLOSED from ESTABLISHED or CLOSE-WAITSnmpTCPEstabResetsfloat64 `json:"snmp_tcp_estab_resets"`// Number of TCP segments received with checksum errorsSnmpTCPInCsumErrorsfloat64 `json:"snmp_tcp_in_csum_errors"`// Number of TCP segments received in errorSnmpTCPInErrsfloat64 `json:"snmp_tcp_in_errs"`// Number of TCP segments receivedSnmpTCPInSegsfloat64 `json:"snmp_tcp_in_segs"`// Limit on the total number of TCP connectionsSnmpTCPMaxConnfloat64 `json:"snmp_tcp_max_conn"`// Number of TCP segments sent with RST flagSnmpTCPOutRstsfloat64 `json:"snmp_tcp_out_rsts"`// Number of TCP segments sentSnmpTCPOutSegsfloat64 `json:"snmp_tcp_out_segs"`// Number of times TCP transitions to SYN-RCVD from LISTENSnmpTCPPassiveOpensfloat64 `json:"snmp_tcp_passive_opens"`// Number of TCP segments retransmittedSnmpTCPRetransSegsfloat64 `json:"snmp_tcp_retrans_segs"`// Maximum value permitted by a TCP implementation for the retransmission timeout// (milliseconds)SnmpTCPRtoMaxfloat64 `json:"snmp_tcp_rto_max"`// Minimum value permitted by a TCP implementation for the retransmission timeout// (milliseconds)SnmpTCPRtoMinfloat64 `json:"snmp_tcp_rto_min"`// Number of UDP datagrams delivered to UDP applicationsSnmpUdpInDatagramsfloat64 `json:"snmp_udp_in_datagrams"`// Number of UDP datagrams failed to be delivered for reasons other than lack of// application at the destination portSnmpUdpInErrorsfloat64 `json:"snmp_udp_in_errors"`// Number of UDP datagrams received for which there was not application at the// destination portSnmpUdpNoPortsfloat64 `json:"snmp_udp_no_ports"`// Number of UDP datagrams sentSnmpUdpOutDatagramsfloat64 `json:"snmp_udp_out_datagrams"`// Boottime of the system (seconds since the Unix epoch)SystemBootTimeSfloat64                                           `json:"system_boot_time_s"`Thermals        []ConnectorSnapshotLatestListResponseItemsThermal `json:"thermals"`Tunnels         []ConnectorSnapshotLatestListResponseItemsTunnel  `json:"tunnels"`// Sum of how much time each core has spent idleUptimeIdleMsfloat64 `json:"uptime_idle_ms"`// Uptime of the system, including time spent in suspendUptimeTotalMsfloat64                                     `json:"uptime_total_ms"`JSON          connectorSnapshotLatestListResponseItemJSON `json:"-"`}

Snapshot

func (*ConnectorSnapshotLatestListResponseItem)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsDHCPLease ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsDHCPLease struct {// Client ID of the device the IP Address was leased toClientIDstring `json:"client_id,required"`// Expiry time of the DHCP lease (seconds since the Unix epoch)ExpiryTimefloat64 `json:"expiry_time,required"`// Hostname of the device the IP Address was leased toHostnamestring `json:"hostname,required"`// Name of the network interfaceInterfaceNamestring `json:"interface_name,required"`// IP Address that was leasedIPAddressstring `json:"ip_address,required"`// MAC Address of the device the IP Address was leased toMacAddressstring `json:"mac_address,required"`// Connector identifierConnectorIDstring                                                `json:"connector_id"`JSON        connectorSnapshotLatestListResponseItemsDHCPLeaseJSON `json:"-"`}

Snapshot DHCP lease

func (*ConnectorSnapshotLatestListResponseItemsDHCPLease)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsDisk ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsDisk struct {// I/Os currently in progressInProgressfloat64 `json:"in_progress,required"`// Device major numberMajorfloat64 `json:"major,required"`// Reads mergedMergedfloat64 `json:"merged,required"`// Device minor numberMinorfloat64 `json:"minor,required"`// Device nameNamestring `json:"name,required"`// Reads completed successfullyReadsfloat64 `json:"reads,required"`// Sectors read successfullySectorsReadfloat64 `json:"sectors_read,required"`// Sectors written successfullySectorsWrittenfloat64 `json:"sectors_written,required"`// Time spent doing I/Os (milliseconds)TimeInProgressMsfloat64 `json:"time_in_progress_ms,required"`// Time spent reading (milliseconds)TimeReadingMsfloat64 `json:"time_reading_ms,required"`// Time spent writing (milliseconds)TimeWritingMsfloat64 `json:"time_writing_ms,required"`// Weighted time spent doing I/Os (milliseconds)WeightedTimeInProgressMsfloat64 `json:"weighted_time_in_progress_ms,required"`// Writes completedWritesfloat64 `json:"writes,required"`// Writes mergedWritesMergedfloat64 `json:"writes_merged,required"`// Connector identifierConnectorIDstring `json:"connector_id"`// Discards completed successfullyDiscardsfloat64 `json:"discards"`// Discards mergedDiscardsMergedfloat64 `json:"discards_merged"`// Flushes completed successfullyFlushesfloat64 `json:"flushes"`// Sectors discardedSectorsDiscardedfloat64 `json:"sectors_discarded"`// Time spent discarding (milliseconds)TimeDiscardingMsfloat64 `json:"time_discarding_ms"`// Time spent flushing (milliseconds)TimeFlushingMsfloat64                                          `json:"time_flushing_ms"`JSON           connectorSnapshotLatestListResponseItemsDiskJSON `json:"-"`}

Snapshot Disk

func (*ConnectorSnapshotLatestListResponseItemsDisk)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsInterface ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsInterface struct {// Name of the network interfaceNamestring `json:"name,required"`// UP/DOWN state of the network interfaceOperstatestring `json:"operstate,required"`// Connector identifierConnectorIDstring                                                        `json:"connector_id"`IPAddresses []ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress `json:"ip_addresses"`// Speed of the network interface (bits per second)Speedfloat64                                               `json:"speed"`JSON  connectorSnapshotLatestListResponseItemsInterfaceJSON `json:"-"`}

Snapshot Interface

func (*ConnectorSnapshotLatestListResponseItemsInterface)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsInterfacesIPAddress ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress struct {// Name of the network interfaceInterfaceNamestring `json:"interface_name,required"`// IP address of the network interfaceIPAddressstring `json:"ip_address,required"`// Connector identifierConnectorIDstring                                                          `json:"connector_id"`JSON        connectorSnapshotLatestListResponseItemsInterfacesIPAddressJSON `json:"-"`}

Snapshot Interface Address

func (*ConnectorSnapshotLatestListResponseItemsInterfacesIPAddress)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsMount ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsMount struct {// File system on disk (EXT4, NTFS, etc.)FileSystemstring `json:"file_system,required"`// Kind of disk (HDD, SSD, etc.)Kindstring `json:"kind,required"`// Path where disk is mountedMountPointstring `json:"mount_point,required"`// Name of the disk mountNamestring `json:"name,required"`// Available disk size (bytes)AvailableBytesfloat64 `json:"available_bytes"`// Connector identifierConnectorIDstring `json:"connector_id"`// Determines whether the disk is read-onlyIsReadOnlybool `json:"is_read_only"`// Determines whether the disk is removableIsRemovablebool `json:"is_removable"`// Total disk size (bytes)TotalBytesfloat64                                           `json:"total_bytes"`JSON       connectorSnapshotLatestListResponseItemsMountJSON `json:"-"`}

Snapshot Mount

func (*ConnectorSnapshotLatestListResponseItemsMount)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsNetdev ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsNetdev struct {// Name of the network deviceNamestring `json:"name,required"`// Total bytes receivedRecvBytesfloat64 `json:"recv_bytes,required"`// Compressed packets receivedRecvCompressedfloat64 `json:"recv_compressed,required"`// Packets droppedRecvDropfloat64 `json:"recv_drop,required"`// Bad packets receivedRecvErrsfloat64 `json:"recv_errs,required"`// FIFO overrunsRecvFifofloat64 `json:"recv_fifo,required"`// Frame alignment errorsRecvFramefloat64 `json:"recv_frame,required"`// Multicast packets receivedRecvMulticastfloat64 `json:"recv_multicast,required"`// Total packets receivedRecvPacketsfloat64 `json:"recv_packets,required"`// Total bytes transmittedSentBytesfloat64 `json:"sent_bytes,required"`// Number of packets not sent due to carrier errorsSentCarrierfloat64 `json:"sent_carrier,required"`// Number of collisionsSentCollsfloat64 `json:"sent_colls,required"`// Number of compressed packets transmittedSentCompressedfloat64 `json:"sent_compressed,required"`// Number of packets dropped during transmissionSentDropfloat64 `json:"sent_drop,required"`// Number of transmission errorsSentErrsfloat64 `json:"sent_errs,required"`// FIFO overrunsSentFifofloat64 `json:"sent_fifo,required"`// Total packets transmittedSentPacketsfloat64 `json:"sent_packets,required"`// Connector identifierConnectorIDstring                                             `json:"connector_id"`JSON        connectorSnapshotLatestListResponseItemsNetdevJSON `json:"-"`}

Snapshot Netdev

func (*ConnectorSnapshotLatestListResponseItemsNetdev)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsThermal ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsThermal struct {// Sensor identifier for the componentLabelstring `json:"label,required"`// Connector identifierConnectorIDstring `json:"connector_id"`// Critical failure temperature of the component (degrees Celsius)CriticalCelciusfloat64 `json:"critical_celcius"`// Current temperature of the component (degrees Celsius)CurrentCelciusfloat64 `json:"current_celcius"`// Maximum temperature of the component (degrees Celsius)MaxCelciusfloat64                                             `json:"max_celcius"`JSON       connectorSnapshotLatestListResponseItemsThermalJSON `json:"-"`}

Snapshot Thermal

func (*ConnectorSnapshotLatestListResponseItemsThermal)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestListResponseItemsTunnel ¶added inv4.4.0

type ConnectorSnapshotLatestListResponseItemsTunnel struct {// Name of tunnel health state (unknown, healthy, degraded, down)HealthStatestring `json:"health_state,required"`// Numeric value associated with tunnel state (0 = unknown, 1 = healthy, 2 =// degraded, 3 = down)HealthValuefloat64 `json:"health_value,required"`// The tunnel interface name (i.e. xfrm1, xfrm3.99, etc.)InterfaceNamestring `json:"interface_name,required"`// Tunnel identifierTunnelIDstring `json:"tunnel_id,required"`// Connector identifierConnectorIDstring                                             `json:"connector_id"`JSON        connectorSnapshotLatestListResponseItemsTunnelJSON `json:"-"`}

Snapshot Tunnels

func (*ConnectorSnapshotLatestListResponseItemsTunnel)UnmarshalJSON ¶added inv4.4.0

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

typeConnectorSnapshotLatestService ¶added inv4.4.0

type ConnectorSnapshotLatestService struct {Options []option.RequestOption}

ConnectorSnapshotLatestService contains methods and other services that helpwith interacting with the cloudflare API.

funcNewConnectorSnapshotLatestService ¶added inv4.4.0

func NewConnectorSnapshotLatestService(opts ...option.RequestOption) (r *ConnectorSnapshotLatestService)

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

func (*ConnectorSnapshotLatestService)List ¶added inv4.4.0

func (r *ConnectorSnapshotLatestService) List(ctxcontext.Context, connectorIDstring, queryConnectorSnapshotLatestListParams, opts ...option.RequestOption) (res *ConnectorSnapshotLatestListResponse, errerror)

Get latest Snapshots

typeConnectorSnapshotListParams ¶added inv4.2.0

type ConnectorSnapshotListParams struct {// Account identifierAccountIDparam.Field[string]  `path:"account_id,required"`Fromparam.Field[float64] `query:"from,required"`Toparam.Field[float64] `query:"to,required"`Cursorparam.Field[string]  `query:"cursor"`Limitparam.Field[float64] `query:"limit"`}

func (ConnectorSnapshotListParams)URLQuery ¶added inv4.2.0

func (rConnectorSnapshotListParams) URLQuery() (vurl.Values)

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

typeConnectorSnapshotListResponse ¶added inv4.2.0

type ConnectorSnapshotListResponse struct {Countfloat64                             `json:"count,required"`Items  []ConnectorSnapshotListResponseItem `json:"items,required"`Cursorstring                              `json:"cursor"`JSON   connectorSnapshotListResponseJSON   `json:"-"`}

func (*ConnectorSnapshotListResponse)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotListResponseEnvelope ¶added inv4.2.0

type ConnectorSnapshotListResponseEnvelope struct {ResultConnectorSnapshotListResponse                   `json:"result,required"`Successbool                                            `json:"success,required"`Errors   []ConnectorSnapshotListResponseEnvelopeErrors   `json:"errors"`Messages []ConnectorSnapshotListResponseEnvelopeMessages `json:"messages"`JSON     connectorSnapshotListResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorSnapshotListResponseEnvelope)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotListResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorSnapshotListResponseEnvelopeErrors struct {Codefloat64                                         `json:"code,required"`Messagestring                                          `json:"message,required"`JSON    connectorSnapshotListResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorSnapshotListResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotListResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorSnapshotListResponseEnvelopeMessages struct {Codefloat64                                           `json:"code,required"`Messagestring                                            `json:"message,required"`JSON    connectorSnapshotListResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorSnapshotListResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotListResponseItem ¶added inv4.2.0

type ConnectorSnapshotListResponseItem struct {// Time the Snapshot was collected (seconds since the Unix epoch)Afloat64 `json:"a,required"`// Time the Snapshot was recorded (seconds since the Unix epoch)Tfloat64                               `json:"t,required"`JSON connectorSnapshotListResponseItemJSON `json:"-"`}

func (*ConnectorSnapshotListResponseItem)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorSnapshotService ¶added inv4.2.0

type ConnectorSnapshotService struct {Options []option.RequestOptionLatest  *ConnectorSnapshotLatestService}

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

funcNewConnectorSnapshotService ¶added inv4.2.0

func NewConnectorSnapshotService(opts ...option.RequestOption) (r *ConnectorSnapshotService)

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

func (*ConnectorSnapshotService)Get ¶added inv4.2.0

func (r *ConnectorSnapshotService) Get(ctxcontext.Context, connectorIDstring, snapshotTfloat64, queryConnectorSnapshotGetParams, opts ...option.RequestOption) (res *ConnectorSnapshotGetResponse, errerror)

Get Snapshot

func (*ConnectorSnapshotService)List ¶added inv4.2.0

func (r *ConnectorSnapshotService) List(ctxcontext.Context, connectorIDstring, paramsConnectorSnapshotListParams, opts ...option.RequestOption) (res *ConnectorSnapshotListResponse, errerror)

List Snapshots

typeConnectorUpdateParams ¶

type ConnectorUpdateParams struct {// Account identifierAccountIDparam.Field[string]  `path:"account_id,required"`Activatedparam.Field[bool]    `json:"activated"`InterruptWindowDurationHoursparam.Field[float64] `json:"interrupt_window_duration_hours"`InterruptWindowHourOfDayparam.Field[float64] `json:"interrupt_window_hour_of_day"`Notesparam.Field[string]  `json:"notes"`Timezoneparam.Field[string]  `json:"timezone"`}

func (ConnectorUpdateParams)MarshalJSON ¶

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

typeConnectorUpdateResponse ¶

type ConnectorUpdateResponse struct {IDstring                        `json:"id,required"`Activatedbool                          `json:"activated,required"`InterruptWindowDurationHoursfloat64                       `json:"interrupt_window_duration_hours,required"`InterruptWindowHourOfDayfloat64                       `json:"interrupt_window_hour_of_day,required"`LastUpdatedstring                        `json:"last_updated,required"`Notesstring                        `json:"notes,required"`Timezonestring                        `json:"timezone,required"`DeviceConnectorUpdateResponseDevice `json:"device"`LastHeartbeatstring                        `json:"last_heartbeat"`LastSeenVersionstring                        `json:"last_seen_version"`JSON                         connectorUpdateResponseJSON   `json:"-"`}

func (*ConnectorUpdateResponse)UnmarshalJSON ¶

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

typeConnectorUpdateResponseDevice ¶

type ConnectorUpdateResponseDevice struct {IDstring                            `json:"id,required"`SerialNumberstring                            `json:"serial_number"`JSON         connectorUpdateResponseDeviceJSON `json:"-"`}

func (*ConnectorUpdateResponseDevice)UnmarshalJSON ¶

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

typeConnectorUpdateResponseEnvelope ¶

type ConnectorUpdateResponseEnvelope struct {Errors   []ConnectorUpdateResponseEnvelopeErrors   `json:"errors,required"`Messages []ConnectorUpdateResponseEnvelopeMessages `json:"messages,required"`ResultConnectorUpdateResponse                   `json:"result,required"`Successbool                                      `json:"success,required"`JSON     connectorUpdateResponseEnvelopeJSON       `json:"-"`}

func (*ConnectorUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeConnectorUpdateResponseEnvelopeErrors ¶added inv4.2.0

type ConnectorUpdateResponseEnvelopeErrors struct {Codefloat64                                   `json:"code,required"`Messagestring                                    `json:"message,required"`JSON    connectorUpdateResponseEnvelopeErrorsJSON `json:"-"`}

func (*ConnectorUpdateResponseEnvelopeErrors)UnmarshalJSON ¶added inv4.2.0

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

typeConnectorUpdateResponseEnvelopeMessages ¶added inv4.2.0

type ConnectorUpdateResponseEnvelopeMessages struct {Codefloat64                                     `json:"code,required"`Messagestring                                      `json:"message,required"`JSON    connectorUpdateResponseEnvelopeMessagesJSON `json:"-"`}

func (*ConnectorUpdateResponseEnvelopeMessages)UnmarshalJSON ¶added inv4.2.0

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

typeDHCPRelay ¶

type DHCPRelay struct {// List of DHCP server IPs.ServerAddresses []string      `json:"server_addresses"`JSON            dhcpRelayJSON `json:"-"`}

func (*DHCPRelay)UnmarshalJSON ¶

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

typeDHCPRelayParam ¶

type DHCPRelayParam struct {// List of DHCP server IPs.ServerAddressesparam.Field[[]string] `json:"server_addresses"`}

func (DHCPRelayParam)MarshalJSON ¶

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

typeDHCPServer ¶

type DHCPServer struct {// A valid IPv4 address.DHCPPoolEndstring `json:"dhcp_pool_end"`// A valid IPv4 address.DHCPPoolStartstring `json:"dhcp_pool_start"`// A valid IPv4 address.DNSServerstring   `json:"dns_server"`DNSServers []string `json:"dns_servers"`// Mapping of MAC addresses to IP addressesReservations map[string]string `json:"reservations"`JSON         dhcpServerJSON    `json:"-"`}

func (*DHCPServer)UnmarshalJSON ¶

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

typeDHCPServerParam ¶

type DHCPServerParam struct {// A valid IPv4 address.DHCPPoolEndparam.Field[string] `json:"dhcp_pool_end"`// A valid IPv4 address.DHCPPoolStartparam.Field[string] `json:"dhcp_pool_start"`// A valid IPv4 address.DNSServerparam.Field[string]   `json:"dns_server"`DNSServersparam.Field[[]string] `json:"dns_servers"`// Mapping of MAC addresses to IP addressesReservationsparam.Field[map[string]string] `json:"reservations"`}

func (DHCPServerParam)MarshalJSON ¶

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

typeError ¶

type Error =apierror.Error

typeErrorData ¶

type ErrorData =shared.ErrorData

This is an alias to an internal type.

typeErrorDataSource ¶added inv4.2.0

type ErrorDataSource =shared.ErrorDataSource

This is an alias to an internal type.

typeGRETunnelBulkUpdateParams ¶

type GRETunnelBulkUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Body              interface{}         `json:"body,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

func (GRETunnelBulkUpdateParams)MarshalJSON ¶

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

typeGRETunnelBulkUpdateResponse ¶

type GRETunnelBulkUpdateResponse struct {Modifiedbool                                           `json:"modified"`ModifiedGRETunnels []GRETunnelBulkUpdateResponseModifiedGRETunnel `json:"modified_gre_tunnels"`JSON               greTunnelBulkUpdateResponseJSON                `json:"-"`}

func (*GRETunnelBulkUpdateResponse)UnmarshalJSON ¶

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

typeGRETunnelBulkUpdateResponseEnvelope ¶

type GRETunnelBulkUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo       `json:"errors,required"`Messages []shared.ResponseInfo       `json:"messages,required"`ResultGRETunnelBulkUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelBulkUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelBulkUpdateResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelBulkUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelBulkUpdateResponseEnvelopeSuccess ¶

type GRETunnelBulkUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelBulkUpdateResponseEnvelopeSuccessTrueGRETunnelBulkUpdateResponseEnvelopeSuccess =true)

func (GRETunnelBulkUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelBulkUpdateResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelBulkUpdateResponseModifiedGRETunnel ¶

type GRETunnelBulkUpdateResponseModifiedGRETunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                                                   `json:"description"`HealthCheckGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                                            `json:"ttl"`JSON greTunnelBulkUpdateResponseModifiedGRETunnelJSON `json:"-"`}

func (*GRETunnelBulkUpdateResponseModifiedGRETunnel)UnmarshalJSON ¶

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

typeGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck ¶

type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                              `json:"type"`JSON greTunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckJSON `json:"-"`}

func (*GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheck)UnmarshalJSON ¶

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

typeGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection ¶

type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirectionstring

The direction of the flow of the healthcheck. Either unidirectional, where theprobe comes to you via the tunnel and the result comes back to Cloudflare viathe open Internet, or bidirectional where both the probe and result come and govia the tunnel.

const (GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirectionUnidirectionalGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection = "unidirectional"GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirectionBidirectionalGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection = "bidirectional")

func (GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection)IsKnown ¶

func (rGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckDirection) IsKnown()bool

typeGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                                   `json:"saved"`JSON  greTunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

The destination address in a request type health check. After the healthcheck isdecapsulated at the customer end of the tunnel, the ICMP echo will be forwardedto this address. This field defaults to `customer_gre_endpoint address`. Thisfield is ignored for bidirectional healthchecks as the interface_address (notassigned to the Cloudflare side of the tunnel) is used as the target.

func (GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion()

func (*GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion ¶

type GRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion interface {ImplementsGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetUnion()}

Union satisfied byGRETunnelBulkUpdateResponseModifiedGRETunnelsHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeGRETunnelDeleteParams ¶

type GRETunnelDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeGRETunnelDeleteResponse ¶

type GRETunnelDeleteResponse struct {Deletedbool                                    `json:"deleted"`DeletedGRETunnelGRETunnelDeleteResponseDeletedGRETunnel `json:"deleted_gre_tunnel"`JSON             greTunnelDeleteResponseJSON             `json:"-"`}

func (*GRETunnelDeleteResponse)UnmarshalJSON ¶

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

typeGRETunnelDeleteResponseDeletedGRETunnel ¶

type GRETunnelDeleteResponseDeletedGRETunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                                             `json:"description"`HealthCheckGRETunnelDeleteResponseDeletedGRETunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                                       `json:"ttl"`JSON greTunnelDeleteResponseDeletedGRETunnelJSON `json:"-"`}

func (*GRETunnelDeleteResponseDeletedGRETunnel)UnmarshalJSON ¶

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

typeGRETunnelDeleteResponseDeletedGRETunnelHealthCheck ¶

type GRETunnelDeleteResponseDeletedGRETunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                        `json:"type"`JSON greTunnelDeleteResponseDeletedGRETunnelHealthCheckJSON `json:"-"`}

func (*GRETunnelDeleteResponseDeletedGRETunnelHealthCheck)UnmarshalJSON ¶

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

typeGRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection ¶

type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirectionstring

const (GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirectionUnidirectionalGRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection = "unidirectional"GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirectionBidirectionalGRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection = "bidirectional")

func (GRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection)IsKnown ¶

func (rGRETunnelDeleteResponseDeletedGRETunnelHealthCheckDirection) IsKnown()bool

typeGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                             `json:"saved"`JSON  greTunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion()

func (*GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion ¶

type GRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion interface {ImplementsGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetUnion()}

Union satisfied byGRETunnelDeleteResponseDeletedGRETunnelHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeGRETunnelDeleteResponseEnvelope ¶

type GRETunnelDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo   `json:"errors,required"`Messages []shared.ResponseInfo   `json:"messages,required"`ResultGRETunnelDeleteResponse `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelDeleteResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelDeleteResponseEnvelopeSuccess ¶

type GRETunnelDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelDeleteResponseEnvelopeSuccessTrueGRETunnelDeleteResponseEnvelopeSuccess =true)

func (GRETunnelDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelDeleteResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelGetParams ¶

type GRETunnelGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeGRETunnelGetResponse ¶

type GRETunnelGetResponse struct {GRETunnelGRETunnelGetResponseGRETunnel `json:"gre_tunnel"`JSON      greTunnelGetResponseJSON      `json:"-"`}

func (*GRETunnelGetResponse)UnmarshalJSON ¶

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

typeGRETunnelGetResponseEnvelope ¶

type GRETunnelGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultGRETunnelGetResponse  `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelGetResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelGetResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelGetResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelGetResponseEnvelopeSuccess ¶

type GRETunnelGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelGetResponseEnvelopeSuccessTrueGRETunnelGetResponseEnvelopeSuccess =true)

func (GRETunnelGetResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelGetResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelGetResponseGRETunnel ¶

type GRETunnelGetResponseGRETunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                                   `json:"description"`HealthCheckGRETunnelGetResponseGRETunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                             `json:"ttl"`JSON greTunnelGetResponseGRETunnelJSON `json:"-"`}

func (*GRETunnelGetResponseGRETunnel)UnmarshalJSON ¶

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

typeGRETunnelGetResponseGRETunnelHealthCheck ¶

type GRETunnelGetResponseGRETunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelGetResponseGRETunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelGetResponseGRETunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                              `json:"type"`JSON greTunnelGetResponseGRETunnelHealthCheckJSON `json:"-"`}

func (*GRETunnelGetResponseGRETunnelHealthCheck)UnmarshalJSON ¶

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

typeGRETunnelGetResponseGRETunnelHealthCheckDirection ¶

type GRETunnelGetResponseGRETunnelHealthCheckDirectionstring

const (GRETunnelGetResponseGRETunnelHealthCheckDirectionUnidirectionalGRETunnelGetResponseGRETunnelHealthCheckDirection = "unidirectional"GRETunnelGetResponseGRETunnelHealthCheckDirectionBidirectionalGRETunnelGetResponseGRETunnelHealthCheckDirection = "bidirectional")

func (GRETunnelGetResponseGRETunnelHealthCheckDirection)IsKnown ¶

func (rGRETunnelGetResponseGRETunnelHealthCheckDirection) IsKnown()bool

typeGRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                   `json:"saved"`JSON  greTunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion()

func (*GRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeGRETunnelGetResponseGRETunnelHealthCheckTargetUnion ¶

type GRETunnelGetResponseGRETunnelHealthCheckTargetUnion interface {ImplementsGRETunnelGetResponseGRETunnelHealthCheckTargetUnion()}

Union satisfied byGRETunnelGetResponseGRETunnelHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeGRETunnelListParams ¶

type GRETunnelListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeGRETunnelListResponse ¶

type GRETunnelListResponse struct {GRETunnels []GRETunnelListResponseGRETunnel `json:"gre_tunnels"`JSON       greTunnelListResponseJSON        `json:"-"`}

func (*GRETunnelListResponse)UnmarshalJSON ¶

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

typeGRETunnelListResponseEnvelope ¶

type GRETunnelListResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultGRETunnelListResponse `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelListResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelListResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelListResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelListResponseEnvelopeSuccess ¶

type GRETunnelListResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelListResponseEnvelopeSuccessTrueGRETunnelListResponseEnvelopeSuccess =true)

func (GRETunnelListResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelListResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelListResponseGRETunnel ¶

type GRETunnelListResponseGRETunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                                     `json:"description"`HealthCheckGRETunnelListResponseGRETunnelsHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                              `json:"ttl"`JSON greTunnelListResponseGRETunnelJSON `json:"-"`}

func (*GRETunnelListResponseGRETunnel)UnmarshalJSON ¶

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

typeGRETunnelListResponseGRETunnelsHealthCheck ¶

type GRETunnelListResponseGRETunnelsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelListResponseGRETunnelsHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelListResponseGRETunnelsHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                `json:"type"`JSON greTunnelListResponseGRETunnelsHealthCheckJSON `json:"-"`}

func (*GRETunnelListResponseGRETunnelsHealthCheck)UnmarshalJSON ¶

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

typeGRETunnelListResponseGRETunnelsHealthCheckDirection ¶

type GRETunnelListResponseGRETunnelsHealthCheckDirectionstring

const (GRETunnelListResponseGRETunnelsHealthCheckDirectionUnidirectionalGRETunnelListResponseGRETunnelsHealthCheckDirection = "unidirectional"GRETunnelListResponseGRETunnelsHealthCheckDirectionBidirectionalGRETunnelListResponseGRETunnelsHealthCheckDirection = "bidirectional")

func (GRETunnelListResponseGRETunnelsHealthCheckDirection)IsKnown ¶

func (rGRETunnelListResponseGRETunnelsHealthCheckDirection) IsKnown()bool

typeGRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                     `json:"saved"`JSON  greTunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion()

func (*GRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeGRETunnelListResponseGRETunnelsHealthCheckTargetUnion ¶

type GRETunnelListResponseGRETunnelsHealthCheckTargetUnion interface {ImplementsGRETunnelListResponseGRETunnelsHealthCheckTargetUnion()}

Union satisfied byGRETunnelListResponseGRETunnelsHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeGRETunnelNewParams ¶

type GRETunnelNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointparam.Field[string] `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointparam.Field[string] `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressparam.Field[string] `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Nameparam.Field[string] `json:"name,required"`// An optional description of the GRE tunnel.Descriptionparam.Field[string]                        `json:"description"`HealthCheckparam.Field[GRETunnelNewParamsHealthCheck] `json:"health_check"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuparam.Field[int64] `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLparam.Field[int64] `json:"ttl"`XMagicNewHcTargetparam.Field[bool]  `header:"x-magic-new-hc-target"`}

func (GRETunnelNewParams)MarshalJSON ¶

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

typeGRETunnelNewParamsHealthCheck ¶added inv4.3.0

type GRETunnelNewParamsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.Directionparam.Field[GRETunnelNewParamsHealthCheckDirection] `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledparam.Field[bool] `json:"enabled"`// How frequent the health check is run. The default value is `mid`.Rateparam.Field[HealthCheckRate] `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.Targetparam.Field[GRETunnelNewParamsHealthCheckTargetUnion] `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.Typeparam.Field[HealthCheckType] `json:"type"`}

func (GRETunnelNewParamsHealthCheck)MarshalJSON ¶added inv4.3.0

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

typeGRETunnelNewParamsHealthCheckDirection ¶added inv4.3.0

type GRETunnelNewParamsHealthCheckDirectionstring

const (GRETunnelNewParamsHealthCheckDirectionUnidirectionalGRETunnelNewParamsHealthCheckDirection = "unidirectional"GRETunnelNewParamsHealthCheckDirectionBidirectionalGRETunnelNewParamsHealthCheckDirection = "bidirectional")

func (GRETunnelNewParamsHealthCheckDirection)IsKnown ¶added inv4.3.0

func (rGRETunnelNewParamsHealthCheckDirection) IsKnown()bool

typeGRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget ¶added inv4.3.0

type GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget struct {// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedparam.Field[string] `json:"saved"`}

func (GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelNewParamsHealthCheckTargetUnion ¶added inv4.3.0

func (rGRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewParamsHealthCheckTargetUnion()

func (GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget)MarshalJSON ¶added inv4.3.0

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

typeGRETunnelNewParamsHealthCheckTargetUnion ¶added inv4.3.0

type GRETunnelNewParamsHealthCheckTargetUnion interface {ImplementsGRETunnelNewParamsHealthCheckTargetUnion()}

Satisfied bymagic_transit.GRETunnelNewParamsHealthCheckTargetMagicHealthCheckTarget,shared.UnionString.

typeGRETunnelNewResponse ¶

type GRETunnelNewResponse struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                          `json:"description"`HealthCheckGRETunnelNewResponseHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                    `json:"ttl"`JSON greTunnelNewResponseJSON `json:"-"`}

func (*GRETunnelNewResponse)UnmarshalJSON ¶

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

typeGRETunnelNewResponseEnvelope ¶

type GRETunnelNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultGRETunnelNewResponse  `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelNewResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelNewResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelNewResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelNewResponseEnvelopeSuccess ¶

type GRETunnelNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelNewResponseEnvelopeSuccessTrueGRETunnelNewResponseEnvelopeSuccess =true)

func (GRETunnelNewResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelNewResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelNewResponseHealthCheck ¶added inv4.3.0

type GRETunnelNewResponseHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelNewResponseHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelNewResponseHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                     `json:"type"`JSON greTunnelNewResponseHealthCheckJSON `json:"-"`}

func (*GRETunnelNewResponseHealthCheck)UnmarshalJSON ¶added inv4.3.0

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

typeGRETunnelNewResponseHealthCheckDirection ¶added inv4.3.0

type GRETunnelNewResponseHealthCheckDirectionstring

const (GRETunnelNewResponseHealthCheckDirectionUnidirectionalGRETunnelNewResponseHealthCheckDirection = "unidirectional"GRETunnelNewResponseHealthCheckDirectionBidirectionalGRETunnelNewResponseHealthCheckDirection = "bidirectional")

func (GRETunnelNewResponseHealthCheckDirection)IsKnown ¶added inv4.3.0

func (rGRETunnelNewResponseHealthCheckDirection) IsKnown()bool

typeGRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget ¶added inv4.3.0

type GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                          `json:"saved"`JSON  greTunnelNewResponseHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelNewResponseHealthCheckTargetUnion ¶added inv4.3.0

func (rGRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelNewResponseHealthCheckTargetUnion()

func (*GRETunnelNewResponseHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶added inv4.3.0

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

typeGRETunnelNewResponseHealthCheckTargetUnion ¶added inv4.3.0

type GRETunnelNewResponseHealthCheckTargetUnion interface {ImplementsGRETunnelNewResponseHealthCheckTargetUnion()}

Union satisfied byGRETunnelNewResponseHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeGRETunnelService ¶

type GRETunnelService struct {Options []option.RequestOption}

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

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

funcNewGRETunnelService ¶

func NewGRETunnelService(opts ...option.RequestOption) (r *GRETunnelService)

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

func (*GRETunnelService)BulkUpdate ¶

func (r *GRETunnelService) BulkUpdate(ctxcontext.Context, paramsGRETunnelBulkUpdateParams, opts ...option.RequestOption) (res *GRETunnelBulkUpdateResponse, errerror)

Updates multiple GRE tunnels. Use `?validate_only=true` as an optional queryparameter to only run validation without persisting changes.

func (*GRETunnelService)Delete ¶

func (r *GRETunnelService) Delete(ctxcontext.Context, greTunnelIDstring, paramsGRETunnelDeleteParams, opts ...option.RequestOption) (res *GRETunnelDeleteResponse, errerror)

Disables and removes a specific static GRE tunnel. Use `?validate_only=true` asan optional query parameter to only run validation without persisting changes.

func (*GRETunnelService)Get ¶

func (r *GRETunnelService) Get(ctxcontext.Context, greTunnelIDstring, paramsGRETunnelGetParams, opts ...option.RequestOption) (res *GRETunnelGetResponse, errerror)

Lists informtion for a specific GRE tunnel.

func (*GRETunnelService)List ¶

func (r *GRETunnelService) List(ctxcontext.Context, paramsGRETunnelListParams, opts ...option.RequestOption) (res *GRETunnelListResponse, errerror)

Lists GRE tunnels associated with an account.

func (*GRETunnelService)New ¶

func (r *GRETunnelService) New(ctxcontext.Context, paramsGRETunnelNewParams, opts ...option.RequestOption) (res *GRETunnelNewResponse, errerror)

Creates a new GRE tunnel. Use `?validate_only=true` as an optional queryparameter to only run validation without persisting changes.

func (*GRETunnelService)Update ¶

func (r *GRETunnelService) Update(ctxcontext.Context, greTunnelIDstring, paramsGRETunnelUpdateParams, opts ...option.RequestOption) (res *GRETunnelUpdateResponse, errerror)

Updates a specific GRE tunnel. Use `?validate_only=true` as an optional queryparameter to only run validation without persisting changes.

typeGRETunnelUpdateParams ¶

type GRETunnelUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointparam.Field[string] `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointparam.Field[string] `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressparam.Field[string] `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Nameparam.Field[string] `json:"name,required"`// An optional description of the GRE tunnel.Descriptionparam.Field[string]                           `json:"description"`HealthCheckparam.Field[GRETunnelUpdateParamsHealthCheck] `json:"health_check"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuparam.Field[int64] `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLparam.Field[int64] `json:"ttl"`XMagicNewHcTargetparam.Field[bool]  `header:"x-magic-new-hc-target"`}

func (GRETunnelUpdateParams)MarshalJSON ¶

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

typeGRETunnelUpdateParamsHealthCheck ¶

type GRETunnelUpdateParamsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.Directionparam.Field[GRETunnelUpdateParamsHealthCheckDirection] `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledparam.Field[bool] `json:"enabled"`// How frequent the health check is run. The default value is `mid`.Rateparam.Field[HealthCheckRate] `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.Targetparam.Field[GRETunnelUpdateParamsHealthCheckTargetUnion] `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.Typeparam.Field[HealthCheckType] `json:"type"`}

func (GRETunnelUpdateParamsHealthCheck)MarshalJSON ¶

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

typeGRETunnelUpdateParamsHealthCheckDirection ¶

type GRETunnelUpdateParamsHealthCheckDirectionstring

const (GRETunnelUpdateParamsHealthCheckDirectionUnidirectionalGRETunnelUpdateParamsHealthCheckDirection = "unidirectional"GRETunnelUpdateParamsHealthCheckDirectionBidirectionalGRETunnelUpdateParamsHealthCheckDirection = "bidirectional")

func (GRETunnelUpdateParamsHealthCheckDirection)IsKnown ¶

func (rGRETunnelUpdateParamsHealthCheckDirection) IsKnown()bool

typeGRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget struct {// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedparam.Field[string] `json:"saved"`}

func (GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion()

func (GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget)MarshalJSON ¶

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

typeGRETunnelUpdateParamsHealthCheckTargetUnion ¶

type GRETunnelUpdateParamsHealthCheckTargetUnion interface {ImplementsGRETunnelUpdateParamsHealthCheckTargetUnion()}

Satisfied bymagic_transit.GRETunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget,shared.UnionString.

typeGRETunnelUpdateResponse ¶

type GRETunnelUpdateResponse struct {Modifiedbool                                     `json:"modified"`ModifiedGRETunnelGRETunnelUpdateResponseModifiedGRETunnel `json:"modified_gre_tunnel"`JSON              greTunnelUpdateResponseJSON              `json:"-"`}

func (*GRETunnelUpdateResponse)UnmarshalJSON ¶

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

typeGRETunnelUpdateResponseEnvelope ¶

type GRETunnelUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo   `json:"errors,required"`Messages []shared.ResponseInfo   `json:"messages,required"`ResultGRETunnelUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessGRETunnelUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    greTunnelUpdateResponseEnvelopeJSON    `json:"-"`}

func (*GRETunnelUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeGRETunnelUpdateResponseEnvelopeSuccess ¶

type GRETunnelUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (GRETunnelUpdateResponseEnvelopeSuccessTrueGRETunnelUpdateResponseEnvelopeSuccess =true)

func (GRETunnelUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rGRETunnelUpdateResponseEnvelopeSuccess) IsKnown()bool

typeGRETunnelUpdateResponseModifiedGRETunnel ¶

type GRETunnelUpdateResponseModifiedGRETunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the GRE tunnel.CloudflareGREEndpointstring `json:"cloudflare_gre_endpoint,required"`// The IP address assigned to the customer side of the GRE tunnel.CustomerGREEndpointstring `json:"customer_gre_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the tunnel. The name cannot contain spaces or special characters,// must be 15 characters or less, and cannot share a name with another GRE tunnel.Namestring `json:"name,required"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional description of the GRE tunnel.Descriptionstring                                              `json:"description"`HealthCheckGRETunnelUpdateResponseModifiedGRETunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The minimum value// is 576.Mtuint64 `json:"mtu"`// Time To Live (TTL) in number of hops of the GRE tunnel.TTLint64                                        `json:"ttl"`JSON greTunnelUpdateResponseModifiedGRETunnelJSON `json:"-"`}

func (*GRETunnelUpdateResponseModifiedGRETunnel)UnmarshalJSON ¶

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

typeGRETunnelUpdateResponseModifiedGRETunnelHealthCheck ¶

type GRETunnelUpdateResponseModifiedGRETunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionGRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                         `json:"type"`JSON greTunnelUpdateResponseModifiedGRETunnelHealthCheckJSON `json:"-"`}

func (*GRETunnelUpdateResponseModifiedGRETunnelHealthCheck)UnmarshalJSON ¶

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

typeGRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection ¶

type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirectionstring

const (GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirectionUnidirectionalGRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection = "unidirectional"GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirectionBidirectionalGRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection = "bidirectional")

func (GRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection)IsKnown ¶

func (rGRETunnelUpdateResponseModifiedGRETunnelHealthCheckDirection) IsKnown()bool

typeGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget ¶

type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                              `json:"saved"`JSON  greTunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion()

func (*GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion ¶

type GRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion interface {ImplementsGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetUnion()}

Union satisfied byGRETunnelUpdateResponseModifiedGRETunnelHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeHealthCheck ¶

type HealthCheck struct {// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType `json:"type"`JSON healthCheckJSON `json:"-"`}

func (*HealthCheck)UnmarshalJSON ¶

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

typeHealthCheckParam ¶

type HealthCheckParam struct {// Determines whether to run healthchecks for a tunnel.Enabledparam.Field[bool] `json:"enabled"`// How frequent the health check is run. The default value is `mid`.Rateparam.Field[HealthCheckRate] `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.Targetparam.Field[HealthCheckTargetUnionParam] `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.Typeparam.Field[HealthCheckType] `json:"type"`}

func (HealthCheckParam)MarshalJSON ¶

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

typeHealthCheckRate ¶

type HealthCheckRatestring

How frequent the health check is run. The default value is `mid`.

const (HealthCheckRateLowHealthCheckRate = "low"HealthCheckRateMidHealthCheckRate = "mid"HealthCheckRateHighHealthCheckRate = "high")

func (HealthCheckRate)IsKnown ¶

func (rHealthCheckRate) IsKnown()bool

typeHealthCheckTargetMagicHealthCheckTarget ¶

type HealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                      `json:"saved"`JSON  healthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (HealthCheckTargetMagicHealthCheckTarget)ImplementsHealthCheckTargetUnion ¶added inv4.1.0

func (rHealthCheckTargetMagicHealthCheckTarget) ImplementsHealthCheckTargetUnion()

func (*HealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeHealthCheckTargetMagicHealthCheckTargetParam ¶

type HealthCheckTargetMagicHealthCheckTargetParam struct {// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedparam.Field[string] `json:"saved"`}

func (HealthCheckTargetMagicHealthCheckTargetParam)ImplementsHealthCheckTargetUnionParam ¶added inv4.1.0

func (rHealthCheckTargetMagicHealthCheckTargetParam) ImplementsHealthCheckTargetUnionParam()

func (HealthCheckTargetMagicHealthCheckTargetParam)MarshalJSON ¶

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

typeHealthCheckTargetUnion ¶

type HealthCheckTargetUnion interface {ImplementsHealthCheckTargetUnion()}

Union satisfied byHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeHealthCheckTargetUnionParam ¶

type HealthCheckTargetUnionParam interface {ImplementsHealthCheckTargetUnionParam()}

Satisfied bymagic_transit.HealthCheckTargetMagicHealthCheckTargetParam,shared.UnionString.

typeHealthCheckType ¶

type HealthCheckTypestring

The type of healthcheck to run, reply or request. The default value is `reply`.

const (HealthCheckTypeReplyHealthCheckType = "reply"HealthCheckTypeRequestHealthCheckType = "request")

func (HealthCheckType)IsKnown ¶

func (rHealthCheckType) IsKnown()bool

typeIPSECTunnelBulkUpdateParams ¶

type IPSECTunnelBulkUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Body              interface{}         `json:"body,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

func (IPSECTunnelBulkUpdateParams)MarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponse ¶

type IPSECTunnelBulkUpdateResponse struct {Modifiedbool                                               `json:"modified"`ModifiedIPSECTunnels []IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel `json:"modified_ipsec_tunnels"`JSON                 ipsecTunnelBulkUpdateResponseJSON                  `json:"-"`}

func (*IPSECTunnelBulkUpdateResponse)UnmarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponseEnvelope ¶

type IPSECTunnelBulkUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo         `json:"errors,required"`Messages []shared.ResponseInfo         `json:"messages,required"`ResultIPSECTunnelBulkUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelBulkUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelBulkUpdateResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelBulkUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponseEnvelopeSuccess ¶

type IPSECTunnelBulkUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelBulkUpdateResponseEnvelopeSuccessTrueIPSECTunnelBulkUpdateResponseEnvelopeSuccess =true)

func (IPSECTunnelBulkUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelBulkUpdateResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelBulkUpdateResponseModifiedIPSECTunnel ¶

type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                                                       `json:"description"`HealthCheckIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                                                 `json:"replay_protection"`JSON             ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelJSON `json:"-"`}

func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnel)UnmarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck ¶

type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                                  `json:"type"`JSON ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckJSON `json:"-"`}

func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheck)UnmarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection ¶

type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionstring

const (IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionUnidirectionalIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "unidirectional"IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirectionBidirectionalIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection = "bidirectional")

func (IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckDirection) IsKnown()bool

typeIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                                       `json:"saved"`JSON  ipsecTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion()

func (*IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion ¶

type IPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion interface {ImplementsIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelBulkUpdateResponseModifiedIPSECTunnelsHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeIPSECTunnelDeleteParams ¶

type IPSECTunnelDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeIPSECTunnelDeleteResponse ¶

type IPSECTunnelDeleteResponse struct {Deletedbool                                        `json:"deleted"`DeletedIPSECTunnelIPSECTunnelDeleteResponseDeletedIPSECTunnel `json:"deleted_ipsec_tunnel"`JSON               ipsecTunnelDeleteResponseJSON               `json:"-"`}

func (*IPSECTunnelDeleteResponse)UnmarshalJSON ¶

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

typeIPSECTunnelDeleteResponseDeletedIPSECTunnel ¶

type IPSECTunnelDeleteResponseDeletedIPSECTunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                                                 `json:"description"`HealthCheckIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                                            `json:"replay_protection"`JSON             ipsecTunnelDeleteResponseDeletedIPSECTunnelJSON `json:"-"`}

func (*IPSECTunnelDeleteResponseDeletedIPSECTunnel)UnmarshalJSON ¶

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

typeIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck ¶

type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                            `json:"type"`JSON ipsecTunnelDeleteResponseDeletedIPSECTunnelHealthCheckJSON `json:"-"`}

func (*IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheck)UnmarshalJSON ¶

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

typeIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection ¶

type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirectionstring

const (IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirectionUnidirectionalIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection = "unidirectional"IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirectionBidirectionalIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection = "bidirectional")

func (IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckDirection) IsKnown()bool

typeIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                                 `json:"saved"`JSON  ipsecTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion()

func (*IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion ¶

type IPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion interface {ImplementsIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelDeleteResponseDeletedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeIPSECTunnelDeleteResponseEnvelope ¶

type IPSECTunnelDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo     `json:"errors,required"`Messages []shared.ResponseInfo     `json:"messages,required"`ResultIPSECTunnelDeleteResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelDeleteResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelDeleteResponseEnvelopeSuccess ¶

type IPSECTunnelDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelDeleteResponseEnvelopeSuccessTrueIPSECTunnelDeleteResponseEnvelopeSuccess =true)

func (IPSECTunnelDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelDeleteResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelGetParams ¶

type IPSECTunnelGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeIPSECTunnelGetResponse ¶

type IPSECTunnelGetResponse struct {IPSECTunnelIPSECTunnelGetResponseIPSECTunnel `json:"ipsec_tunnel"`JSON        ipsecTunnelGetResponseJSON        `json:"-"`}

func (*IPSECTunnelGetResponse)UnmarshalJSON ¶

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

typeIPSECTunnelGetResponseEnvelope ¶

type IPSECTunnelGetResponseEnvelope struct {Errors   []shared.ResponseInfo  `json:"errors,required"`Messages []shared.ResponseInfo  `json:"messages,required"`ResultIPSECTunnelGetResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelGetResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelGetResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelGetResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelGetResponseEnvelopeSuccess ¶

type IPSECTunnelGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelGetResponseEnvelopeSuccessTrueIPSECTunnelGetResponseEnvelopeSuccess =true)

func (IPSECTunnelGetResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelGetResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelGetResponseIPSECTunnel ¶

type IPSECTunnelGetResponseIPSECTunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                                       `json:"description"`HealthCheckIPSECTunnelGetResponseIPSECTunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                                  `json:"replay_protection"`JSON             ipsecTunnelGetResponseIPSECTunnelJSON `json:"-"`}

func (*IPSECTunnelGetResponseIPSECTunnel)UnmarshalJSON ¶

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

typeIPSECTunnelGetResponseIPSECTunnelHealthCheck ¶

type IPSECTunnelGetResponseIPSECTunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelGetResponseIPSECTunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                  `json:"type"`JSON ipsecTunnelGetResponseIPSECTunnelHealthCheckJSON `json:"-"`}

func (*IPSECTunnelGetResponseIPSECTunnelHealthCheck)UnmarshalJSON ¶

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

typeIPSECTunnelGetResponseIPSECTunnelHealthCheckDirection ¶

type IPSECTunnelGetResponseIPSECTunnelHealthCheckDirectionstring

const (IPSECTunnelGetResponseIPSECTunnelHealthCheckDirectionUnidirectionalIPSECTunnelGetResponseIPSECTunnelHealthCheckDirection = "unidirectional"IPSECTunnelGetResponseIPSECTunnelHealthCheckDirectionBidirectionalIPSECTunnelGetResponseIPSECTunnelHealthCheckDirection = "bidirectional")

func (IPSECTunnelGetResponseIPSECTunnelHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelGetResponseIPSECTunnelHealthCheckDirection) IsKnown()bool

typeIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                       `json:"saved"`JSON  ipsecTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion()

func (*IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion ¶

type IPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion interface {ImplementsIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelGetResponseIPSECTunnelHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeIPSECTunnelListParams ¶

type IPSECTunnelListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeIPSECTunnelListResponse ¶

type IPSECTunnelListResponse struct {IPSECTunnels []IPSECTunnelListResponseIPSECTunnel `json:"ipsec_tunnels"`JSON         ipsecTunnelListResponseJSON          `json:"-"`}

func (*IPSECTunnelListResponse)UnmarshalJSON ¶

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

typeIPSECTunnelListResponseEnvelope ¶

type IPSECTunnelListResponseEnvelope struct {Errors   []shared.ResponseInfo   `json:"errors,required"`Messages []shared.ResponseInfo   `json:"messages,required"`ResultIPSECTunnelListResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelListResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelListResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelListResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelListResponseEnvelopeSuccess ¶

type IPSECTunnelListResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelListResponseEnvelopeSuccessTrueIPSECTunnelListResponseEnvelopeSuccess =true)

func (IPSECTunnelListResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelListResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelListResponseIPSECTunnel ¶

type IPSECTunnelListResponseIPSECTunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                                         `json:"description"`HealthCheckIPSECTunnelListResponseIPSECTunnelsHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                                   `json:"replay_protection"`JSON             ipsecTunnelListResponseIPSECTunnelJSON `json:"-"`}

func (*IPSECTunnelListResponseIPSECTunnel)UnmarshalJSON ¶

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

typeIPSECTunnelListResponseIPSECTunnelsHealthCheck ¶

type IPSECTunnelListResponseIPSECTunnelsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelListResponseIPSECTunnelsHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                    `json:"type"`JSON ipsecTunnelListResponseIPSECTunnelsHealthCheckJSON `json:"-"`}

func (*IPSECTunnelListResponseIPSECTunnelsHealthCheck)UnmarshalJSON ¶

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

typeIPSECTunnelListResponseIPSECTunnelsHealthCheckDirection ¶

type IPSECTunnelListResponseIPSECTunnelsHealthCheckDirectionstring

const (IPSECTunnelListResponseIPSECTunnelsHealthCheckDirectionUnidirectionalIPSECTunnelListResponseIPSECTunnelsHealthCheckDirection = "unidirectional"IPSECTunnelListResponseIPSECTunnelsHealthCheckDirectionBidirectionalIPSECTunnelListResponseIPSECTunnelsHealthCheckDirection = "bidirectional")

func (IPSECTunnelListResponseIPSECTunnelsHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelListResponseIPSECTunnelsHealthCheckDirection) IsKnown()bool

typeIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                         `json:"saved"`JSON  ipsecTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion()

func (*IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion ¶

type IPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion interface {ImplementsIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelListResponseIPSECTunnelsHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeIPSECTunnelNewParams ¶

type IPSECTunnelNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointparam.Field[string] `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressparam.Field[string] `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Nameparam.Field[string] `json:"name,required"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointparam.Field[string] `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionparam.Field[string]                          `json:"description"`HealthCheckparam.Field[IPSECTunnelNewParamsHealthCheck] `json:"health_check"`// A randomly generated or provided string for use in the IPsec tunnel.PSKparam.Field[string] `json:"psk"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionparam.Field[bool] `json:"replay_protection"`XMagicNewHcTargetparam.Field[bool] `header:"x-magic-new-hc-target"`}

func (IPSECTunnelNewParams)MarshalJSON ¶

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

typeIPSECTunnelNewParamsHealthCheck ¶

type IPSECTunnelNewParamsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.Directionparam.Field[IPSECTunnelNewParamsHealthCheckDirection] `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledparam.Field[bool] `json:"enabled"`// How frequent the health check is run. The default value is `mid`.Rateparam.Field[HealthCheckRate] `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.Targetparam.Field[IPSECTunnelNewParamsHealthCheckTargetUnion] `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.Typeparam.Field[HealthCheckType] `json:"type"`}

func (IPSECTunnelNewParamsHealthCheck)MarshalJSON ¶

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

typeIPSECTunnelNewParamsHealthCheckDirection ¶

type IPSECTunnelNewParamsHealthCheckDirectionstring

const (IPSECTunnelNewParamsHealthCheckDirectionUnidirectionalIPSECTunnelNewParamsHealthCheckDirection = "unidirectional"IPSECTunnelNewParamsHealthCheckDirectionBidirectionalIPSECTunnelNewParamsHealthCheckDirection = "bidirectional")

func (IPSECTunnelNewParamsHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelNewParamsHealthCheckDirection) IsKnown()bool

typeIPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget struct {// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedparam.Field[string] `json:"saved"`}

func (IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion()

func (IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget)MarshalJSON ¶

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

typeIPSECTunnelNewParamsHealthCheckTargetUnion ¶

type IPSECTunnelNewParamsHealthCheckTargetUnion interface {ImplementsIPSECTunnelNewParamsHealthCheckTargetUnion()}

Satisfied bymagic_transit.IPSECTunnelNewParamsHealthCheckTargetMagicHealthCheckTarget,shared.UnionString.

typeIPSECTunnelNewResponse ¶

type IPSECTunnelNewResponse struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                            `json:"description"`HealthCheckIPSECTunnelNewResponseHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                       `json:"replay_protection"`JSON             ipsecTunnelNewResponseJSON `json:"-"`}

func (*IPSECTunnelNewResponse)UnmarshalJSON ¶

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

typeIPSECTunnelNewResponseEnvelope ¶

type IPSECTunnelNewResponseEnvelope struct {Errors   []shared.ResponseInfo  `json:"errors,required"`Messages []shared.ResponseInfo  `json:"messages,required"`ResultIPSECTunnelNewResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelNewResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelNewResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelNewResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelNewResponseEnvelopeSuccess ¶

type IPSECTunnelNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelNewResponseEnvelopeSuccessTrueIPSECTunnelNewResponseEnvelopeSuccess =true)

func (IPSECTunnelNewResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelNewResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelNewResponseHealthCheck ¶added inv4.3.0

type IPSECTunnelNewResponseHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelNewResponseHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelNewResponseHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                       `json:"type"`JSON ipsecTunnelNewResponseHealthCheckJSON `json:"-"`}

func (*IPSECTunnelNewResponseHealthCheck)UnmarshalJSON ¶added inv4.3.0

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

typeIPSECTunnelNewResponseHealthCheckDirection ¶added inv4.3.0

type IPSECTunnelNewResponseHealthCheckDirectionstring

const (IPSECTunnelNewResponseHealthCheckDirectionUnidirectionalIPSECTunnelNewResponseHealthCheckDirection = "unidirectional"IPSECTunnelNewResponseHealthCheckDirectionBidirectionalIPSECTunnelNewResponseHealthCheckDirection = "bidirectional")

func (IPSECTunnelNewResponseHealthCheckDirection)IsKnown ¶added inv4.3.0

func (rIPSECTunnelNewResponseHealthCheckDirection) IsKnown()bool

typeIPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget ¶added inv4.3.0

type IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                            `json:"saved"`JSON  ipsecTunnelNewResponseHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion ¶added inv4.3.0

func (rIPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion()

func (*IPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶added inv4.3.0

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

typeIPSECTunnelNewResponseHealthCheckTargetUnion ¶added inv4.3.0

type IPSECTunnelNewResponseHealthCheckTargetUnion interface {ImplementsIPSECTunnelNewResponseHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelNewResponseHealthCheckTargetMagicHealthCheckTarget orshared.UnionString.

typeIPSECTunnelPSKGenerateParams ¶

type IPSECTunnelPSKGenerateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Body      interface{}         `json:"body,required"`}

func (IPSECTunnelPSKGenerateParams)MarshalJSON ¶

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

typeIPSECTunnelPSKGenerateResponse ¶

type IPSECTunnelPSKGenerateResponse struct {// IdentifierIPSECTunnelIDstring `json:"ipsec_tunnel_id"`// A randomly generated or provided string for use in the IPsec tunnel.PSKstring `json:"psk"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata                        `json:"psk_metadata"`JSON        ipsecTunnelPSKGenerateResponseJSON `json:"-"`}

func (*IPSECTunnelPSKGenerateResponse)UnmarshalJSON ¶

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

typeIPSECTunnelPSKGenerateResponseEnvelope ¶

type IPSECTunnelPSKGenerateResponseEnvelope struct {Errors   []shared.ResponseInfo          `json:"errors,required"`Messages []shared.ResponseInfo          `json:"messages,required"`ResultIPSECTunnelPSKGenerateResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelPSKGenerateResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelPSKGenerateResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelPSKGenerateResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelPSKGenerateResponseEnvelopeSuccess ¶

type IPSECTunnelPSKGenerateResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelPSKGenerateResponseEnvelopeSuccessTrueIPSECTunnelPSKGenerateResponseEnvelopeSuccess =true)

func (IPSECTunnelPSKGenerateResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelPSKGenerateResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelService ¶

type IPSECTunnelService struct {Options []option.RequestOption}

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

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

funcNewIPSECTunnelService ¶

func NewIPSECTunnelService(opts ...option.RequestOption) (r *IPSECTunnelService)

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

func (*IPSECTunnelService)BulkUpdate ¶

func (r *IPSECTunnelService) BulkUpdate(ctxcontext.Context, paramsIPSECTunnelBulkUpdateParams, opts ...option.RequestOption) (res *IPSECTunnelBulkUpdateResponse, errerror)

Update multiple IPsec tunnels associated with an account. Use`?validate_only=true` as an optional query parameter to only run validationwithout persisting changes.

func (*IPSECTunnelService)Delete ¶

func (r *IPSECTunnelService) Delete(ctxcontext.Context, ipsecTunnelIDstring, paramsIPSECTunnelDeleteParams, opts ...option.RequestOption) (res *IPSECTunnelDeleteResponse, errerror)

Disables and removes a specific static IPsec Tunnel associated with an account.Use `?validate_only=true` as an optional query parameter to only run validationwithout persisting changes.

func (*IPSECTunnelService)Get ¶

func (r *IPSECTunnelService) Get(ctxcontext.Context, ipsecTunnelIDstring, paramsIPSECTunnelGetParams, opts ...option.RequestOption) (res *IPSECTunnelGetResponse, errerror)

Lists details for a specific IPsec tunnel.

func (*IPSECTunnelService)List ¶

func (r *IPSECTunnelService) List(ctxcontext.Context, paramsIPSECTunnelListParams, opts ...option.RequestOption) (res *IPSECTunnelListResponse, errerror)

Lists IPsec tunnels associated with an account.

func (*IPSECTunnelService)New ¶

func (r *IPSECTunnelService) New(ctxcontext.Context, paramsIPSECTunnelNewParams, opts ...option.RequestOption) (res *IPSECTunnelNewResponse, errerror)

Creates a new IPsec tunnel associated with an account. Use `?validate_only=true`as an optional query parameter to only run validation without persistingchanges.

func (*IPSECTunnelService)PSKGenerate ¶

func (r *IPSECTunnelService) PSKGenerate(ctxcontext.Context, ipsecTunnelIDstring, paramsIPSECTunnelPSKGenerateParams, opts ...option.RequestOption) (res *IPSECTunnelPSKGenerateResponse, errerror)

Generates a Pre Shared Key for a specific IPsec tunnel used in the IKE session.Use `?validate_only=true` as an optional query parameter to only run validationwithout persisting changes. After a PSK is generated, the PSK is immediatelypersisted to Cloudflare's edge and cannot be retrieved later. Note the PSK in asafe place.

func (*IPSECTunnelService)Update ¶

func (r *IPSECTunnelService) Update(ctxcontext.Context, ipsecTunnelIDstring, paramsIPSECTunnelUpdateParams, opts ...option.RequestOption) (res *IPSECTunnelUpdateResponse, errerror)

Updates a specific IPsec tunnel associated with an account. Use`?validate_only=true` as an optional query parameter to only run validationwithout persisting changes.

typeIPSECTunnelUpdateParams ¶

type IPSECTunnelUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointparam.Field[string] `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressparam.Field[string] `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Nameparam.Field[string] `json:"name,required"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointparam.Field[string] `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionparam.Field[string]                             `json:"description"`HealthCheckparam.Field[IPSECTunnelUpdateParamsHealthCheck] `json:"health_check"`// A randomly generated or provided string for use in the IPsec tunnel.PSKparam.Field[string] `json:"psk"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionparam.Field[bool] `json:"replay_protection"`XMagicNewHcTargetparam.Field[bool] `header:"x-magic-new-hc-target"`}

func (IPSECTunnelUpdateParams)MarshalJSON ¶

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

typeIPSECTunnelUpdateParamsHealthCheck ¶

type IPSECTunnelUpdateParamsHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.Directionparam.Field[IPSECTunnelUpdateParamsHealthCheckDirection] `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledparam.Field[bool] `json:"enabled"`// How frequent the health check is run. The default value is `mid`.Rateparam.Field[HealthCheckRate] `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.Targetparam.Field[IPSECTunnelUpdateParamsHealthCheckTargetUnion] `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.Typeparam.Field[HealthCheckType] `json:"type"`}

func (IPSECTunnelUpdateParamsHealthCheck)MarshalJSON ¶

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

typeIPSECTunnelUpdateParamsHealthCheckDirection ¶

type IPSECTunnelUpdateParamsHealthCheckDirectionstring

const (IPSECTunnelUpdateParamsHealthCheckDirectionUnidirectionalIPSECTunnelUpdateParamsHealthCheckDirection = "unidirectional"IPSECTunnelUpdateParamsHealthCheckDirectionBidirectionalIPSECTunnelUpdateParamsHealthCheckDirection = "bidirectional")

func (IPSECTunnelUpdateParamsHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelUpdateParamsHealthCheckDirection) IsKnown()bool

typeIPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget struct {// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedparam.Field[string] `json:"saved"`}

func (IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion()

func (IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget)MarshalJSON ¶

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

typeIPSECTunnelUpdateParamsHealthCheckTargetUnion ¶

type IPSECTunnelUpdateParamsHealthCheckTargetUnion interface {ImplementsIPSECTunnelUpdateParamsHealthCheckTargetUnion()}

Satisfied bymagic_transit.IPSECTunnelUpdateParamsHealthCheckTargetMagicHealthCheckTarget,shared.UnionString.

typeIPSECTunnelUpdateResponse ¶

type IPSECTunnelUpdateResponse struct {Modifiedbool                                         `json:"modified"`ModifiedIPSECTunnelIPSECTunnelUpdateResponseModifiedIPSECTunnel `json:"modified_ipsec_tunnel"`JSON                ipsecTunnelUpdateResponseJSON                `json:"-"`}

func (*IPSECTunnelUpdateResponse)UnmarshalJSON ¶

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

typeIPSECTunnelUpdateResponseEnvelope ¶

type IPSECTunnelUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo     `json:"errors,required"`Messages []shared.ResponseInfo     `json:"messages,required"`ResultIPSECTunnelUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessIPSECTunnelUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    ipsecTunnelUpdateResponseEnvelopeJSON    `json:"-"`}

func (*IPSECTunnelUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeIPSECTunnelUpdateResponseEnvelopeSuccess ¶

type IPSECTunnelUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (IPSECTunnelUpdateResponseEnvelopeSuccessTrueIPSECTunnelUpdateResponseEnvelopeSuccess =true)

func (IPSECTunnelUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rIPSECTunnelUpdateResponseEnvelopeSuccess) IsKnown()bool

typeIPSECTunnelUpdateResponseModifiedIPSECTunnel ¶

type IPSECTunnelUpdateResponseModifiedIPSECTunnel struct {// IdentifierIDstring `json:"id,required"`// The IP address assigned to the Cloudflare side of the IPsec tunnel.CloudflareEndpointstring `json:"cloudflare_endpoint,required"`// A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one for each side// of the tunnel. Select the subnet from the following private IP space:// 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.InterfaceAddressstring `json:"interface_address,required"`// The name of the IPsec tunnel. The name cannot share a name with other tunnels.Namestring `json:"name,required"`// When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in the ESP tunnel// (Phase 2).AllowNullCipherbool `json:"allow_null_cipher"`// The date and time the tunnel was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// The IP address assigned to the customer side of the IPsec tunnel. Not required,// but must be set for proactive traceroutes to work.CustomerEndpointstring `json:"customer_endpoint"`// An optional description forthe IPsec tunnel.Descriptionstring                                                  `json:"description"`HealthCheckIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck `json:"health_check"`// The date and time the tunnel was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// The PSK metadata that includes when the PSK was generated.PSKMetadataPSKMetadata `json:"psk_metadata"`// If `true`, then IPsec replay protection will be supported in the// Cloudflare-to-customer direction.ReplayProtectionbool                                             `json:"replay_protection"`JSON             ipsecTunnelUpdateResponseModifiedIPSECTunnelJSON `json:"-"`}

func (*IPSECTunnelUpdateResponseModifiedIPSECTunnel)UnmarshalJSON ¶

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

typeIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck ¶

type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck struct {// The direction of the flow of the healthcheck. Either unidirectional, where the// probe comes to you via the tunnel and the result comes back to Cloudflare via// the open Internet, or bidirectional where both the probe and result come and go// via the tunnel.DirectionIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection `json:"direction"`// Determines whether to run healthchecks for a tunnel.Enabledbool `json:"enabled"`// How frequent the health check is run. The default value is `mid`.RateHealthCheckRate `json:"rate"`// The destination address in a request type health check. After the healthcheck is// decapsulated at the customer end of the tunnel, the ICMP echo will be forwarded// to this address. This field defaults to `customer_gre_endpoint address`. This// field is ignored for bidirectional healthchecks as the interface_address (not// assigned to the Cloudflare side of the tunnel) is used as the target. Must be in// object form if the x-magic-new-hc-target header is set to true and string form// if x-magic-new-hc-target is absent or set to false.TargetIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion `json:"target"`// The type of healthcheck to run, reply or request. The default value is `reply`.TypeHealthCheckType                                             `json:"type"`JSON ipsecTunnelUpdateResponseModifiedIPSECTunnelHealthCheckJSON `json:"-"`}

func (*IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheck)UnmarshalJSON ¶

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

typeIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection ¶

type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirectionstring

const (IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirectionUnidirectionalIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection = "unidirectional"IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirectionBidirectionalIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection = "bidirectional")

func (IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection)IsKnown ¶

func (rIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckDirection) IsKnown()bool

typeIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget ¶

type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget struct {// The effective health check target. If 'saved' is empty, then this field will be// populated with the calculated default value on GET requests. Ignored in POST,// PUT, and PATCH requests.Effectivestring `json:"effective"`// The saved health check target. Setting the value to the empty string indicates// that the calculated default value will be used.Savedstring                                                                                  `json:"saved"`JSON  ipsecTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetJSON `json:"-"`}

func (IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion ¶added inv4.1.0

func (rIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget) ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion()

func (*IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTarget)UnmarshalJSON ¶

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

typeIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion ¶

type IPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion interface {ImplementsIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetUnion()}

Union satisfied byIPSECTunnelUpdateResponseModifiedIPSECTunnelHealthCheckTargetMagicHealthCheckTargetorshared.UnionString.

typeLAN ¶

type LAN struct {// IdentifierIDstring `json:"id"`// mark true to use this LAN for HA probing. only works for site with HA turned on.// only one LAN can be set as the ha_link.HaLinkbool           `json:"ha_link"`Namestring         `json:"name"`NatNat            `json:"nat"`Physportint64          `json:"physport"`RoutedSubnets []RoutedSubnet `json:"routed_subnets"`// IdentifierSiteIDstring `json:"site_id"`// If the site is not configured in high availability mode, this configuration is// optional (if omitted, use DHCP). However, if in high availability mode,// static_address is required along with secondary and virtual address.StaticAddressingLANStaticAddressing `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagint64   `json:"vlan_tag"`JSON    lanJSON `json:"-"`}

func (*LAN)UnmarshalJSON ¶

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

typeLANStaticAddressing ¶

type LANStaticAddressing struct {// A valid CIDR notation representing an IP range.Addressstring     `json:"address,required"`DHCPRelayDHCPRelay  `json:"dhcp_relay"`DHCPServerDHCPServer `json:"dhcp_server"`// A valid CIDR notation representing an IP range.SecondaryAddressstring `json:"secondary_address"`// A valid CIDR notation representing an IP range.VirtualAddressstring                  `json:"virtual_address"`JSON           lanStaticAddressingJSON `json:"-"`}

If the site is not configured in high availability mode, this configuration isoptional (if omitted, use DHCP). However, if in high availability mode,static_address is required along with secondary and virtual address.

func (*LANStaticAddressing)UnmarshalJSON ¶

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

typeLANStaticAddressingParam ¶

type LANStaticAddressingParam struct {// A valid CIDR notation representing an IP range.Addressparam.Field[string]          `json:"address,required"`DHCPRelayparam.Field[DHCPRelayParam]  `json:"dhcp_relay"`DHCPServerparam.Field[DHCPServerParam] `json:"dhcp_server"`// A valid CIDR notation representing an IP range.SecondaryAddressparam.Field[string] `json:"secondary_address"`// A valid CIDR notation representing an IP range.VirtualAddressparam.Field[string] `json:"virtual_address"`}

func (LANStaticAddressingParam)MarshalJSON ¶

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

typeMagicTransitService ¶

type MagicTransitService struct {Options         []option.RequestOptionApps            *AppServiceCfInterconnects *CfInterconnectServiceGRETunnels      *GRETunnelServiceIPSECTunnels    *IPSECTunnelServiceRoutes          *RouteServiceSites           *SiteServiceConnectors      *ConnectorServicePCAPs           *PCAPService}

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

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

funcNewMagicTransitService ¶

func NewMagicTransitService(opts ...option.RequestOption) (r *MagicTransitService)

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

typeMember ¶

type Member =shared.Member

This is an alias to an internal type.

typeMemberPoliciesAccess ¶

type MemberPoliciesAccess =shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

typeMemberPoliciesPermissionGroup ¶

type MemberPoliciesPermissionGroup =shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

typeMemberPoliciesPermissionGroupsMeta ¶

type MemberPoliciesPermissionGroupsMeta =shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroup ¶

type MemberPoliciesResourceGroup =shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsMeta ¶

type MemberPoliciesResourceGroupsMeta =shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScope ¶

type MemberPoliciesResourceGroupsScope =shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

typeMemberPoliciesResourceGroupsScopeObject ¶

type MemberPoliciesResourceGroupsScopeObject =shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

typeMemberPolicy ¶

type MemberPolicy =shared.MemberPolicy

This is an alias to an internal type.

typeMemberStatus ¶

type MemberStatus =shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

typeMemberUser ¶

type MemberUser =shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

typeNat ¶

type Nat struct {// A valid CIDR notation representing an IP range.StaticPrefixstring  `json:"static_prefix"`JSON         natJSON `json:"-"`}

func (*Nat)UnmarshalJSON ¶

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

typeNatParam ¶

type NatParam struct {// A valid CIDR notation representing an IP range.StaticPrefixparam.Field[string] `json:"static_prefix"`}

func (NatParam)MarshalJSON ¶

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

typeOwnership ¶

type Ownership struct {// The bucket ID associated with the packet captures API.IDstring `json:"id,required"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf,required"`// The ownership challenge filename stored in the bucket.Filenamestring `json:"filename,required"`// The status of the ownership challenge. Can be pending, success or failed.StatusOwnershipStatus `json:"status,required"`// TheRFC 3339 timestamp when the bucket was added to packet captures API.Submittedstring `json:"submitted,required"`// TheRFC 3339 timestamp when the bucket was validated.Validatedstring        `json:"validated"`JSON      ownershipJSON `json:"-"`}

func (*Ownership)UnmarshalJSON ¶

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

typeOwnershipStatus ¶

type OwnershipStatusstring

The status of the ownership challenge. Can be pending, success or failed.

const (OwnershipStatusPendingOwnershipStatus = "pending"OwnershipStatusSuccessOwnershipStatus = "success"OwnershipStatusFailedOwnershipStatus = "failed")

func (OwnershipStatus)IsKnown ¶

func (rOwnershipStatus) IsKnown()bool

typePCAP ¶

type PCAP struct {// The ID for the packet capture.IDstring `json:"id"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimetime.Time `json:"offset_time" format:"date-time"`// The status of the packet capture request.StatusPCAPStatus `json:"status"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPType `json:"type"`JSON pcapJSON `json:"-"`}

func (*PCAP)UnmarshalJSON ¶

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

typePCAPDownloadGetParams ¶

type PCAPDownloadGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPDownloadService ¶

type PCAPDownloadService struct {Options []option.RequestOption}

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

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

funcNewPCAPDownloadService ¶

func NewPCAPDownloadService(opts ...option.RequestOption) (r *PCAPDownloadService)

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

func (*PCAPDownloadService)Get ¶

func (r *PCAPDownloadService) Get(ctxcontext.Context, pcapIDstring, queryPCAPDownloadGetParams, opts ...option.RequestOption) (res *http.Response, errerror)

Download PCAP information into a file. Response is a binary PCAP file.

typePCAPFilter ¶

type PCAPFilter struct {// The destination IP address of the packet.DestinationAddressstring `json:"destination_address"`// The destination port of the packet.DestinationPortfloat64 `json:"destination_port"`// The protocol number of the packet.Protocolfloat64 `json:"protocol"`// The source IP address of the packet.SourceAddressstring `json:"source_address"`// The source port of the packet.SourcePortfloat64        `json:"source_port"`JSON       pcapFilterJSON `json:"-"`}

The packet capture filter. When this field is empty, all packets are captured.

func (*PCAPFilter)UnmarshalJSON ¶

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

typePCAPFilterParam ¶

type PCAPFilterParam struct {// The destination IP address of the packet.DestinationAddressparam.Field[string] `json:"destination_address"`// The destination port of the packet.DestinationPortparam.Field[float64] `json:"destination_port"`// The protocol number of the packet.Protocolparam.Field[float64] `json:"protocol"`// The source IP address of the packet.SourceAddressparam.Field[string] `json:"source_address"`// The source port of the packet.SourcePortparam.Field[float64] `json:"source_port"`}

The packet capture filter. When this field is empty, all packets are captured.

func (PCAPFilterParam)MarshalJSON ¶

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

typePCAPGetParams ¶

type PCAPGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPGetResponse ¶

type PCAPGetResponse struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimetime.Time `json:"offset_time" format:"date-time"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPGetResponseStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPGetResponseSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPGetResponseType `json:"type"`JSON pcapGetResponseJSON `json:"-"`// contains filtered or unexported fields}

func (PCAPGetResponse)AsUnion ¶

func (rPCAPGetResponse) AsUnion()PCAPGetResponseUnion

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

Possible runtime types of the union arePCAP,PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull.

func (*PCAPGetResponse)UnmarshalJSON ¶

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

typePCAPGetResponseEnvelope ¶

type PCAPGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultPCAPGetResponse       `json:"result,required"`// Whether the API call was successfulSuccessPCAPGetResponseEnvelopeSuccess `json:"success,required"`JSON    pcapGetResponseEnvelopeJSON    `json:"-"`}

func (*PCAPGetResponseEnvelope)UnmarshalJSON ¶

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

typePCAPGetResponseEnvelopeSuccess ¶

type PCAPGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (PCAPGetResponseEnvelopeSuccessTruePCAPGetResponseEnvelopeSuccess =true)

func (PCAPGetResponseEnvelopeSuccess)IsKnown ¶

func (rPCAPGetResponseEnvelopeSuccess) IsKnown()bool

typePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull ¶

type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`JSON pcapGetResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`}

func (*PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull)UnmarshalJSON ¶

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

typePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶

type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusstring

The status of the packet capture request.

const (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknownPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccessPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPendingPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunningPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPendingPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunningPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusCompletePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailedPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed")

func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus)IsKnown ¶

func (rPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown()bool

typePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶

type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystemstring

The system used to collect packet captures.

const (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransitPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit")

func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem)IsKnown ¶

func (rPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown()bool

typePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶

type PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimplePCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple"PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFullPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full")

func (PCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType)IsKnown ¶

func (rPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown()bool

typePCAPGetResponseStatus ¶

type PCAPGetResponseStatusstring

The status of the packet capture request.

const (PCAPGetResponseStatusUnknownPCAPGetResponseStatus = "unknown"PCAPGetResponseStatusSuccessPCAPGetResponseStatus = "success"PCAPGetResponseStatusPendingPCAPGetResponseStatus = "pending"PCAPGetResponseStatusRunningPCAPGetResponseStatus = "running"PCAPGetResponseStatusConversionPendingPCAPGetResponseStatus = "conversion_pending"PCAPGetResponseStatusConversionRunningPCAPGetResponseStatus = "conversion_running"PCAPGetResponseStatusCompletePCAPGetResponseStatus = "complete"PCAPGetResponseStatusFailedPCAPGetResponseStatus = "failed")

func (PCAPGetResponseStatus)IsKnown ¶

func (rPCAPGetResponseStatus) IsKnown()bool

typePCAPGetResponseSystem ¶

type PCAPGetResponseSystemstring

The system used to collect packet captures.

const (PCAPGetResponseSystemMagicTransitPCAPGetResponseSystem = "magic-transit")

func (PCAPGetResponseSystem)IsKnown ¶

func (rPCAPGetResponseSystem) IsKnown()bool

typePCAPGetResponseType ¶

type PCAPGetResponseTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPGetResponseTypeSimplePCAPGetResponseType = "simple"PCAPGetResponseTypeFullPCAPGetResponseType = "full")

func (PCAPGetResponseType)IsKnown ¶

func (rPCAPGetResponseType) IsKnown()bool

typePCAPGetResponseUnion ¶

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

Union satisfied byPCAP orPCAPGetResponseMagicVisibilityPCAPsPCAPsResponseFull.

typePCAPListParams ¶

type PCAPListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPListResponse ¶

type PCAPListResponse struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimetime.Time `json:"offset_time" format:"date-time"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPListResponseStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPListResponseSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPListResponseType `json:"type"`JSON pcapListResponseJSON `json:"-"`// contains filtered or unexported fields}

func (PCAPListResponse)AsUnion ¶

func (rPCAPListResponse) AsUnion()PCAPListResponseUnion

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

Possible runtime types of the union arePCAP,PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull.

func (*PCAPListResponse)UnmarshalJSON ¶

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

typePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull ¶

type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`JSON pcapListResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`}

func (*PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull)UnmarshalJSON ¶

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

typePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶

type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusstring

The status of the packet capture request.

const (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknownPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccessPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPendingPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunningPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPendingPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunningPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusCompletePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailedPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed")

func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus)IsKnown ¶

func (rPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown()bool

typePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶

type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystemstring

The system used to collect packet captures.

const (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransitPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit")

func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem)IsKnown ¶

func (rPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown()bool

typePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶

type PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimplePCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple"PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFullPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full")

func (PCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType)IsKnown ¶

func (rPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown()bool

typePCAPListResponseStatus ¶

type PCAPListResponseStatusstring

The status of the packet capture request.

const (PCAPListResponseStatusUnknownPCAPListResponseStatus = "unknown"PCAPListResponseStatusSuccessPCAPListResponseStatus = "success"PCAPListResponseStatusPendingPCAPListResponseStatus = "pending"PCAPListResponseStatusRunningPCAPListResponseStatus = "running"PCAPListResponseStatusConversionPendingPCAPListResponseStatus = "conversion_pending"PCAPListResponseStatusConversionRunningPCAPListResponseStatus = "conversion_running"PCAPListResponseStatusCompletePCAPListResponseStatus = "complete"PCAPListResponseStatusFailedPCAPListResponseStatus = "failed")

func (PCAPListResponseStatus)IsKnown ¶

func (rPCAPListResponseStatus) IsKnown()bool

typePCAPListResponseSystem ¶

type PCAPListResponseSystemstring

The system used to collect packet captures.

const (PCAPListResponseSystemMagicTransitPCAPListResponseSystem = "magic-transit")

func (PCAPListResponseSystem)IsKnown ¶

func (rPCAPListResponseSystem) IsKnown()bool

typePCAPListResponseType ¶

type PCAPListResponseTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPListResponseTypeSimplePCAPListResponseType = "simple"PCAPListResponseTypeFullPCAPListResponseType = "full")

func (PCAPListResponseType)IsKnown ¶

func (rPCAPListResponseType) IsKnown()bool

typePCAPListResponseUnion ¶

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

Union satisfied byPCAP orPCAPListResponseMagicVisibilityPCAPsPCAPsResponseFull.

typePCAPNewParams ¶

type PCAPNewParams struct {// IdentifierAccountIDparam.Field[string]    `path:"account_id,required"`BodyPCAPNewParamsBodyUnion `json:"body,required"`}

func (PCAPNewParams)MarshalJSON ¶

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

typePCAPNewParamsBody ¶

type PCAPNewParamsBody struct {// The system used to collect packet captures.Systemparam.Field[PCAPNewParamsBodySystem] `json:"system,required"`// The packet capture duration in seconds.TimeLimitparam.Field[float64] `json:"time_limit,required"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.Typeparam.Field[PCAPNewParamsBodyType] `json:"type,required"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitparam.Field[float64] `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNameparam.Field[string] `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfparam.Field[string] `json:"destination_conf"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1param.Field[PCAPFilterParam] `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimeparam.Field[time.Time] `json:"offset_time" format:"date-time"`// The limit of packets contained in a packet capture.PacketLimitparam.Field[float64] `json:"packet_limit"`}

func (PCAPNewParamsBody)MarshalJSON ¶

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

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull struct {// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNameparam.Field[string] `json:"colo_name,required"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfparam.Field[string] `json:"destination_conf,required"`// The system used to collect packet captures.Systemparam.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem] `json:"system,required"`// The packet capture duration in seconds.TimeLimitparam.Field[float64] `json:"time_limit,required"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.Typeparam.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType] `json:"type,required"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitparam.Field[float64] `json:"byte_limit"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1param.Field[PCAPFilterParam] `json:"filter_v1"`// The limit of packets contained in a packet capture.PacketLimitparam.Field[float64] `json:"packet_limit"`}

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull)MarshalJSON ¶

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

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystemstring

The system used to collect packet captures.

const (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystemMagicTransitPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem = "magic-transit")

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem)IsKnown ¶

func (rPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullSystem) IsKnown()bool

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullTypeSimplePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType = "simple"PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullTypeFullPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType = "full")

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType)IsKnown ¶

func (rPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFullType) IsKnown()bool

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple struct {// The limit of packets contained in a packet capture.PacketLimitparam.Field[float64] `json:"packet_limit,required"`// The system used to collect packet captures.Systemparam.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem] `json:"system,required"`// The packet capture duration in seconds.TimeLimitparam.Field[float64] `json:"time_limit,required"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.Typeparam.Field[PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType] `json:"type,required"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1param.Field[PCAPFilterParam] `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimeparam.Field[time.Time] `json:"offset_time" format:"date-time"`}

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple)MarshalJSON ¶

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

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystemstring

The system used to collect packet captures.

const (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystemMagicTransitPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem = "magic-transit")

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem)IsKnown ¶

func (rPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleSystem) IsKnown()bool

typePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType ¶

type PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypeSimplePCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType = "simple"PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleTypeFullPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType = "full")

func (PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType)IsKnown ¶

func (rPCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimpleType) IsKnown()bool

typePCAPNewParamsBodySystem ¶

type PCAPNewParamsBodySystemstring

The system used to collect packet captures.

const (PCAPNewParamsBodySystemMagicTransitPCAPNewParamsBodySystem = "magic-transit")

func (PCAPNewParamsBodySystem)IsKnown ¶

func (rPCAPNewParamsBodySystem) IsKnown()bool

typePCAPNewParamsBodyType ¶

type PCAPNewParamsBodyTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPNewParamsBodyTypeSimplePCAPNewParamsBodyType = "simple"PCAPNewParamsBodyTypeFullPCAPNewParamsBodyType = "full")

func (PCAPNewParamsBodyType)IsKnown ¶

func (rPCAPNewParamsBodyType) IsKnown()bool

typePCAPNewParamsBodyUnion ¶

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

Satisfied bymagic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestSimple,magic_transit.PCAPNewParamsBodyMagicVisibilityPCAPsPCAPsRequestFull,PCAPNewParamsBody.

typePCAPNewResponse ¶

type PCAPNewResponse struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// TheRFC 3339 offset timestamp from which to query backwards for packets. Must be// within the last 24h. When this field is empty, defaults to time of request.OffsetTimetime.Time `json:"offset_time" format:"date-time"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPNewResponseStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPNewResponseSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPNewResponseType `json:"type"`JSON pcapNewResponseJSON `json:"-"`// contains filtered or unexported fields}

func (PCAPNewResponse)AsUnion ¶

func (rPCAPNewResponse) AsUnion()PCAPNewResponseUnion

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

Possible runtime types of the union arePCAP,PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull.

func (*PCAPNewResponse)UnmarshalJSON ¶

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

typePCAPNewResponseEnvelope ¶

type PCAPNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultPCAPNewResponse       `json:"result,required"`// Whether the API call was successfulSuccessPCAPNewResponseEnvelopeSuccess `json:"success,required"`JSON    pcapNewResponseEnvelopeJSON    `json:"-"`}

func (*PCAPNewResponseEnvelope)UnmarshalJSON ¶

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

typePCAPNewResponseEnvelopeSuccess ¶

type PCAPNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (PCAPNewResponseEnvelopeSuccessTruePCAPNewResponseEnvelopeSuccess =true)

func (PCAPNewResponseEnvelopeSuccess)IsKnown ¶

func (rPCAPNewResponseEnvelopeSuccess) IsKnown()bool

typePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull ¶

type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull struct {// The ID for the packet capture.IDstring `json:"id"`// The maximum number of bytes to capture. This field only applies to `full` packet// captures.ByteLimitfloat64 `json:"byte_limit"`// The name of the data center used for the packet capture. This can be a specific// colo (ord02) or a multi-colo name (ORD). This field only applies to `full`// packet captures.ColoNamestring `json:"colo_name"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfstring `json:"destination_conf"`// An error message that describes why the packet capture failed. This field only// applies to `full` packet captures.ErrorMessagestring `json:"error_message"`// The packet capture filter. When this field is empty, all packets are captured.FilterV1PCAPFilter `json:"filter_v1"`// The number of packets captured.PacketsCapturedint64 `json:"packets_captured"`// The status of the packet capture request.StatusPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus `json:"status"`// TheRFC 3339 timestamp when stopping the packet capture was requested. This// field only applies to `full` packet captures.StopRequestedtime.Time `json:"stop_requested" format:"date-time"`// TheRFC 3339 timestamp when the packet capture was created.Submittedstring `json:"submitted"`// The system used to collect packet captures.SystemPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem `json:"system"`// The packet capture duration in seconds.TimeLimitfloat64 `json:"time_limit"`// The type of packet capture. `Simple` captures sampled packets, and `full`// captures entire payloads and non-sampled packets.TypePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType `json:"type"`JSON pcapNewResponseMagicVisibilityPCAPsPCAPsResponseFullJSON `json:"-"`}

func (*PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull)UnmarshalJSON ¶

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

typePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus ¶

type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusstring

The status of the packet capture request.

const (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusUnknownPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "unknown"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusSuccessPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "success"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusPendingPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "pending"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusRunningPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "running"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionPendingPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_pending"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusConversionRunningPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "conversion_running"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusCompletePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "complete"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatusFailedPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus = "failed")

func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus)IsKnown ¶

func (rPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullStatus) IsKnown()bool

typePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem ¶

type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystemstring

The system used to collect packet captures.

const (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystemMagicTransitPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem = "magic-transit")

func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem)IsKnown ¶

func (rPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullSystem) IsKnown()bool

typePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType ¶

type PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeSimplePCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "simple"PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullTypeFullPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType = "full")

func (PCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType)IsKnown ¶

func (rPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFullType) IsKnown()bool

typePCAPNewResponseStatus ¶

type PCAPNewResponseStatusstring

The status of the packet capture request.

const (PCAPNewResponseStatusUnknownPCAPNewResponseStatus = "unknown"PCAPNewResponseStatusSuccessPCAPNewResponseStatus = "success"PCAPNewResponseStatusPendingPCAPNewResponseStatus = "pending"PCAPNewResponseStatusRunningPCAPNewResponseStatus = "running"PCAPNewResponseStatusConversionPendingPCAPNewResponseStatus = "conversion_pending"PCAPNewResponseStatusConversionRunningPCAPNewResponseStatus = "conversion_running"PCAPNewResponseStatusCompletePCAPNewResponseStatus = "complete"PCAPNewResponseStatusFailedPCAPNewResponseStatus = "failed")

func (PCAPNewResponseStatus)IsKnown ¶

func (rPCAPNewResponseStatus) IsKnown()bool

typePCAPNewResponseSystem ¶

type PCAPNewResponseSystemstring

The system used to collect packet captures.

const (PCAPNewResponseSystemMagicTransitPCAPNewResponseSystem = "magic-transit")

func (PCAPNewResponseSystem)IsKnown ¶

func (rPCAPNewResponseSystem) IsKnown()bool

typePCAPNewResponseType ¶

type PCAPNewResponseTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPNewResponseTypeSimplePCAPNewResponseType = "simple"PCAPNewResponseTypeFullPCAPNewResponseType = "full")

func (PCAPNewResponseType)IsKnown ¶

func (rPCAPNewResponseType) IsKnown()bool

typePCAPNewResponseUnion ¶

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

Union satisfied byPCAP orPCAPNewResponseMagicVisibilityPCAPsPCAPsResponseFull.

typePCAPOwnershipDeleteParams ¶

type PCAPOwnershipDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPOwnershipGetParams ¶

type PCAPOwnershipGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPOwnershipNewParams ¶

type PCAPOwnershipNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfparam.Field[string] `json:"destination_conf,required"`}

func (PCAPOwnershipNewParams)MarshalJSON ¶

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

typePCAPOwnershipNewResponseEnvelope ¶

type PCAPOwnershipNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultOwnership             `json:"result,required"`// Whether the API call was successfulSuccessPCAPOwnershipNewResponseEnvelopeSuccess `json:"success,required"`JSON    pcapOwnershipNewResponseEnvelopeJSON    `json:"-"`}

func (*PCAPOwnershipNewResponseEnvelope)UnmarshalJSON ¶

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

typePCAPOwnershipNewResponseEnvelopeSuccess ¶

type PCAPOwnershipNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (PCAPOwnershipNewResponseEnvelopeSuccessTruePCAPOwnershipNewResponseEnvelopeSuccess =true)

func (PCAPOwnershipNewResponseEnvelopeSuccess)IsKnown ¶

func (rPCAPOwnershipNewResponseEnvelopeSuccess) IsKnown()bool

typePCAPOwnershipService ¶

type PCAPOwnershipService struct {Options []option.RequestOption}

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

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

funcNewPCAPOwnershipService ¶

func NewPCAPOwnershipService(opts ...option.RequestOption) (r *PCAPOwnershipService)

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

func (*PCAPOwnershipService)Delete ¶

func (r *PCAPOwnershipService) Delete(ctxcontext.Context, ownershipIDstring, bodyPCAPOwnershipDeleteParams, opts ...option.RequestOption) (errerror)

Deletes buckets added to the packet captures API.

func (*PCAPOwnershipService)Get ¶

func (r *PCAPOwnershipService) Get(ctxcontext.Context, queryPCAPOwnershipGetParams, opts ...option.RequestOption) (res *pagination.SinglePage[Ownership], errerror)

List all buckets configured for use with PCAPs API.

func (*PCAPOwnershipService)GetAutoPaging ¶added inv4.1.0

func (r *PCAPOwnershipService) GetAutoPaging(ctxcontext.Context, queryPCAPOwnershipGetParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Ownership]

List all buckets configured for use with PCAPs API.

func (*PCAPOwnershipService)New ¶

func (r *PCAPOwnershipService) New(ctxcontext.Context, paramsPCAPOwnershipNewParams, opts ...option.RequestOption) (res *Ownership, errerror)

Adds an AWS or GCP bucket to use with full packet captures.

func (*PCAPOwnershipService)Validate ¶

func (r *PCAPOwnershipService) Validate(ctxcontext.Context, paramsPCAPOwnershipValidateParams, opts ...option.RequestOption) (res *Ownership, errerror)

Validates buckets added to the packet captures API.

typePCAPOwnershipValidateParams ¶

type PCAPOwnershipValidateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The full URI for the bucket. This field only applies to `full` packet captures.DestinationConfparam.Field[string] `json:"destination_conf,required"`// The ownership challenge filename stored in the bucket.OwnershipChallengeparam.Field[string] `json:"ownership_challenge,required"`}

func (PCAPOwnershipValidateParams)MarshalJSON ¶

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

typePCAPOwnershipValidateResponseEnvelope ¶

type PCAPOwnershipValidateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultOwnership             `json:"result,required"`// Whether the API call was successfulSuccessPCAPOwnershipValidateResponseEnvelopeSuccess `json:"success,required"`JSON    pcapOwnershipValidateResponseEnvelopeJSON    `json:"-"`}

func (*PCAPOwnershipValidateResponseEnvelope)UnmarshalJSON ¶

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

typePCAPOwnershipValidateResponseEnvelopeSuccess ¶

type PCAPOwnershipValidateResponseEnvelopeSuccessbool

Whether the API call was successful

const (PCAPOwnershipValidateResponseEnvelopeSuccessTruePCAPOwnershipValidateResponseEnvelopeSuccess =true)

func (PCAPOwnershipValidateResponseEnvelopeSuccess)IsKnown ¶

func (rPCAPOwnershipValidateResponseEnvelopeSuccess) IsKnown()bool

typePCAPService ¶

type PCAPService struct {Options   []option.RequestOptionOwnership *PCAPOwnershipServiceDownload  *PCAPDownloadService}

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

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

funcNewPCAPService ¶

func NewPCAPService(opts ...option.RequestOption) (r *PCAPService)

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

func (*PCAPService)Get ¶

func (r *PCAPService) Get(ctxcontext.Context, pcapIDstring, queryPCAPGetParams, opts ...option.RequestOption) (res *PCAPGetResponse, errerror)

Get information for a PCAP request by id.

func (*PCAPService)List ¶

func (r *PCAPService) List(ctxcontext.Context, queryPCAPListParams, opts ...option.RequestOption) (res *pagination.SinglePage[PCAPListResponse], errerror)

Lists all packet capture requests for an account.

func (*PCAPService)ListAutoPaging ¶

func (r *PCAPService) ListAutoPaging(ctxcontext.Context, queryPCAPListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[PCAPListResponse]

Lists all packet capture requests for an account.

func (*PCAPService)New ¶

func (r *PCAPService) New(ctxcontext.Context, paramsPCAPNewParams, opts ...option.RequestOption) (res *PCAPNewResponse, errerror)

Create new PCAP request for account.

func (*PCAPService)Stop ¶added inv4.4.0

func (r *PCAPService) Stop(ctxcontext.Context, pcapIDstring, bodyPCAPStopParams, opts ...option.RequestOption) (errerror)

Stop full PCAP

typePCAPStatus ¶

type PCAPStatusstring

The status of the packet capture request.

const (PCAPStatusUnknownPCAPStatus = "unknown"PCAPStatusSuccessPCAPStatus = "success"PCAPStatusPendingPCAPStatus = "pending"PCAPStatusRunningPCAPStatus = "running"PCAPStatusConversionPendingPCAPStatus = "conversion_pending"PCAPStatusConversionRunningPCAPStatus = "conversion_running"PCAPStatusCompletePCAPStatus = "complete"PCAPStatusFailedPCAPStatus = "failed")

func (PCAPStatus)IsKnown ¶

func (rPCAPStatus) IsKnown()bool

typePCAPStopParams ¶added inv4.4.0

type PCAPStopParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typePCAPSystem ¶

type PCAPSystemstring

The system used to collect packet captures.

const (PCAPSystemMagicTransitPCAPSystem = "magic-transit")

func (PCAPSystem)IsKnown ¶

func (rPCAPSystem) IsKnown()bool

typePCAPType ¶

type PCAPTypestring

The type of packet capture. `Simple` captures sampled packets, and `full`captures entire payloads and non-sampled packets.

const (PCAPTypeSimplePCAPType = "simple"PCAPTypeFullPCAPType = "full")

func (PCAPType)IsKnown ¶

func (rPCAPType) IsKnown()bool

typePSKMetadata ¶

type PSKMetadata struct {// The date and time the tunnel was last modified.LastGeneratedOntime.Time       `json:"last_generated_on" format:"date-time"`JSON            pskMetadataJSON `json:"-"`}

The PSK metadata that includes when the PSK was generated.

func (*PSKMetadata)UnmarshalJSON ¶

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

typePermission ¶

type Permission =shared.Permission

This is an alias to an internal type.

typePermissionGrant ¶

type PermissionGrant =shared.PermissionGrant

This is an alias to an internal type.

typePermissionGrantParam ¶

type PermissionGrantParam =shared.PermissionGrantParam

This is an alias to an internal type.

typeRatePlan ¶

type RatePlan =shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

typeRatePlanID ¶added inv4.1.0

type RatePlanID =shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

typeRatePlanParam ¶

type RatePlanParam =shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

typeResponseInfo ¶

type ResponseInfo =shared.ResponseInfo

This is an alias to an internal type.

typeResponseInfoSource ¶added inv4.3.0

type ResponseInfoSource =shared.ResponseInfoSource

This is an alias to an internal type.

typeRole ¶

type Role =shared.Role

This is an alias to an internal type.

typeRoleParam ¶

type RoleParam =shared.RoleParam

This is an alias to an internal type.

typeRolePermissions ¶

type RolePermissions =shared.RolePermissions

This is an alias to an internal type.

typeRolePermissionsParam ¶

type RolePermissionsParam =shared.RolePermissionsParam

This is an alias to an internal type.

typeRouteBulkUpdateParams ¶

type RouteBulkUpdateParams struct {// IdentifierAccountIDparam.Field[string]                       `path:"account_id,required"`Routesparam.Field[[]RouteBulkUpdateParamsRoute] `json:"routes,required"`}

func (RouteBulkUpdateParams)MarshalJSON ¶

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

typeRouteBulkUpdateParamsRoute ¶

type RouteBulkUpdateParamsRoute struct {// IdentifierIDparam.Field[string] `json:"id,required"`// The next-hop IP Address for the static route.Nexthopparam.Field[string] `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixparam.Field[string] `json:"prefix,required"`// Priority of the static route.Priorityparam.Field[int64] `json:"priority,required"`// An optional human provided description of the static route.Descriptionparam.Field[string] `json:"description"`// Used only for ECMP routes.Scopeparam.Field[ScopeParam] `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightparam.Field[int64] `json:"weight"`}

func (RouteBulkUpdateParamsRoute)MarshalJSON ¶

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

typeRouteBulkUpdateResponse ¶

type RouteBulkUpdateResponse struct {Modifiedbool                                   `json:"modified"`ModifiedRoutes []RouteBulkUpdateResponseModifiedRoute `json:"modified_routes"`JSON           routeBulkUpdateResponseJSON            `json:"-"`}

func (*RouteBulkUpdateResponse)UnmarshalJSON ¶

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

typeRouteBulkUpdateResponseEnvelope ¶

type RouteBulkUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo   `json:"errors,required"`Messages []shared.ResponseInfo   `json:"messages,required"`ResultRouteBulkUpdateResponse `json:"result,required"`// Whether the API call was successfulSuccessRouteBulkUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    routeBulkUpdateResponseEnvelopeJSON    `json:"-"`}

func (*RouteBulkUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeRouteBulkUpdateResponseEnvelopeSuccess ¶

type RouteBulkUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteBulkUpdateResponseEnvelopeSuccessTrueRouteBulkUpdateResponseEnvelopeSuccess =true)

func (RouteBulkUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rRouteBulkUpdateResponseEnvelopeSuccess) IsKnown()bool

typeRouteBulkUpdateResponseModifiedRoute ¶

type RouteBulkUpdateResponseModifiedRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                                    `json:"weight"`JSON   routeBulkUpdateResponseModifiedRouteJSON `json:"-"`}

func (*RouteBulkUpdateResponseModifiedRoute)UnmarshalJSON ¶

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

typeRouteDeleteParams ¶

type RouteDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeRouteDeleteResponse ¶

type RouteDeleteResponse struct {Deletedbool                            `json:"deleted"`DeletedRouteRouteDeleteResponseDeletedRoute `json:"deleted_route"`JSON         routeDeleteResponseJSON         `json:"-"`}

func (*RouteDeleteResponse)UnmarshalJSON ¶

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

typeRouteDeleteResponseDeletedRoute ¶

type RouteDeleteResponseDeletedRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                               `json:"weight"`JSON   routeDeleteResponseDeletedRouteJSON `json:"-"`}

func (*RouteDeleteResponseDeletedRoute)UnmarshalJSON ¶

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

typeRouteDeleteResponseEnvelope ¶

type RouteDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteDeleteResponse   `json:"result,required"`// Whether the API call was successfulSuccessRouteDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    routeDeleteResponseEnvelopeJSON    `json:"-"`}

func (*RouteDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeRouteDeleteResponseEnvelopeSuccess ¶

type RouteDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteDeleteResponseEnvelopeSuccessTrueRouteDeleteResponseEnvelopeSuccess =true)

func (RouteDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rRouteDeleteResponseEnvelopeSuccess) IsKnown()bool

typeRouteEmptyParams ¶

type RouteEmptyParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeRouteEmptyResponse ¶

type RouteEmptyResponse struct {Deletedbool                             `json:"deleted"`DeletedRoutes []RouteEmptyResponseDeletedRoute `json:"deleted_routes"`JSON          routeEmptyResponseJSON           `json:"-"`}

func (*RouteEmptyResponse)UnmarshalJSON ¶

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

typeRouteEmptyResponseDeletedRoute ¶

type RouteEmptyResponseDeletedRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                              `json:"weight"`JSON   routeEmptyResponseDeletedRouteJSON `json:"-"`}

func (*RouteEmptyResponseDeletedRoute)UnmarshalJSON ¶

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

typeRouteEmptyResponseEnvelope ¶

type RouteEmptyResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteEmptyResponse    `json:"result,required"`// Whether the API call was successfulSuccessRouteEmptyResponseEnvelopeSuccess `json:"success,required"`JSON    routeEmptyResponseEnvelopeJSON    `json:"-"`}

func (*RouteEmptyResponseEnvelope)UnmarshalJSON ¶

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

typeRouteEmptyResponseEnvelopeSuccess ¶

type RouteEmptyResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteEmptyResponseEnvelopeSuccessTrueRouteEmptyResponseEnvelopeSuccess =true)

func (RouteEmptyResponseEnvelopeSuccess)IsKnown ¶

func (rRouteEmptyResponseEnvelopeSuccess) IsKnown()bool

typeRouteGetParams ¶

type RouteGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeRouteGetResponse ¶

type RouteGetResponse struct {RouteRouteGetResponseRoute `json:"route"`JSON  routeGetResponseJSON  `json:"-"`}

func (*RouteGetResponse)UnmarshalJSON ¶

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

typeRouteGetResponseEnvelope ¶

type RouteGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteGetResponse      `json:"result,required"`// Whether the API call was successfulSuccessRouteGetResponseEnvelopeSuccess `json:"success,required"`JSON    routeGetResponseEnvelopeJSON    `json:"-"`}

func (*RouteGetResponseEnvelope)UnmarshalJSON ¶

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

typeRouteGetResponseEnvelopeSuccess ¶

type RouteGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteGetResponseEnvelopeSuccessTrueRouteGetResponseEnvelopeSuccess =true)

func (RouteGetResponseEnvelopeSuccess)IsKnown ¶

func (rRouteGetResponseEnvelopeSuccess) IsKnown()bool

typeRouteGetResponseRoute ¶

type RouteGetResponseRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                     `json:"weight"`JSON   routeGetResponseRouteJSON `json:"-"`}

func (*RouteGetResponseRoute)UnmarshalJSON ¶

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

typeRouteListParams ¶

type RouteListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeRouteListResponse ¶

type RouteListResponse struct {Routes []RouteListResponseRoute `json:"routes"`JSON   routeListResponseJSON    `json:"-"`}

func (*RouteListResponse)UnmarshalJSON ¶

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

typeRouteListResponseEnvelope ¶

type RouteListResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteListResponse     `json:"result,required"`// Whether the API call was successfulSuccessRouteListResponseEnvelopeSuccess `json:"success,required"`JSON    routeListResponseEnvelopeJSON    `json:"-"`}

func (*RouteListResponseEnvelope)UnmarshalJSON ¶

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

typeRouteListResponseEnvelopeSuccess ¶

type RouteListResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteListResponseEnvelopeSuccessTrueRouteListResponseEnvelopeSuccess =true)

func (RouteListResponseEnvelopeSuccess)IsKnown ¶

func (rRouteListResponseEnvelopeSuccess) IsKnown()bool

typeRouteListResponseRoute ¶

type RouteListResponseRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                      `json:"weight"`JSON   routeListResponseRouteJSON `json:"-"`}

func (*RouteListResponseRoute)UnmarshalJSON ¶

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

typeRouteNewParams ¶

type RouteNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The next-hop IP Address for the static route.Nexthopparam.Field[string] `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixparam.Field[string] `json:"prefix,required"`// Priority of the static route.Priorityparam.Field[int64] `json:"priority,required"`// An optional human provided description of the static route.Descriptionparam.Field[string] `json:"description"`// Used only for ECMP routes.Scopeparam.Field[ScopeParam] `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightparam.Field[int64] `json:"weight"`}

func (RouteNewParams)MarshalJSON ¶

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

typeRouteNewResponse ¶

type RouteNewResponse struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                `json:"weight"`JSON   routeNewResponseJSON `json:"-"`}

func (*RouteNewResponse)UnmarshalJSON ¶

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

typeRouteNewResponseEnvelope ¶

type RouteNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteNewResponse      `json:"result,required"`// Whether the API call was successfulSuccessRouteNewResponseEnvelopeSuccess `json:"success,required"`JSON    routeNewResponseEnvelopeJSON    `json:"-"`}

func (*RouteNewResponseEnvelope)UnmarshalJSON ¶

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

typeRouteNewResponseEnvelopeSuccess ¶

type RouteNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteNewResponseEnvelopeSuccessTrueRouteNewResponseEnvelopeSuccess =true)

func (RouteNewResponseEnvelopeSuccess)IsKnown ¶

func (rRouteNewResponseEnvelopeSuccess) IsKnown()bool

typeRouteService ¶

type RouteService struct {Options []option.RequestOption}

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

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

funcNewRouteService ¶

func NewRouteService(opts ...option.RequestOption) (r *RouteService)

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

func (*RouteService)BulkUpdate ¶

func (r *RouteService) BulkUpdate(ctxcontext.Context, paramsRouteBulkUpdateParams, opts ...option.RequestOption) (res *RouteBulkUpdateResponse, errerror)

Update multiple Magic static routes. Use `?validate_only=true` as an optionalquery parameter to run validation only without persisting changes. Only fieldsfor a route that need to be changed need be provided.

func (*RouteService)Delete ¶

func (r *RouteService) Delete(ctxcontext.Context, routeIDstring, bodyRouteDeleteParams, opts ...option.RequestOption) (res *RouteDeleteResponse, errerror)

Disable and remove a specific Magic static route.

func (*RouteService)Empty ¶

func (r *RouteService) Empty(ctxcontext.Context, bodyRouteEmptyParams, opts ...option.RequestOption) (res *RouteEmptyResponse, errerror)

Delete multiple Magic static routes.

func (*RouteService)Get ¶

func (r *RouteService) Get(ctxcontext.Context, routeIDstring, queryRouteGetParams, opts ...option.RequestOption) (res *RouteGetResponse, errerror)

Get a specific Magic static route.

func (*RouteService)List ¶

func (r *RouteService) List(ctxcontext.Context, queryRouteListParams, opts ...option.RequestOption) (res *RouteListResponse, errerror)

List all Magic static routes.

func (*RouteService)New ¶

func (r *RouteService) New(ctxcontext.Context, paramsRouteNewParams, opts ...option.RequestOption) (res *RouteNewResponse, errerror)

Creates a new Magic static route. Use `?validate_only=true` as an optional queryparameter to run validation only without persisting changes.

func (*RouteService)Update ¶

func (r *RouteService) Update(ctxcontext.Context, routeIDstring, paramsRouteUpdateParams, opts ...option.RequestOption) (res *RouteUpdateResponse, errerror)

Update a specific Magic static route. Use `?validate_only=true` as an optionalquery parameter to run validation only without persisting changes.

typeRouteUpdateParams ¶

type RouteUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The next-hop IP Address for the static route.Nexthopparam.Field[string] `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixparam.Field[string] `json:"prefix,required"`// Priority of the static route.Priorityparam.Field[int64] `json:"priority,required"`// An optional human provided description of the static route.Descriptionparam.Field[string] `json:"description"`// Used only for ECMP routes.Scopeparam.Field[ScopeParam] `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightparam.Field[int64] `json:"weight"`}

func (RouteUpdateParams)MarshalJSON ¶

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

typeRouteUpdateResponse ¶

type RouteUpdateResponse struct {Modifiedbool                             `json:"modified"`ModifiedRouteRouteUpdateResponseModifiedRoute `json:"modified_route"`JSON          routeUpdateResponseJSON          `json:"-"`}

func (*RouteUpdateResponse)UnmarshalJSON ¶

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

typeRouteUpdateResponseEnvelope ¶

type RouteUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultRouteUpdateResponse   `json:"result,required"`// Whether the API call was successfulSuccessRouteUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    routeUpdateResponseEnvelopeJSON    `json:"-"`}

func (*RouteUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeRouteUpdateResponseEnvelopeSuccess ¶

type RouteUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (RouteUpdateResponseEnvelopeSuccessTrueRouteUpdateResponseEnvelopeSuccess =true)

func (RouteUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rRouteUpdateResponseEnvelopeSuccess) IsKnown()bool

typeRouteUpdateResponseModifiedRoute ¶

type RouteUpdateResponseModifiedRoute struct {// IdentifierIDstring `json:"id,required"`// The next-hop IP Address for the static route.Nexthopstring `json:"nexthop,required"`// IP Prefix in Classless Inter-Domain Routing format.Prefixstring `json:"prefix,required"`// Priority of the static route.Priorityint64 `json:"priority,required"`// When the route was created.CreatedOntime.Time `json:"created_on" format:"date-time"`// An optional human provided description of the static route.Descriptionstring `json:"description"`// When the route was last modified.ModifiedOntime.Time `json:"modified_on" format:"date-time"`// Used only for ECMP routes.ScopeScope `json:"scope"`// Optional weight of the ECMP scope - if provided.Weightint64                                `json:"weight"`JSON   routeUpdateResponseModifiedRouteJSON `json:"-"`}

func (*RouteUpdateResponseModifiedRoute)UnmarshalJSON ¶

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

typeRoutedSubnet ¶

type RoutedSubnet struct {// A valid IPv4 address.NextHopstring `json:"next_hop,required"`// A valid CIDR notation representing an IP range.Prefixstring           `json:"prefix,required"`NatNat              `json:"nat"`JSON   routedSubnetJSON `json:"-"`}

func (*RoutedSubnet)UnmarshalJSON ¶

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

typeRoutedSubnetParam ¶

type RoutedSubnetParam struct {// A valid IPv4 address.NextHopparam.Field[string] `json:"next_hop,required"`// A valid CIDR notation representing an IP range.Prefixparam.Field[string]   `json:"prefix,required"`Natparam.Field[NatParam] `json:"nat"`}

func (RoutedSubnetParam)MarshalJSON ¶

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

typeScope ¶

type Scope struct {// List of colo names for the ECMP scope.ColoNames []string `json:"colo_names"`// List of colo regions for the ECMP scope.ColoRegions []string  `json:"colo_regions"`JSON        scopeJSON `json:"-"`}

Used only for ECMP routes.

func (*Scope)UnmarshalJSON ¶

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

typeScopeParam ¶

type ScopeParam struct {// List of colo names for the ECMP scope.ColoNamesparam.Field[[]string] `json:"colo_names"`// List of colo regions for the ECMP scope.ColoRegionsparam.Field[[]string] `json:"colo_regions"`}

Used only for ECMP routes.

func (ScopeParam)MarshalJSON ¶

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

typeSite ¶

type Site struct {// IdentifierIDstring `json:"id"`// Magic Connector identifier tag.ConnectorIDstring `json:"connector_id"`Descriptionstring `json:"description"`// Site high availability mode. If set to true, the site can have two connectors// and runs in high availability mode.HaModebool `json:"ha_mode"`// Location of site in latitude and longitude.LocationSiteLocation `json:"location"`// The name of the site.Namestring `json:"name"`// Magic Connector identifier tag. Used when high availability mode is on.SecondaryConnectorIDstring   `json:"secondary_connector_id"`JSON                 siteJSON `json:"-"`}

func (*Site)UnmarshalJSON ¶

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

typeSiteACLDeleteParams ¶

type SiteACLDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteACLDeleteResponseEnvelope ¶

type SiteACLDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Bidirectional ACL policy for network traffic within a site.ResultACL `json:"result,required"`// Whether the API call was successfulSuccessSiteACLDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    siteACLDeleteResponseEnvelopeJSON    `json:"-"`}

func (*SiteACLDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeSiteACLDeleteResponseEnvelopeSuccess ¶

type SiteACLDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteACLDeleteResponseEnvelopeSuccessTrueSiteACLDeleteResponseEnvelopeSuccess =true)

func (SiteACLDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rSiteACLDeleteResponseEnvelopeSuccess) IsKnown()bool

typeSiteACLEditParams ¶

type SiteACLEditParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// Description for the ACL.Descriptionparam.Field[string] `json:"description"`// The desired forwarding action for this ACL policy. If set to "false", the policy// will forward traffic to Cloudflare. If set to "true", the policy will forward// traffic locally on the Magic Connector. If not included in request, will default// to false.ForwardLocallyparam.Field[bool]                  `json:"forward_locally"`LAN1param.Field[ACLConfigurationParam] `json:"lan_1"`LAN2param.Field[ACLConfigurationParam] `json:"lan_2"`// The name of the ACL.Nameparam.Field[string]            `json:"name"`Protocolsparam.Field[[]AllowedProtocol] `json:"protocols"`// The desired traffic direction for this ACL policy. If set to "false", the policy// will allow bidirectional traffic. If set to "true", the policy will only allow// traffic in one direction. If not included in request, will default to false.Unidirectionalparam.Field[bool] `json:"unidirectional"`}

func (SiteACLEditParams)MarshalJSON ¶

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

typeSiteACLEditResponseEnvelope ¶

type SiteACLEditResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Bidirectional ACL policy for network traffic within a site.ResultACL `json:"result,required"`// Whether the API call was successfulSuccessSiteACLEditResponseEnvelopeSuccess `json:"success,required"`JSON    siteACLEditResponseEnvelopeJSON    `json:"-"`}

func (*SiteACLEditResponseEnvelope)UnmarshalJSON ¶

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

typeSiteACLEditResponseEnvelopeSuccess ¶

type SiteACLEditResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteACLEditResponseEnvelopeSuccessTrueSiteACLEditResponseEnvelopeSuccess =true)

func (SiteACLEditResponseEnvelopeSuccess)IsKnown ¶

func (rSiteACLEditResponseEnvelopeSuccess) IsKnown()bool

typeSiteACLGetParams ¶

type SiteACLGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteACLGetResponseEnvelope ¶

type SiteACLGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Bidirectional ACL policy for network traffic within a site.ResultACL `json:"result,required"`// Whether the API call was successfulSuccessSiteACLGetResponseEnvelopeSuccess `json:"success,required"`JSON    siteACLGetResponseEnvelopeJSON    `json:"-"`}

func (*SiteACLGetResponseEnvelope)UnmarshalJSON ¶

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

typeSiteACLGetResponseEnvelopeSuccess ¶

type SiteACLGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteACLGetResponseEnvelopeSuccessTrueSiteACLGetResponseEnvelopeSuccess =true)

func (SiteACLGetResponseEnvelopeSuccess)IsKnown ¶

func (rSiteACLGetResponseEnvelopeSuccess) IsKnown()bool

typeSiteACLListParams ¶

type SiteACLListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteACLNewParams ¶

type SiteACLNewParams struct {// IdentifierAccountIDparam.Field[string]                `path:"account_id,required"`LAN1param.Field[ACLConfigurationParam] `json:"lan_1,required"`LAN2param.Field[ACLConfigurationParam] `json:"lan_2,required"`// The name of the ACL.Nameparam.Field[string] `json:"name,required"`// Description for the ACL.Descriptionparam.Field[string] `json:"description"`// The desired forwarding action for this ACL policy. If set to "false", the policy// will forward traffic to Cloudflare. If set to "true", the policy will forward// traffic locally on the Magic Connector. If not included in request, will default// to false.ForwardLocallyparam.Field[bool]              `json:"forward_locally"`Protocolsparam.Field[[]AllowedProtocol] `json:"protocols"`// The desired traffic direction for this ACL policy. If set to "false", the policy// will allow bidirectional traffic. If set to "true", the policy will only allow// traffic in one direction. If not included in request, will default to false.Unidirectionalparam.Field[bool] `json:"unidirectional"`}

func (SiteACLNewParams)MarshalJSON ¶

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

typeSiteACLNewResponseEnvelope ¶

type SiteACLNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Bidirectional ACL policy for network traffic within a site.ResultACL `json:"result,required"`// Whether the API call was successfulSuccessSiteACLNewResponseEnvelopeSuccess `json:"success,required"`JSON    siteACLNewResponseEnvelopeJSON    `json:"-"`}

func (*SiteACLNewResponseEnvelope)UnmarshalJSON ¶

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

typeSiteACLNewResponseEnvelopeSuccess ¶

type SiteACLNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteACLNewResponseEnvelopeSuccessTrueSiteACLNewResponseEnvelopeSuccess =true)

func (SiteACLNewResponseEnvelopeSuccess)IsKnown ¶

func (rSiteACLNewResponseEnvelopeSuccess) IsKnown()bool

typeSiteACLService ¶

type SiteACLService struct {Options []option.RequestOption}

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

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

funcNewSiteACLService ¶

func NewSiteACLService(opts ...option.RequestOption) (r *SiteACLService)

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

func (*SiteACLService)Delete ¶

func (r *SiteACLService) Delete(ctxcontext.Context, siteIDstring, aclIDstring, bodySiteACLDeleteParams, opts ...option.RequestOption) (res *ACL, errerror)

Remove a specific Site ACL.

func (*SiteACLService)Edit ¶

func (r *SiteACLService) Edit(ctxcontext.Context, siteIDstring, aclIDstring, paramsSiteACLEditParams, opts ...option.RequestOption) (res *ACL, errerror)

Patch a specific Site ACL.

func (*SiteACLService)Get ¶

func (r *SiteACLService) Get(ctxcontext.Context, siteIDstring, aclIDstring, querySiteACLGetParams, opts ...option.RequestOption) (res *ACL, errerror)

Get a specific Site ACL.

func (*SiteACLService)List ¶

func (r *SiteACLService) List(ctxcontext.Context, siteIDstring, querySiteACLListParams, opts ...option.RequestOption) (res *pagination.SinglePage[ACL], errerror)

Lists Site ACLs associated with an account.

func (*SiteACLService)ListAutoPaging ¶

func (r *SiteACLService) ListAutoPaging(ctxcontext.Context, siteIDstring, querySiteACLListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[ACL]

Lists Site ACLs associated with an account.

func (*SiteACLService)New ¶

func (r *SiteACLService) New(ctxcontext.Context, siteIDstring, paramsSiteACLNewParams, opts ...option.RequestOption) (res *ACL, errerror)

Creates a new Site ACL.

func (*SiteACLService)Update ¶

func (r *SiteACLService) Update(ctxcontext.Context, siteIDstring, aclIDstring, paramsSiteACLUpdateParams, opts ...option.RequestOption) (res *ACL, errerror)

Update a specific Site ACL.

typeSiteACLUpdateParams ¶

type SiteACLUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// Description for the ACL.Descriptionparam.Field[string] `json:"description"`// The desired forwarding action for this ACL policy. If set to "false", the policy// will forward traffic to Cloudflare. If set to "true", the policy will forward// traffic locally on the Magic Connector. If not included in request, will default// to false.ForwardLocallyparam.Field[bool]                  `json:"forward_locally"`LAN1param.Field[ACLConfigurationParam] `json:"lan_1"`LAN2param.Field[ACLConfigurationParam] `json:"lan_2"`// The name of the ACL.Nameparam.Field[string]            `json:"name"`Protocolsparam.Field[[]AllowedProtocol] `json:"protocols"`// The desired traffic direction for this ACL policy. If set to "false", the policy// will allow bidirectional traffic. If set to "true", the policy will only allow// traffic in one direction. If not included in request, will default to false.Unidirectionalparam.Field[bool] `json:"unidirectional"`}

func (SiteACLUpdateParams)MarshalJSON ¶

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

typeSiteACLUpdateResponseEnvelope ¶

type SiteACLUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`// Bidirectional ACL policy for network traffic within a site.ResultACL `json:"result,required"`// Whether the API call was successfulSuccessSiteACLUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    siteACLUpdateResponseEnvelopeJSON    `json:"-"`}

func (*SiteACLUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeSiteACLUpdateResponseEnvelopeSuccess ¶

type SiteACLUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteACLUpdateResponseEnvelopeSuccessTrueSiteACLUpdateResponseEnvelopeSuccess =true)

func (SiteACLUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rSiteACLUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSiteDeleteParams ¶

type SiteDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteDeleteResponseEnvelope ¶

type SiteDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultSite                  `json:"result,required"`// Whether the API call was successfulSuccessSiteDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    siteDeleteResponseEnvelopeJSON    `json:"-"`}

func (*SiteDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeSiteDeleteResponseEnvelopeSuccess ¶

type SiteDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteDeleteResponseEnvelopeSuccessTrueSiteDeleteResponseEnvelopeSuccess =true)

func (SiteDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rSiteDeleteResponseEnvelopeSuccess) IsKnown()bool

typeSiteEditParams ¶

type SiteEditParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// Magic Connector identifier tag.ConnectorIDparam.Field[string] `json:"connector_id"`Descriptionparam.Field[string] `json:"description"`// Location of site in latitude and longitude.Locationparam.Field[SiteLocationParam] `json:"location"`// The name of the site.Nameparam.Field[string] `json:"name"`// Magic Connector identifier tag. Used when high availability mode is on.SecondaryConnectorIDparam.Field[string] `json:"secondary_connector_id"`}

func (SiteEditParams)MarshalJSON ¶

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

typeSiteEditResponseEnvelope ¶

type SiteEditResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultSite                  `json:"result,required"`// Whether the API call was successfulSuccessSiteEditResponseEnvelopeSuccess `json:"success,required"`JSON    siteEditResponseEnvelopeJSON    `json:"-"`}

func (*SiteEditResponseEnvelope)UnmarshalJSON ¶

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

typeSiteEditResponseEnvelopeSuccess ¶

type SiteEditResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteEditResponseEnvelopeSuccessTrueSiteEditResponseEnvelopeSuccess =true)

func (SiteEditResponseEnvelopeSuccess)IsKnown ¶

func (rSiteEditResponseEnvelopeSuccess) IsKnown()bool

typeSiteGetParams ¶

type SiteGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`XMagicNewHcTargetparam.Field[bool]   `header:"x-magic-new-hc-target"`}

typeSiteGetResponseEnvelope ¶

type SiteGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultSite                  `json:"result,required"`// Whether the API call was successfulSuccessSiteGetResponseEnvelopeSuccess `json:"success,required"`JSON    siteGetResponseEnvelopeJSON    `json:"-"`}

func (*SiteGetResponseEnvelope)UnmarshalJSON ¶

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

typeSiteGetResponseEnvelopeSuccess ¶

type SiteGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteGetResponseEnvelopeSuccessTrueSiteGetResponseEnvelopeSuccess =true)

func (SiteGetResponseEnvelopeSuccess)IsKnown ¶

func (rSiteGetResponseEnvelopeSuccess) IsKnown()bool

typeSiteLANDeleteParams ¶

type SiteLANDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteLANDeleteResponseEnvelope ¶

type SiteLANDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultLAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteLANDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    siteLANDeleteResponseEnvelopeJSON    `json:"-"`}

func (*SiteLANDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeSiteLANDeleteResponseEnvelopeSuccess ¶

type SiteLANDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteLANDeleteResponseEnvelopeSuccessTrueSiteLANDeleteResponseEnvelopeSuccess =true)

func (SiteLANDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rSiteLANDeleteResponseEnvelopeSuccess) IsKnown()bool

typeSiteLANEditParams ¶

type SiteLANEditParams struct {// IdentifierAccountIDparam.Field[string]              `path:"account_id,required"`Nameparam.Field[string]              `json:"name"`Natparam.Field[NatParam]            `json:"nat"`Physportparam.Field[int64]               `json:"physport"`RoutedSubnetsparam.Field[[]RoutedSubnetParam] `json:"routed_subnets"`// If the site is not configured in high availability mode, this configuration is// optional (if omitted, use DHCP). However, if in high availability mode,// static_address is required along with secondary and virtual address.StaticAddressingparam.Field[LANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteLANEditParams)MarshalJSON ¶

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

typeSiteLANEditResponseEnvelope ¶

type SiteLANEditResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultLAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteLANEditResponseEnvelopeSuccess `json:"success,required"`JSON    siteLANEditResponseEnvelopeJSON    `json:"-"`}

func (*SiteLANEditResponseEnvelope)UnmarshalJSON ¶

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

typeSiteLANEditResponseEnvelopeSuccess ¶

type SiteLANEditResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteLANEditResponseEnvelopeSuccessTrueSiteLANEditResponseEnvelopeSuccess =true)

func (SiteLANEditResponseEnvelopeSuccess)IsKnown ¶

func (rSiteLANEditResponseEnvelopeSuccess) IsKnown()bool

typeSiteLANGetParams ¶

type SiteLANGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteLANGetResponseEnvelope ¶

type SiteLANGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultLAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteLANGetResponseEnvelopeSuccess `json:"success,required"`JSON    siteLANGetResponseEnvelopeJSON    `json:"-"`}

func (*SiteLANGetResponseEnvelope)UnmarshalJSON ¶

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

typeSiteLANGetResponseEnvelopeSuccess ¶

type SiteLANGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteLANGetResponseEnvelopeSuccessTrueSiteLANGetResponseEnvelopeSuccess =true)

func (SiteLANGetResponseEnvelopeSuccess)IsKnown ¶

func (rSiteLANGetResponseEnvelopeSuccess) IsKnown()bool

typeSiteLANListParams ¶

type SiteLANListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteLANNewParams ¶

type SiteLANNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Physportparam.Field[int64]  `json:"physport,required"`// mark true to use this LAN for HA probing. only works for site with HA turned on.// only one LAN can be set as the ha_link.HaLinkparam.Field[bool]                `json:"ha_link"`Nameparam.Field[string]              `json:"name"`Natparam.Field[NatParam]            `json:"nat"`RoutedSubnetsparam.Field[[]RoutedSubnetParam] `json:"routed_subnets"`// If the site is not configured in high availability mode, this configuration is// optional (if omitted, use DHCP). However, if in high availability mode,// static_address is required along with secondary and virtual address.StaticAddressingparam.Field[LANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteLANNewParams)MarshalJSON ¶

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

typeSiteLANService ¶

type SiteLANService struct {Options []option.RequestOption}

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

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

funcNewSiteLANService ¶

func NewSiteLANService(opts ...option.RequestOption) (r *SiteLANService)

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

func (*SiteLANService)Delete ¶

func (r *SiteLANService) Delete(ctxcontext.Context, siteIDstring, lanIDstring, bodySiteLANDeleteParams, opts ...option.RequestOption) (res *LAN, errerror)

Remove a specific Site LAN.

func (*SiteLANService)Edit ¶

func (r *SiteLANService) Edit(ctxcontext.Context, siteIDstring, lanIDstring, paramsSiteLANEditParams, opts ...option.RequestOption) (res *LAN, errerror)

Patch a specific Site LAN.

func (*SiteLANService)Get ¶

func (r *SiteLANService) Get(ctxcontext.Context, siteIDstring, lanIDstring, querySiteLANGetParams, opts ...option.RequestOption) (res *LAN, errerror)

Get a specific Site LAN.

func (*SiteLANService)List ¶

func (r *SiteLANService) List(ctxcontext.Context, siteIDstring, querySiteLANListParams, opts ...option.RequestOption) (res *pagination.SinglePage[LAN], errerror)

Lists Site LANs associated with an account.

func (*SiteLANService)ListAutoPaging ¶

func (r *SiteLANService) ListAutoPaging(ctxcontext.Context, siteIDstring, querySiteLANListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[LAN]

Lists Site LANs associated with an account.

func (*SiteLANService)New ¶

func (r *SiteLANService) New(ctxcontext.Context, siteIDstring, paramsSiteLANNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[LAN], errerror)

Creates a new Site LAN. If the site is in high availability mode,static_addressing is required along with secondary and virtual address.

func (*SiteLANService)NewAutoPaging ¶added inv4.1.0

func (r *SiteLANService) NewAutoPaging(ctxcontext.Context, siteIDstring, paramsSiteLANNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[LAN]

Creates a new Site LAN. If the site is in high availability mode,static_addressing is required along with secondary and virtual address.

func (*SiteLANService)Update ¶

func (r *SiteLANService) Update(ctxcontext.Context, siteIDstring, lanIDstring, paramsSiteLANUpdateParams, opts ...option.RequestOption) (res *LAN, errerror)

Update a specific Site LAN.

typeSiteLANUpdateParams ¶

type SiteLANUpdateParams struct {// IdentifierAccountIDparam.Field[string]              `path:"account_id,required"`Nameparam.Field[string]              `json:"name"`Natparam.Field[NatParam]            `json:"nat"`Physportparam.Field[int64]               `json:"physport"`RoutedSubnetsparam.Field[[]RoutedSubnetParam] `json:"routed_subnets"`// If the site is not configured in high availability mode, this configuration is// optional (if omitted, use DHCP). However, if in high availability mode,// static_address is required along with secondary and virtual address.StaticAddressingparam.Field[LANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteLANUpdateParams)MarshalJSON ¶

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

typeSiteLANUpdateResponseEnvelope ¶

type SiteLANUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultLAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteLANUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    siteLANUpdateResponseEnvelopeJSON    `json:"-"`}

func (*SiteLANUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeSiteLANUpdateResponseEnvelopeSuccess ¶

type SiteLANUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteLANUpdateResponseEnvelopeSuccessTrueSiteLANUpdateResponseEnvelopeSuccess =true)

func (SiteLANUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rSiteLANUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSiteListParams ¶

type SiteListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// IdentifierConnectoridparam.Field[string] `query:"connectorid"`}

func (SiteListParams)URLQuery ¶

func (rSiteListParams) URLQuery() (vurl.Values)

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

typeSiteLocation ¶

type SiteLocation struct {// LatitudeLatstring `json:"lat"`// LongitudeLonstring           `json:"lon"`JSON siteLocationJSON `json:"-"`}

Location of site in latitude and longitude.

func (*SiteLocation)UnmarshalJSON ¶

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

typeSiteLocationParam ¶

type SiteLocationParam struct {// LatitudeLatparam.Field[string] `json:"lat"`// LongitudeLonparam.Field[string] `json:"lon"`}

Location of site in latitude and longitude.

func (SiteLocationParam)MarshalJSON ¶

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

typeSiteNewParams ¶

type SiteNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// The name of the site.Nameparam.Field[string] `json:"name,required"`// Magic Connector identifier tag.ConnectorIDparam.Field[string] `json:"connector_id"`Descriptionparam.Field[string] `json:"description"`// Site high availability mode. If set to true, the site can have two connectors// and runs in high availability mode.HaModeparam.Field[bool] `json:"ha_mode"`// Location of site in latitude and longitude.Locationparam.Field[SiteLocationParam] `json:"location"`// Magic Connector identifier tag. Used when high availability mode is on.SecondaryConnectorIDparam.Field[string] `json:"secondary_connector_id"`}

func (SiteNewParams)MarshalJSON ¶

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

typeSiteNewResponseEnvelope ¶

type SiteNewResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultSite                  `json:"result,required"`// Whether the API call was successfulSuccessSiteNewResponseEnvelopeSuccess `json:"success,required"`JSON    siteNewResponseEnvelopeJSON    `json:"-"`}

func (*SiteNewResponseEnvelope)UnmarshalJSON ¶

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

typeSiteNewResponseEnvelopeSuccess ¶

type SiteNewResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteNewResponseEnvelopeSuccessTrueSiteNewResponseEnvelopeSuccess =true)

func (SiteNewResponseEnvelopeSuccess)IsKnown ¶

func (rSiteNewResponseEnvelopeSuccess) IsKnown()bool

typeSiteService ¶

type SiteService struct {Options []option.RequestOptionACLs    *SiteACLServiceLANs    *SiteLANServiceWANs    *SiteWANService}

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

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

funcNewSiteService ¶

func NewSiteService(opts ...option.RequestOption) (r *SiteService)

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

func (*SiteService)Delete ¶

func (r *SiteService) Delete(ctxcontext.Context, siteIDstring, bodySiteDeleteParams, opts ...option.RequestOption) (res *Site, errerror)

Remove a specific Site.

func (*SiteService)Edit ¶

func (r *SiteService) Edit(ctxcontext.Context, siteIDstring, paramsSiteEditParams, opts ...option.RequestOption) (res *Site, errerror)

Patch a specific Site.

func (*SiteService)Get ¶

func (r *SiteService) Get(ctxcontext.Context, siteIDstring, paramsSiteGetParams, opts ...option.RequestOption) (res *Site, errerror)

Get a specific Site.

func (*SiteService)List ¶

func (r *SiteService) List(ctxcontext.Context, paramsSiteListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Site], errerror)

Lists Sites associated with an account. Use connectorid query param to returnsites where connectorid matches either site.ConnectorID orsite.SecondaryConnectorID.

func (*SiteService)ListAutoPaging ¶

func (r *SiteService) ListAutoPaging(ctxcontext.Context, paramsSiteListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Site]

Lists Sites associated with an account. Use connectorid query param to returnsites where connectorid matches either site.ConnectorID orsite.SecondaryConnectorID.

func (*SiteService)New ¶

func (r *SiteService) New(ctxcontext.Context, paramsSiteNewParams, opts ...option.RequestOption) (res *Site, errerror)

Creates a new Site

func (*SiteService)Update ¶

func (r *SiteService) Update(ctxcontext.Context, siteIDstring, paramsSiteUpdateParams, opts ...option.RequestOption) (res *Site, errerror)

Update a specific Site.

typeSiteUpdateParams ¶

type SiteUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`// Magic Connector identifier tag.ConnectorIDparam.Field[string] `json:"connector_id"`Descriptionparam.Field[string] `json:"description"`// Location of site in latitude and longitude.Locationparam.Field[SiteLocationParam] `json:"location"`// The name of the site.Nameparam.Field[string] `json:"name"`// Magic Connector identifier tag. Used when high availability mode is on.SecondaryConnectorIDparam.Field[string] `json:"secondary_connector_id"`}

func (SiteUpdateParams)MarshalJSON ¶

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

typeSiteUpdateResponseEnvelope ¶

type SiteUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultSite                  `json:"result,required"`// Whether the API call was successfulSuccessSiteUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    siteUpdateResponseEnvelopeJSON    `json:"-"`}

func (*SiteUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeSiteUpdateResponseEnvelopeSuccess ¶

type SiteUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteUpdateResponseEnvelopeSuccessTrueSiteUpdateResponseEnvelopeSuccess =true)

func (SiteUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rSiteUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSiteWANDeleteParams ¶

type SiteWANDeleteParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteWANDeleteResponseEnvelope ¶

type SiteWANDeleteResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultWAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteWANDeleteResponseEnvelopeSuccess `json:"success,required"`JSON    siteWANDeleteResponseEnvelopeJSON    `json:"-"`}

func (*SiteWANDeleteResponseEnvelope)UnmarshalJSON ¶

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

typeSiteWANDeleteResponseEnvelopeSuccess ¶

type SiteWANDeleteResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteWANDeleteResponseEnvelopeSuccessTrueSiteWANDeleteResponseEnvelopeSuccess =true)

func (SiteWANDeleteResponseEnvelopeSuccess)IsKnown ¶

func (rSiteWANDeleteResponseEnvelopeSuccess) IsKnown()bool

typeSiteWANEditParams ¶

type SiteWANEditParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Nameparam.Field[string] `json:"name"`Physportparam.Field[int64]  `json:"physport"`Priorityparam.Field[int64]  `json:"priority"`// (optional) if omitted, use DHCP. Submit secondary_address when site is in high// availability mode.StaticAddressingparam.Field[WANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteWANEditParams)MarshalJSON ¶

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

typeSiteWANEditResponseEnvelope ¶

type SiteWANEditResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultWAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteWANEditResponseEnvelopeSuccess `json:"success,required"`JSON    siteWANEditResponseEnvelopeJSON    `json:"-"`}

func (*SiteWANEditResponseEnvelope)UnmarshalJSON ¶

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

typeSiteWANEditResponseEnvelopeSuccess ¶

type SiteWANEditResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteWANEditResponseEnvelopeSuccessTrueSiteWANEditResponseEnvelopeSuccess =true)

func (SiteWANEditResponseEnvelopeSuccess)IsKnown ¶

func (rSiteWANEditResponseEnvelopeSuccess) IsKnown()bool

typeSiteWANGetParams ¶

type SiteWANGetParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteWANGetResponseEnvelope ¶

type SiteWANGetResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultWAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteWANGetResponseEnvelopeSuccess `json:"success,required"`JSON    siteWANGetResponseEnvelopeJSON    `json:"-"`}

func (*SiteWANGetResponseEnvelope)UnmarshalJSON ¶

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

typeSiteWANGetResponseEnvelopeSuccess ¶

type SiteWANGetResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteWANGetResponseEnvelopeSuccessTrueSiteWANGetResponseEnvelopeSuccess =true)

func (SiteWANGetResponseEnvelopeSuccess)IsKnown ¶

func (rSiteWANGetResponseEnvelopeSuccess) IsKnown()bool

typeSiteWANListParams ¶

type SiteWANListParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`}

typeSiteWANNewParams ¶

type SiteWANNewParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Physportparam.Field[int64]  `json:"physport,required"`Nameparam.Field[string] `json:"name"`Priorityparam.Field[int64]  `json:"priority"`// (optional) if omitted, use DHCP. Submit secondary_address when site is in high// availability mode.StaticAddressingparam.Field[WANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteWANNewParams)MarshalJSON ¶

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

typeSiteWANService ¶

type SiteWANService struct {Options []option.RequestOption}

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

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

funcNewSiteWANService ¶

func NewSiteWANService(opts ...option.RequestOption) (r *SiteWANService)

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

func (*SiteWANService)Delete ¶

func (r *SiteWANService) Delete(ctxcontext.Context, siteIDstring, wanIDstring, bodySiteWANDeleteParams, opts ...option.RequestOption) (res *WAN, errerror)

Remove a specific Site WAN.

func (*SiteWANService)Edit ¶

func (r *SiteWANService) Edit(ctxcontext.Context, siteIDstring, wanIDstring, paramsSiteWANEditParams, opts ...option.RequestOption) (res *WAN, errerror)

Patch a specific Site WAN.

func (*SiteWANService)Get ¶

func (r *SiteWANService) Get(ctxcontext.Context, siteIDstring, wanIDstring, querySiteWANGetParams, opts ...option.RequestOption) (res *WAN, errerror)

Get a specific Site WAN.

func (*SiteWANService)List ¶

func (r *SiteWANService) List(ctxcontext.Context, siteIDstring, querySiteWANListParams, opts ...option.RequestOption) (res *pagination.SinglePage[WAN], errerror)

Lists Site WANs associated with an account.

func (*SiteWANService)ListAutoPaging ¶

func (r *SiteWANService) ListAutoPaging(ctxcontext.Context, siteIDstring, querySiteWANListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[WAN]

Lists Site WANs associated with an account.

func (*SiteWANService)New ¶

func (r *SiteWANService) New(ctxcontext.Context, siteIDstring, paramsSiteWANNewParams, opts ...option.RequestOption) (res *pagination.SinglePage[WAN], errerror)

Creates a new Site WAN.

func (*SiteWANService)NewAutoPaging ¶added inv4.1.0

func (r *SiteWANService) NewAutoPaging(ctxcontext.Context, siteIDstring, paramsSiteWANNewParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[WAN]

Creates a new Site WAN.

func (*SiteWANService)Update ¶

func (r *SiteWANService) Update(ctxcontext.Context, siteIDstring, wanIDstring, paramsSiteWANUpdateParams, opts ...option.RequestOption) (res *WAN, errerror)

Update a specific Site WAN.

typeSiteWANUpdateParams ¶

type SiteWANUpdateParams struct {// IdentifierAccountIDparam.Field[string] `path:"account_id,required"`Nameparam.Field[string] `json:"name"`Physportparam.Field[int64]  `json:"physport"`Priorityparam.Field[int64]  `json:"priority"`// (optional) if omitted, use DHCP. Submit secondary_address when site is in high// availability mode.StaticAddressingparam.Field[WANStaticAddressingParam] `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagparam.Field[int64] `json:"vlan_tag"`}

func (SiteWANUpdateParams)MarshalJSON ¶

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

typeSiteWANUpdateResponseEnvelope ¶

type SiteWANUpdateResponseEnvelope struct {Errors   []shared.ResponseInfo `json:"errors,required"`Messages []shared.ResponseInfo `json:"messages,required"`ResultWAN                   `json:"result,required"`// Whether the API call was successfulSuccessSiteWANUpdateResponseEnvelopeSuccess `json:"success,required"`JSON    siteWANUpdateResponseEnvelopeJSON    `json:"-"`}

func (*SiteWANUpdateResponseEnvelope)UnmarshalJSON ¶

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

typeSiteWANUpdateResponseEnvelopeSuccess ¶

type SiteWANUpdateResponseEnvelopeSuccessbool

Whether the API call was successful

const (SiteWANUpdateResponseEnvelopeSuccessTrueSiteWANUpdateResponseEnvelopeSuccess =true)

func (SiteWANUpdateResponseEnvelopeSuccess)IsKnown ¶

func (rSiteWANUpdateResponseEnvelopeSuccess) IsKnown()bool

typeSortDirection ¶

type SortDirection =shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

typeSubnet ¶

type Subnet =string

typeSubnetParam ¶

type SubnetParam =string

typeSubscription ¶

type Subscription =shared.Subscription

This is an alias to an internal type.

typeSubscriptionFrequency ¶

type SubscriptionFrequency =shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

typeSubscriptionParam ¶

type SubscriptionParam =shared.SubscriptionParam

This is an alias to an internal type.

typeSubscriptionState ¶

type SubscriptionState =shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

typeToken ¶

type Token =shared.Token

This is an alias to an internal type.

typeTokenCondition ¶

type TokenCondition =shared.TokenCondition

This is an alias to an internal type.

typeTokenConditionCIDRList ¶

type TokenConditionCIDRList =shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionCIDRListParam ¶

type TokenConditionCIDRListParam =shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

typeTokenConditionParam ¶

type TokenConditionParam =shared.TokenConditionParam

This is an alias to an internal type.

typeTokenConditionRequestIP ¶

type TokenConditionRequestIP =shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

typeTokenConditionRequestIPParam ¶

type TokenConditionRequestIPParam =shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

typeTokenParam ¶

type TokenParam =shared.TokenParam

This is an alias to an internal type.

typeTokenPolicy ¶

type TokenPolicy =shared.TokenPolicy

This is an alias to an internal type.

typeTokenPolicyEffect ¶

type TokenPolicyEffect =shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

typeTokenPolicyParam ¶

type TokenPolicyParam =shared.TokenPolicyParam

This is an alias to an internal type.

typeTokenPolicyPermissionGroup ¶

type TokenPolicyPermissionGroup =shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

typeTokenPolicyPermissionGroupParam ¶

type TokenPolicyPermissionGroupParam =shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMeta ¶

type TokenPolicyPermissionGroupsMeta =shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyPermissionGroupsMetaParam ¶

type TokenPolicyPermissionGroupsMetaParam =shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

typeTokenPolicyResourcesMap ¶added inv4.6.0

type TokenPolicyResourcesMap =shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesMapParam ¶added inv4.6.0

type TokenPolicyResourcesMapParam =shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

typeTokenPolicyResourcesUnion ¶added inv4.6.0

type TokenPolicyResourcesUnion =shared.TokenPolicyResourcesUnion

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

This is an alias to an internal type.

typeTokenPolicyResourcesUnionParam ¶added inv4.6.0

type TokenPolicyResourcesUnionParam =shared.TokenPolicyResourcesUnionParam

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

This is an alias to an internal type.

typeTokenStatus ¶

type TokenStatus =shared.TokenStatus

Status of the token.

This is an alias to an internal type.

typeTokenValue ¶

type TokenValue =shared.TokenValue

The token value.

This is an alias to an internal type.

typeWAN ¶

type WAN struct {// IdentifierIDstring `json:"id"`// Magic WAN health check rate for tunnels created on this link. The default value// is `mid`.HealthCheckRateWANHealthCheckRate `json:"health_check_rate"`Namestring             `json:"name"`Physportint64              `json:"physport"`// Priority of WAN for traffic loadbalancing.Priorityint64 `json:"priority"`// IdentifierSiteIDstring `json:"site_id"`// (optional) if omitted, use DHCP. Submit secondary_address when site is in high// availability mode.StaticAddressingWANStaticAddressing `json:"static_addressing"`// VLAN ID. Use zero for untagged.VlanTagint64   `json:"vlan_tag"`JSON    wanJSON `json:"-"`}

func (*WAN)UnmarshalJSON ¶

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

typeWANHealthCheckRate ¶

type WANHealthCheckRatestring

Magic WAN health check rate for tunnels created on this link. The default valueis `mid`.

const (WANHealthCheckRateLowWANHealthCheckRate = "low"WANHealthCheckRateMidWANHealthCheckRate = "mid"WANHealthCheckRateHighWANHealthCheckRate = "high")

func (WANHealthCheckRate)IsKnown ¶

func (rWANHealthCheckRate) IsKnown()bool

typeWANStaticAddressing ¶

type WANStaticAddressing struct {// A valid CIDR notation representing an IP range.Addressstring `json:"address,required"`// A valid IPv4 address.GatewayAddressstring `json:"gateway_address,required"`// A valid CIDR notation representing an IP range.SecondaryAddressstring                  `json:"secondary_address"`JSON             wanStaticAddressingJSON `json:"-"`}

(optional) if omitted, use DHCP. Submit secondary_address when site is in highavailability mode.

func (*WANStaticAddressing)UnmarshalJSON ¶

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

typeWANStaticAddressingParam ¶

type WANStaticAddressingParam struct {// A valid CIDR notation representing an IP range.Addressparam.Field[string] `json:"address,required"`// A valid IPv4 address.GatewayAddressparam.Field[string] `json:"gateway_address,required"`// A valid CIDR notation representing an IP range.SecondaryAddressparam.Field[string] `json:"secondary_address"`}

(optional) if omitted, use DHCP. Submit secondary_address when site is in highavailability mode.

func (WANStaticAddressingParam)MarshalJSON ¶

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

Source Files¶

View all Source files

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

Movatterモバイル変換

Details

Repository

Links

Documentation¶

Index¶

Constants¶

Variables¶

Functions¶

Types¶

typeACL¶

func (*ACL)UnmarshalJSON¶

typeACLConfiguration¶

func (*ACLConfiguration)UnmarshalJSON¶

typeACLConfigurationParam¶

func (ACLConfigurationParam)MarshalJSON¶

typeASN¶

typeASNParam¶

typeAllowedProtocol¶

func (AllowedProtocol)IsKnown¶

typeAppDeleteParams¶

typeAppDeleteResponse¶

func (*AppDeleteResponse)UnmarshalJSON¶

typeAppDeleteResponseEnvelope¶

func (*AppDeleteResponseEnvelope)UnmarshalJSON¶

typeAppDeleteResponseEnvelopeSuccess¶

func (AppDeleteResponseEnvelopeSuccess)IsKnown¶

typeAppEditParams¶added inv4.3.0

func (AppEditParams)MarshalJSON¶added inv4.3.0

typeAppEditResponse¶added inv4.3.0

func (*AppEditResponse)UnmarshalJSON¶added inv4.3.0

typeAppEditResponseEnvelope¶added inv4.3.0

func (*AppEditResponseEnvelope)UnmarshalJSON¶added inv4.3.0

typeAppEditResponseEnvelopeSuccess¶added inv4.3.0

func (AppEditResponseEnvelopeSuccess)IsKnown¶added inv4.3.0

typeAppListParams¶

typeAppListResponse¶

func (AppListResponse)AsUnion¶

func (*AppListResponse)UnmarshalJSON¶

typeAppListResponseMagicAccountApp¶

func (*AppListResponseMagicAccountApp)UnmarshalJSON¶

typeAppListResponseMagicManagedApp¶

func (*AppListResponseMagicManagedApp)UnmarshalJSON¶

typeAppListResponseUnion¶

typeAppNewParams¶

func (AppNewParams)MarshalJSON¶

typeAppNewResponse¶

func (*AppNewResponse)UnmarshalJSON¶

typeAppNewResponseEnvelope¶

func (*AppNewResponseEnvelope)UnmarshalJSON¶

typeAppNewResponseEnvelopeSuccess¶

func (AppNewResponseEnvelopeSuccess)IsKnown¶

typeAppService¶

funcNewAppService¶

func (*AppService)Delete¶

func (*AppService)Edit¶added inv4.3.0

func (*AppService)List¶

func (*AppService)ListAutoPaging¶

func (*AppService)New¶

func (*AppService)Update¶

typeAppUpdateParams¶

func (AppUpdateParams)MarshalJSON¶

typeAppUpdateResponse¶

func (*AppUpdateResponse)UnmarshalJSON¶

typeAppUpdateResponseEnvelope¶

func (*AppUpdateResponseEnvelope)UnmarshalJSON¶

typeAppUpdateResponseEnvelopeSuccess¶

func (AppUpdateResponseEnvelopeSuccess)IsKnown¶

typeAuditLog¶

typeAuditLogAction¶

typeAuditLogActor¶

typeAuditLogActorType¶

typeAuditLogOwner¶

typeAuditLogResource¶

typeCertificateCA¶

typeCertificateRequestType¶

typeCfInterconnectBulkUpdateParams¶

func (CfInterconnectBulkUpdateParams)MarshalJSON¶

typeCfInterconnectBulkUpdateResponse¶

func (*CfInterconnectBulkUpdateResponse)UnmarshalJSON¶

Documentation ¶

typeACL ¶

func (*ACL)UnmarshalJSON ¶

typeACLConfiguration ¶

func (*ACLConfiguration)UnmarshalJSON ¶

typeACLConfigurationParam ¶

func (ACLConfigurationParam)MarshalJSON ¶

typeASN ¶

typeASNParam ¶

typeAllowedProtocol ¶

func (AllowedProtocol)IsKnown ¶

typeAppDeleteParams ¶

typeAppDeleteResponse ¶

func (*AppDeleteResponse)UnmarshalJSON ¶

typeAppDeleteResponseEnvelope ¶

func (*AppDeleteResponseEnvelope)UnmarshalJSON ¶

typeAppDeleteResponseEnvelopeSuccess ¶

func (AppDeleteResponseEnvelopeSuccess)IsKnown ¶

typeAppEditParams ¶added inv4.3.0

func (AppEditParams)MarshalJSON ¶added inv4.3.0

typeAppEditResponse ¶added inv4.3.0

func (*AppEditResponse)UnmarshalJSON ¶added inv4.3.0

typeAppEditResponseEnvelope ¶added inv4.3.0

func (*AppEditResponseEnvelope)UnmarshalJSON ¶added inv4.3.0

typeAppEditResponseEnvelopeSuccess ¶added inv4.3.0

func (AppEditResponseEnvelopeSuccess)IsKnown ¶added inv4.3.0

typeAppListParams ¶

typeAppListResponse ¶

func (AppListResponse)AsUnion ¶

func (*AppListResponse)UnmarshalJSON ¶

typeAppListResponseMagicAccountApp ¶

func (*AppListResponseMagicAccountApp)UnmarshalJSON ¶

typeAppListResponseMagicManagedApp ¶

func (*AppListResponseMagicManagedApp)UnmarshalJSON ¶

typeAppListResponseUnion ¶

typeAppNewParams ¶

func (AppNewParams)MarshalJSON ¶

typeAppNewResponse ¶

func (*AppNewResponse)UnmarshalJSON ¶

typeAppNewResponseEnvelope ¶

func (*AppNewResponseEnvelope)UnmarshalJSON ¶

typeAppNewResponseEnvelopeSuccess ¶

func (AppNewResponseEnvelopeSuccess)IsKnown ¶

typeAppService ¶

funcNewAppService ¶

func (*AppService)Delete ¶

func (*AppService)Edit ¶added inv4.3.0

func (*AppService)List ¶

func (*AppService)ListAutoPaging ¶

func (*AppService)New ¶

func (*AppService)Update ¶

typeAppUpdateParams ¶

func (AppUpdateParams)MarshalJSON ¶

typeAppUpdateResponse ¶

func (*AppUpdateResponse)UnmarshalJSON ¶

typeAppUpdateResponseEnvelope ¶

func (*AppUpdateResponseEnvelope)UnmarshalJSON ¶

typeAppUpdateResponseEnvelopeSuccess ¶

func (AppUpdateResponseEnvelopeSuccess)IsKnown ¶

typeAuditLog ¶

typeAuditLogAction ¶

typeAuditLogActor ¶

typeAuditLogActorType ¶

typeAuditLogOwner ¶

typeAuditLogResource ¶

typeCertificateCA ¶

typeCertificateRequestType ¶

typeCfInterconnectBulkUpdateParams ¶

func (CfInterconnectBulkUpdateParams)MarshalJSON ¶

typeCfInterconnectBulkUpdateResponse ¶

func (*CfInterconnectBulkUpdateResponse)UnmarshalJSON ¶

typeCfInterconnectBulkUpdateResponseEnvelope ¶

func (*CfInterconnectBulkUpdateResponseEnvelope)UnmarshalJSON ¶

typeCfInterconnectBulkUpdateResponseEnvelopeSuccess ¶

func (CfInterconnectBulkUpdateResponseEnvelopeSuccess)IsKnown ¶

typeCfInterconnectBulkUpdateResponseModifiedInterconnect ¶

func (*CfInterconnectBulkUpdateResponseModifiedInterconnect)UnmarshalJSON ¶

typeCfInterconnectBulkUpdateResponseModifiedInterconnectsGRE ¶

func (*CfInterconnectBulkUpdateResponseModifiedInterconnectsGRE)UnmarshalJSON ¶

typeCfInterconnectGetParams ¶