warp_connector

package
v2.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0

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 CloudflareTunnel

type CloudflareTunnel = shared.CloudflareTunnel

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

This is an alias to an internal type.

type CloudflareTunnelConnection

type CloudflareTunnelConnection = shared.CloudflareTunnelConnection

This is an alias to an internal type.

type CloudflareTunnelTunType

type CloudflareTunnelTunType = shared.CloudflareTunnelTunType

The type of tunnel.

This is an alias to an internal type.

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type Member added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

type MemberParam added in v2.1.0

type MemberParam = shared.MemberParam

This is an alias to an internal type.

type MemberRole added in v2.1.0

type MemberRole = shared.MemberRole

This is an alias to an internal type.

type MemberRoleParam added in v2.1.0

type MemberRoleParam = shared.MemberRoleParam

This is an alias to an internal type.

type MemberRolesPermissions added in v2.1.0

type MemberRolesPermissions = shared.MemberRolesPermissions

This is an alias to an internal type.

type MemberRolesPermissionsParam added in v2.1.0

type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam

This is an alias to an internal type.

type MemberUser added in v2.1.0

type MemberUser = shared.MemberUser

This is an alias to an internal type.

type MemberUserParam added in v2.1.0

type MemberUserParam = shared.MemberUserParam

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type WARPConnectorDeleteParams

type WARPConnectorDeleteParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	Body      interface{}         `json:"body,required"`
}

func (WARPConnectorDeleteParams) MarshalJSON

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

type WARPConnectorDeleteResponse

type WARPConnectorDeleteResponse struct {
	// Cloudflare account ID
	AccountTag  string      `json:"account_tag"`
	Connections interface{} `json:"connections,required"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// UUID of the tunnel.
	ID       string      `json:"id" format:"uuid"`
	Metadata interface{} `json:"metadata,required"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorDeleteResponseTunType `json:"tun_type"`
	JSON    warpConnectorDeleteResponseJSON    `json:"-"`
	// contains filtered or unexported fields
}

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

func (WARPConnectorDeleteResponse) AsUnion

func (*WARPConnectorDeleteResponse) UnmarshalJSON

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

type WARPConnectorDeleteResponseEnvelope

type WARPConnectorDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
	Result WARPConnectorDeleteResponse `json:"result,required"`
	// Whether the API call was successful
	Success WARPConnectorDeleteResponseEnvelopeSuccess `json:"success,required"`
	JSON    warpConnectorDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*WARPConnectorDeleteResponseEnvelope) UnmarshalJSON

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

type WARPConnectorDeleteResponseEnvelopeSuccess

type WARPConnectorDeleteResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	WARPConnectorDeleteResponseEnvelopeSuccessTrue WARPConnectorDeleteResponseEnvelopeSuccess = true
)

func (WARPConnectorDeleteResponseEnvelopeSuccess) IsKnown

type WARPConnectorDeleteResponseTunType

type WARPConnectorDeleteResponseTunType string

The type of tunnel.

const (
	WARPConnectorDeleteResponseTunTypeCfdTunnel     WARPConnectorDeleteResponseTunType = "cfd_tunnel"
	WARPConnectorDeleteResponseTunTypeWARPConnector WARPConnectorDeleteResponseTunType = "warp_connector"
	WARPConnectorDeleteResponseTunTypeIPSec         WARPConnectorDeleteResponseTunType = "ip_sec"
	WARPConnectorDeleteResponseTunTypeGRE           WARPConnectorDeleteResponseTunType = "gre"
	WARPConnectorDeleteResponseTunTypeCNI           WARPConnectorDeleteResponseTunType = "cni"
)

func (WARPConnectorDeleteResponseTunType) IsKnown

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnel

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id" format:"uuid"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []WARPConnectorDeleteResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    warpConnectorDeleteResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

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

func (WARPConnectorDeleteResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorDeleteResponse

func (r WARPConnectorDeleteResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorDeleteResponse()

func (*WARPConnectorDeleteResponseTunnelWARPConnectorTunnel) UnmarshalJSON

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

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnelConnection

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id" format:"uuid"`
	// UUID of the Cloudflare Tunnel connector.
	ClientID string `json:"client_id" format:"uuid"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                             `json:"uuid" format:"uuid"`
	JSON warpConnectorDeleteResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*WARPConnectorDeleteResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType

type WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel.

const (
	WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunTypeWARPConnector WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunTypeIPSec         WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunTypeGRE           WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType = "gre"
	WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunTypeCNI           WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType = "cni"
)

func (WARPConnectorDeleteResponseTunnelWARPConnectorTunnelTunType) IsKnown

type WARPConnectorDeleteResponseUnion

type WARPConnectorDeleteResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorDeleteResponse()
}

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

Union satisfied by shared.CloudflareTunnel or warp_connector.WARPConnectorDeleteResponseTunnelWARPConnectorTunnel.

type WARPConnectorEditParams

type WARPConnectorEditParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A user-friendly name for a tunnel.
	Name param.Field[string] `json:"name"`
	// Sets the password required to run a locally-managed tunnel. Must be at least 32
	// bytes and encoded as a base64 string.
	TunnelSecret param.Field[string] `json:"tunnel_secret"`
}

func (WARPConnectorEditParams) MarshalJSON

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

type WARPConnectorEditResponse

type WARPConnectorEditResponse struct {
	// Cloudflare account ID
	AccountTag  string      `json:"account_tag"`
	Connections interface{} `json:"connections,required"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// UUID of the tunnel.
	ID       string      `json:"id" format:"uuid"`
	Metadata interface{} `json:"metadata,required"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorEditResponseTunType `json:"tun_type"`
	JSON    warpConnectorEditResponseJSON    `json:"-"`
	// contains filtered or unexported fields
}

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

func (WARPConnectorEditResponse) AsUnion

func (*WARPConnectorEditResponse) UnmarshalJSON

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

type WARPConnectorEditResponseEnvelope

type WARPConnectorEditResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
	Result WARPConnectorEditResponse `json:"result,required"`
	// Whether the API call was successful
	Success WARPConnectorEditResponseEnvelopeSuccess `json:"success,required"`
	JSON    warpConnectorEditResponseEnvelopeJSON    `json:"-"`
}

func (*WARPConnectorEditResponseEnvelope) UnmarshalJSON

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

type WARPConnectorEditResponseEnvelopeSuccess

type WARPConnectorEditResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	WARPConnectorEditResponseEnvelopeSuccessTrue WARPConnectorEditResponseEnvelopeSuccess = true
)

func (WARPConnectorEditResponseEnvelopeSuccess) IsKnown

type WARPConnectorEditResponseTunType

type WARPConnectorEditResponseTunType string

The type of tunnel.

const (
	WARPConnectorEditResponseTunTypeCfdTunnel     WARPConnectorEditResponseTunType = "cfd_tunnel"
	WARPConnectorEditResponseTunTypeWARPConnector WARPConnectorEditResponseTunType = "warp_connector"
	WARPConnectorEditResponseTunTypeIPSec         WARPConnectorEditResponseTunType = "ip_sec"
	WARPConnectorEditResponseTunTypeGRE           WARPConnectorEditResponseTunType = "gre"
	WARPConnectorEditResponseTunTypeCNI           WARPConnectorEditResponseTunType = "cni"
)

func (WARPConnectorEditResponseTunType) IsKnown

type WARPConnectorEditResponseTunnelWARPConnectorTunnel

type WARPConnectorEditResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id" format:"uuid"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []WARPConnectorEditResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    warpConnectorEditResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

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

func (WARPConnectorEditResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorEditResponse

func (r WARPConnectorEditResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorEditResponse()

func (*WARPConnectorEditResponseTunnelWARPConnectorTunnel) UnmarshalJSON

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

type WARPConnectorEditResponseTunnelWARPConnectorTunnelConnection

type WARPConnectorEditResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id" format:"uuid"`
	// UUID of the Cloudflare Tunnel connector.
	ClientID string `json:"client_id" format:"uuid"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                           `json:"uuid" format:"uuid"`
	JSON warpConnectorEditResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*WARPConnectorEditResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON

type WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType

type WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel.

const (
	WARPConnectorEditResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	WARPConnectorEditResponseTunnelWARPConnectorTunnelTunTypeWARPConnector WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	WARPConnectorEditResponseTunnelWARPConnectorTunnelTunTypeIPSec         WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	WARPConnectorEditResponseTunnelWARPConnectorTunnelTunTypeGRE           WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType = "gre"
	WARPConnectorEditResponseTunnelWARPConnectorTunnelTunTypeCNI           WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType = "cni"
)

func (WARPConnectorEditResponseTunnelWARPConnectorTunnelTunType) IsKnown

type WARPConnectorEditResponseUnion

type WARPConnectorEditResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorEditResponse()
}

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

Union satisfied by shared.CloudflareTunnel or warp_connector.WARPConnectorEditResponseTunnelWARPConnectorTunnel.

type WARPConnectorGetParams

type WARPConnectorGetParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type WARPConnectorGetResponse

type WARPConnectorGetResponse struct {
	// Cloudflare account ID
	AccountTag  string      `json:"account_tag"`
	Connections interface{} `json:"connections,required"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// UUID of the tunnel.
	ID       string      `json:"id" format:"uuid"`
	Metadata interface{} `json:"metadata,required"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorGetResponseTunType `json:"tun_type"`
	JSON    warpConnectorGetResponseJSON    `json:"-"`
	// contains filtered or unexported fields
}

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

func (WARPConnectorGetResponse) AsUnion

func (*WARPConnectorGetResponse) UnmarshalJSON

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

type WARPConnectorGetResponseEnvelope

type WARPConnectorGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
	Result WARPConnectorGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success WARPConnectorGetResponseEnvelopeSuccess `json:"success,required"`
	JSON    warpConnectorGetResponseEnvelopeJSON    `json:"-"`
}

func (*WARPConnectorGetResponseEnvelope) UnmarshalJSON

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

type WARPConnectorGetResponseEnvelopeSuccess

type WARPConnectorGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	WARPConnectorGetResponseEnvelopeSuccessTrue WARPConnectorGetResponseEnvelopeSuccess = true
)

func (WARPConnectorGetResponseEnvelopeSuccess) IsKnown

type WARPConnectorGetResponseTunType

type WARPConnectorGetResponseTunType string

The type of tunnel.

const (
	WARPConnectorGetResponseTunTypeCfdTunnel     WARPConnectorGetResponseTunType = "cfd_tunnel"
	WARPConnectorGetResponseTunTypeWARPConnector WARPConnectorGetResponseTunType = "warp_connector"
	WARPConnectorGetResponseTunTypeIPSec         WARPConnectorGetResponseTunType = "ip_sec"
	WARPConnectorGetResponseTunTypeGRE           WARPConnectorGetResponseTunType = "gre"
	WARPConnectorGetResponseTunTypeCNI           WARPConnectorGetResponseTunType = "cni"
)

func (WARPConnectorGetResponseTunType) IsKnown

type WARPConnectorGetResponseTunnelWARPConnectorTunnel

type WARPConnectorGetResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id" format:"uuid"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []WARPConnectorGetResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    warpConnectorGetResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

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

func (WARPConnectorGetResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorGetResponse

func (r WARPConnectorGetResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorGetResponse()

func (*WARPConnectorGetResponseTunnelWARPConnectorTunnel) UnmarshalJSON

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

type WARPConnectorGetResponseTunnelWARPConnectorTunnelConnection

type WARPConnectorGetResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id" format:"uuid"`
	// UUID of the Cloudflare Tunnel connector.
	ClientID string `json:"client_id" format:"uuid"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                          `json:"uuid" format:"uuid"`
	JSON warpConnectorGetResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*WARPConnectorGetResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON

type WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType

type WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel.

const (
	WARPConnectorGetResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	WARPConnectorGetResponseTunnelWARPConnectorTunnelTunTypeWARPConnector WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	WARPConnectorGetResponseTunnelWARPConnectorTunnelTunTypeIPSec         WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	WARPConnectorGetResponseTunnelWARPConnectorTunnelTunTypeGRE           WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType = "gre"
	WARPConnectorGetResponseTunnelWARPConnectorTunnelTunTypeCNI           WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType = "cni"
)

func (WARPConnectorGetResponseTunnelWARPConnectorTunnelTunType) IsKnown

type WARPConnectorGetResponseUnion

type WARPConnectorGetResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorGetResponse()
}

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

Union satisfied by shared.CloudflareTunnel or warp_connector.WARPConnectorGetResponseTunnelWARPConnectorTunnel.

type WARPConnectorListParams

type WARPConnectorListParams struct {
	// Cloudflare account ID
	AccountID     param.Field[string] `path:"account_id,required"`
	ExcludePrefix param.Field[string] `query:"exclude_prefix"`
	// If provided, include only tunnels that were created (and not deleted) before
	// this time.
	ExistedAt     param.Field[time.Time] `query:"existed_at" format:"date-time"`
	IncludePrefix param.Field[string]    `query:"include_prefix"`
	// If `true`, only include deleted tunnels. If `false`, exclude deleted tunnels. If
	// empty, all tunnels will be included.
	IsDeleted param.Field[bool] `query:"is_deleted"`
	// A user-friendly name for the tunnel.
	Name param.Field[string] `query:"name"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Number of results to display.
	PerPage param.Field[float64] `query:"per_page"`
	// UUID of the tunnel.
	UUID          param.Field[string]    `query:"uuid" format:"uuid"`
	WasActiveAt   param.Field[time.Time] `query:"was_active_at" format:"date-time"`
	WasInactiveAt param.Field[time.Time] `query:"was_inactive_at" format:"date-time"`
}

func (WARPConnectorListParams) URLQuery

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

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

type WARPConnectorListResponse

type WARPConnectorListResponse struct {
	// Cloudflare account ID
	AccountTag  string      `json:"account_tag"`
	Connections interface{} `json:"connections,required"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// UUID of the tunnel.
	ID       string      `json:"id" format:"uuid"`
	Metadata interface{} `json:"metadata,required"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorListResponseTunType `json:"tun_type"`
	JSON    warpConnectorListResponseJSON    `json:"-"`
	// contains filtered or unexported fields
}

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

func (WARPConnectorListResponse) AsUnion

func (*WARPConnectorListResponse) UnmarshalJSON

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

type WARPConnectorListResponseTunType

type WARPConnectorListResponseTunType string

The type of tunnel.

const (
	WARPConnectorListResponseTunTypeCfdTunnel     WARPConnectorListResponseTunType = "cfd_tunnel"
	WARPConnectorListResponseTunTypeWARPConnector WARPConnectorListResponseTunType = "warp_connector"
	WARPConnectorListResponseTunTypeIPSec         WARPConnectorListResponseTunType = "ip_sec"
	WARPConnectorListResponseTunTypeGRE           WARPConnectorListResponseTunType = "gre"
	WARPConnectorListResponseTunTypeCNI           WARPConnectorListResponseTunType = "cni"
)

func (WARPConnectorListResponseTunType) IsKnown

type WARPConnectorListResponseTunnelWARPConnectorTunnel

type WARPConnectorListResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id" format:"uuid"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []WARPConnectorListResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorListResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    warpConnectorListResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

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

func (WARPConnectorListResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorListResponse

func (r WARPConnectorListResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorListResponse()

func (*WARPConnectorListResponseTunnelWARPConnectorTunnel) UnmarshalJSON

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

type WARPConnectorListResponseTunnelWARPConnectorTunnelConnection

type WARPConnectorListResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id" format:"uuid"`
	// UUID of the Cloudflare Tunnel connector.
	ClientID string `json:"client_id" format:"uuid"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                           `json:"uuid" format:"uuid"`
	JSON warpConnectorListResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*WARPConnectorListResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON

type WARPConnectorListResponseTunnelWARPConnectorTunnelTunType

type WARPConnectorListResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel.

const (
	WARPConnectorListResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     WARPConnectorListResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	WARPConnectorListResponseTunnelWARPConnectorTunnelTunTypeWARPConnector WARPConnectorListResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	WARPConnectorListResponseTunnelWARPConnectorTunnelTunTypeIPSec         WARPConnectorListResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	WARPConnectorListResponseTunnelWARPConnectorTunnelTunTypeGRE           WARPConnectorListResponseTunnelWARPConnectorTunnelTunType = "gre"
	WARPConnectorListResponseTunnelWARPConnectorTunnelTunTypeCNI           WARPConnectorListResponseTunnelWARPConnectorTunnelTunType = "cni"
)

func (WARPConnectorListResponseTunnelWARPConnectorTunnelTunType) IsKnown

type WARPConnectorListResponseUnion

type WARPConnectorListResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorListResponse()
}

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

Union satisfied by shared.CloudflareTunnel or warp_connector.WARPConnectorListResponseTunnelWARPConnectorTunnel.

type WARPConnectorNewParams

type WARPConnectorNewParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
	// A user-friendly name for a tunnel.
	Name param.Field[string] `json:"name,required"`
}

func (WARPConnectorNewParams) MarshalJSON

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

type WARPConnectorNewResponse

type WARPConnectorNewResponse struct {
	// Cloudflare account ID
	AccountTag  string      `json:"account_tag"`
	Connections interface{} `json:"connections,required"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// UUID of the tunnel.
	ID       string      `json:"id" format:"uuid"`
	Metadata interface{} `json:"metadata,required"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// If `true`, the tunnel can be configured remotely from the Zero Trust dashboard.
	// If `false`, the tunnel must be configured locally on the origin machine.
	RemoteConfig bool `json:"remote_config"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorNewResponseTunType `json:"tun_type"`
	JSON    warpConnectorNewResponseJSON    `json:"-"`
	// contains filtered or unexported fields
}

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

func (WARPConnectorNewResponse) AsUnion

func (*WARPConnectorNewResponse) UnmarshalJSON

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

type WARPConnectorNewResponseEnvelope

type WARPConnectorNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
	Result WARPConnectorNewResponse `json:"result,required"`
	// Whether the API call was successful
	Success WARPConnectorNewResponseEnvelopeSuccess `json:"success,required"`
	JSON    warpConnectorNewResponseEnvelopeJSON    `json:"-"`
}

func (*WARPConnectorNewResponseEnvelope) UnmarshalJSON

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

type WARPConnectorNewResponseEnvelopeSuccess

type WARPConnectorNewResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	WARPConnectorNewResponseEnvelopeSuccessTrue WARPConnectorNewResponseEnvelopeSuccess = true
)

func (WARPConnectorNewResponseEnvelopeSuccess) IsKnown

type WARPConnectorNewResponseTunType

type WARPConnectorNewResponseTunType string

The type of tunnel.

const (
	WARPConnectorNewResponseTunTypeCfdTunnel     WARPConnectorNewResponseTunType = "cfd_tunnel"
	WARPConnectorNewResponseTunTypeWARPConnector WARPConnectorNewResponseTunType = "warp_connector"
	WARPConnectorNewResponseTunTypeIPSec         WARPConnectorNewResponseTunType = "ip_sec"
	WARPConnectorNewResponseTunTypeGRE           WARPConnectorNewResponseTunType = "gre"
	WARPConnectorNewResponseTunTypeCNI           WARPConnectorNewResponseTunType = "cni"
)

func (WARPConnectorNewResponseTunType) IsKnown

type WARPConnectorNewResponseTunnelWARPConnectorTunnel

type WARPConnectorNewResponseTunnelWARPConnectorTunnel struct {
	// UUID of the tunnel.
	ID string `json:"id" format:"uuid"`
	// Cloudflare account ID
	AccountTag string `json:"account_tag"`
	// The Cloudflare Tunnel connections between your origin and Cloudflare's edge.
	Connections []WARPConnectorNewResponseTunnelWARPConnectorTunnelConnection `json:"connections"`
	// Timestamp of when the tunnel established at least one connection to Cloudflare's
	// edge. If `null`, the tunnel is inactive.
	ConnsActiveAt time.Time `json:"conns_active_at" format:"date-time"`
	// Timestamp of when the tunnel became inactive (no connections to Cloudflare's
	// edge). If `null`, the tunnel is active.
	ConnsInactiveAt time.Time `json:"conns_inactive_at" format:"date-time"`
	// Timestamp of when the resource was created.
	CreatedAt time.Time `json:"created_at" format:"date-time"`
	// Timestamp of when the resource was deleted. If `null`, the resource has not been
	// deleted.
	DeletedAt time.Time `json:"deleted_at" format:"date-time"`
	// Metadata associated with the tunnel.
	Metadata interface{} `json:"metadata"`
	// A user-friendly name for a tunnel.
	Name string `json:"name"`
	// 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).
	Status string `json:"status"`
	// The type of tunnel.
	TunType WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType `json:"tun_type"`
	JSON    warpConnectorNewResponseTunnelWARPConnectorTunnelJSON    `json:"-"`
}

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

func (WARPConnectorNewResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorNewResponse

func (r WARPConnectorNewResponseTunnelWARPConnectorTunnel) ImplementsWARPConnectorWARPConnectorNewResponse()

func (*WARPConnectorNewResponseTunnelWARPConnectorTunnel) UnmarshalJSON

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

type WARPConnectorNewResponseTunnelWARPConnectorTunnelConnection

type WARPConnectorNewResponseTunnelWARPConnectorTunnelConnection struct {
	// UUID of the Cloudflare Tunnel connection.
	ID string `json:"id" format:"uuid"`
	// UUID of the Cloudflare Tunnel connector.
	ClientID string `json:"client_id" format:"uuid"`
	// The cloudflared version used to establish this connection.
	ClientVersion string `json:"client_version"`
	// The Cloudflare data center used for this connection.
	ColoName string `json:"colo_name"`
	// Cloudflare continues to track connections for several minutes after they
	// disconnect. This is an optimization to improve latency and reliability of
	// reconnecting. If `true`, the connection has disconnected but is still being
	// tracked. If `false`, the connection is actively serving traffic.
	IsPendingReconnect bool `json:"is_pending_reconnect"`
	// Timestamp of when the connection was established.
	OpenedAt time.Time `json:"opened_at" format:"date-time"`
	// The public IP address of the host running cloudflared.
	OriginIP string `json:"origin_ip"`
	// UUID of the Cloudflare Tunnel connection.
	UUID string                                                          `json:"uuid" format:"uuid"`
	JSON warpConnectorNewResponseTunnelWARPConnectorTunnelConnectionJSON `json:"-"`
}

func (*WARPConnectorNewResponseTunnelWARPConnectorTunnelConnection) UnmarshalJSON

type WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType

type WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType string

The type of tunnel.

const (
	WARPConnectorNewResponseTunnelWARPConnectorTunnelTunTypeCfdTunnel     WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType = "cfd_tunnel"
	WARPConnectorNewResponseTunnelWARPConnectorTunnelTunTypeWARPConnector WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType = "warp_connector"
	WARPConnectorNewResponseTunnelWARPConnectorTunnelTunTypeIPSec         WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType = "ip_sec"
	WARPConnectorNewResponseTunnelWARPConnectorTunnelTunTypeGRE           WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType = "gre"
	WARPConnectorNewResponseTunnelWARPConnectorTunnelTunTypeCNI           WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType = "cni"
)

func (WARPConnectorNewResponseTunnelWARPConnectorTunnelTunType) IsKnown

type WARPConnectorNewResponseUnion

type WARPConnectorNewResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorNewResponse()
}

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

Union satisfied by shared.CloudflareTunnel or warp_connector.WARPConnectorNewResponseTunnelWARPConnectorTunnel.

type WARPConnectorService

type WARPConnectorService struct {
	Options []option.RequestOption
}

WARPConnectorService 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 NewWARPConnectorService method instead.

func NewWARPConnectorService

func NewWARPConnectorService(opts ...option.RequestOption) (r *WARPConnectorService)

NewWARPConnectorService 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 (*WARPConnectorService) Delete

Deletes a Warp Connector Tunnel from an account.

func (*WARPConnectorService) Edit

Updates an existing Warp Connector Tunnel.

func (*WARPConnectorService) Get

Fetches a single Warp Connector Tunnel.

func (*WARPConnectorService) List

Lists and filters Warp Connector Tunnels in an account.

func (*WARPConnectorService) ListAutoPaging

Lists and filters Warp Connector Tunnels in an account.

func (*WARPConnectorService) New

Creates a new Warp Connector Tunnel in an account.

func (*WARPConnectorService) Token

Gets the token used to associate warp device with a specific Warp Connector tunnel.

type WARPConnectorTokenParams

type WARPConnectorTokenParams struct {
	// Cloudflare account ID
	AccountID param.Field[string] `path:"account_id,required"`
}

type WARPConnectorTokenResponseArray

type WARPConnectorTokenResponseArray []interface{}

func (WARPConnectorTokenResponseArray) ImplementsWARPConnectorWARPConnectorTokenResponseUnion

func (r WARPConnectorTokenResponseArray) ImplementsWARPConnectorWARPConnectorTokenResponseUnion()

type WARPConnectorTokenResponseEnvelope

type WARPConnectorTokenResponseEnvelope struct {
	Errors   []shared.ResponseInfo           `json:"errors,required"`
	Messages []shared.ResponseInfo           `json:"messages,required"`
	Result   WARPConnectorTokenResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success WARPConnectorTokenResponseEnvelopeSuccess `json:"success,required"`
	JSON    warpConnectorTokenResponseEnvelopeJSON    `json:"-"`
}

func (*WARPConnectorTokenResponseEnvelope) UnmarshalJSON

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

type WARPConnectorTokenResponseEnvelopeSuccess

type WARPConnectorTokenResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	WARPConnectorTokenResponseEnvelopeSuccessTrue WARPConnectorTokenResponseEnvelopeSuccess = true
)

func (WARPConnectorTokenResponseEnvelopeSuccess) IsKnown

type WARPConnectorTokenResponseUnion

type WARPConnectorTokenResponseUnion interface {
	ImplementsWARPConnectorWARPConnectorTokenResponseUnion()
}

Union satisfied by warp_connector.WARPConnectorTokenResponseUnknown, warp_connector.WARPConnectorTokenResponseArray or shared.UnionString.

Jump to

Keyboard shortcuts

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