public final class ListBackupsRequest extends GeneratedMessageV3 implements ListBackupsRequestOrBuilder
The request for ListBackups.
Protobuf type google.bigtable.admin.v2.ListBackupsRequest
Fields
FILTER_FIELD_NUMBER
public static final int FILTER_FIELD_NUMBER
Field Value
ORDER_BY_FIELD_NUMBER
public static final int ORDER_BY_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()
A filter expression that filters backups listed in the response.
The expression must specify the field name, a comparison operator,
and the value that you want to use for filtering. The value must be a
string, a number, or a boolean. The comparison operator must be
<, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is
roughly synonymous with equality. Filter rules are case insensitive.
The fields eligible for filtering are:
namesource_tablestatestart_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)end_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)size_bytes
To filter on multiple expressions, provide each separate expression within
parentheses. By default, each expression is an AND expression. However,
you can include AND, OR, and NOT expressions explicitly.
Some examples of using filters are:name:"exact" --> The backup's name is the string "exact".name:howl --> The backup's name contains the string "howl".source_table:prod
--> The source_table'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 (start_time < \"2018-03-28T14:50:00Z\")
--> The backup name contains the string "howl" and start_time
of the backup 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()
A filter expression that filters backups listed in the response.
The expression must specify the field name, a comparison operator,
and the value that you want to use for filtering. The value must be a
string, a number, or a boolean. The comparison operator must be
<, >, <=, >=, !=, =, or :. Colon ':' represents a HAS operator which is
roughly synonymous with equality. Filter rules are case insensitive.
The fields eligible for filtering are:
namesource_tablestatestart_time (and values are of the format YYYY-MM-DDTHH:MM:SSZ)end_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)size_bytes
To filter on multiple expressions, provide each separate expression within
parentheses. By default, each expression is an AND expression. However,
you can include AND, OR, and NOT expressions explicitly.
Some examples of using filters are:name:"exact" --> The backup's name is the string "exact".name:howl --> The backup's name contains the string "howl".source_table:prod
--> The source_table'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 (start_time < \"2018-03-28T14:50:00Z\")
--> The backup name contains the string "howl" and start_time
of the backup is before 2018-03-28T14:50:00Z.size_bytes > 10000000000 --> The backup's size is greater than 10GB
string filter = 2;
getOrderBy()
public String getOrderBy()
An expression for specifying the sort order of the results of the request.
The string value should specify one or more fields in Backup. The full
syntax is described at https://aip.dev/132#ordering.
Fields supported are:
- name
- source_table
- expire_time
- start_time
- end_time
- size_bytes
- state
For example, "start_time". The default sorting order is ascending.
To specify descending order for the field, a suffix " desc" should
be appended to the field name. For example, "start_time desc".
Redundant space characters in the syntax are insigificant.
If order_by is empty, results will be sorted by
start_time in descending
order starting from the most recently created backup.
string order_by = 3;
| Type | Description |
| String | The orderBy.
|
getOrderByBytes()
public ByteString getOrderByBytes()
An expression for specifying the sort order of the results of the request.
The string value should specify one or more fields in Backup. The full
syntax is described at https://aip.dev/132#ordering.
Fields supported are:
- name
- source_table
- expire_time
- start_time
- end_time
- size_bytes
- state
For example, "start_time". The default sorting order is ascending.
To specify descending order for the field, a suffix " desc" should
be appended to the field name. For example, "start_time desc".
Redundant space characters in the syntax are insigificant.
If order_by is empty, results will be sorted by
start_time in descending
order starting from the most recently created backup.
string order_by = 3;
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 = 4;
| 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 = 5;
| 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 = 5;
getParent()
public String getParent()
Required. The cluster to list backups from. Values are of the
form projects/{project}/instances/{instance}/clusters/{cluster}.
Use {cluster} = '-' to list backups for all clusters in an instance,
e.g., projects/{project}/instances/{instance}/clusters/-.
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Type | Description |
| String | The parent.
|
getParentBytes()
public ByteString getParentBytes()
Required. The cluster to list backups from. Values are of the
form projects/{project}/instances/{instance}/clusters/{cluster}.
Use {cluster} = '-' to list backups for all clusters in an instance,
e.g., projects/{project}/instances/{instance}/clusters/-.
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
