GoogleApi.Spanner.V1.Api.Projects.spanner_projects_instances_backups_list

You're seeing just the function spanner_projects_instances_backups_list, go back to GoogleApi.Spanner.V1.Api.Projects module for more information.
Link to this function

spanner_projects_instances_backups_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

spanner_projects_instances_backups_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.Spanner.V1.Model.ListBackupsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists completed and pending backups. Backups returned are ordered by create_time in descending order, starting from the most recent create_time.

Parameters

  • connection (type: GoogleApi.Spanner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The instance to list backups from. Values are of the form projects//instances/.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :filter (type: String.t) - An expression that filters the list of returned backups. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, >, <=, >=, !=, =, or :. Colon : is the contains operator. Filter rules are not case sensitive. The following fields in the Backup are eligible for filtering: name database state create_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) version_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ) size_bytes You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic, but you can specify AND, OR, and NOT logic explicitly. Here are a few examples: name:Howl - The backup's name contains the string "howl". database:prod - The database's name contains the string "prod". state:CREATING - The backup is pending creation. state:READY - The backup is fully created and ready for use. (name:howl) AND (create_time < \"2018-03-28T14:50:00Z\") - The backup name contains the string "howl" and create_time of the backup is before 2018-03-28T14:50:00Z. expire_time < \"2018-03-28T14:50:00Z\" - The backup expire_time is before 2018-03-28T14:50:00Z. size_bytes > 10000000000 - The backup's size is greater than 10GB
    • :pageSize (type: integer()) - Number of backups to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
    • :pageToken (type: String.t) - If non-empty, page_token should contain a next_page_token from a previous ListBackupsResponse to the same parent and with the same filter.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Spanner.V1.Model.ListBackupsResponse{}} on success
  • {:error, info} on failure