kv

package
v2.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

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 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 CloudflareTunnelTunTypeWARPConnector = shared.CloudflareTunnelTunTypeWARPConnector

This is an alias to an internal value.

Variables

This section is empty.

Functions

This section is empty.

Types

type ASN added in v2.1.0

type ASN = shared.ASN

This is an alias to an internal type.

type ASNParam added in v2.1.0

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

type Error = apierror.Error

type ErrorData

type ErrorData = shared.ErrorData

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"`
	// Arbitrary JSON that is associated with a key.
	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 added in v2.1.0

type Member = shared.Member

This is an alias to an internal type.

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

type NamespaceBulkDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo            `json:"errors,required"`
	Messages []shared.ResponseInfo            `json:"messages,required"`
	Result   NamespaceBulkDeleteResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceBulkDeleteResponseEnvelopeSuccess `json:"success,required"`
	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 NamespaceBulkDeleteResponseUnion

type NamespaceBulkDeleteResponseUnion interface {
	ImplementsKVNamespaceBulkDeleteResponseUnion()
}

Union satisfied by kv.NamespaceBulkDeleteResponseUnknown or shared.UnionString.

type NamespaceBulkService

type NamespaceBulkService struct {
	Options []option.RequestOption
}

NamespaceBulkService 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 NewNamespaceBulkService method instead.

func NewNamespaceBulkService

func NewNamespaceBulkService(opts ...option.RequestOption) (r *NamespaceBulkService)

NewNamespaceBulkService 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 (*NamespaceBulkService) Delete

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

func (*NamespaceBulkService) Update

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.

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 {
	// 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"`
	// The time, measured in number of seconds since the UNIX epoch, at which the key
	// should expire.
	Expiration param.Field[float64] `json:"expiration"`
	// The number of seconds for which the key should be visible before it expires. At
	// least 60.
	ExpirationTTL param.Field[float64] `json:"expiration_ttl"`
	// 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"`
	// Arbitrary JSON that is associated with a key.
	Metadata param.Field[interface{}] `json:"metadata"`
	// A UTF-8 encoded string to be stored, up to 25 MiB in length.
	Value param.Field[string] `json:"value"`
}

func (NamespaceBulkUpdateParamsBody) MarshalJSON

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

type NamespaceBulkUpdateResponseEnvelope

type NamespaceBulkUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo            `json:"errors,required"`
	Messages []shared.ResponseInfo            `json:"messages,required"`
	Result   NamespaceBulkUpdateResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceBulkUpdateResponseEnvelopeSuccess `json:"success,required"`
	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 NamespaceBulkUpdateResponseUnion

type NamespaceBulkUpdateResponseUnion interface {
	ImplementsKVNamespaceBulkUpdateResponseUnion()
}

Union satisfied by kv.NamespaceBulkUpdateResponseUnknown or shared.UnionString.

type NamespaceDeleteParams

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

func (NamespaceDeleteParams) MarshalJSON

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

type NamespaceDeleteResponseEnvelope

type NamespaceDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo        `json:"errors,required"`
	Messages []shared.ResponseInfo        `json:"messages,required"`
	Result   NamespaceDeleteResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceDeleteResponseEnvelopeSuccess `json:"success,required"`
	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 NamespaceDeleteResponseUnion

type NamespaceDeleteResponseUnion interface {
	ImplementsKVNamespaceDeleteResponseUnion()
}

Union satisfied by kv.NamespaceDeleteResponseUnknown or shared.UnionString.

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"`
	// The number of keys to return. 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"`
	// A string prefix used to filter down which keys will be returned. 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) 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"`
	// Arbitrary JSON that is associated with a key.
	Result NamespaceMetadataGetResponse `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceMetadataGetResponseEnvelopeSuccess `json:"success,required"`
	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"`
	Result   Namespace             `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceNewResponseEnvelopeSuccess `json:"success,required"`
	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
	Bulk     *NamespaceBulkService
	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) Delete

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

Deletes 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 *NamespaceUpdateResponseUnion, 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   NamespaceUpdateResponseUnion `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 NamespaceUpdateResponseUnion

type NamespaceUpdateResponseUnion interface {
	ImplementsKVNamespaceUpdateResponseUnion()
}

Union satisfied by kv.NamespaceUpdateResponseUnknown or shared.UnionString.

type NamespaceValueDeleteParams

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

func (NamespaceValueDeleteParams) MarshalJSON

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

type NamespaceValueDeleteResponseEnvelope

type NamespaceValueDeleteResponseEnvelope struct {
	Errors   []shared.ResponseInfo             `json:"errors,required"`
	Messages []shared.ResponseInfo             `json:"messages,required"`
	Result   NamespaceValueDeleteResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceValueDeleteResponseEnvelopeSuccess `json:"success,required"`
	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 NamespaceValueDeleteResponseUnion

type NamespaceValueDeleteResponseUnion interface {
	ImplementsKVNamespaceValueDeleteResponseUnion()
}

Union satisfied by kv.NamespaceValueDeleteResponseUnknown or shared.UnionString.

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 *string, 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

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 along with JSON metadata to be associated with the key/value pair. 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"`
	// Arbitrary JSON to be associated with a key/value pair.
	Metadata param.Field[string] `json:"metadata,required"`
	// A byte sequence to be stored, up to 25 MiB in length.
	Value param.Field[string] `json:"value,required"`
}

func (NamespaceValueUpdateParams) MarshalJSON

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

type NamespaceValueUpdateResponseEnvelope

type NamespaceValueUpdateResponseEnvelope struct {
	Errors   []shared.ResponseInfo             `json:"errors,required"`
	Messages []shared.ResponseInfo             `json:"messages,required"`
	Result   NamespaceValueUpdateResponseUnion `json:"result,required"`
	// Whether the API call was successful
	Success NamespaceValueUpdateResponseEnvelopeSuccess `json:"success,required"`
	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 NamespaceValueUpdateResponseUnion

type NamespaceValueUpdateResponseUnion interface {
	ImplementsKVNamespaceValueUpdateResponseUnion()
}

Union satisfied by kv.NamespaceValueUpdateResponseUnknown or shared.UnionString.

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.

Jump to

Keyboard shortcuts

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