DataStore — cloud.docs

Represents a data store.

Properties

Name	Type	Required	Description
path	string	false	The resource path of the data store. Format: `universes/{universe_id}/data-stores/{data_store_id}`
createTime	string	false	The timestamp when the data store was created.
expireTime	string	false	The timestamp when the data store will expire (or did expire). This field is set when the data store is soft-deleted and indicates when it will be permanently removed.
state	string	false	The state of the data store. Possible values: \| Value \| Description \| \| --- \| --- \| \| STATE_UNSPECIFIED \| The default value. This value is used if the state is omitted. \| \| ACTIVE \| The data store is active. \| \| DELETED \| The data store is deleted. After the expiration time passes, it will be permanently deleted. \|
id	string	false	The ID of the data store. Matches the last segment of the path.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123/data-stores/some-data-store",
      "type": "string",
      "description": "The resource path of the data store.\n\nFormat: `universes/{universe_id}/data-stores/{data_store_id}`"
    },
    "createTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the data store was created.",
      "format": "date-time"
    },
    "expireTime": {
      "readOnly": true,
      "example": "2023-07-05T12:34:56Z",
      "type": "string",
      "description": "The timestamp when the data store will expire (or did expire).\n\nThis field is set when the data store is soft-deleted and indicates\nwhen it will be permanently removed.",
      "format": "date-time"
    },
    "state": {
      "readOnly": true,
      "example": "STATE_UNSPECIFIED",
      "enum": [
        "STATE_UNSPECIFIED",
        "ACTIVE",
        "DELETED"
      ],
      "type": "string",
      "description": "The state of the data store.\n\nPossible values:\n\n  | Value | Description |\n  | --- | --- |\n  | STATE_UNSPECIFIED | The default value. This value is used if the state is omitted. |\n  | ACTIVE | The data store is active. |\n  | DELETED | The data store is deleted.  After the expiration time passes, it will be permanently deleted. |",
      "format": "enum"
    },
    "id": {
      "readOnly": true,
      "type": "string",
      "description": "The ID of the data store. Matches the last segment of the path."
    }
  },
  "description": "Represents a data store.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/data-stores/{data_store_id}"
    ],
    "plural": "data-stores",
    "singular": "data-store"
  },
  "x-resource": true
}