kv

package
v4.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2025 License: Apache-2.0 Imports: 15 Imported by: 2

Documentation

Index

Constants

View Source
const AuditLogActorTypeAdmin = shared.AuditLogActorTypeAdmin

This is an alias to an internal value.

View Source
const AuditLogActorTypeCloudflare = shared.AuditLogActorTypeCloudflare

This is an alias to an internal value.

View Source
const AuditLogActorTypeUser = shared.AuditLogActorTypeUser

This is an alias to an internal value.

View Source
const CertificateCADigicert = shared.CertificateCADigicert

This is an alias to an internal value.

View Source
const CertificateCAGoogle = shared.CertificateCAGoogle

This is an alias to an internal value.

View Source
const CertificateCALetsEncrypt = shared.CertificateCALetsEncrypt

This is an alias to an internal value.

View Source
const CertificateCASSLCom = shared.CertificateCASSLCom

This is an alias to an internal value.

View Source
const CertificateRequestTypeKeylessCertificate = shared.CertificateRequestTypeKeylessCertificate

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginECC = shared.CertificateRequestTypeOriginECC

This is an alias to an internal value.

View Source
const CertificateRequestTypeOriginRSA = shared.CertificateRequestTypeOriginRSA

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDegraded = shared.CloudflareTunnelStatusDegraded

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusDown = shared.CloudflareTunnelStatusDown

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusHealthy = shared.CloudflareTunnelStatusHealthy

This is an alias to an internal value.

View Source
const CloudflareTunnelStatusInactive = shared.CloudflareTunnelStatusInactive

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCNI = shared.CloudflareTunnelTunTypeCNI

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeCfdTunnel = shared.CloudflareTunnelTunTypeCfdTunnel

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeGRE = shared.CloudflareTunnelTunTypeGRE

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeIPSec = shared.CloudflareTunnelTunTypeIPSec

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeMagic = shared.CloudflareTunnelTunTypeMagic

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARP = shared.CloudflareTunnelTunTypeWARP

This is an alias to an internal value.

View Source
const CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

View Source
const MemberPoliciesAccessAllow = shared.MemberPoliciesAccessAllow

This is an alias to an internal value.

View Source
const MemberPoliciesAccessDeny = shared.MemberPoliciesAccessDeny

This is an alias to an internal value.

View Source
const MemberStatusAccepted = shared.MemberStatusAccepted

This is an alias to an internal value.

View Source
const MemberStatusPending = shared.MemberStatusPending

This is an alias to an internal value.

View Source
const RatePlanIDBusiness = shared.RatePlanIDBusiness

This is an alias to an internal value.

View Source
const RatePlanIDEnterprise = shared.RatePlanIDEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDFree = shared.RatePlanIDFree

This is an alias to an internal value.

View Source
const RatePlanIDLite = shared.RatePlanIDLite

This is an alias to an internal value.

View Source
const RatePlanIDPartnersBusiness = shared.RatePlanIDPartnersBusiness

This is an alias to an internal value.

View Source
const RatePlanIDPartnersEnterprise = shared.RatePlanIDPartnersEnterprise

This is an alias to an internal value.

View Source
const RatePlanIDPartnersFree = shared.RatePlanIDPartnersFree

This is an alias to an internal value.

View Source
const RatePlanIDPartnersPro = shared.RatePlanIDPartnersPro

This is an alias to an internal value.

View Source
const RatePlanIDPro = shared.RatePlanIDPro

This is an alias to an internal value.

View Source
const RatePlanIDProPlus = shared.RatePlanIDProPlus

This is an alias to an internal value.

View Source
const SortDirectionAsc = shared.SortDirectionAsc

This is an alias to an internal value.

View Source
const SortDirectionDesc = shared.SortDirectionDesc

This is an alias to an internal value.

View Source
const SubscriptionFrequencyMonthly = shared.SubscriptionFrequencyMonthly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyQuarterly = shared.SubscriptionFrequencyQuarterly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyWeekly = shared.SubscriptionFrequencyWeekly

This is an alias to an internal value.

View Source
const SubscriptionFrequencyYearly = shared.SubscriptionFrequencyYearly

This is an alias to an internal value.

View Source
const SubscriptionStateAwaitingPayment = shared.SubscriptionStateAwaitingPayment

This is an alias to an internal value.

View Source
const SubscriptionStateCancelled = shared.SubscriptionStateCancelled

This is an alias to an internal value.

View Source
const SubscriptionStateExpired = shared.SubscriptionStateExpired

This is an alias to an internal value.

View Source
const SubscriptionStateFailed = shared.SubscriptionStateFailed

This is an alias to an internal value.

View Source
const SubscriptionStatePaid = shared.SubscriptionStatePaid

This is an alias to an internal value.

View Source
const SubscriptionStateProvisioned = shared.SubscriptionStateProvisioned

This is an alias to an internal value.

View Source
const SubscriptionStateTrial = shared.SubscriptionStateTrial

This is an alias to an internal value.

View Source
const TokenPolicyEffectAllow = shared.TokenPolicyEffectAllow

This is an alias to an internal value.

View Source
const TokenPolicyEffectDeny = shared.TokenPolicyEffectDeny

This is an alias to an internal value.

View Source
const TokenStatusActive = shared.TokenStatusActive

This is an alias to an internal value.

View Source
const TokenStatusDisabled = shared.TokenStatusDisabled

This is an alias to an internal value.

View Source
const TokenStatusExpired = shared.TokenStatusExpired

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

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 Error

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

This is an alias to an internal type.

type ErrorDataSource added in v4.2.0

type ErrorDataSource = shared.ErrorDataSource

This is an alias to an internal type.

type KVService

type KVService struct {
	Options    []option.RequestOption
	Namespaces *NamespaceService
}

KVService 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 NewKVService method instead.

func NewKVService

func NewKVService(opts ...option.RequestOption) (r *KVService)

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

type Key struct {
	// A key's name. The name may be at most 512 bytes. All printable, non-whitespace
	// characters are valid. Use percent-encoding to define key names as part of a URL.
	Name string `json:"name,required"`
	// The time, measured in number of seconds since the UNIX epoch, at which the key
	// will expire. This property is omitted for keys that will not expire.
	Expiration float64     `json:"expiration"`
	Metadata   interface{} `json:"metadata"`
	JSON       keyJSON     `json:"-"`
}

A name for a value. A value stored under a given key may be retrieved via the same key.

func (*Key) UnmarshalJSON

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

type Member

type Member = shared.Member

This is an alias to an internal type.

type MemberPoliciesAccess

type MemberPoliciesAccess = shared.MemberPoliciesAccess

Allow or deny operations against the resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroup

type MemberPoliciesPermissionGroup = shared.MemberPoliciesPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type MemberPoliciesPermissionGroupsMeta

type MemberPoliciesPermissionGroupsMeta = shared.MemberPoliciesPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type MemberPoliciesResourceGroup

type MemberPoliciesResourceGroup = shared.MemberPoliciesResourceGroup

A group of scoped resources.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsMeta

type MemberPoliciesResourceGroupsMeta = shared.MemberPoliciesResourceGroupsMeta

Attributes associated to the resource group.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScope

type MemberPoliciesResourceGroupsScope = shared.MemberPoliciesResourceGroupsScope

A scope is a combination of scope objects which provides additional context.

This is an alias to an internal type.

type MemberPoliciesResourceGroupsScopeObject

type MemberPoliciesResourceGroupsScopeObject = shared.MemberPoliciesResourceGroupsScopeObject

A scope object represents any resource that can have actions applied against invite.

This is an alias to an internal type.

type MemberPolicy

type MemberPolicy = shared.MemberPolicy

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 MemberUser

type MemberUser = shared.MemberUser

Details of the user associated to the membership.

This is an alias to an internal type.

type Namespace

type Namespace struct {
	// Namespace identifier tag.
	ID string `json:"id,required"`
	// A human-readable string name for a Namespace.
	Title string `json:"title,required"`
	// True if new beta namespace, with additional preview features.
	Beta bool `json:"beta"`
	// True if keys written on the URL will be URL-decoded before storing. For example,
	// if set to "true", a key written on the URL as "%3F" will be stored as "?".
	SupportsURLEncoding bool          `json:"supports_url_encoding"`
	JSON                namespaceJSON `json:"-"`
}

func (*Namespace) UnmarshalJSON

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

type NamespaceBulkDeleteParams

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

func (NamespaceBulkDeleteParams) MarshalJSON

func (r NamespaceBulkDeleteParams) MarshalJSON() (data []byte, err error)

type NamespaceBulkDeleteResponse

type NamespaceBulkDeleteResponse struct {
	// Number of keys successfully updated.
	SuccessfulKeyCount float64 `json:"successful_key_count"`
	// Name of the keys that failed to be fully updated. They should be retried.
	UnsuccessfulKeys []string                        `json:"unsuccessful_keys"`
	JSON             namespaceBulkDeleteResponseJSON `json:"-"`
}

func (*NamespaceBulkDeleteResponse) UnmarshalJSON

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

type NamespaceBulkDeleteResponseEnvelope

type NamespaceBulkDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceBulkDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceBulkDeleteResponse                `json:"result,nullable"`
	JSON    namespaceBulkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceBulkDeleteResponseEnvelope) UnmarshalJSON

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

type NamespaceBulkDeleteResponseEnvelopeSuccess

type NamespaceBulkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceBulkDeleteResponseEnvelopeSuccessTrue NamespaceBulkDeleteResponseEnvelopeSuccess = true
)

func (NamespaceBulkDeleteResponseEnvelopeSuccess) IsKnown

type NamespaceBulkGetParams added in v4.5.0

type NamespaceBulkGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Array of keys to retrieve (maximum of 100).
	Keys param.Field[[]string] `json:"keys,required"`
	// Whether to parse JSON values in the response.
	Type param.Field[NamespaceBulkGetParamsType] `json:"type"`
	// Whether to include metadata in the response.
	WithMetadata param.Field[bool] `json:"withMetadata"`
}

func (NamespaceBulkGetParams) MarshalJSON added in v4.5.0

func (r NamespaceBulkGetParams) MarshalJSON() (data []byte, err error)

type NamespaceBulkGetParamsType added in v4.5.0

type NamespaceBulkGetParamsType string

Whether to parse JSON values in the response.

const (
	NamespaceBulkGetParamsTypeText NamespaceBulkGetParamsType = "text"
	NamespaceBulkGetParamsTypeJson NamespaceBulkGetParamsType = "json"
)

func (NamespaceBulkGetParamsType) IsKnown added in v4.5.0

func (r NamespaceBulkGetParamsType) IsKnown() bool

type NamespaceBulkGetResponse added in v4.5.0

type NamespaceBulkGetResponse struct {
	// This field can have the runtime type of
	// [map[string]NamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion],
	// [map[string]NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValue].
	Values interface{}                  `json:"values"`
	JSON   namespaceBulkGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (NamespaceBulkGetResponse) AsUnion added in v4.5.0

AsUnion returns a NamespaceBulkGetResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NamespaceBulkGetResponseWorkersKVBulkGetResult, NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadata.

func (*NamespaceBulkGetResponse) UnmarshalJSON added in v4.5.0

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

type NamespaceBulkGetResponseEnvelope added in v4.5.0

type NamespaceBulkGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceBulkGetResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceBulkGetResponse                `json:"result,nullable"`
	JSON    namespaceBulkGetResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceBulkGetResponseEnvelope) UnmarshalJSON added in v4.5.0

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

type NamespaceBulkGetResponseEnvelopeSuccess added in v4.5.0

type NamespaceBulkGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceBulkGetResponseEnvelopeSuccessTrue NamespaceBulkGetResponseEnvelopeSuccess = true
)

func (NamespaceBulkGetResponseEnvelopeSuccess) IsKnown added in v4.5.0

type NamespaceBulkGetResponseUnion added in v4.5.0

type NamespaceBulkGetResponseUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NamespaceBulkGetResponseWorkersKVBulkGetResult or NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadata.

type NamespaceBulkGetResponseWorkersKVBulkGetResult added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResult struct {
	// Requested keys are paired with their values in an object.
	Values map[string]NamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion `json:"values"`
	JSON   namespaceBulkGetResponseWorkersKVBulkGetResultJSON                   `json:"-"`
}

func (*NamespaceBulkGetResponseWorkersKVBulkGetResult) UnmarshalJSON added in v4.5.0

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

type NamespaceBulkGetResponseWorkersKVBulkGetResultValuesMap added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResultValuesMap map[string]interface{}

func (NamespaceBulkGetResponseWorkersKVBulkGetResultValuesMap) ImplementsNamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion added in v4.5.0

func (r NamespaceBulkGetResponseWorkersKVBulkGetResultValuesMap) ImplementsNamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion()

type NamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion interface {
	ImplementsNamespaceBulkGetResponseWorkersKVBulkGetResultValuesUnion()
}

The value associated with the key.

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or NamespaceBulkGetResponseWorkersKVBulkGetResultValuesMap.

type NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadata added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadata struct {
	// Requested keys are paired with their values and metadata in an object.
	Values map[string]NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValue `json:"values"`
	JSON   namespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataJSON             `json:"-"`
}

func (*NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadata) UnmarshalJSON added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValue added in v4.5.0

type NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValue struct {
	Metadata interface{} `json:"metadata,required"`
	Value    interface{} `json:"value,required"`
	// Expires the key at a certain time, measured in number of seconds since the UNIX
	// epoch.
	Expiration float64                                                             `json:"expiration"`
	JSON       namespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValueJSON `json:"-"`
}

func (*NamespaceBulkGetResponseWorkersKVBulkGetResultWithMetadataValue) UnmarshalJSON added in v4.5.0

type NamespaceBulkUpdateParams

type NamespaceBulkUpdateParams struct {
	// Identifier.
	AccountID param.Field[string]             `path:"account_id,required"`
	Body      []NamespaceBulkUpdateParamsBody `json:"body,required"`
}

func (NamespaceBulkUpdateParams) MarshalJSON

func (r NamespaceBulkUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceBulkUpdateParamsBody

type NamespaceBulkUpdateParamsBody struct {
	// A key's name. The name may be at most 512 bytes. All printable, non-whitespace
	// characters are valid.
	Key param.Field[string] `json:"key,required"`
	// A UTF-8 encoded string to be stored, up to 25 MiB in length.
	Value param.Field[string] `json:"value,required"`
	// Indicates whether or not the server should base64 decode the value before
	// storing it. Useful for writing values that wouldn't otherwise be valid JSON
	// strings, such as images.
	Base64 param.Field[bool] `json:"base64"`
	// Expires the key at a certain time, measured in number of seconds since the UNIX
	// epoch.
	Expiration param.Field[float64] `json:"expiration"`
	// Expires the key after a number of seconds. Must be at least 60.
	ExpirationTTL param.Field[float64]     `json:"expiration_ttl"`
	Metadata      param.Field[interface{}] `json:"metadata"`
}

func (NamespaceBulkUpdateParamsBody) MarshalJSON

func (r NamespaceBulkUpdateParamsBody) MarshalJSON() (data []byte, err error)

type NamespaceBulkUpdateResponse

type NamespaceBulkUpdateResponse struct {
	// Number of keys successfully updated.
	SuccessfulKeyCount float64 `json:"successful_key_count"`
	// Name of the keys that failed to be fully updated. They should be retried.
	UnsuccessfulKeys []string                        `json:"unsuccessful_keys"`
	JSON             namespaceBulkUpdateResponseJSON `json:"-"`
}

func (*NamespaceBulkUpdateResponse) UnmarshalJSON

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

type NamespaceBulkUpdateResponseEnvelope

type NamespaceBulkUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceBulkUpdateResponse                `json:"result,nullable"`
	JSON    namespaceBulkUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceBulkUpdateResponseEnvelope) UnmarshalJSON

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

type NamespaceBulkUpdateResponseEnvelopeSuccess

type NamespaceBulkUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceBulkUpdateResponseEnvelopeSuccessTrue NamespaceBulkUpdateResponseEnvelopeSuccess = true
)

func (NamespaceBulkUpdateResponseEnvelopeSuccess) IsKnown

type NamespaceDeleteParams

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

type NamespaceDeleteResponse

type NamespaceDeleteResponse struct {
	JSON namespaceDeleteResponseJSON `json:"-"`
}

func (*NamespaceDeleteResponse) UnmarshalJSON

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

type NamespaceDeleteResponseEnvelope

type NamespaceDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceDeleteResponse                `json:"result,nullable"`
	JSON    namespaceDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceDeleteResponseEnvelope) UnmarshalJSON

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

type NamespaceDeleteResponseEnvelopeSuccess

type NamespaceDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceDeleteResponseEnvelopeSuccessTrue NamespaceDeleteResponseEnvelopeSuccess = true
)

func (NamespaceDeleteResponseEnvelopeSuccess) IsKnown

type NamespaceGetParams

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

type NamespaceGetResponseEnvelope

type NamespaceGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceGetResponseEnvelopeSuccess `json:"success,required"`
	Result  Namespace                           `json:"result"`
	JSON    namespaceGetResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceGetResponseEnvelope) UnmarshalJSON

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

type NamespaceGetResponseEnvelopeSuccess

type NamespaceGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceGetResponseEnvelopeSuccessTrue NamespaceGetResponseEnvelopeSuccess = true
)

func (NamespaceGetResponseEnvelopeSuccess) IsKnown

type NamespaceKeyBulkDeleteParams added in v4.3.0

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

func (NamespaceKeyBulkDeleteParams) MarshalJSON added in v4.3.0

func (r NamespaceKeyBulkDeleteParams) MarshalJSON() (data []byte, err error)

type NamespaceKeyBulkDeleteResponse added in v4.3.0

type NamespaceKeyBulkDeleteResponse struct {
	// Number of keys successfully updated.
	SuccessfulKeyCount float64 `json:"successful_key_count"`
	// Name of the keys that failed to be fully updated. They should be retried.
	UnsuccessfulKeys []string                           `json:"unsuccessful_keys"`
	JSON             namespaceKeyBulkDeleteResponseJSON `json:"-"`
}

func (*NamespaceKeyBulkDeleteResponse) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkDeleteResponseEnvelope added in v4.3.0

type NamespaceKeyBulkDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceKeyBulkDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceKeyBulkDeleteResponse                `json:"result,nullable"`
	JSON    namespaceKeyBulkDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceKeyBulkDeleteResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkDeleteResponseEnvelopeSuccess added in v4.3.0

type NamespaceKeyBulkDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceKeyBulkDeleteResponseEnvelopeSuccessTrue NamespaceKeyBulkDeleteResponseEnvelopeSuccess = true
)

func (NamespaceKeyBulkDeleteResponseEnvelopeSuccess) IsKnown added in v4.3.0

type NamespaceKeyBulkGetParams added in v4.3.0

type NamespaceKeyBulkGetParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Array of keys to retrieve (maximum of 100).
	Keys param.Field[[]string] `json:"keys,required"`
	// Whether to parse JSON values in the response.
	Type param.Field[NamespaceKeyBulkGetParamsType] `json:"type"`
	// Whether to include metadata in the response.
	WithMetadata param.Field[bool] `json:"withMetadata"`
}

func (NamespaceKeyBulkGetParams) MarshalJSON added in v4.3.0

func (r NamespaceKeyBulkGetParams) MarshalJSON() (data []byte, err error)

type NamespaceKeyBulkGetParamsType added in v4.3.0

type NamespaceKeyBulkGetParamsType string

Whether to parse JSON values in the response.

const (
	NamespaceKeyBulkGetParamsTypeText NamespaceKeyBulkGetParamsType = "text"
	NamespaceKeyBulkGetParamsTypeJson NamespaceKeyBulkGetParamsType = "json"
)

func (NamespaceKeyBulkGetParamsType) IsKnown added in v4.3.0

func (r NamespaceKeyBulkGetParamsType) IsKnown() bool

type NamespaceKeyBulkGetResponse added in v4.3.0

type NamespaceKeyBulkGetResponse struct {
	// This field can have the runtime type of
	// [map[string]NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion],
	// [map[string]NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValue].
	Values interface{}                     `json:"values"`
	JSON   namespaceKeyBulkGetResponseJSON `json:"-"`
	// contains filtered or unexported fields
}

func (NamespaceKeyBulkGetResponse) AsUnion added in v4.3.0

AsUnion returns a NamespaceKeyBulkGetResponseUnion interface which you can cast to the specific types for more type safety.

Possible runtime types of the union are NamespaceKeyBulkGetResponseWorkersKVBulkGetResult, NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadata.

func (*NamespaceKeyBulkGetResponse) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkGetResponseEnvelope added in v4.3.0

type NamespaceKeyBulkGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceKeyBulkGetResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceKeyBulkGetResponse                `json:"result,nullable"`
	JSON    namespaceKeyBulkGetResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceKeyBulkGetResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkGetResponseEnvelopeSuccess added in v4.3.0

type NamespaceKeyBulkGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceKeyBulkGetResponseEnvelopeSuccessTrue NamespaceKeyBulkGetResponseEnvelopeSuccess = true
)

func (NamespaceKeyBulkGetResponseEnvelopeSuccess) IsKnown added in v4.3.0

type NamespaceKeyBulkGetResponseUnion added in v4.3.0

type NamespaceKeyBulkGetResponseUnion interface {
	// contains filtered or unexported methods
}

Union satisfied by NamespaceKeyBulkGetResponseWorkersKVBulkGetResult or NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadata.

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResult added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResult struct {
	// Requested keys are paired with their values in an object.
	Values map[string]NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion `json:"values"`
	JSON   namespaceKeyBulkGetResponseWorkersKVBulkGetResultJSON                   `json:"-"`
}

func (*NamespaceKeyBulkGetResponseWorkersKVBulkGetResult) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesMap added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesMap map[string]interface{}

func (NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesMap) ImplementsNamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion added in v4.3.0

func (r NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesMap) ImplementsNamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion()

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion interface {
	ImplementsNamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesUnion()
}

The value associated with the key.

Union satisfied by shared.UnionString, shared.UnionFloat, shared.UnionBool or NamespaceKeyBulkGetResponseWorkersKVBulkGetResultValuesMap.

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadata added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadata struct {
	// Requested keys are paired with their values and metadata in an object.
	Values map[string]NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValue `json:"values"`
	JSON   namespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataJSON             `json:"-"`
}

func (*NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadata) UnmarshalJSON added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValue added in v4.3.0

type NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValue struct {
	Metadata interface{} `json:"metadata,required"`
	Value    interface{} `json:"value,required"`
	// Expires the key at a certain time, measured in number of seconds since the UNIX
	// epoch.
	Expiration float64                                                                `json:"expiration"`
	JSON       namespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValueJSON `json:"-"`
}

func (*NamespaceKeyBulkGetResponseWorkersKVBulkGetResultWithMetadataValue) UnmarshalJSON added in v4.3.0

type NamespaceKeyBulkUpdateParams added in v4.3.0

type NamespaceKeyBulkUpdateParams struct {
	// Identifier.
	AccountID param.Field[string]                `path:"account_id,required"`
	Body      []NamespaceKeyBulkUpdateParamsBody `json:"body,required"`
}

func (NamespaceKeyBulkUpdateParams) MarshalJSON added in v4.3.0

func (r NamespaceKeyBulkUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceKeyBulkUpdateParamsBody added in v4.3.0

type NamespaceKeyBulkUpdateParamsBody struct {
	// A key's name. The name may be at most 512 bytes. All printable, non-whitespace
	// characters are valid.
	Key param.Field[string] `json:"key,required"`
	// A UTF-8 encoded string to be stored, up to 25 MiB in length.
	Value param.Field[string] `json:"value,required"`
	// Indicates whether or not the server should base64 decode the value before
	// storing it. Useful for writing values that wouldn't otherwise be valid JSON
	// strings, such as images.
	Base64 param.Field[bool] `json:"base64"`
	// Expires the key at a certain time, measured in number of seconds since the UNIX
	// epoch.
	Expiration param.Field[float64] `json:"expiration"`
	// Expires the key after a number of seconds. Must be at least 60.
	ExpirationTTL param.Field[float64]     `json:"expiration_ttl"`
	Metadata      param.Field[interface{}] `json:"metadata"`
}

func (NamespaceKeyBulkUpdateParamsBody) MarshalJSON added in v4.3.0

func (r NamespaceKeyBulkUpdateParamsBody) MarshalJSON() (data []byte, err error)

type NamespaceKeyBulkUpdateResponse added in v4.3.0

type NamespaceKeyBulkUpdateResponse struct {
	// Number of keys successfully updated.
	SuccessfulKeyCount float64 `json:"successful_key_count"`
	// Name of the keys that failed to be fully updated. They should be retried.
	UnsuccessfulKeys []string                           `json:"unsuccessful_keys"`
	JSON             namespaceKeyBulkUpdateResponseJSON `json:"-"`
}

func (*NamespaceKeyBulkUpdateResponse) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkUpdateResponseEnvelope added in v4.3.0

type NamespaceKeyBulkUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceKeyBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceKeyBulkUpdateResponse                `json:"result,nullable"`
	JSON    namespaceKeyBulkUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceKeyBulkUpdateResponseEnvelope) UnmarshalJSON added in v4.3.0

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

type NamespaceKeyBulkUpdateResponseEnvelopeSuccess added in v4.3.0

type NamespaceKeyBulkUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceKeyBulkUpdateResponseEnvelopeSuccessTrue NamespaceKeyBulkUpdateResponseEnvelopeSuccess = true
)

func (NamespaceKeyBulkUpdateResponseEnvelopeSuccess) IsKnown added in v4.3.0

type NamespaceKeyListParams

type NamespaceKeyListParams 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 if the amount of list results was limited by the limit
	// parameter. A valid value for the cursor can be obtained from the `cursors`
	// object in the `result_info` structure.
	Cursor param.Field[string] `query:"cursor"`
	// Limits the number of keys returned in the response. The cursor attribute may be
	// used to iterate over the next batch of keys if there are more than the limit.
	Limit param.Field[float64] `query:"limit"`
	// Filters returned keys by a name prefix. Exact matches and any key names that
	// begin with the prefix will be returned.
	Prefix param.Field[string] `query:"prefix"`
}

func (NamespaceKeyListParams) URLQuery

func (r NamespaceKeyListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceKeyListParams's query parameters as `url.Values`.

type NamespaceKeyService

type NamespaceKeyService struct {
	Options []option.RequestOption
}

NamespaceKeyService 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 NewNamespaceKeyService method instead.

func NewNamespaceKeyService

func NewNamespaceKeyService(opts ...option.RequestOption) (r *NamespaceKeyService)

NewNamespaceKeyService 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 (*NamespaceKeyService) BulkDelete deprecated added in v4.3.0

Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.

Deprecated: Please use kv.namespaces.bulk_delete instead

func (*NamespaceKeyService) BulkGet deprecated added in v4.3.0

Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if `withMetadata` is true.

Deprecated: Please use kv.namespaces.bulk_get instead

func (*NamespaceKeyService) BulkUpdate deprecated added in v4.3.0

Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.

Deprecated: Please use kv.namespaces.bulk_update instead

func (*NamespaceKeyService) List

Lists a namespace's keys.

func (*NamespaceKeyService) ListAutoPaging

Lists a namespace's keys.

type NamespaceListParams

type NamespaceListParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// Direction to order namespaces.
	Direction param.Field[NamespaceListParamsDirection] `query:"direction"`
	// Field to order results by.
	Order param.Field[NamespaceListParamsOrder] `query:"order"`
	// Page number of paginated results.
	Page param.Field[float64] `query:"page"`
	// Maximum number of results per page.
	PerPage param.Field[float64] `query:"per_page"`
}

func (NamespaceListParams) URLQuery

func (r NamespaceListParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceListParams's query parameters as `url.Values`.

type NamespaceListParamsDirection

type NamespaceListParamsDirection string

Direction to order namespaces.

const (
	NamespaceListParamsDirectionAsc  NamespaceListParamsDirection = "asc"
	NamespaceListParamsDirectionDesc NamespaceListParamsDirection = "desc"
)

func (NamespaceListParamsDirection) IsKnown

func (r NamespaceListParamsDirection) IsKnown() bool

type NamespaceListParamsOrder

type NamespaceListParamsOrder string

Field to order results by.

const (
	NamespaceListParamsOrderID    NamespaceListParamsOrder = "id"
	NamespaceListParamsOrderTitle NamespaceListParamsOrder = "title"
)

func (NamespaceListParamsOrder) IsKnown

func (r NamespaceListParamsOrder) IsKnown() bool

type NamespaceMetadataGetParams

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

type NamespaceMetadataGetResponse

type NamespaceMetadataGetResponse = interface{}

type NamespaceMetadataGetResponseEnvelope

type NamespaceMetadataGetResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceMetadataGetResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceMetadataGetResponse                `json:"result"`
	JSON    namespaceMetadataGetResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceMetadataGetResponseEnvelope) UnmarshalJSON

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

type NamespaceMetadataGetResponseEnvelopeSuccess

type NamespaceMetadataGetResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceMetadataGetResponseEnvelopeSuccessTrue NamespaceMetadataGetResponseEnvelopeSuccess = true
)

func (NamespaceMetadataGetResponseEnvelopeSuccess) IsKnown

type NamespaceMetadataService

type NamespaceMetadataService struct {
	Options []option.RequestOption
}

NamespaceMetadataService 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 NewNamespaceMetadataService method instead.

func NewNamespaceMetadataService

func NewNamespaceMetadataService(opts ...option.RequestOption) (r *NamespaceMetadataService)

NewNamespaceMetadataService 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 (*NamespaceMetadataService) Get

Returns the metadata associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.

type NamespaceNewParams

type NamespaceNewParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// A human-readable string name for a Namespace.
	Title param.Field[string] `json:"title,required"`
}

func (NamespaceNewParams) MarshalJSON

func (r NamespaceNewParams) MarshalJSON() (data []byte, err error)

type NamespaceNewResponseEnvelope

type NamespaceNewResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceNewResponseEnvelopeSuccess `json:"success,required"`
	Result  Namespace                           `json:"result"`
	JSON    namespaceNewResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceNewResponseEnvelope) UnmarshalJSON

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

type NamespaceNewResponseEnvelopeSuccess

type NamespaceNewResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceNewResponseEnvelopeSuccessTrue NamespaceNewResponseEnvelopeSuccess = true
)

func (NamespaceNewResponseEnvelopeSuccess) IsKnown

type NamespaceService

type NamespaceService struct {
	Options  []option.RequestOption
	Keys     *NamespaceKeyService
	Metadata *NamespaceMetadataService
	Values   *NamespaceValueService
}

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

func (r *NamespaceService) BulkDelete(ctx context.Context, namespaceID string, params NamespaceBulkDeleteParams, opts ...option.RequestOption) (res *NamespaceBulkDeleteResponse, err error)

Remove multiple KV pairs from the namespace. Body should be an array of up to 10,000 keys to be removed.

func (*NamespaceService) BulkGet added in v4.5.0

func (r *NamespaceService) BulkGet(ctx context.Context, namespaceID string, params NamespaceBulkGetParams, opts ...option.RequestOption) (res *NamespaceBulkGetResponse, err error)

Retrieve up to 100 KV pairs from the namespace. Keys must contain text-based values. JSON values can optionally be parsed instead of being returned as a string value. Metadata can be included if `withMetadata` is true.

func (*NamespaceService) BulkUpdate

func (r *NamespaceService) BulkUpdate(ctx context.Context, namespaceID string, params NamespaceBulkUpdateParams, opts ...option.RequestOption) (res *NamespaceBulkUpdateResponse, err error)

Write multiple keys and values at once. Body should be an array of up to 10,000 key-value pairs to be stored, along with optional expiration information. Existing values and expirations will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored. The entire request size must be 100 megabytes or less.

func (*NamespaceService) Delete

func (r *NamespaceService) Delete(ctx context.Context, namespaceID string, body NamespaceDeleteParams, opts ...option.RequestOption) (res *NamespaceDeleteResponse, err error)

Deletes the namespace corresponding to the given ID.

func (*NamespaceService) Get

func (r *NamespaceService) Get(ctx context.Context, namespaceID string, query NamespaceGetParams, opts ...option.RequestOption) (res *Namespace, err error)

Get the namespace corresponding to the given ID.

func (*NamespaceService) List

Returns the namespaces owned by an account.

func (*NamespaceService) ListAutoPaging

Returns the namespaces owned by an account.

func (*NamespaceService) New

func (r *NamespaceService) New(ctx context.Context, params NamespaceNewParams, opts ...option.RequestOption) (res *Namespace, err error)

Creates a namespace under the given title. A `400` is returned if the account already owns a namespace with this title. A namespace must be explicitly deleted to be replaced.

func (*NamespaceService) Update

func (r *NamespaceService) Update(ctx context.Context, namespaceID string, params NamespaceUpdateParams, opts ...option.RequestOption) (res *Namespace, err error)

Modifies a namespace's title.

type NamespaceUpdateParams

type NamespaceUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// A human-readable string name for a Namespace.
	Title param.Field[string] `json:"title,required"`
}

func (NamespaceUpdateParams) MarshalJSON

func (r NamespaceUpdateParams) MarshalJSON() (data []byte, err error)

type NamespaceUpdateResponseEnvelope

type NamespaceUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	Result   Namespace             `json:"result,required"`
	// Whether the API call was successful.
	Success NamespaceUpdateResponseEnvelopeSuccess `json:"success,required"`
	JSON    namespaceUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceUpdateResponseEnvelope) UnmarshalJSON

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

type NamespaceUpdateResponseEnvelopeSuccess

type NamespaceUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceUpdateResponseEnvelopeSuccessTrue NamespaceUpdateResponseEnvelopeSuccess = true
)

func (NamespaceUpdateResponseEnvelopeSuccess) IsKnown

type NamespaceValueDeleteParams

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

type NamespaceValueDeleteResponse

type NamespaceValueDeleteResponse struct {
	JSON namespaceValueDeleteResponseJSON `json:"-"`
}

func (*NamespaceValueDeleteResponse) UnmarshalJSON

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

type NamespaceValueDeleteResponseEnvelope

type NamespaceValueDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceValueDeleteResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceValueDeleteResponse                `json:"result,nullable"`
	JSON    namespaceValueDeleteResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceValueDeleteResponseEnvelope) UnmarshalJSON

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

type NamespaceValueDeleteResponseEnvelopeSuccess

type NamespaceValueDeleteResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceValueDeleteResponseEnvelopeSuccessTrue NamespaceValueDeleteResponseEnvelopeSuccess = true
)

func (NamespaceValueDeleteResponseEnvelopeSuccess) IsKnown

type NamespaceValueGetParams

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

type NamespaceValueService

type NamespaceValueService struct {
	Options []option.RequestOption
}

NamespaceValueService 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 NewNamespaceValueService method instead.

func NewNamespaceValueService

func NewNamespaceValueService(opts ...option.RequestOption) (r *NamespaceValueService)

NewNamespaceValueService 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 (*NamespaceValueService) Delete

Remove a KV pair from the namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name.

func (*NamespaceValueService) Get

func (r *NamespaceValueService) Get(ctx context.Context, namespaceID string, keyName string, query NamespaceValueGetParams, opts ...option.RequestOption) (res *http.Response, err error)

Returns the value associated with the given key in the given namespace. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. If the KV-pair is set to expire at some point, the expiration time as measured in seconds since the UNIX epoch will be returned in the `expiration` response header.

func (*NamespaceValueService) Update

func (r *NamespaceValueService) Update(ctx context.Context, namespaceID string, keyName string, params NamespaceValueUpdateParams, opts ...option.RequestOption) (res *NamespaceValueUpdateResponse, err error)

Write a value identified by a key. Use URL-encoding to use special characters (for example, `:`, `!`, `%`) in the key name. Body should be the value to be stored. If JSON metadata to be associated with the key/value pair is needed, use `multipart/form-data` content type for your PUT request (see dropdown below in `REQUEST BODY SCHEMA`). Existing values, expirations, and metadata will be overwritten. If neither `expiration` nor `expiration_ttl` is specified, the key-value pair will never expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.

type NamespaceValueUpdateParams

type NamespaceValueUpdateParams struct {
	// Identifier.
	AccountID param.Field[string] `path:"account_id,required"`
	// A byte sequence to be stored, up to 25 MiB in length.
	Value param.Field[string] `json:"value,required"`
	// Expires the key at a certain time, measured in number of seconds since the UNIX
	// epoch.
	Expiration param.Field[float64] `query:"expiration"`
	// Expires the key after a number of seconds. Must be at least 60.
	ExpirationTTL param.Field[float64]     `query:"expiration_ttl"`
	Metadata      param.Field[interface{}] `json:"metadata"`
}

func (NamespaceValueUpdateParams) MarshalJSON

func (r NamespaceValueUpdateParams) MarshalJSON() (data []byte, err error)

func (NamespaceValueUpdateParams) URLQuery

func (r NamespaceValueUpdateParams) URLQuery() (v url.Values)

URLQuery serializes NamespaceValueUpdateParams's query parameters as `url.Values`.

type NamespaceValueUpdateResponse

type NamespaceValueUpdateResponse struct {
	JSON namespaceValueUpdateResponseJSON `json:"-"`
}

func (*NamespaceValueUpdateResponse) UnmarshalJSON

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

type NamespaceValueUpdateResponseEnvelope

type NamespaceValueUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo `json:"errors,required"`
	Messages []shared.ResponseInfo `json:"messages,required"`
	// Whether the API call was successful.
	Success NamespaceValueUpdateResponseEnvelopeSuccess `json:"success,required"`
	Result  NamespaceValueUpdateResponse                `json:"result,nullable"`
	JSON    namespaceValueUpdateResponseEnvelopeJSON    `json:"-"`
}

func (*NamespaceValueUpdateResponseEnvelope) UnmarshalJSON

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

type NamespaceValueUpdateResponseEnvelopeSuccess

type NamespaceValueUpdateResponseEnvelopeSuccess bool

Whether the API call was successful.

const (
	NamespaceValueUpdateResponseEnvelopeSuccessTrue NamespaceValueUpdateResponseEnvelopeSuccess = true
)

func (NamespaceValueUpdateResponseEnvelopeSuccess) IsKnown

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 RatePlan

type RatePlan = shared.RatePlan

The rate plan applied to the subscription.

This is an alias to an internal type.

type RatePlanID added in v4.1.0

type RatePlanID = shared.RatePlanID

The ID of the rate plan.

This is an alias to an internal type.

type RatePlanParam

type RatePlanParam = shared.RatePlanParam

The rate plan applied to the subscription.

This is an alias to an internal type.

type ResponseInfo

type ResponseInfo = shared.ResponseInfo

This is an alias to an internal type.

type ResponseInfoSource added in v4.3.0

type ResponseInfoSource = shared.ResponseInfoSource

This is an alias to an internal type.

type Role

type Role = shared.Role

This is an alias to an internal type.

type RoleParam

type RoleParam = shared.RoleParam

This is an alias to an internal type.

type RolePermissions

type RolePermissions = shared.RolePermissions

This is an alias to an internal type.

type RolePermissionsParam

type RolePermissionsParam = shared.RolePermissionsParam

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.

type Subscription

type Subscription = shared.Subscription

This is an alias to an internal type.

type SubscriptionFrequency

type SubscriptionFrequency = shared.SubscriptionFrequency

How often the subscription is renewed automatically.

This is an alias to an internal type.

type SubscriptionParam

type SubscriptionParam = shared.SubscriptionParam

This is an alias to an internal type.

type SubscriptionState

type SubscriptionState = shared.SubscriptionState

The state that the subscription is in.

This is an alias to an internal type.

type Token

type Token = shared.Token

This is an alias to an internal type.

type TokenCondition

type TokenCondition = shared.TokenCondition

This is an alias to an internal type.

type TokenConditionCIDRList

type TokenConditionCIDRList = shared.TokenConditionCIDRList

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionCIDRListParam

type TokenConditionCIDRListParam = shared.TokenConditionCIDRListParam

IPv4/IPv6 CIDR.

This is an alias to an internal type.

type TokenConditionParam

type TokenConditionParam = shared.TokenConditionParam

This is an alias to an internal type.

type TokenConditionRequestIP

type TokenConditionRequestIP = shared.TokenConditionRequestIP

Client IP restrictions.

This is an alias to an internal type.

type TokenConditionRequestIPParam

type TokenConditionRequestIPParam = shared.TokenConditionRequestIPParam

Client IP restrictions.

This is an alias to an internal type.

type TokenParam

type TokenParam = shared.TokenParam

This is an alias to an internal type.

type TokenPolicy

type TokenPolicy = shared.TokenPolicy

This is an alias to an internal type.

type TokenPolicyEffect

type TokenPolicyEffect = shared.TokenPolicyEffect

Allow or deny operations against the resources.

This is an alias to an internal type.

type TokenPolicyParam

type TokenPolicyParam = shared.TokenPolicyParam

This is an alias to an internal type.

type TokenPolicyPermissionGroup

type TokenPolicyPermissionGroup = shared.TokenPolicyPermissionGroup

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupParam

type TokenPolicyPermissionGroupParam = shared.TokenPolicyPermissionGroupParam

A named group of permissions that map to a group of operations against resources.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMeta

type TokenPolicyPermissionGroupsMeta = shared.TokenPolicyPermissionGroupsMeta

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyPermissionGroupsMetaParam

type TokenPolicyPermissionGroupsMetaParam = shared.TokenPolicyPermissionGroupsMetaParam

Attributes associated to the permission group.

This is an alias to an internal type.

type TokenPolicyResourcesMap added in v4.6.0

type TokenPolicyResourcesMap = shared.TokenPolicyResourcesMap

A nested permission grant for further scoping.

This is an alias to an internal type.

type TokenPolicyResourcesMapParam added in v4.6.0

type TokenPolicyResourcesMapParam = shared.TokenPolicyResourcesMapParam

A nested permission grant for further scoping.

This is an alias to an internal type.

type TokenPolicyResourcesUnion added in v4.6.0

type TokenPolicyResourcesUnion = shared.TokenPolicyResourcesUnion

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

type TokenPolicyResourcesUnionParam added in v4.6.0

type TokenPolicyResourcesUnionParam = shared.TokenPolicyResourcesUnionParam

A simple wildcard permission, e.g., "\*".

This is an alias to an internal type.

type TokenStatus

type TokenStatus = shared.TokenStatus

Status of the token.

This is an alias to an internal type.

type TokenValue

type TokenValue = shared.TokenValue

The token value.

This is an alias to an internal type.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL