GoogleApi.Spanner.V1.Api.Projects.spanner_projects_instances_backup_operations_list

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

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

View Source

Specs

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

Lists the backup long-running operations in the given instance. A backup operation has a name of the form projects//instances//backups//operations/. The long-running operation metadata field type metadata.type_url describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by operation.metadata.value.progress.start_time in descending order starting from the most recently started operation.

Parameters

  • connection (type: GoogleApi.Spanner.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The instance of the backup operations. 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 backup operations. 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 operation are eligible for filtering: name - The name of the long-running operation done - False if the operation is in progress, else true. metadata.@type - the type of metadata. For example, the type string for CreateBackupMetadata is type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata. metadata. - any field in metadata.value. error - Error associated with the long-running operation. response.@type - the type of response. response. - any field in response.value. 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: done:true - The operation is complete. metadata.database:prod - The database the backup was taken from has a name containing the string "prod". (metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND \ (metadata.name:howl) AND \ (metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND \ (error:*) - Returns operations where: The operation's metadata type is CreateBackupMetadata. The backup name contains the string "howl". The operation started before 2018-03-28T14:50:00Z. The operation resulted in an error.
    • :pageSize (type: integer()) - Number of operations 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 ListBackupOperationsResponse to the same parent and with the same filter.
  • opts (type: keyword()) - Call options

Returns

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