public final class ListBackupsRequest extends GeneratedMessageV3 implements ListBackupsRequestOrBuilder
The request for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsRequest
Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
PAGE_SIZE_FIELD_NUMBER
public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
PAGE_TOKEN_FIELD_NUMBER
public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
PARENT_FIELD_NUMBER
public static final int PARENT_FIELD_NUMBER
Field Value
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getDefaultInstance()
public static ListBackupsRequest getDefaultInstance()
Returns
getDefaultInstanceForType()
public ListBackupsRequest getDefaultInstanceForType()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
getFilter()
public String getFilter()
An expression that filters the list of returned backups.
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 Backup are eligible for filtering:
namedatabasestatecreate_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)version_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)size_bytes
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:name:Howl - The backup's name contains the string "howl".database:prod
- The database's name contains the string "prod".
state:CREATING - The backup is pending creation.state:READY - The backup is fully created and ready for use.(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")
- The backup name contains the string "howl" and
create_time
of the backup is before 2018-03-28T14:50:00Z.
expire_time < \"2018-03-28T14:50:00Z\"
- The backup
expire_time is before 2018-03-28T14:50:00Z.
size_bytes > 10000000000 - The backup's size is greater than 10GB
string filter = 2;
| Type | Description |
| String | The filter.
|
getFilterBytes()
public ByteString getFilterBytes()
An expression that filters the list of returned backups.
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 Backup are eligible for filtering:
namedatabasestatecreate_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)expire_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)version_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)size_bytes
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:name:Howl - The backup's name contains the string "howl".database:prod
- The database's name contains the string "prod".
state:CREATING - The backup is pending creation.state:READY - The backup is fully created and ready for use.(name:howl) AND (create_time < \"2018-03-28T14:50:00Z\")
- The backup name contains the string "howl" and
create_time
of the backup is before 2018-03-28T14:50:00Z.
expire_time < \"2018-03-28T14:50:00Z\"
- The backup
expire_time is before 2018-03-28T14:50:00Z.
size_bytes > 10000000000 - The backup's size is greater than 10GB
string filter = 2;
getPageSize()
Number of backups 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 String getPageToken()
If non-empty, page_token should contain a
next_page_token from a
previous ListBackupsResponse to the same parent and with the same
filter.
string page_token = 4;
| Type | Description |
| String | The pageToken.
|
getPageTokenBytes()
public ByteString getPageTokenBytes()
If non-empty, page_token should contain a
next_page_token from a
previous ListBackupsResponse to the same parent and with the same
filter.
string page_token = 4;
getParent()
public String getParent()
Required. The instance to list backups from. 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 ByteString getParentBytes()
Required. The instance to list backups from. Values are of the
form projects/<project>/instances/<instance>.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
getParserForType()
public Parser<ListBackupsRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilder()
public static ListBackupsRequest.Builder newBuilder()
Returns
newBuilder(ListBackupsRequest prototype)
public static ListBackupsRequest.Builder newBuilder(ListBackupsRequest prototype)
Parameter
Returns
newBuilderForType()
public ListBackupsRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBackupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public static ListBackupsRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListBackupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ListBackupsRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ListBackupsRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListBackupsRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static ListBackupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static ListBackupsRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static ListBackupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ListBackupsRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<ListBackupsRequest> parser()
Returns
toBuilder()
public ListBackupsRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
