Skip to main content

Module types

Module types 

Source
Expand description

Shared types for the Redis Cloud REST API.

Types in this module are referenced from many endpoints and modules in the crate. They model the cross-cutting concepts the API itself reuses:

These models are the single canonical location for shared shapes (#64): endpoint modules import them rather than redefining their own copies of TaskStateUpdate and the tag types.

Structs§

CloudTag
A single tag as returned by the database tag endpoints.
CloudTags
Collection wrapper returned by the database tags listing endpoints.
DatabaseTrafficStateResponse
Traffic state for a database, returned by the .../traffic endpoints.
EmptyResponse
Empty response body. Returned by operations that succeed without payload.
ErrorResponse
Generic error response body.
Link
HATEOAS link to a related API resource.
Links
Collection wrapper for a list of Link.
PaginatedResponse
Generic paginated-response wrapper.
ProcessorResponse
Result payload included on a completed TaskStateUpdate.
Tag
Key-value tag used in create/update request bodies and embedded tag lists.
TaskStateUpdate
State of an asynchronous Redis Cloud task.
TasksStateUpdate
Wrapper for the GET /tasks response ({tasks: [...]}).

Enums§

CloudProvider
Cloud provider hosting a Redis Cloud resource.
DataPersistence
Database persistence policy.
DatabaseStatus
Lifecycle status of a database.
ProcessorError
Coarse subset of Redis Cloud’s processor error codes.
Protocol
Redis protocol exposed by a database endpoint.
SubscriptionStatus
Lifecycle status of a Pro subscription.
TaskStatus
Terminal and intermediate states of a Redis Cloud task.