Documentation ¶
Index ¶
- Constants
- type ASN
- type ASNParam
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CertificateCA
- type CertificateRequestType
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelStatus
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type ManagedHeaderEditParams
- type ManagedHeaderEditResponse
- type ManagedHeaderEditResponseManagedRequestHeader
- type ManagedHeaderEditResponseManagedResponseHeader
- type ManagedHeaderListResponse
- type ManagedHeaderService
- type MemberParam
- type MemberRoleParam
- type MemberRolesPermissionsParam
- type MemberStatus
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type RequestModel
- type RequestModelParam
- type ResponseInfo
- type Role
- type SortDirection
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 CertificateCADigicert = shared.CertificateCADigicert
This is an alias to an internal value.
const CertificateCAGoogle = shared.CertificateCAGoogle
This is an alias to an internal value.
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt
This is an alias to an internal value.
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate
This is an alias to an internal value.
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC
This is an alias to an internal value.
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA
This is an alias to an internal value.
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded
This is an alias to an internal value.
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown
This is an alias to an internal value.
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy
This is an alias to an internal value.
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive
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.
const MemberStatusAccepted = shared.MemberStatusAccepted
This is an alias to an internal value.
const MemberStatusPending = shared.MemberStatusPending
This is an alias to an internal value.
const SortDirectionAsc = shared.SortDirectionAsc
This is an alias to an internal value.
const SortDirectionDesc = shared.SortDirectionDesc
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 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 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 ManagedHeaderEditParams ¶
type ManagedHeaderEditParams struct { ManagedRequestHeaders param.Field[[]RequestModelParam] `json:"managed_request_headers,required"` ManagedResponseHeaders param.Field[[]RequestModelParam] `json:"managed_response_headers,required"` }
func (ManagedHeaderEditParams) MarshalJSON ¶
func (r ManagedHeaderEditParams) MarshalJSON() (data []byte, err error)
type ManagedHeaderEditResponse ¶
type ManagedHeaderEditResponse struct { ManagedRequestHeaders []ManagedHeaderEditResponseManagedRequestHeader `json:"managed_request_headers"` ManagedResponseHeaders []ManagedHeaderEditResponseManagedResponseHeader `json:"managed_response_headers"` JSON managedHeaderEditResponseJSON `json:"-"` }
func (*ManagedHeaderEditResponse) UnmarshalJSON ¶
func (r *ManagedHeaderEditResponse) UnmarshalJSON(data []byte) (err error)
type ManagedHeaderEditResponseManagedRequestHeader ¶
type ManagedHeaderEditResponseManagedRequestHeader struct { // Human-readable identifier of the Managed Transform. ID string `json:"id"` // When true, the Managed Transform is available in the current Cloudflare plan. Available bool `json:"available"` // When true, the Managed Transform is enabled. Enabled bool `json:"enabled"` JSON managedHeaderEditResponseManagedRequestHeaderJSON `json:"-"` }
func (*ManagedHeaderEditResponseManagedRequestHeader) UnmarshalJSON ¶
func (r *ManagedHeaderEditResponseManagedRequestHeader) UnmarshalJSON(data []byte) (err error)
type ManagedHeaderEditResponseManagedResponseHeader ¶
type ManagedHeaderEditResponseManagedResponseHeader struct { // Human-readable identifier of the Managed Transform. ID string `json:"id"` // When true, the Managed Transform is available in the current Cloudflare plan. Available bool `json:"available"` // When true, the Managed Transform is enabled. Enabled bool `json:"enabled"` JSON managedHeaderEditResponseManagedResponseHeaderJSON `json:"-"` }
func (*ManagedHeaderEditResponseManagedResponseHeader) UnmarshalJSON ¶
func (r *ManagedHeaderEditResponseManagedResponseHeader) UnmarshalJSON(data []byte) (err error)
type ManagedHeaderListResponse ¶
type ManagedHeaderListResponse struct { ManagedRequestHeaders []RequestModel `json:"managed_request_headers"` ManagedResponseHeaders []RequestModel `json:"managed_response_headers"` JSON managedHeaderListResponseJSON `json:"-"` }
func (*ManagedHeaderListResponse) UnmarshalJSON ¶
func (r *ManagedHeaderListResponse) UnmarshalJSON(data []byte) (err error)
type ManagedHeaderService ¶
type ManagedHeaderService struct {
Options []option.RequestOption
}
ManagedHeaderService contains methods and other services that help with interacting with the testcloudflare 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 NewManagedHeaderService method instead.
func NewManagedHeaderService ¶
func NewManagedHeaderService(opts ...option.RequestOption) (r *ManagedHeaderService)
NewManagedHeaderService 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 (*ManagedHeaderService) Edit ¶
func (r *ManagedHeaderService) Edit(ctx context.Context, zoneID string, body ManagedHeaderEditParams, opts ...option.RequestOption) (res *ManagedHeaderEditResponse, err error)
Updates the status of one or more Managed Transforms.
func (*ManagedHeaderService) List ¶
func (r *ManagedHeaderService) List(ctx context.Context, zoneID string, opts ...option.RequestOption) (res *ManagedHeaderListResponse, err error)
Fetches a list of all Managed Transforms.
type MemberRoleParam ¶
type MemberRoleParam = shared.MemberRoleParam
This is an alias to an internal type.
type MemberRolesPermissionsParam ¶
type MemberRolesPermissionsParam = shared.MemberRolesPermissionsParam
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 MemberUserParam ¶
type MemberUserParam = shared.MemberUserParam
Details of the user associated to the membership.
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 RequestModel ¶
type RequestModel struct { // Human-readable identifier of the Managed Transform. ID string `json:"id"` // When true, the Managed Transform is enabled. Enabled bool `json:"enabled"` JSON requestModelJSON `json:"-"` }
func (*RequestModel) UnmarshalJSON ¶
func (r *RequestModel) UnmarshalJSON(data []byte) (err error)
type RequestModelParam ¶
type RequestModelParam struct { // Human-readable identifier of the Managed Transform. ID param.Field[string] `json:"id"` // When true, the Managed Transform is enabled. Enabled param.Field[bool] `json:"enabled"` }
func (RequestModelParam) MarshalJSON ¶
func (r RequestModelParam) MarshalJSON() (data []byte, err error)
type SortDirection ¶
type SortDirection = shared.SortDirection
Direction to order DNS records in.
This is an alias to an internal type.