list(parent=None, pageSize=None, pageToken=None, x__xgafv=None, filter=None)

Lists database longrunning-operations.
A database operation has a name of the form
`projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`.
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.

Args:
parent: string, Required. The instance of the database operations.
Values are of the form `projects/<project>/instances/<instance>`. (required)
pageSize: integer, Number of operations to be returned in the response. If 0 or
less, defaults to the server's maximum allowed page size.
pageToken: string, If non-empty, `page_token` should contain a
next_page_token
from a previous ListDatabaseOperationsResponse to the
same `parent` and with the same `filter`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
filter: string, A filter expression that filters what operations are returned in the
response.

The filter expression must specify the field name, a comparison operator,
and the value that you want to use for filtering. The value must be a
string, a number, or a boolean. The comparison operator must be
<, >, <=, >=, !=, =, or :. Colon ‘:’ represents a HAS operator which is
roughly synonymous with equality. Filter rules are case insensitive.

The long-running operation fields eligible for filtering are:
* `name` --> The name of the long-running operation
* `done` --> False if the operation is in progress, else true.
* `metadata.type_url` (using filter string `metadata.@type`) and fields
in `metadata.value` (using filter string `metadata.<field_name>`,
where <field_name> is a field in metadata.value) are eligible for
filtering.
* `error` --> Error associated with the long-running operation.
* `response.type_url` (using filter string `response.@type`) and fields
in `response.value` (using filter string `response.<field_name>`,
where <field_name> is a field in response.value) are eligible for
filtering.

To filter on multiple expressions, provide each separate expression within
parentheses. By default, each expression is an AND expression. However,
you can include AND, OR, and NOT expressions explicitly.

Some examples of using filters are:

* `done:true` --> The operation is complete.
* `(metadata.@type:type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata)
AND (metadata.source_type:BACKUP)
AND (metadata.backup_info.backup:backup_howl)
AND (metadata.name:restored_howl)
AND (metadata.progress.start_time < \"2018-03-28T14:50:00Z\")
AND (error:*)`
--> Return RestoreDatabase operations from backups whose name
contains "backup_howl", where the created database name
contains the string "restored_howl", the start_time of the
restore operation is before 2018-03-28T14:50:00Z,
and the operation returned an error.

Returns:
An object of the form:

{ # The response for
# ListDatabaseOperations.
"nextPageToken": "A String", # `next_page_token` can be sent in a subsequent
# ListDatabaseOperations
# call to fetch more of the matching metadata.
"operations": [ # The list of matching database long-running
# operations. Each operation's name will be
# prefixed by the database's name. The operation's
# metadata field type
# `metadata.type_url` describes the type of the metadata.
{ # This resource represents a long-running operation that is the result of a
# network API call.
"response": { # The normal response of the operation in case of success. If the original
# method returns no data on success, such as `Delete`, the response is
# `google.protobuf.Empty`. If the original method is standard
# `Get`/`Create`/`Update`, the response should be the resource. For other
# methods, the response should have the type `XxxResponse`, where `Xxx`
# is the original method name. For example, if the original method name
# is `TakeSnapshot()`, the inferred response type is
# `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"metadata": { # Service-specific metadata associated with the operation. It typically
# contains progress information and common metadata such as create time.
# Some services might not provide such metadata. Any method that returns a
# long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"done": True or False, # If the value is `false`, it means the operation is still in progress.
# If `true`, the operation is completed, and either `error` or `response` is
# available.
"name": "A String", # The server-assigned name, which is only unique within the same service that
# originally returns it. If you use the default HTTP mapping, the
# `name` should be a resource name ending with `operations/{unique_id}`.
"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
# different programming environments, including REST APIs and RPC APIs. It is
# used by [gRPC](https://github.com/grpc). Each `Status` message contains
# three pieces of data: error code, error message, and error details.
#
# You can find out more about this error model and how to work with it in the
# [API Design Guide](https://cloud.google.com/apis/design/errors).
"message": "A String", # A developer-facing error message, which should be in English. Any
# user-facing error message should be localized and sent in the
# google.rpc.Status.details field, or localized by the client.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of
# message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
},
],
}

Cloud Spanner API . projects . instances . databaseOperations

Instance Methods

Method Details