public final class ListBackupsRequest extends GeneratedMessageV3 implements ListBackupsRequestOrBuilder
The request for
ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsRequest
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 ListBackupsRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static ListBackupsRequest.Builder newBuilder()
newBuilder(ListBackupsRequest prototype)
public static ListBackupsRequest.Builder newBuilder(ListBackupsRequest prototype)
public static ListBackupsRequest parseDelimitedFrom(InputStream input)
public static ListBackupsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static ListBackupsRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static ListBackupsRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(CodedInputStream input)
public static ListBackupsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(InputStream input)
public static ListBackupsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static ListBackupsRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ListBackupsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<ListBackupsRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public ListBackupsRequest getDefaultInstanceForType()
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_bytesbackup_schedules
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 10GBbackup_schedules:daily
- The backup is created from a schedule with "daily" in its name.
string filter = 2;
| Returns |
| 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_bytesbackup_schedules
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 10GBbackup_schedules:daily
- The backup is created from a schedule with "daily" in its name.
string filter = 2;
| Returns |
| Type |
Description |
ByteString |
The bytes for filter.
|
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;
| Returns |
| 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;
| Returns |
| 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;
| Returns |
| Type |
Description |
ByteString |
The bytes for pageToken.
|
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) = { ... }
| Returns |
| 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for parent.
|
getParserForType()
public Parser<ListBackupsRequest> 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 ListBackupsRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ListBackupsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public ListBackupsRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
