Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::ListDatabaseOperationsRequest.
The request for ListDatabaseOperations.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#filter
def filter() -> ::String
-
(::String) —
An expression that filters the list of returned 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 operationdone
- False if the operation is in progress, else true.metadata.@type
- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata
.metadata.<field_name>
- any field in metadata.value.metadata.@type
must be specified first, if filtering on metadata fields.error
- Error associated with the long-running operation.response.@type
- the type of response.response.<field_name>
- any field in response.value.
You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
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 operations where:- The operation's metadata type is RestoreDatabaseMetadata.
- The database is restored from a backup.
- The backup name contains "backup_howl".
- The restored database's name contains "restored_howl".
- The operation started before 2018-03-28T14:50:00Z.
- The operation resulted in an error.
#filter=
def filter=(value) -> ::String
-
value (::String) —
An expression that filters the list of returned 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 operationdone
- False if the operation is in progress, else true.metadata.@type
- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata
.metadata.<field_name>
- any field in metadata.value.metadata.@type
must be specified first, if filtering on metadata fields.error
- Error associated with the long-running operation.response.@type
- the type of response.response.<field_name>
- any field in response.value.
You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
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 operations where:- The operation's metadata type is RestoreDatabaseMetadata.
- The database is restored from a backup.
- The backup name contains "backup_howl".
- The restored database's name contains "restored_howl".
- The operation started before 2018-03-28T14:50:00Z.
- The operation resulted in an error.
-
(::String) —
An expression that filters the list of returned 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 operationdone
- False if the operation is in progress, else true.metadata.@type
- the type of metadata. For example, the type string for RestoreDatabaseMetadata istype.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata
.metadata.<field_name>
- any field in metadata.value.metadata.@type
must be specified first, if filtering on metadata fields.error
- Error associated with the long-running operation.response.@type
- the type of response.response.<field_name>
- any field in response.value.
You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly.
Here are a few examples:
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 operations where:- The operation's metadata type is RestoreDatabaseMetadata.
- The database is restored from a backup.
- The backup name contains "backup_howl".
- The restored database's name contains "restored_howl".
- The operation started before 2018-03-28T14:50:00Z.
- The operation resulted in an error.
#page_size
def page_size() -> ::Integer
- (::Integer) — Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
#page_size=
def page_size=(value) -> ::Integer
- value (::Integer) — Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
- (::Integer) — Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
#page_token
def page_token() -> ::String
-
(::String) — If non-empty,
page_token
should contain a next_page_token from a previous ListDatabaseOperationsResponse to the sameparent
and with the samefilter
.
#page_token=
def page_token=(value) -> ::String
-
value (::String) — If non-empty,
page_token
should contain a next_page_token from a previous ListDatabaseOperationsResponse to the sameparent
and with the samefilter
.
-
(::String) — If non-empty,
page_token
should contain a next_page_token from a previous ListDatabaseOperationsResponse to the sameparent
and with the samefilter
.
#parent
def parent() -> ::String
-
(::String) — Required. The instance of the database operations.
Values are of the form
projects/<project>/instances/<instance>
.
#parent=
def parent=(value) -> ::String
-
value (::String) — Required. The instance of the database operations.
Values are of the form
projects/<project>/instances/<instance>
.
-
(::String) — Required. The instance of the database operations.
Values are of the form
projects/<project>/instances/<instance>
.