dcv_delegation

Documentation

Index

• Constants
• type AuditLog
• type AuditLogAction
• type AuditLogActor
• type AuditLogActorType
• type AuditLogOwner
• type AuditLogResource
• type CloudflareTunnel
• type CloudflareTunnelConnection
• type CloudflareTunnelTunType
• type DCVDelegationService
  • func NewDCVDelegationService(opts ...option.RequestOption) (r *DCVDelegationService)
• type DCVDelegationUUID
  • func (r *DCVDelegationUUID) UnmarshalJSON(data []byte) (err error)
• type Error
• type ErrorData
• type Permission
• type PermissionGrant
• type PermissionGrantParam
• type ResponseInfo
• type Role
• type UUIDGetParams
• type UUIDGetResponseEnvelope
  • func (r *UUIDGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
• type UUIDGetResponseEnvelopeSuccess
  • func (r UUIDGetResponseEnvelopeSuccess) IsKnown() bool
• type UUIDService
  • func NewUUIDService(opts ...option.RequestOption) (r *UUIDService)
  • func (r *UUIDService) Get(ctx context.Context, query UUIDGetParams, opts ...option.RequestOption) (res *DCVDelegationUUID, err error)
• type User
• type UserParam
• type UserRole
• type UserRoleParam
• type UserRolesPermissions
• type UserRolesPermissionsParam
• type UserUser
• type UserUserParam

Constants

const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Types

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 DCVDelegationService

type DCVDelegationService struct {
	Options []option.RequestOption
	UUID    *UUIDService
}

DCVDelegationService 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 NewDCVDelegationService method instead.

func NewDCVDelegationService

func NewDCVDelegationService(opts ...option.RequestOption) (r *DCVDelegationService)

NewDCVDelegationService 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 DCVDelegationUUID

type DCVDelegationUUID struct {
	// The DCV Delegation unique identifier.
	UUID string                `json:"uuid"`
	JSON dcvDelegationUUIDJSON `json:"-"`
}

func (*DCVDelegationUUID) UnmarshalJSON

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

type Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

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 UUIDGetParams

type UUIDGetParams struct {
	// Identifier
	ZoneID param.Field[string] `path:"zone_id,required"`
}

type UUIDGetResponseEnvelope

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

func (*UUIDGetResponseEnvelope) UnmarshalJSON

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

type UUIDGetResponseEnvelopeSuccess

type UUIDGetResponseEnvelopeSuccess bool

Whether the API call was successful

const (
	UUIDGetResponseEnvelopeSuccessTrue UUIDGetResponseEnvelopeSuccess = true
)

func (UUIDGetResponseEnvelopeSuccess) IsKnown

func (r UUIDGetResponseEnvelopeSuccess) IsKnown() bool

type UUIDService

type UUIDService struct {
	Options []option.RequestOption
}

UUIDService 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 NewUUIDService method instead.

func NewUUIDService

func NewUUIDService(opts ...option.RequestOption) (r *UUIDService)

NewUUIDService 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 (*UUIDService) Get

func (r *UUIDService) Get(ctx context.Context, query UUIDGetParams, opts ...option.RequestOption) (res *DCVDelegationUUID, err error)

Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation.

type User

type User = shared.User

This is an alias to an internal type.

type UserParam

type UserParam = shared.UserParam

This is an alias to an internal type.

type UserRole

type UserRole = shared.UserRole

This is an alias to an internal type.

type UserRoleParam

type UserRoleParam = shared.UserRoleParam

This is an alias to an internal type.

type UserRolesPermissions

type UserRolesPermissions = shared.UserRolesPermissions

This is an alias to an internal type.

type UserRolesPermissionsParam

type UserRolesPermissionsParam = shared.UserRolesPermissionsParam

This is an alias to an internal type.

type UserUser

type UserUser = shared.UserUser

This is an alias to an internal type.

type UserUserParam

type UserUserParam = shared.UserUserParam

This is an alias to an internal type.