public interface ListBackupOperationsRequestOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getFilter()
public abstract String 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.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.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.
string filter = 2;
Type | Description |
String | The filter. |
getFilterBytes()
public abstract ByteString getFilterBytes()
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.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.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.
string filter = 2;
Type | Description |
ByteString | The bytes for filter. |
getPageSize()
public abstract int getPageSize()
Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
int32 page_size = 3;
Type | Description |
int | The pageSize. |
getPageToken()
public abstract String 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
.
string page_token = 4;
Type | Description |
String | The pageToken. |
getPageTokenBytes()
public abstract ByteString getPageTokenBytes()
If non-empty, page_token
should contain a
next_page_token
from a previous ListBackupOperationsResponse to the
same parent
and with the same filter
.
string page_token = 4;
Type | Description |
ByteString | The bytes for pageToken. |
getParent()
public abstract String getParent()
Required. The instance of the backup operations. Values are of
the form projects/<project>/instances/<instance>
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
String | The parent. |
getParentBytes()
public abstract ByteString getParentBytes()
Required. The instance of the backup operations. Values are of
the form projects/<project>/instances/<instance>
.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
Type | Description |
ByteString | The bytes for parent. |