Reference documentation and code samples for the Cloud Spanner V1 Client class ListBackupOperationsRequest.
The request for ListBackupOperations.
Generated from protobuf message google.spanner.admin.database.v1.ListBackupOperationsRequest
Namespace
Google \ Cloud \ Spanner \ Admin \ Database \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The instance of the backup operations. Values are of the form |
↳ filter |
string
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: |
↳ page_size |
int
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size. |
↳ page_token |
string
If non-empty, |
getParent
Required. The instance of the backup operations. Values are of
the form projects/<project>/instances/<instance>
.
Returns | |
---|---|
Type | Description |
string |
setParent
Required. The instance of the backup operations. Values are of
the form projects/<project>/instances/<instance>
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getFilter
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 operationdone
- False if the operation is in progress, else true.metadata.@type
- the type of metadata. For example, the type string for CreateBackupMetadata istype.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata
.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, but 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.CreateBackupMetadata) AND
\metadata.database:prod
- Returns operations where:- The operation's metadata type is CreateBackupMetadata.
- The source database name of backup contains 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.
(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
\(metadata.source_backup:test) AND
\(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND
\(error:*)
- Returns operations where:- The operation's metadata type is CopyBackupMetadata.
- The source backup name contains the string "test".
- The operation started before 2022-01-18T14:50:00Z.
- The operation resulted in an error.
((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND
\(metadata.database:test_db)) OR
\((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
\(metadata.source_backup:test_bkp)) AND
\(error:*)
- Returns operations where:- The operation's metadata matches either of criteria:
- The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db"
- The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp"
- The operation resulted in an error.
- The operation's metadata matches either of criteria:
Returns | |
---|---|
Type | Description |
string |
setFilter
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 operationdone
- False if the operation is in progress, else true.metadata.@type
- the type of metadata. For example, the type string for CreateBackupMetadata istype.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata
.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, but 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.CreateBackupMetadata) AND
\metadata.database:prod
- Returns operations where:- The operation's metadata type is CreateBackupMetadata.
- The source database name of backup contains 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.
(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
\(metadata.source_backup:test) AND
\(metadata.progress.start_time < \"2022-01-18T14:50:00Z\") AND
\(error:*)
- Returns operations where:- The operation's metadata type is CopyBackupMetadata.
- The source backup name contains the string "test".
- The operation started before 2022-01-18T14:50:00Z.
- The operation resulted in an error.
((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND
\(metadata.database:test_db)) OR
\((metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CopyBackupMetadata) AND
\(metadata.source_backup:test_bkp)) AND
\(error:*)
- Returns operations where:- The operation's metadata matches either of criteria:
- The operation's metadata type is CreateBackupMetadata AND the source database name of the backup contains the string "test_db"
- The operation's metadata type is CopyBackupMetadata AND the source backup name contains the string "test_bkp"
- The operation resulted in an error.
- The operation's metadata matches either of criteria:
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getPageSize
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Returns | |
---|---|
Type | Description |
int |
setPageSize
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getPageToken
If non-empty, page_token
should contain a
next_page_token
from a previous
ListBackupOperationsResponse
to the same parent
and with the same filter
.
Returns | |
---|---|
Type | Description |
string |
setPageToken
If non-empty, page_token
should contain a
next_page_token
from a previous
ListBackupOperationsResponse
to the same parent
and with the same filter
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
static::build
Parameter | |
---|---|
Name | Description |
parent |
string
Required. The instance of the backup operations. Values are of
the form |
Returns | |
---|---|
Type | Description |
Google\Cloud\Spanner\Admin\Database\V1\ListBackupOperationsRequest |