public final class ListBackupOperationsRequest extends GeneratedMessageV3 implements ListBackupOperationsRequestOrBuilder
The request for
ListBackupOperations.
Protobuf type google.spanner.admin.database.v1.ListBackupOperationsRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static ListBackupOperationsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListBackupOperationsRequest.Builder newBuilder()
newBuilder(ListBackupOperationsRequest prototype)
public static ListBackupOperationsRequest.Builder newBuilder(ListBackupOperationsRequest prototype)
public static ListBackupOperationsRequest parseDelimitedFrom(InputStream input)
public static ListBackupOperationsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListBackupOperationsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBackupOperationsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListBackupOperationsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupOperationsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupOperationsRequest parseFrom(CodedInputStream input)
public static ListBackupOperationsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListBackupOperationsRequest parseFrom(InputStream input)
public static ListBackupOperationsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListBackupOperationsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBackupOperationsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListBackupOperationsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListBackupOperationsRequest getDefaultInstanceForType()
getFilter()
public 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 is
type.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 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.
(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 of the copied 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
database the backup was taken from has name containing string
"test_db"
- The operation's metadata type is CopyBackupMetadata AND the
backup the backup was copied from has name containing string
"test_bkp"
- The operation resulted in an error.
string filter = 2;
| Returns |
| Type |
Description |
String |
The filter.
|
getFilterBytes()
public 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 is
type.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 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.
(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 of the copied 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
database the backup was taken from has name containing string
"test_db"
- The operation's metadata type is CopyBackupMetadata AND the
backup the backup was copied from has name containing string
"test_bkp"
- The operation resulted in an error.
string filter = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
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;
| Returns |
| Type |
Description |
int |
The pageSize.
|
getPageToken()
public 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;
| Returns |
| Type |
Description |
String |
The pageToken.
|
getPageTokenBytes()
public 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
getParent()
public 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) = { ... }
| Returns |
| Type |
Description |
String |
The parent.
|
getParentBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListBackupOperationsRequest> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public ListBackupOperationsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBackupOperationsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListBackupOperationsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
