connectivity

package
v6.7.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcCloudflare = shared.CloudflareTunnelConfigSrcCloudflare

This is an alias to an internal value.

View Source
const CloudflareTunnelConfigSrcLocal = shared.CloudflareTunnelConfigSrcLocal

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

type AuditLogAction

type AuditLogAction = shared.AuditLogAction

This is an alias to an internal type.

type AuditLogActor

type AuditLogActor = shared.AuditLogActor

This is an alias to an internal type.

type AuditLogActorType

type AuditLogActorType = shared.AuditLogActorType

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

This is an alias to an internal type.

type AuditLogOwner

type AuditLogOwner = shared.AuditLogOwner

This is an alias to an internal type.

type AuditLogResource

type AuditLogResource = shared.AuditLogResource

This is an alias to an internal type.

type CertificateCA

type CertificateCA = shared.CertificateCA

The Certificate Authority that will issue the certificate

This is an alias to an internal type.

type CertificateRequestType

type CertificateRequestType = shared.CertificateRequestType

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

This is an alias to an internal type.

type CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConfigSrc

type CloudflareTunnelConfigSrc = shared.CloudflareTunnelConfigSrc

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

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelStatus

type CloudflareTunnelStatus = shared.CloudflareTunnelStatus

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

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type ConnectivityService

type ConnectivityService struct {
	Options   []option.RequestOption
	Directory *DirectoryService
}

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

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

func NewConnectivityService

func NewConnectivityService(opts ...option.RequestOption) (r *ConnectivityService)

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

type DirectoryService

type DirectoryService struct {
	Options  []option.RequestOption
	Services *DirectoryServiceService
}

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

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

func NewDirectoryService

func NewDirectoryService(opts ...option.RequestOption) (r *DirectoryService)

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

type DirectoryServiceDeleteParams

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

type DirectoryServiceGetParams

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

type DirectoryServiceGetResponse

type DirectoryServiceGetResponse struct {
	Host      DirectoryServiceGetResponseHost `json:"host,required"`
	Name      string                          `json:"name,required"`
	Type      DirectoryServiceGetResponseType `json:"type,required"`
	CreatedAt time.Time                       `json:"created_at" format:"date-time"`
	HTTPPort  int64                           `json:"http_port,nullable"`
	HTTPSPort int64                           `json:"https_port,nullable"`
	ServiceID string                          `json:"service_id" format:"uuid"`
	UpdatedAt time.Time                       `json:"updated_at" format:"date-time"`
	JSON      directoryServiceGetResponseJSON `json:"-"`
}

func (*DirectoryServiceGetResponse) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelope

type DirectoryServiceGetResponseEnvelope struct {
	Errors   []DirectoryServiceGetResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DirectoryServiceGetResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DirectoryServiceGetResponseEnvelopeSuccess `json:"success,required"`
	Result  DirectoryServiceGetResponse                `json:"result"`
	JSON    directoryServiceGetResponseEnvelopeJSON    `json:"-"`
}

func (*DirectoryServiceGetResponseEnvelope) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelopeErrors

type DirectoryServiceGetResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           DirectoryServiceGetResponseEnvelopeErrorsSource `json:"source"`
	JSON             directoryServiceGetResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DirectoryServiceGetResponseEnvelopeErrors) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelopeErrorsSource

type DirectoryServiceGetResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    directoryServiceGetResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DirectoryServiceGetResponseEnvelopeErrorsSource) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelopeMessages

type DirectoryServiceGetResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           DirectoryServiceGetResponseEnvelopeMessagesSource `json:"source"`
	JSON             directoryServiceGetResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DirectoryServiceGetResponseEnvelopeMessages) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelopeMessagesSource

type DirectoryServiceGetResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    directoryServiceGetResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DirectoryServiceGetResponseEnvelopeMessagesSource) UnmarshalJSON

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

type DirectoryServiceGetResponseEnvelopeSuccess

type DirectoryServiceGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DirectoryServiceGetResponseEnvelopeSuccessTrue DirectoryServiceGetResponseEnvelopeSuccess = true
)

func (DirectoryServiceGetResponseEnvelopeSuccess) IsKnown

type DirectoryServiceGetResponseHost

type DirectoryServiceGetResponseHost struct {
	Hostname string `json:"hostname"`
	IPV4     string `json:"ipv4"`
	IPV6     string `json:"ipv6"`
	// This field can have the runtime type of
	// [DirectoryServiceGetResponseHostInfraIPv4HostNetwork],
	// [DirectoryServiceGetResponseHostInfraIPv6HostNetwork],
	// [DirectoryServiceGetResponseHostInfraDualStackHostNetwork].
	Network interface{} `json:"network"`
	// This field can have the runtime type of
	// [DirectoryServiceGetResponseHostInfraHostnameHostResolverNetwork].
	ResolverNetwork interface{}                         `json:"resolver_network"`
	JSON            directoryServiceGetResponseHostJSON `json:"-"`
	// contains filtered or unexported fields
}

func (DirectoryServiceGetResponseHost) AsUnion

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

Possible runtime types of the union are DirectoryServiceGetResponseHostInfraIPv4Host, DirectoryServiceGetResponseHostInfraIPv6Host, DirectoryServiceGetResponseHostInfraDualStackHost, DirectoryServiceGetResponseHostInfraHostnameHost.

func (*DirectoryServiceGetResponseHost) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraDualStackHost

type DirectoryServiceGetResponseHostInfraDualStackHost struct {
	IPV4    string                                                   `json:"ipv4,required"`
	IPV6    string                                                   `json:"ipv6,required"`
	Network DirectoryServiceGetResponseHostInfraDualStackHostNetwork `json:"network,required"`
	JSON    directoryServiceGetResponseHostInfraDualStackHostJSON    `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraDualStackHost) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraDualStackHostNetwork

type DirectoryServiceGetResponseHostInfraDualStackHostNetwork struct {
	TunnelID string                                                       `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceGetResponseHostInfraDualStackHostNetworkJSON `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraDualStackHostNetwork) UnmarshalJSON

type DirectoryServiceGetResponseHostInfraHostnameHost

type DirectoryServiceGetResponseHostInfraHostnameHost struct {
	Hostname        string                                                          `json:"hostname,required"`
	ResolverNetwork DirectoryServiceGetResponseHostInfraHostnameHostResolverNetwork `json:"resolver_network,required"`
	JSON            directoryServiceGetResponseHostInfraHostnameHostJSON            `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraHostnameHost) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraHostnameHostResolverNetwork

type DirectoryServiceGetResponseHostInfraHostnameHostResolverNetwork struct {
	TunnelID    string                                                              `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs []string                                                            `json:"resolver_ips,nullable"`
	JSON        directoryServiceGetResponseHostInfraHostnameHostResolverNetworkJSON `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraHostnameHostResolverNetwork) UnmarshalJSON

type DirectoryServiceGetResponseHostInfraIPv4Host

type DirectoryServiceGetResponseHostInfraIPv4Host struct {
	IPV4    string                                              `json:"ipv4,required"`
	Network DirectoryServiceGetResponseHostInfraIPv4HostNetwork `json:"network,required"`
	JSON    directoryServiceGetResponseHostInfraIPv4HostJSON    `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraIPv4Host) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraIPv4HostNetwork

type DirectoryServiceGetResponseHostInfraIPv4HostNetwork struct {
	TunnelID string                                                  `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceGetResponseHostInfraIPv4HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraIPv4HostNetwork) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraIPv6Host

type DirectoryServiceGetResponseHostInfraIPv6Host struct {
	IPV6    string                                              `json:"ipv6,required"`
	Network DirectoryServiceGetResponseHostInfraIPv6HostNetwork `json:"network,required"`
	JSON    directoryServiceGetResponseHostInfraIPv6HostJSON    `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraIPv6Host) UnmarshalJSON

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

type DirectoryServiceGetResponseHostInfraIPv6HostNetwork

type DirectoryServiceGetResponseHostInfraIPv6HostNetwork struct {
	TunnelID string                                                  `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceGetResponseHostInfraIPv6HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceGetResponseHostInfraIPv6HostNetwork) UnmarshalJSON

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

type DirectoryServiceGetResponseType

type DirectoryServiceGetResponseType string
const (
	DirectoryServiceGetResponseTypeHTTP DirectoryServiceGetResponseType = "http"
)

func (DirectoryServiceGetResponseType) IsKnown

type DirectoryServiceListParams

type DirectoryServiceListParams struct {
	// Account identifier
	AccountID param.Field[string] `path:"account_id,required"`
	// Current page in the response
	Page param.Field[int64] `query:"page"`
	// Max amount of entries returned per page
	PerPage param.Field[int64]                          `query:"per_page"`
	Type    param.Field[DirectoryServiceListParamsType] `query:"type"`
}

func (DirectoryServiceListParams) URLQuery

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

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

type DirectoryServiceListParamsType

type DirectoryServiceListParamsType string
const (
	DirectoryServiceListParamsTypeHTTP DirectoryServiceListParamsType = "http"
)

func (DirectoryServiceListParamsType) IsKnown

type DirectoryServiceListResponse

type DirectoryServiceListResponse struct {
	Host      DirectoryServiceListResponseHost `json:"host,required"`
	Name      string                           `json:"name,required"`
	Type      DirectoryServiceListResponseType `json:"type,required"`
	CreatedAt time.Time                        `json:"created_at" format:"date-time"`
	HTTPPort  int64                            `json:"http_port,nullable"`
	HTTPSPort int64                            `json:"https_port,nullable"`
	ServiceID string                           `json:"service_id" format:"uuid"`
	UpdatedAt time.Time                        `json:"updated_at" format:"date-time"`
	JSON      directoryServiceListResponseJSON `json:"-"`
}

func (*DirectoryServiceListResponse) UnmarshalJSON

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

type DirectoryServiceListResponseHost

type DirectoryServiceListResponseHost struct {
	Hostname string `json:"hostname"`
	IPV4     string `json:"ipv4"`
	IPV6     string `json:"ipv6"`
	// This field can have the runtime type of
	// [DirectoryServiceListResponseHostInfraIPv4HostNetwork],
	// [DirectoryServiceListResponseHostInfraIPv6HostNetwork],
	// [DirectoryServiceListResponseHostInfraDualStackHostNetwork].
	Network interface{} `json:"network"`
	// This field can have the runtime type of
	// [DirectoryServiceListResponseHostInfraHostnameHostResolverNetwork].
	ResolverNetwork interface{}                          `json:"resolver_network"`
	JSON            directoryServiceListResponseHostJSON `json:"-"`
	// contains filtered or unexported fields
}

func (DirectoryServiceListResponseHost) AsUnion

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

Possible runtime types of the union are DirectoryServiceListResponseHostInfraIPv4Host, DirectoryServiceListResponseHostInfraIPv6Host, DirectoryServiceListResponseHostInfraDualStackHost, DirectoryServiceListResponseHostInfraHostnameHost.

func (*DirectoryServiceListResponseHost) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraDualStackHost

type DirectoryServiceListResponseHostInfraDualStackHost struct {
	IPV4    string                                                    `json:"ipv4,required"`
	IPV6    string                                                    `json:"ipv6,required"`
	Network DirectoryServiceListResponseHostInfraDualStackHostNetwork `json:"network,required"`
	JSON    directoryServiceListResponseHostInfraDualStackHostJSON    `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraDualStackHost) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraDualStackHostNetwork

type DirectoryServiceListResponseHostInfraDualStackHostNetwork struct {
	TunnelID string                                                        `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceListResponseHostInfraDualStackHostNetworkJSON `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraDualStackHostNetwork) UnmarshalJSON

type DirectoryServiceListResponseHostInfraHostnameHost

type DirectoryServiceListResponseHostInfraHostnameHost struct {
	Hostname        string                                                           `json:"hostname,required"`
	ResolverNetwork DirectoryServiceListResponseHostInfraHostnameHostResolverNetwork `json:"resolver_network,required"`
	JSON            directoryServiceListResponseHostInfraHostnameHostJSON            `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraHostnameHost) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraHostnameHostResolverNetwork

type DirectoryServiceListResponseHostInfraHostnameHostResolverNetwork struct {
	TunnelID    string                                                               `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs []string                                                             `json:"resolver_ips,nullable"`
	JSON        directoryServiceListResponseHostInfraHostnameHostResolverNetworkJSON `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraHostnameHostResolverNetwork) UnmarshalJSON

type DirectoryServiceListResponseHostInfraIPv4Host

type DirectoryServiceListResponseHostInfraIPv4Host struct {
	IPV4    string                                               `json:"ipv4,required"`
	Network DirectoryServiceListResponseHostInfraIPv4HostNetwork `json:"network,required"`
	JSON    directoryServiceListResponseHostInfraIPv4HostJSON    `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraIPv4Host) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraIPv4HostNetwork

type DirectoryServiceListResponseHostInfraIPv4HostNetwork struct {
	TunnelID string                                                   `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceListResponseHostInfraIPv4HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraIPv4HostNetwork) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraIPv6Host

type DirectoryServiceListResponseHostInfraIPv6Host struct {
	IPV6    string                                               `json:"ipv6,required"`
	Network DirectoryServiceListResponseHostInfraIPv6HostNetwork `json:"network,required"`
	JSON    directoryServiceListResponseHostInfraIPv6HostJSON    `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraIPv6Host) UnmarshalJSON

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

type DirectoryServiceListResponseHostInfraIPv6HostNetwork

type DirectoryServiceListResponseHostInfraIPv6HostNetwork struct {
	TunnelID string                                                   `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceListResponseHostInfraIPv6HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceListResponseHostInfraIPv6HostNetwork) UnmarshalJSON

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

type DirectoryServiceListResponseType

type DirectoryServiceListResponseType string
const (
	DirectoryServiceListResponseTypeHTTP DirectoryServiceListResponseType = "http"
)

func (DirectoryServiceListResponseType) IsKnown

type DirectoryServiceNewParams

type DirectoryServiceNewParams struct {
	// Account identifier
	AccountID param.Field[string]                             `path:"account_id,required"`
	Host      param.Field[DirectoryServiceNewParamsHostUnion] `json:"host,required"`
	Name      param.Field[string]                             `json:"name,required"`
	Type      param.Field[DirectoryServiceNewParamsType]      `json:"type,required"`
	HTTPPort  param.Field[int64]                              `json:"http_port"`
	HTTPSPort param.Field[int64]                              `json:"https_port"`
}

func (DirectoryServiceNewParams) MarshalJSON

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

type DirectoryServiceNewParamsHost

type DirectoryServiceNewParamsHost struct {
	Hostname        param.Field[string]      `json:"hostname"`
	IPV4            param.Field[string]      `json:"ipv4"`
	IPV6            param.Field[string]      `json:"ipv6"`
	Network         param.Field[interface{}] `json:"network"`
	ResolverNetwork param.Field[interface{}] `json:"resolver_network"`
}

func (DirectoryServiceNewParamsHost) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraDualStackHost

type DirectoryServiceNewParamsHostInfraDualStackHost struct {
	IPV4    param.Field[string]                                                 `json:"ipv4,required"`
	IPV6    param.Field[string]                                                 `json:"ipv6,required"`
	Network param.Field[DirectoryServiceNewParamsHostInfraDualStackHostNetwork] `json:"network,required"`
}

func (DirectoryServiceNewParamsHostInfraDualStackHost) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraDualStackHostNetwork

type DirectoryServiceNewParamsHostInfraDualStackHostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceNewParamsHostInfraDualStackHostNetwork) MarshalJSON

type DirectoryServiceNewParamsHostInfraHostnameHost

type DirectoryServiceNewParamsHostInfraHostnameHost struct {
	Hostname        param.Field[string]                                                        `json:"hostname,required"`
	ResolverNetwork param.Field[DirectoryServiceNewParamsHostInfraHostnameHostResolverNetwork] `json:"resolver_network,required"`
}

func (DirectoryServiceNewParamsHostInfraHostnameHost) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraHostnameHostResolverNetwork

type DirectoryServiceNewParamsHostInfraHostnameHostResolverNetwork struct {
	TunnelID    param.Field[string]   `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs param.Field[[]string] `json:"resolver_ips"`
}

func (DirectoryServiceNewParamsHostInfraHostnameHostResolverNetwork) MarshalJSON

type DirectoryServiceNewParamsHostInfraIPv4Host

type DirectoryServiceNewParamsHostInfraIPv4Host struct {
	IPV4    param.Field[string]                                            `json:"ipv4,required"`
	Network param.Field[DirectoryServiceNewParamsHostInfraIPv4HostNetwork] `json:"network,required"`
}

func (DirectoryServiceNewParamsHostInfraIPv4Host) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraIPv4HostNetwork

type DirectoryServiceNewParamsHostInfraIPv4HostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceNewParamsHostInfraIPv4HostNetwork) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraIPv6Host

type DirectoryServiceNewParamsHostInfraIPv6Host struct {
	IPV6    param.Field[string]                                            `json:"ipv6,required"`
	Network param.Field[DirectoryServiceNewParamsHostInfraIPv6HostNetwork] `json:"network,required"`
}

func (DirectoryServiceNewParamsHostInfraIPv6Host) MarshalJSON

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

type DirectoryServiceNewParamsHostInfraIPv6HostNetwork

type DirectoryServiceNewParamsHostInfraIPv6HostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceNewParamsHostInfraIPv6HostNetwork) MarshalJSON

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

type DirectoryServiceNewParamsType

type DirectoryServiceNewParamsType string
const (
	DirectoryServiceNewParamsTypeHTTP DirectoryServiceNewParamsType = "http"
)

func (DirectoryServiceNewParamsType) IsKnown

func (r DirectoryServiceNewParamsType) IsKnown() bool

type DirectoryServiceNewResponse

type DirectoryServiceNewResponse struct {
	Host      DirectoryServiceNewResponseHost `json:"host,required"`
	Name      string                          `json:"name,required"`
	Type      DirectoryServiceNewResponseType `json:"type,required"`
	CreatedAt time.Time                       `json:"created_at" format:"date-time"`
	HTTPPort  int64                           `json:"http_port,nullable"`
	HTTPSPort int64                           `json:"https_port,nullable"`
	ServiceID string                          `json:"service_id" format:"uuid"`
	UpdatedAt time.Time                       `json:"updated_at" format:"date-time"`
	JSON      directoryServiceNewResponseJSON `json:"-"`
}

func (*DirectoryServiceNewResponse) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelope

type DirectoryServiceNewResponseEnvelope struct {
	Errors   []DirectoryServiceNewResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DirectoryServiceNewResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DirectoryServiceNewResponseEnvelopeSuccess `json:"success,required"`
	Result  DirectoryServiceNewResponse                `json:"result"`
	JSON    directoryServiceNewResponseEnvelopeJSON    `json:"-"`
}

func (*DirectoryServiceNewResponseEnvelope) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelopeErrors

type DirectoryServiceNewResponseEnvelopeErrors struct {
	Code             int64                                           `json:"code,required"`
	Message          string                                          `json:"message,required"`
	DocumentationURL string                                          `json:"documentation_url"`
	Source           DirectoryServiceNewResponseEnvelopeErrorsSource `json:"source"`
	JSON             directoryServiceNewResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DirectoryServiceNewResponseEnvelopeErrors) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelopeErrorsSource

type DirectoryServiceNewResponseEnvelopeErrorsSource struct {
	Pointer string                                              `json:"pointer"`
	JSON    directoryServiceNewResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DirectoryServiceNewResponseEnvelopeErrorsSource) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelopeMessages

type DirectoryServiceNewResponseEnvelopeMessages struct {
	Code             int64                                             `json:"code,required"`
	Message          string                                            `json:"message,required"`
	DocumentationURL string                                            `json:"documentation_url"`
	Source           DirectoryServiceNewResponseEnvelopeMessagesSource `json:"source"`
	JSON             directoryServiceNewResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DirectoryServiceNewResponseEnvelopeMessages) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelopeMessagesSource

type DirectoryServiceNewResponseEnvelopeMessagesSource struct {
	Pointer string                                                `json:"pointer"`
	JSON    directoryServiceNewResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DirectoryServiceNewResponseEnvelopeMessagesSource) UnmarshalJSON

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

type DirectoryServiceNewResponseEnvelopeSuccess

type DirectoryServiceNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DirectoryServiceNewResponseEnvelopeSuccessTrue DirectoryServiceNewResponseEnvelopeSuccess = true
)

func (DirectoryServiceNewResponseEnvelopeSuccess) IsKnown

type DirectoryServiceNewResponseHost

type DirectoryServiceNewResponseHost struct {
	Hostname string `json:"hostname"`
	IPV4     string `json:"ipv4"`
	IPV6     string `json:"ipv6"`
	// This field can have the runtime type of
	// [DirectoryServiceNewResponseHostInfraIPv4HostNetwork],
	// [DirectoryServiceNewResponseHostInfraIPv6HostNetwork],
	// [DirectoryServiceNewResponseHostInfraDualStackHostNetwork].
	Network interface{} `json:"network"`
	// This field can have the runtime type of
	// [DirectoryServiceNewResponseHostInfraHostnameHostResolverNetwork].
	ResolverNetwork interface{}                         `json:"resolver_network"`
	JSON            directoryServiceNewResponseHostJSON `json:"-"`
	// contains filtered or unexported fields
}

func (DirectoryServiceNewResponseHost) AsUnion

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

Possible runtime types of the union are DirectoryServiceNewResponseHostInfraIPv4Host, DirectoryServiceNewResponseHostInfraIPv6Host, DirectoryServiceNewResponseHostInfraDualStackHost, DirectoryServiceNewResponseHostInfraHostnameHost.

func (*DirectoryServiceNewResponseHost) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraDualStackHost

type DirectoryServiceNewResponseHostInfraDualStackHost struct {
	IPV4    string                                                   `json:"ipv4,required"`
	IPV6    string                                                   `json:"ipv6,required"`
	Network DirectoryServiceNewResponseHostInfraDualStackHostNetwork `json:"network,required"`
	JSON    directoryServiceNewResponseHostInfraDualStackHostJSON    `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraDualStackHost) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraDualStackHostNetwork

type DirectoryServiceNewResponseHostInfraDualStackHostNetwork struct {
	TunnelID string                                                       `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceNewResponseHostInfraDualStackHostNetworkJSON `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraDualStackHostNetwork) UnmarshalJSON

type DirectoryServiceNewResponseHostInfraHostnameHost

type DirectoryServiceNewResponseHostInfraHostnameHost struct {
	Hostname        string                                                          `json:"hostname,required"`
	ResolverNetwork DirectoryServiceNewResponseHostInfraHostnameHostResolverNetwork `json:"resolver_network,required"`
	JSON            directoryServiceNewResponseHostInfraHostnameHostJSON            `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraHostnameHost) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraHostnameHostResolverNetwork

type DirectoryServiceNewResponseHostInfraHostnameHostResolverNetwork struct {
	TunnelID    string                                                              `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs []string                                                            `json:"resolver_ips,nullable"`
	JSON        directoryServiceNewResponseHostInfraHostnameHostResolverNetworkJSON `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraHostnameHostResolverNetwork) UnmarshalJSON

type DirectoryServiceNewResponseHostInfraIPv4Host

type DirectoryServiceNewResponseHostInfraIPv4Host struct {
	IPV4    string                                              `json:"ipv4,required"`
	Network DirectoryServiceNewResponseHostInfraIPv4HostNetwork `json:"network,required"`
	JSON    directoryServiceNewResponseHostInfraIPv4HostJSON    `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraIPv4Host) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraIPv4HostNetwork

type DirectoryServiceNewResponseHostInfraIPv4HostNetwork struct {
	TunnelID string                                                  `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceNewResponseHostInfraIPv4HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraIPv4HostNetwork) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraIPv6Host

type DirectoryServiceNewResponseHostInfraIPv6Host struct {
	IPV6    string                                              `json:"ipv6,required"`
	Network DirectoryServiceNewResponseHostInfraIPv6HostNetwork `json:"network,required"`
	JSON    directoryServiceNewResponseHostInfraIPv6HostJSON    `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraIPv6Host) UnmarshalJSON

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

type DirectoryServiceNewResponseHostInfraIPv6HostNetwork

type DirectoryServiceNewResponseHostInfraIPv6HostNetwork struct {
	TunnelID string                                                  `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceNewResponseHostInfraIPv6HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceNewResponseHostInfraIPv6HostNetwork) UnmarshalJSON

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

type DirectoryServiceNewResponseType

type DirectoryServiceNewResponseType string
const (
	DirectoryServiceNewResponseTypeHTTP DirectoryServiceNewResponseType = "http"
)

func (DirectoryServiceNewResponseType) IsKnown

type DirectoryServiceService

type DirectoryServiceService struct {
	Options []option.RequestOption
}

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

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

func NewDirectoryServiceService

func NewDirectoryServiceService(opts ...option.RequestOption) (r *DirectoryServiceService)

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

func (*DirectoryServiceService) Delete

Delete connectivity service

func (*DirectoryServiceService) Get

Get connectivity service

func (*DirectoryServiceService) List

List connectivity services

func (*DirectoryServiceService) ListAutoPaging

List connectivity services

func (*DirectoryServiceService) New

Create connectivity service

func (*DirectoryServiceService) Update

Update connectivity service

type DirectoryServiceUpdateParams

type DirectoryServiceUpdateParams struct {
	AccountID param.Field[string]                                `path:"account_id,required"`
	Host      param.Field[DirectoryServiceUpdateParamsHostUnion] `json:"host,required"`
	Name      param.Field[string]                                `json:"name,required"`
	Type      param.Field[DirectoryServiceUpdateParamsType]      `json:"type,required"`
	HTTPPort  param.Field[int64]                                 `json:"http_port"`
	HTTPSPort param.Field[int64]                                 `json:"https_port"`
}

func (DirectoryServiceUpdateParams) MarshalJSON

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

type DirectoryServiceUpdateParamsHost

type DirectoryServiceUpdateParamsHost struct {
	Hostname        param.Field[string]      `json:"hostname"`
	IPV4            param.Field[string]      `json:"ipv4"`
	IPV6            param.Field[string]      `json:"ipv6"`
	Network         param.Field[interface{}] `json:"network"`
	ResolverNetwork param.Field[interface{}] `json:"resolver_network"`
}

func (DirectoryServiceUpdateParamsHost) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraDualStackHost

type DirectoryServiceUpdateParamsHostInfraDualStackHost struct {
	IPV4    param.Field[string]                                                    `json:"ipv4,required"`
	IPV6    param.Field[string]                                                    `json:"ipv6,required"`
	Network param.Field[DirectoryServiceUpdateParamsHostInfraDualStackHostNetwork] `json:"network,required"`
}

func (DirectoryServiceUpdateParamsHostInfraDualStackHost) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraDualStackHostNetwork

type DirectoryServiceUpdateParamsHostInfraDualStackHostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceUpdateParamsHostInfraDualStackHostNetwork) MarshalJSON

type DirectoryServiceUpdateParamsHostInfraHostnameHost

type DirectoryServiceUpdateParamsHostInfraHostnameHost struct {
	Hostname        param.Field[string]                                                           `json:"hostname,required"`
	ResolverNetwork param.Field[DirectoryServiceUpdateParamsHostInfraHostnameHostResolverNetwork] `json:"resolver_network,required"`
}

func (DirectoryServiceUpdateParamsHostInfraHostnameHost) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraHostnameHostResolverNetwork

type DirectoryServiceUpdateParamsHostInfraHostnameHostResolverNetwork struct {
	TunnelID    param.Field[string]   `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs param.Field[[]string] `json:"resolver_ips"`
}

func (DirectoryServiceUpdateParamsHostInfraHostnameHostResolverNetwork) MarshalJSON

type DirectoryServiceUpdateParamsHostInfraIPv4Host

type DirectoryServiceUpdateParamsHostInfraIPv4Host struct {
	IPV4    param.Field[string]                                               `json:"ipv4,required"`
	Network param.Field[DirectoryServiceUpdateParamsHostInfraIPv4HostNetwork] `json:"network,required"`
}

func (DirectoryServiceUpdateParamsHostInfraIPv4Host) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraIPv4HostNetwork

type DirectoryServiceUpdateParamsHostInfraIPv4HostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceUpdateParamsHostInfraIPv4HostNetwork) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraIPv6Host

type DirectoryServiceUpdateParamsHostInfraIPv6Host struct {
	IPV6    param.Field[string]                                               `json:"ipv6,required"`
	Network param.Field[DirectoryServiceUpdateParamsHostInfraIPv6HostNetwork] `json:"network,required"`
}

func (DirectoryServiceUpdateParamsHostInfraIPv6Host) MarshalJSON

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

type DirectoryServiceUpdateParamsHostInfraIPv6HostNetwork

type DirectoryServiceUpdateParamsHostInfraIPv6HostNetwork struct {
	TunnelID param.Field[string] `json:"tunnel_id,required" format:"uuid"`
}

func (DirectoryServiceUpdateParamsHostInfraIPv6HostNetwork) MarshalJSON

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

type DirectoryServiceUpdateParamsType

type DirectoryServiceUpdateParamsType string
const (
	DirectoryServiceUpdateParamsTypeHTTP DirectoryServiceUpdateParamsType = "http"
)

func (DirectoryServiceUpdateParamsType) IsKnown

type DirectoryServiceUpdateResponse

type DirectoryServiceUpdateResponse struct {
	Host      DirectoryServiceUpdateResponseHost `json:"host,required"`
	Name      string                             `json:"name,required"`
	Type      DirectoryServiceUpdateResponseType `json:"type,required"`
	CreatedAt time.Time                          `json:"created_at" format:"date-time"`
	HTTPPort  int64                              `json:"http_port,nullable"`
	HTTPSPort int64                              `json:"https_port,nullable"`
	ServiceID string                             `json:"service_id" format:"uuid"`
	UpdatedAt time.Time                          `json:"updated_at" format:"date-time"`
	JSON      directoryServiceUpdateResponseJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponse) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelope

type DirectoryServiceUpdateResponseEnvelope struct {
	Errors   []DirectoryServiceUpdateResponseEnvelopeErrors   `json:"errors,required"`
	Messages []DirectoryServiceUpdateResponseEnvelopeMessages `json:"messages,required"`
	// Whether the API call was successful.
	Success DirectoryServiceUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  DirectoryServiceUpdateResponse                `json:"result"`
	JSON    directoryServiceUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*DirectoryServiceUpdateResponseEnvelope) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelopeErrors

type DirectoryServiceUpdateResponseEnvelopeErrors struct {
	Code             int64                                              `json:"code,required"`
	Message          string                                             `json:"message,required"`
	DocumentationURL string                                             `json:"documentation_url"`
	Source           DirectoryServiceUpdateResponseEnvelopeErrorsSource `json:"source"`
	JSON             directoryServiceUpdateResponseEnvelopeErrorsJSON   `json:"-"`
}

func (*DirectoryServiceUpdateResponseEnvelopeErrors) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelopeErrorsSource

type DirectoryServiceUpdateResponseEnvelopeErrorsSource struct {
	Pointer string                                                 `json:"pointer"`
	JSON    directoryServiceUpdateResponseEnvelopeErrorsSourceJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseEnvelopeErrorsSource) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelopeMessages

type DirectoryServiceUpdateResponseEnvelopeMessages struct {
	Code             int64                                                `json:"code,required"`
	Message          string                                               `json:"message,required"`
	DocumentationURL string                                               `json:"documentation_url"`
	Source           DirectoryServiceUpdateResponseEnvelopeMessagesSource `json:"source"`
	JSON             directoryServiceUpdateResponseEnvelopeMessagesJSON   `json:"-"`
}

func (*DirectoryServiceUpdateResponseEnvelopeMessages) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelopeMessagesSource

type DirectoryServiceUpdateResponseEnvelopeMessagesSource struct {
	Pointer string                                                   `json:"pointer"`
	JSON    directoryServiceUpdateResponseEnvelopeMessagesSourceJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseEnvelopeMessagesSource) UnmarshalJSON

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

type DirectoryServiceUpdateResponseEnvelopeSuccess

type DirectoryServiceUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	DirectoryServiceUpdateResponseEnvelopeSuccessTrue DirectoryServiceUpdateResponseEnvelopeSuccess = true
)

func (DirectoryServiceUpdateResponseEnvelopeSuccess) IsKnown

type DirectoryServiceUpdateResponseHost

type DirectoryServiceUpdateResponseHost struct {
	Hostname string `json:"hostname"`
	IPV4     string `json:"ipv4"`
	IPV6     string `json:"ipv6"`
	// This field can have the runtime type of
	// [DirectoryServiceUpdateResponseHostInfraIPv4HostNetwork],
	// [DirectoryServiceUpdateResponseHostInfraIPv6HostNetwork],
	// [DirectoryServiceUpdateResponseHostInfraDualStackHostNetwork].
	Network interface{} `json:"network"`
	// This field can have the runtime type of
	// [DirectoryServiceUpdateResponseHostInfraHostnameHostResolverNetwork].
	ResolverNetwork interface{}                            `json:"resolver_network"`
	JSON            directoryServiceUpdateResponseHostJSON `json:"-"`
	// contains filtered or unexported fields
}

func (*DirectoryServiceUpdateResponseHost) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraDualStackHost

type DirectoryServiceUpdateResponseHostInfraDualStackHost struct {
	IPV4    string                                                      `json:"ipv4,required"`
	IPV6    string                                                      `json:"ipv6,required"`
	Network DirectoryServiceUpdateResponseHostInfraDualStackHostNetwork `json:"network,required"`
	JSON    directoryServiceUpdateResponseHostInfraDualStackHostJSON    `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraDualStackHost) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraDualStackHostNetwork

type DirectoryServiceUpdateResponseHostInfraDualStackHostNetwork struct {
	TunnelID string                                                          `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceUpdateResponseHostInfraDualStackHostNetworkJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraDualStackHostNetwork) UnmarshalJSON

type DirectoryServiceUpdateResponseHostInfraHostnameHost

type DirectoryServiceUpdateResponseHostInfraHostnameHost struct {
	Hostname        string                                                             `json:"hostname,required"`
	ResolverNetwork DirectoryServiceUpdateResponseHostInfraHostnameHostResolverNetwork `json:"resolver_network,required"`
	JSON            directoryServiceUpdateResponseHostInfraHostnameHostJSON            `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraHostnameHost) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraHostnameHostResolverNetwork

type DirectoryServiceUpdateResponseHostInfraHostnameHostResolverNetwork struct {
	TunnelID    string                                                                 `json:"tunnel_id,required" format:"uuid"`
	ResolverIPs []string                                                               `json:"resolver_ips,nullable"`
	JSON        directoryServiceUpdateResponseHostInfraHostnameHostResolverNetworkJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraHostnameHostResolverNetwork) UnmarshalJSON

type DirectoryServiceUpdateResponseHostInfraIPv4Host

type DirectoryServiceUpdateResponseHostInfraIPv4Host struct {
	IPV4    string                                                 `json:"ipv4,required"`
	Network DirectoryServiceUpdateResponseHostInfraIPv4HostNetwork `json:"network,required"`
	JSON    directoryServiceUpdateResponseHostInfraIPv4HostJSON    `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraIPv4Host) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraIPv4HostNetwork

type DirectoryServiceUpdateResponseHostInfraIPv4HostNetwork struct {
	TunnelID string                                                     `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceUpdateResponseHostInfraIPv4HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraIPv4HostNetwork) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraIPv6Host

type DirectoryServiceUpdateResponseHostInfraIPv6Host struct {
	IPV6    string                                                 `json:"ipv6,required"`
	Network DirectoryServiceUpdateResponseHostInfraIPv6HostNetwork `json:"network,required"`
	JSON    directoryServiceUpdateResponseHostInfraIPv6HostJSON    `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraIPv6Host) UnmarshalJSON

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

type DirectoryServiceUpdateResponseHostInfraIPv6HostNetwork

type DirectoryServiceUpdateResponseHostInfraIPv6HostNetwork struct {
	TunnelID string                                                     `json:"tunnel_id,required" format:"uuid"`
	JSON     directoryServiceUpdateResponseHostInfraIPv6HostNetworkJSON `json:"-"`
}

func (*DirectoryServiceUpdateResponseHostInfraIPv6HostNetwork) UnmarshalJSON

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

type DirectoryServiceUpdateResponseType

type DirectoryServiceUpdateResponseType string
const (
	DirectoryServiceUpdateResponseTypeHTTP DirectoryServiceUpdateResponseType = "http"
)

func (DirectoryServiceUpdateResponseType) IsKnown

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

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

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

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

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

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

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

This is an alias to an internal type.

type MemberStatus

type MemberStatus = shared.MemberStatus

A member's status in the account.

This is an alias to an internal type.

type MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Permission

type Permission = shared.Permission

This is an alias to an internal type.

type PermissionGrant

type PermissionGrant = shared.PermissionGrant

This is an alias to an internal type.

type PermissionGrantParam

type PermissionGrantParam = shared.PermissionGrantParam

This is an alias to an internal type.

type RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

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

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNested

type TokenPolicyResourcesIAMResourcesTypeObjectNested = shared.TokenPolicyResourcesIAMResourcesTypeObjectNested

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

type TokenPolicyResourcesIAMResourcesTypeObjectNestedParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectNestedParam

Map of nested resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectString

type TokenPolicyResourcesIAMResourcesTypeObjectString = shared.TokenPolicyResourcesIAMResourcesTypeObjectString

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam

type TokenPolicyResourcesIAMResourcesTypeObjectStringParam = shared.TokenPolicyResourcesIAMResourcesTypeObjectStringParam

Map of simple string resource permissions

This is an alias to an internal type.

type TokenPolicyResourcesUnion

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A list of resource names that the policy applies to.

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

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