durable_objects

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 DurableObject
  • func (r *DurableObject) UnmarshalJSON(data []byte) (err error)
• type DurableObjectService
  • func NewDurableObjectService(opts ...option.RequestOption) (r *DurableObjectService)
• type Error
• type ErrorData
• type MemberParam
• type MemberRoleParam
• type MemberRolesPermissionsParam
• type MemberStatus
• type MemberUserParam
• type Namespace
  • func (r *Namespace) UnmarshalJSON(data []byte) (err error)
• type NamespaceListParams
• type NamespaceObjectListParams
  • func (r NamespaceObjectListParams) URLQuery() (v url.Values)
• type NamespaceObjectService
  • func NewNamespaceObjectService(opts ...option.RequestOption) (r *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 NewNamespaceService(opts ...option.RequestOption) (r *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 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.

Types

type ASN

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam

type ASNParam = shared.ASNParam

This is an alias to an internal type.

type AuditLog

type AuditLog = shared.AuditLog

This is an alias to an internal type.

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 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 Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type MemberParam

type MemberParam = shared.MemberParam

This is an alias to an internal type.

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 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

func (r *Namespace) UnmarshalJSON(data []byte) (err error)

type NamespaceListParams

type NamespaceListParams struct {
	// Identifier
	AccountID param.Field[string] `path:"account_id,required"`
}

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 Permission

type Permission = shared.Permission

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 ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type SortDirection

type SortDirection = shared.SortDirection

Direction to order DNS records in.

This is an alias to an internal type.