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:
- Task tracking —
TaskStateUpdate,TaskStatus,TasksStateUpdate, andProcessorResponsesurface the async workflow the Cloud API uses for most mutating operations: a request returns a task ID; the caller pollsGET /tasks/{taskId}until completion. - HATEOAS navigation —
LinkandLinkscapture thelinksarrays the API returns alongside most resources. - Tagging —
Tagis the key/value pair used in request bodies;CloudTagandCloudTagsmodel the richer shapes the database tag endpoints return. - Common enums —
CloudProvider,Protocol,DataPersistence,SubscriptionStatus,DatabaseStatusare shared across the database, subscription, and connectivity modules. - Generic wrappers —
PaginatedResponse,EmptyResponse,ErrorResponsefor cross-cutting response shapes.
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§
- Cloud
Tag - A single tag as returned by the database tag endpoints.
- Cloud
Tags - Collection wrapper returned by the database tags listing endpoints.
- Database
Traffic State Response - Traffic state for a database, returned by the
.../trafficendpoints. - Empty
Response - Empty response body. Returned by operations that succeed without payload.
- Error
Response - Generic error response body.
- Link
- HATEOAS link to a related API resource.
- Links
- Collection wrapper for a list of
Link. - Paginated
Response - Generic paginated-response wrapper.
- Processor
Response - Result payload included on a completed
TaskStateUpdate. - Tag
- Key-value tag used in create/update request bodies and embedded tag lists.
- Task
State Update - State of an asynchronous Redis Cloud task.
- Tasks
State Update - Wrapper for the
GET /tasksresponse ({tasks: [...]}).
Enums§
- Cloud
Provider - Cloud provider hosting a Redis Cloud resource.
- Data
Persistence - Database persistence policy.
- Database
Status - Lifecycle status of a database.
- Processor
Error - Coarse subset of Redis Cloud’s processor error codes.
- Protocol
- Redis protocol exposed by a database endpoint.
- Subscription
Status - Lifecycle status of a Pro subscription.
- Task
Status - Terminal and intermediate states of a Redis Cloud task.