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 HostnameService
- type Member
- type MemberParam
- type MemberRole
- type MemberRoleParam
- type MemberRolesPermissions
- type MemberRolesPermissionsParam
- type MemberUser
- type MemberUserParam
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
- type Setting
- type SettingService
- type SettingTLSDeleteParams
- type SettingTLSDeleteParamsSettingID
- type SettingTLSDeleteResponse
- type SettingTLSDeleteResponseEnvelope
- type SettingTLSDeleteResponseEnvelopeSuccess
- type SettingTLSGetParams
- type SettingTLSGetParamsSettingID
- type SettingTLSGetResponse
- type SettingTLSGetResponseEnvelope
- type SettingTLSGetResponseEnvelopeResultInfo
- type SettingTLSGetResponseEnvelopeSuccess
- type SettingTLSService
- func (r *SettingTLSService) Delete(ctx context.Context, settingID SettingTLSDeleteParamsSettingID, ...) (res *SettingTLSDeleteResponse, err error)
- func (r *SettingTLSService) Get(ctx context.Context, settingID SettingTLSGetParamsSettingID, ...) (res *[]SettingTLSGetResponse, err error)
- func (r *SettingTLSService) Update(ctx context.Context, settingID SettingTLSUpdateParamsSettingID, ...) (res *Setting, err error)
- type SettingTLSUpdateParams
- type SettingTLSUpdateParamsSettingID
- type SettingTLSUpdateResponseEnvelope
- type SettingTLSUpdateResponseEnvelopeSuccess
- type SettingValueArray
- type SettingValueArrayParam
- type SettingValueUnion
- type SettingValueUnionParam
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 HostnameService ¶
type HostnameService struct { Options []option.RequestOption Settings *SettingService }
HostnameService 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 NewHostnameService method instead.
func NewHostnameService ¶
func NewHostnameService(opts ...option.RequestOption) (r *HostnameService)
NewHostnameService 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 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 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 Setting ¶
type Setting struct { // This is the time the tls setting was originally created for this hostname. CreatedAt time.Time `json:"created_at" format:"date-time"` // The hostname for which the tls settings are set. Hostname string `json:"hostname"` // Deployment status for the given tls setting. Status string `json:"status"` // This is the time the tls setting was updated. UpdatedAt time.Time `json:"updated_at" format:"date-time"` // The tls setting value. Value SettingValueUnion `json:"value"` JSON settingJSON `json:"-"` }
func (*Setting) UnmarshalJSON ¶
type SettingService ¶
type SettingService struct { Options []option.RequestOption TLS *SettingTLSService }
SettingService 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 NewSettingService method instead.
func NewSettingService ¶
func NewSettingService(opts ...option.RequestOption) (r *SettingService)
NewSettingService 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 SettingTLSDeleteParams ¶
type SettingTLSDeleteParamsSettingID ¶
type SettingTLSDeleteParamsSettingID string
The TLS Setting name.
const ( SettingTLSDeleteParamsSettingIDCiphers SettingTLSDeleteParamsSettingID = "ciphers" SettingTLSDeleteParamsSettingIDMinTLSVersion SettingTLSDeleteParamsSettingID = "min_tls_version" SettingTLSDeleteParamsSettingIDHTTP2 SettingTLSDeleteParamsSettingID = "http2" )
func (SettingTLSDeleteParamsSettingID) IsKnown ¶
func (r SettingTLSDeleteParamsSettingID) IsKnown() bool
type SettingTLSDeleteResponse ¶
type SettingTLSDeleteResponse struct { // This is the time the tls setting was originally created for this hostname. CreatedAt time.Time `json:"created_at" format:"date-time"` // The hostname for which the tls settings are set. Hostname string `json:"hostname"` Status string `json:"status"` // This is the time the tls setting was updated. UpdatedAt time.Time `json:"updated_at" format:"date-time"` Value string `json:"value"` JSON settingTLSDeleteResponseJSON `json:"-"` }
func (*SettingTLSDeleteResponse) UnmarshalJSON ¶
func (r *SettingTLSDeleteResponse) UnmarshalJSON(data []byte) (err error)
type SettingTLSDeleteResponseEnvelope ¶
type SettingTLSDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result SettingTLSDeleteResponse `json:"result,required"` // Whether the API call was successful Success SettingTLSDeleteResponseEnvelopeSuccess `json:"success,required"` JSON settingTLSDeleteResponseEnvelopeJSON `json:"-"` }
func (*SettingTLSDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SettingTLSDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingTLSDeleteResponseEnvelopeSuccess ¶
type SettingTLSDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SettingTLSDeleteResponseEnvelopeSuccessTrue SettingTLSDeleteResponseEnvelopeSuccess = true
)
func (SettingTLSDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SettingTLSDeleteResponseEnvelopeSuccess) IsKnown() bool
type SettingTLSGetParams ¶
type SettingTLSGetParamsSettingID ¶
type SettingTLSGetParamsSettingID string
The TLS Setting name.
const ( SettingTLSGetParamsSettingIDCiphers SettingTLSGetParamsSettingID = "ciphers" SettingTLSGetParamsSettingIDMinTLSVersion SettingTLSGetParamsSettingID = "min_tls_version" SettingTLSGetParamsSettingIDHTTP2 SettingTLSGetParamsSettingID = "http2" )
func (SettingTLSGetParamsSettingID) IsKnown ¶
func (r SettingTLSGetParamsSettingID) IsKnown() bool
type SettingTLSGetResponse ¶
type SettingTLSGetResponse struct { // This is the time the tls setting was originally created for this hostname. CreatedAt time.Time `json:"created_at" format:"date-time"` // The hostname for which the tls settings are set. Hostname string `json:"hostname"` // Deployment status for the given tls setting. Status string `json:"status"` // This is the time the tls setting was updated. UpdatedAt time.Time `json:"updated_at" format:"date-time"` // The tls setting value. Value SettingValueUnion `json:"value"` JSON settingTLSGetResponseJSON `json:"-"` }
func (*SettingTLSGetResponse) UnmarshalJSON ¶
func (r *SettingTLSGetResponse) UnmarshalJSON(data []byte) (err error)
type SettingTLSGetResponseEnvelope ¶
type SettingTLSGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result []SettingTLSGetResponse `json:"result,required,nullable"` // Whether the API call was successful Success SettingTLSGetResponseEnvelopeSuccess `json:"success,required"` ResultInfo SettingTLSGetResponseEnvelopeResultInfo `json:"result_info"` JSON settingTLSGetResponseEnvelopeJSON `json:"-"` }
func (*SettingTLSGetResponseEnvelope) UnmarshalJSON ¶
func (r *SettingTLSGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingTLSGetResponseEnvelopeResultInfo ¶
type SettingTLSGetResponseEnvelopeResultInfo struct { // Total number of results for the requested service Count float64 `json:"count"` // Current page within paginated list of results Page float64 `json:"page"` // Number of results per page of results PerPage float64 `json:"per_page"` // Total results available without any search parameters TotalCount float64 `json:"total_count"` // Total pages available of results TotalPages float64 `json:"total_pages"` JSON settingTLSGetResponseEnvelopeResultInfoJSON `json:"-"` }
func (*SettingTLSGetResponseEnvelopeResultInfo) UnmarshalJSON ¶
func (r *SettingTLSGetResponseEnvelopeResultInfo) UnmarshalJSON(data []byte) (err error)
type SettingTLSGetResponseEnvelopeSuccess ¶
type SettingTLSGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SettingTLSGetResponseEnvelopeSuccessTrue SettingTLSGetResponseEnvelopeSuccess = true
)
func (SettingTLSGetResponseEnvelopeSuccess) IsKnown ¶
func (r SettingTLSGetResponseEnvelopeSuccess) IsKnown() bool
type SettingTLSService ¶
type SettingTLSService struct {
Options []option.RequestOption
}
SettingTLSService 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 NewSettingTLSService method instead.
func NewSettingTLSService ¶
func NewSettingTLSService(opts ...option.RequestOption) (r *SettingTLSService)
NewSettingTLSService 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 (*SettingTLSService) Delete ¶
func (r *SettingTLSService) Delete(ctx context.Context, settingID SettingTLSDeleteParamsSettingID, hostname string, body SettingTLSDeleteParams, opts ...option.RequestOption) (res *SettingTLSDeleteResponse, err error)
Delete the tls setting value for the hostname.
func (*SettingTLSService) Get ¶
func (r *SettingTLSService) Get(ctx context.Context, settingID SettingTLSGetParamsSettingID, query SettingTLSGetParams, opts ...option.RequestOption) (res *[]SettingTLSGetResponse, err error)
List the requested TLS setting for the hostnames under this zone.
func (*SettingTLSService) Update ¶
func (r *SettingTLSService) Update(ctx context.Context, settingID SettingTLSUpdateParamsSettingID, hostname string, params SettingTLSUpdateParams, opts ...option.RequestOption) (res *Setting, err error)
Update the tls setting value for the hostname.
type SettingTLSUpdateParams ¶
type SettingTLSUpdateParams struct { // Identifier ZoneID param.Field[string] `path:"zone_id,required"` // The tls setting value. Value param.Field[SettingValueUnionParam] `json:"value,required"` }
func (SettingTLSUpdateParams) MarshalJSON ¶
func (r SettingTLSUpdateParams) MarshalJSON() (data []byte, err error)
type SettingTLSUpdateParamsSettingID ¶
type SettingTLSUpdateParamsSettingID string
The TLS Setting name.
const ( SettingTLSUpdateParamsSettingIDCiphers SettingTLSUpdateParamsSettingID = "ciphers" SettingTLSUpdateParamsSettingIDMinTLSVersion SettingTLSUpdateParamsSettingID = "min_tls_version" SettingTLSUpdateParamsSettingIDHTTP2 SettingTLSUpdateParamsSettingID = "http2" )
func (SettingTLSUpdateParamsSettingID) IsKnown ¶
func (r SettingTLSUpdateParamsSettingID) IsKnown() bool
type SettingTLSUpdateResponseEnvelope ¶
type SettingTLSUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result Setting `json:"result,required"` // Whether the API call was successful Success SettingTLSUpdateResponseEnvelopeSuccess `json:"success,required"` JSON settingTLSUpdateResponseEnvelopeJSON `json:"-"` }
func (*SettingTLSUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SettingTLSUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SettingTLSUpdateResponseEnvelopeSuccess ¶
type SettingTLSUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SettingTLSUpdateResponseEnvelopeSuccessTrue SettingTLSUpdateResponseEnvelopeSuccess = true
)
func (SettingTLSUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SettingTLSUpdateResponseEnvelopeSuccess) IsKnown() bool
type SettingValueArray ¶
type SettingValueArray []string
func (SettingValueArray) ImplementsHostnamesSettingValueUnion ¶
func (r SettingValueArray) ImplementsHostnamesSettingValueUnion()
type SettingValueArrayParam ¶
type SettingValueArrayParam []string
func (SettingValueArrayParam) ImplementsHostnamesSettingValueUnionParam ¶
func (r SettingValueArrayParam) ImplementsHostnamesSettingValueUnionParam()
type SettingValueUnion ¶
type SettingValueUnion interface {
ImplementsHostnamesSettingValueUnion()
}
The tls setting value.
Union satisfied by shared.UnionFloat, shared.UnionString or hostnames.SettingValueArray.
type SettingValueUnionParam ¶
type SettingValueUnionParam interface {
ImplementsHostnamesSettingValueUnionParam()
}
The tls setting value.
Satisfied by shared.UnionFloat, shared.UnionString, hostnames.SettingValueArrayParam.