Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type OriginPostQuantumEncryptionGetParams
- type OriginPostQuantumEncryptionGetResponseEnvelope
- type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess
- type OriginPostQuantumEncryptionGetResponseUnion
- type OriginPostQuantumEncryptionService
- func (r *OriginPostQuantumEncryptionService) Get(ctx context.Context, query OriginPostQuantumEncryptionGetParams, ...) (res *OriginPostQuantumEncryptionGetResponseUnion, err error)
- func (r *OriginPostQuantumEncryptionService) Update(ctx context.Context, params OriginPostQuantumEncryptionUpdateParams, ...) (res *OriginPostQuantumEncryptionUpdateResponseUnion, err error)
- type OriginPostQuantumEncryptionUpdateParams
- type OriginPostQuantumEncryptionUpdateParamsValue
- type OriginPostQuantumEncryptionUpdateResponseEnvelope
- type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess
- type OriginPostQuantumEncryptionUpdateResponseUnion
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
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.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditLogAction ¶
type AuditLogAction = shared.AuditLogAction
This is an alias to an internal type.
type AuditLogActor ¶
type AuditLogActor = shared.AuditLogActor
This is an alias to an internal type.
type AuditLogActorType ¶
type AuditLogActorType = shared.AuditLogActorType
The type of actor, whether a User, Cloudflare Admin, or an Automated System.
This is an alias to an internal type.
type AuditLogOwner ¶
type AuditLogOwner = shared.AuditLogOwner
This is an alias to an internal type.
type AuditLogResource ¶
type AuditLogResource = shared.AuditLogResource
This is an alias to an internal type.
type 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 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 OriginPostQuantumEncryptionGetResponseEnvelope ¶
type OriginPostQuantumEncryptionGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result OriginPostQuantumEncryptionGetResponseUnion `json:"result,required"` // Whether the API call was successful Success OriginPostQuantumEncryptionGetResponseEnvelopeSuccess `json:"success,required"` JSON originPostQuantumEncryptionGetResponseEnvelopeJSON `json:"-"` }
func (*OriginPostQuantumEncryptionGetResponseEnvelope) UnmarshalJSON ¶
func (r *OriginPostQuantumEncryptionGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess ¶
type OriginPostQuantumEncryptionGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
OriginPostQuantumEncryptionGetResponseEnvelopeSuccessTrue OriginPostQuantumEncryptionGetResponseEnvelopeSuccess = true
)
func (OriginPostQuantumEncryptionGetResponseEnvelopeSuccess) IsKnown ¶
func (r OriginPostQuantumEncryptionGetResponseEnvelopeSuccess) IsKnown() bool
type OriginPostQuantumEncryptionGetResponseUnion ¶
type OriginPostQuantumEncryptionGetResponseUnion interface {
ImplementsOriginPostQuantumEncryptionOriginPostQuantumEncryptionGetResponseUnion()
}
Union satisfied by origin_post_quantum_encryption.OriginPostQuantumEncryptionGetResponseUnknown or shared.UnionString.
type OriginPostQuantumEncryptionService ¶
type OriginPostQuantumEncryptionService struct {
Options []option.RequestOption
}
OriginPostQuantumEncryptionService 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 NewOriginPostQuantumEncryptionService method instead.
func NewOriginPostQuantumEncryptionService ¶
func NewOriginPostQuantumEncryptionService(opts ...option.RequestOption) (r *OriginPostQuantumEncryptionService)
NewOriginPostQuantumEncryptionService 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 (*OriginPostQuantumEncryptionService) Get ¶
func (r *OriginPostQuantumEncryptionService) Get(ctx context.Context, query OriginPostQuantumEncryptionGetParams, opts ...option.RequestOption) (res *OriginPostQuantumEncryptionGetResponseUnion, err error)
Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised
func (*OriginPostQuantumEncryptionService) Update ¶
func (r *OriginPostQuantumEncryptionService) Update(ctx context.Context, params OriginPostQuantumEncryptionUpdateParams, opts ...option.RequestOption) (res *OriginPostQuantumEncryptionUpdateResponseUnion, err error)
Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised
type OriginPostQuantumEncryptionUpdateParams ¶
type OriginPostQuantumEncryptionUpdateParams struct { // Identifier ZoneID param.Field[string] `path:"zone_id,required"` // Value of the Origin Post Quantum Encryption Setting. Value param.Field[OriginPostQuantumEncryptionUpdateParamsValue] `json:"value,required"` }
func (OriginPostQuantumEncryptionUpdateParams) MarshalJSON ¶
func (r OriginPostQuantumEncryptionUpdateParams) MarshalJSON() (data []byte, err error)
type OriginPostQuantumEncryptionUpdateParamsValue ¶
type OriginPostQuantumEncryptionUpdateParamsValue string
Value of the Origin Post Quantum Encryption Setting.
const ( OriginPostQuantumEncryptionUpdateParamsValuePreferred OriginPostQuantumEncryptionUpdateParamsValue = "preferred" OriginPostQuantumEncryptionUpdateParamsValueSupported OriginPostQuantumEncryptionUpdateParamsValue = "supported" OriginPostQuantumEncryptionUpdateParamsValueOff OriginPostQuantumEncryptionUpdateParamsValue = "off" )
func (OriginPostQuantumEncryptionUpdateParamsValue) IsKnown ¶
func (r OriginPostQuantumEncryptionUpdateParamsValue) IsKnown() bool
type OriginPostQuantumEncryptionUpdateResponseEnvelope ¶
type OriginPostQuantumEncryptionUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result OriginPostQuantumEncryptionUpdateResponseUnion `json:"result,required"` // Whether the API call was successful Success OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess `json:"success,required"` JSON originPostQuantumEncryptionUpdateResponseEnvelopeJSON `json:"-"` }
func (*OriginPostQuantumEncryptionUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *OriginPostQuantumEncryptionUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess ¶
type OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccessTrue OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess = true
)
func (OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r OriginPostQuantumEncryptionUpdateResponseEnvelopeSuccess) IsKnown() bool
type OriginPostQuantumEncryptionUpdateResponseUnion ¶
type OriginPostQuantumEncryptionUpdateResponseUnion interface {
ImplementsOriginPostQuantumEncryptionOriginPostQuantumEncryptionUpdateResponseUnion()
}
Union satisfied by origin_post_quantum_encryption.OriginPostQuantumEncryptionUpdateResponseUnknown or shared.UnionString.
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.