Documentation
¶
Index ¶
- Constants
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type Error
- type ErrorData
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
- type URLNormalizationGetParams
- type URLNormalizationGetResponse
- type URLNormalizationService
- type URLNormalizationUpdateParams
- type URLNormalizationUpdateResponse
- 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.
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 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 URLNormalizationGetResponse ¶
type URLNormalizationGetResponse struct {
// The scope of the URL normalization.
Scope string `json:"scope"`
// The type of URL normalization performed by Cloudflare.
Type string `json:"type"`
JSON urlNormalizationGetResponseJSON `json:"-"`
}
func (*URLNormalizationGetResponse) UnmarshalJSON ¶
func (r *URLNormalizationGetResponse) UnmarshalJSON(data []byte) (err error)
type URLNormalizationService ¶
type URLNormalizationService struct {
Options []option.RequestOption
}
URLNormalizationService 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 NewURLNormalizationService method instead.
func NewURLNormalizationService ¶
func NewURLNormalizationService(opts ...option.RequestOption) (r *URLNormalizationService)
NewURLNormalizationService 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 (*URLNormalizationService) Get ¶
func (r *URLNormalizationService) Get(ctx context.Context, query URLNormalizationGetParams, opts ...option.RequestOption) (res *URLNormalizationGetResponse, err error)
Fetches the current URL normalization settings.
func (*URLNormalizationService) Update ¶
func (r *URLNormalizationService) Update(ctx context.Context, params URLNormalizationUpdateParams, opts ...option.RequestOption) (res *URLNormalizationUpdateResponse, err error)
Updates the URL normalization settings.
type URLNormalizationUpdateParams ¶
type URLNormalizationUpdateParams struct {
// Identifier
ZoneID param.Field[string] `path:"zone_id,required"`
// The scope of the URL normalization.
Scope param.Field[string] `json:"scope"`
// The type of URL normalization performed by Cloudflare.
Type param.Field[string] `json:"type"`
}
func (URLNormalizationUpdateParams) MarshalJSON ¶
func (r URLNormalizationUpdateParams) MarshalJSON() (data []byte, err error)
type URLNormalizationUpdateResponse ¶
type URLNormalizationUpdateResponse struct {
// The scope of the URL normalization.
Scope string `json:"scope"`
// The type of URL normalization performed by Cloudflare.
Type string `json:"type"`
JSON urlNormalizationUpdateResponseJSON `json:"-"`
}
func (*URLNormalizationUpdateResponse) UnmarshalJSON ¶
func (r *URLNormalizationUpdateResponse) UnmarshalJSON(data []byte) (err error)
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 UserUserParam ¶
type UserUserParam = shared.UserUserParam
This is an alias to an internal type.