Documentation
¶
Index ¶
- Constants
- type AuditLog
- type AuditLogAction
- type AuditLogActor
- type AuditLogActorType
- type AuditLogOwner
- type AuditLogResource
- type CloudflareTunnel
- type CloudflareTunnelConnection
- type CloudflareTunnelTunType
- type DurableObject
- type DurableObjectService
- type Error
- type ErrorData
- type Namespace
- type NamespaceListParams
- type NamespaceObjectListParams
- type NamespaceObjectService
- func (r *NamespaceObjectService) List(ctx context.Context, id string, params NamespaceObjectListParams, ...) (res *pagination.CursorLimitPagination[DurableObject], err error)
- func (r *NamespaceObjectService) ListAutoPaging(ctx context.Context, id string, params NamespaceObjectListParams, ...) *pagination.CursorLimitPaginationAutoPager[DurableObject]
- type NamespaceService
- func (r *NamespaceService) List(ctx context.Context, query NamespaceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Namespace], err error)
- func (r *NamespaceService) ListAutoPaging(ctx context.Context, query NamespaceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Namespace]
- type Permission
- type PermissionGrant
- type PermissionGrantParam
- type ResponseInfo
- type Role
- 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 DurableObject ¶
type DurableObject struct {
// ID of the Durable Object.
ID string `json:"id"`
// Whether the Durable Object has stored data.
HasStoredData bool `json:"hasStoredData"`
JSON durableObjectJSON `json:"-"`
}
func (*DurableObject) UnmarshalJSON ¶
func (r *DurableObject) UnmarshalJSON(data []byte) (err error)
type DurableObjectService ¶
type DurableObjectService struct {
Options []option.RequestOption
Namespaces *NamespaceService
}
DurableObjectService 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 NewDurableObjectService method instead.
func NewDurableObjectService ¶
func NewDurableObjectService(opts ...option.RequestOption) (r *DurableObjectService)
NewDurableObjectService 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 Namespace ¶
type Namespace struct {
ID interface{} `json:"id"`
Class interface{} `json:"class"`
Name interface{} `json:"name"`
Script interface{} `json:"script"`
JSON namespaceJSON `json:"-"`
}
func (*Namespace) UnmarshalJSON ¶
type NamespaceListParams ¶
type NamespaceObjectListParams ¶
type NamespaceObjectListParams struct {
// Identifier
AccountID param.Field[string] `path:"account_id,required"`
// Opaque token indicating the position from which to continue when requesting the
// next set of records. A valid value for the cursor can be obtained from the
// cursors object in the result_info structure.
Cursor param.Field[string] `query:"cursor"`
// The number of objects to return. The cursor attribute may be used to iterate
// over the next batch of objects if there are more than the limit.
Limit param.Field[float64] `query:"limit"`
}
func (NamespaceObjectListParams) URLQuery ¶
func (r NamespaceObjectListParams) URLQuery() (v url.Values)
URLQuery serializes NamespaceObjectListParams's query parameters as `url.Values`.
type NamespaceObjectService ¶
type NamespaceObjectService struct {
Options []option.RequestOption
}
NamespaceObjectService 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 NewNamespaceObjectService method instead.
func NewNamespaceObjectService ¶
func NewNamespaceObjectService(opts ...option.RequestOption) (r *NamespaceObjectService)
NewNamespaceObjectService 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 (*NamespaceObjectService) List ¶
func (r *NamespaceObjectService) List(ctx context.Context, id string, params NamespaceObjectListParams, opts ...option.RequestOption) (res *pagination.CursorLimitPagination[DurableObject], err error)
Returns the Durable Objects in a given namespace.
func (*NamespaceObjectService) ListAutoPaging ¶
func (r *NamespaceObjectService) ListAutoPaging(ctx context.Context, id string, params NamespaceObjectListParams, opts ...option.RequestOption) *pagination.CursorLimitPaginationAutoPager[DurableObject]
Returns the Durable Objects in a given namespace.
type NamespaceService ¶
type NamespaceService struct {
Options []option.RequestOption
Objects *NamespaceObjectService
}
NamespaceService 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 NewNamespaceService method instead.
func NewNamespaceService ¶
func NewNamespaceService(opts ...option.RequestOption) (r *NamespaceService)
NewNamespaceService 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 (*NamespaceService) List ¶
func (r *NamespaceService) List(ctx context.Context, query NamespaceListParams, opts ...option.RequestOption) (res *pagination.SinglePage[Namespace], err error)
Returns the Durable Object namespaces owned by an account.
func (*NamespaceService) ListAutoPaging ¶
func (r *NamespaceService) ListAutoPaging(ctx context.Context, query NamespaceListParams, opts ...option.RequestOption) *pagination.SinglePageAutoPager[Namespace]
Returns the Durable Object namespaces owned by an account.
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 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.