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 ContentService
- type Error
- type ErrorData
- 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 RuleListResponse
- type RuleService
- func (r *RuleService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)
- func (r *RuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]
- func (r *RuleService) Update(ctx context.Context, zoneIdentifier string, body RuleUpdateParams, ...) (res *[]RuleUpdateResponse, err error)
- type RuleUpdateParams
- type RuleUpdateParamsRule
- type RuleUpdateResponse
- type RuleUpdateResponseEnvelope
- type RuleUpdateResponseEnvelopeSuccess
- type Snippet
- type SnippetDeleteResponseArray
- type SnippetDeleteResponseEnvelope
- type SnippetDeleteResponseEnvelopeSuccess
- type SnippetDeleteResponseUnion
- type SnippetGetResponseEnvelope
- type SnippetGetResponseEnvelopeSuccess
- type SnippetService
- func (r *SnippetService) Delete(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *SnippetDeleteResponseUnion, err error)
- func (r *SnippetService) Get(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *Snippet, err error)
- func (r *SnippetService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[Snippet], err error)
- func (r *SnippetService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Snippet]
- func (r *SnippetService) Update(ctx context.Context, zoneIdentifier string, snippetName string, ...) (res *Snippet, err error)
- type SnippetUpdateParams
- type SnippetUpdateParamsMetadata
- type SnippetUpdateResponseEnvelope
- type SnippetUpdateResponseEnvelopeSuccess
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 ContentService ¶
type ContentService struct {
Options []option.RequestOption
}
ContentService 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 NewContentService method instead.
func NewContentService ¶
func NewContentService(opts ...option.RequestOption) (r *ContentService)
NewContentService 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 RuleListResponse ¶
type RuleListResponse struct { Description string `json:"description"` Enabled bool `json:"enabled"` Expression string `json:"expression"` // Snippet identifying name SnippetName string `json:"snippet_name"` JSON ruleListResponseJSON `json:"-"` }
func (*RuleListResponse) UnmarshalJSON ¶
func (r *RuleListResponse) UnmarshalJSON(data []byte) (err error)
type RuleService ¶
type RuleService struct {
Options []option.RequestOption
}
RuleService 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 NewRuleService method instead.
func NewRuleService ¶
func NewRuleService(opts ...option.RequestOption) (r *RuleService)
NewRuleService 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 (*RuleService) List ¶
func (r *RuleService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[RuleListResponse], err error)
Rules
func (*RuleService) ListAutoPaging ¶
func (r *RuleService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[RuleListResponse]
Rules
func (*RuleService) Update ¶
func (r *RuleService) Update(ctx context.Context, zoneIdentifier string, body RuleUpdateParams, opts ...option.RequestOption) (res *[]RuleUpdateResponse, err error)
Put Rules
type RuleUpdateParams ¶
type RuleUpdateParams struct { // List of snippet rules Rules param.Field[[]RuleUpdateParamsRule] `json:"rules"` }
func (RuleUpdateParams) MarshalJSON ¶
func (r RuleUpdateParams) MarshalJSON() (data []byte, err error)
type RuleUpdateParamsRule ¶
type RuleUpdateParamsRule struct { Description param.Field[string] `json:"description"` Enabled param.Field[bool] `json:"enabled"` Expression param.Field[string] `json:"expression"` // Snippet identifying name SnippetName param.Field[string] `json:"snippet_name"` }
func (RuleUpdateParamsRule) MarshalJSON ¶
func (r RuleUpdateParamsRule) MarshalJSON() (data []byte, err error)
type RuleUpdateResponse ¶
type RuleUpdateResponse struct { Description string `json:"description"` Enabled bool `json:"enabled"` Expression string `json:"expression"` // Snippet identifying name SnippetName string `json:"snippet_name"` JSON ruleUpdateResponseJSON `json:"-"` }
func (*RuleUpdateResponse) UnmarshalJSON ¶
func (r *RuleUpdateResponse) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelope ¶
type RuleUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // List of snippet rules Result []RuleUpdateResponse `json:"result,required"` // Whether the API call was successful Success RuleUpdateResponseEnvelopeSuccess `json:"success,required"` JSON ruleUpdateResponseEnvelopeJSON `json:"-"` }
func (*RuleUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *RuleUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type RuleUpdateResponseEnvelopeSuccess ¶
type RuleUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
RuleUpdateResponseEnvelopeSuccessTrue RuleUpdateResponseEnvelopeSuccess = true
)
func (RuleUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r RuleUpdateResponseEnvelopeSuccess) IsKnown() bool
type Snippet ¶
type Snippet struct { // Creation time of the snippet CreatedOn string `json:"created_on"` // Modification time of the snippet ModifiedOn string `json:"modified_on"` // Snippet identifying name SnippetName string `json:"snippet_name"` JSON snippetJSON `json:"-"` }
Snippet Information
func (*Snippet) UnmarshalJSON ¶
type SnippetDeleteResponseArray ¶
type SnippetDeleteResponseArray []interface{}
func (SnippetDeleteResponseArray) ImplementsSnippetsSnippetDeleteResponseUnion ¶
func (r SnippetDeleteResponseArray) ImplementsSnippetsSnippetDeleteResponseUnion()
type SnippetDeleteResponseEnvelope ¶
type SnippetDeleteResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` Result SnippetDeleteResponseUnion `json:"result,required"` // Whether the API call was successful Success SnippetDeleteResponseEnvelopeSuccess `json:"success,required"` JSON snippetDeleteResponseEnvelopeJSON `json:"-"` }
func (*SnippetDeleteResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetDeleteResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetDeleteResponseEnvelopeSuccess ¶
type SnippetDeleteResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetDeleteResponseEnvelopeSuccessTrue SnippetDeleteResponseEnvelopeSuccess = true
)
func (SnippetDeleteResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetDeleteResponseEnvelopeSuccess) IsKnown() bool
type SnippetDeleteResponseUnion ¶
type SnippetDeleteResponseUnion interface {
ImplementsSnippetsSnippetDeleteResponseUnion()
}
Union satisfied by snippets.SnippetDeleteResponseUnknown, snippets.SnippetDeleteResponseArray or shared.UnionString.
type SnippetGetResponseEnvelope ¶
type SnippetGetResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Snippet Information Result Snippet `json:"result,required"` // Whether the API call was successful Success SnippetGetResponseEnvelopeSuccess `json:"success,required"` JSON snippetGetResponseEnvelopeJSON `json:"-"` }
func (*SnippetGetResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetGetResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetGetResponseEnvelopeSuccess ¶
type SnippetGetResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetGetResponseEnvelopeSuccessTrue SnippetGetResponseEnvelopeSuccess = true
)
func (SnippetGetResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetGetResponseEnvelopeSuccess) IsKnown() bool
type SnippetService ¶
type SnippetService struct { Options []option.RequestOption Content *ContentService Rules *RuleService }
SnippetService 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 NewSnippetService method instead.
func NewSnippetService ¶
func NewSnippetService(opts ...option.RequestOption) (r *SnippetService)
NewSnippetService 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 (*SnippetService) Delete ¶
func (r *SnippetService) Delete(ctx context.Context, zoneIdentifier string, snippetName string, opts ...option.RequestOption) (res *SnippetDeleteResponseUnion, err error)
Delete Snippet
func (*SnippetService) Get ¶
func (r *SnippetService) Get(ctx context.Context, zoneIdentifier string, snippetName string, opts ...option.RequestOption) (res *Snippet, err error)
Snippet
func (*SnippetService) List ¶
func (r *SnippetService) List(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) (res *pagination.SinglePage[Snippet], err error)
All Snippets
func (*SnippetService) ListAutoPaging ¶
func (r *SnippetService) ListAutoPaging(ctx context.Context, zoneIdentifier string, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Snippet]
All Snippets
func (*SnippetService) Update ¶
func (r *SnippetService) Update(ctx context.Context, zoneIdentifier string, snippetName string, body SnippetUpdateParams, opts ...option.RequestOption) (res *Snippet, err error)
Put Snippet
type SnippetUpdateParams ¶
type SnippetUpdateParams struct { // Content files of uploaded snippet Files param.Field[string] `json:"files"` Metadata param.Field[SnippetUpdateParamsMetadata] `json:"metadata"` }
func (SnippetUpdateParams) MarshalJSON ¶
func (r SnippetUpdateParams) MarshalJSON() (data []byte, err error)
type SnippetUpdateParamsMetadata ¶
type SnippetUpdateParamsMetadata struct { // Main module name of uploaded snippet MainModule param.Field[string] `json:"main_module"` }
func (SnippetUpdateParamsMetadata) MarshalJSON ¶
func (r SnippetUpdateParamsMetadata) MarshalJSON() (data []byte, err error)
type SnippetUpdateResponseEnvelope ¶
type SnippetUpdateResponseEnvelope struct { Errors []shared.ResponseInfo `json:"errors,required"` Messages []shared.ResponseInfo `json:"messages,required"` // Snippet Information Result Snippet `json:"result,required"` // Whether the API call was successful Success SnippetUpdateResponseEnvelopeSuccess `json:"success,required"` JSON snippetUpdateResponseEnvelopeJSON `json:"-"` }
func (*SnippetUpdateResponseEnvelope) UnmarshalJSON ¶
func (r *SnippetUpdateResponseEnvelope) UnmarshalJSON(data []byte) (err error)
type SnippetUpdateResponseEnvelopeSuccess ¶
type SnippetUpdateResponseEnvelopeSuccess bool
Whether the API call was successful
const (
SnippetUpdateResponseEnvelopeSuccessTrue SnippetUpdateResponseEnvelopeSuccess = true
)
func (SnippetUpdateResponseEnvelopeSuccess) IsKnown ¶
func (r SnippetUpdateResponseEnvelopeSuccess) IsKnown() bool