public static final class ListBackupsRequest.Builder extends GeneratedMessageV3.Builder<ListBackupsRequest.Builder> implements ListBackupsRequestOrBuilderThe request for ListBackups.
Protobuf type google.bigtable.admin.v2.ListBackupsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupsRequest.BuilderImplements
ListBackupsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListBackupsRequest.Builder |
build()
public ListBackupsRequest build()| Type | Description |
| ListBackupsRequest |
buildPartial()
public ListBackupsRequest buildPartial()| Type | Description |
| ListBackupsRequest |
clear()
public ListBackupsRequest.Builder clear()| Type | Description |
| ListBackupsRequest.Builder |
clearField(Descriptors.FieldDescriptor field)
public ListBackupsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| ListBackupsRequest.Builder |
clearFilter()
public ListBackupsRequest.Builder clearFilter()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_bytesTo 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 |
| ListBackupsRequest.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBackupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| ListBackupsRequest.Builder |
clearOrderBy()
public ListBackupsRequest.Builder clearOrderBy()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_timein descending order starting from the most recently created backup.
string order_by = 3;
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
clearPageSize()
public ListBackupsRequest.Builder clearPageSize()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 |
| ListBackupsRequest.Builder | This builder for chaining. |
clearPageToken()
public ListBackupsRequest.Builder clearPageToken() 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 |
| ListBackupsRequest.Builder | This builder for chaining. |
clearParent()
public ListBackupsRequest.Builder clearParent() 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 |
| ListBackupsRequest.Builder | This builder for chaining. |
clone()
public ListBackupsRequest.Builder clone()| Type | Description |
| ListBackupsRequest.Builder |
getDefaultInstanceForType()
public ListBackupsRequest getDefaultInstanceForType()| Type | Description |
| ListBackupsRequest |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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_bytesTo 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_bytesTo 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 |
| ByteString | The bytes for filter. |
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_timein 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_timein descending order starting from the most recently created backup.
string order_by = 3;
| Type | Description |
| ByteString | The bytes for orderBy. |
getPageSize()
public int 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;
| Type | Description |
| ByteString | The bytes for pageToken. |
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) = { ... }
| Type | Description |
| ByteString | The bytes for parent. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(ListBackupsRequest other)
public ListBackupsRequest.Builder mergeFrom(ListBackupsRequest other)| Name | Description |
| other | ListBackupsRequest |
| Type | Description |
| ListBackupsRequest.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBackupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| ListBackupsRequest.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public ListBackupsRequest.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| ListBackupsRequest.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListBackupsRequest.Builder |
setField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| ListBackupsRequest.Builder |
setFilter(String value)
public ListBackupsRequest.Builder setFilter(String value)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_bytesTo 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;
| Name | Description |
| value | StringThe filter to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setFilterBytes(ByteString value)
public ListBackupsRequest.Builder setFilterBytes(ByteString value)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_bytesTo 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;
| Name | Description |
| value | ByteStringThe bytes for filter to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setOrderBy(String value)
public ListBackupsRequest.Builder setOrderBy(String value)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_timein descending order starting from the most recently created backup.
string order_by = 3;
| Name | Description |
| value | StringThe orderBy to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setOrderByBytes(ByteString value)
public ListBackupsRequest.Builder setOrderByBytes(ByteString value)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_timein descending order starting from the most recently created backup.
string order_by = 3;
| Name | Description |
| value | ByteStringThe bytes for orderBy to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setPageSize(int value)
public ListBackupsRequest.Builder setPageSize(int value)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;
| Name | Description |
| value | intThe pageSize to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setPageToken(String value)
public ListBackupsRequest.Builder setPageToken(String value) 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;
| Name | Description |
| value | StringThe pageToken to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setPageTokenBytes(ByteString value)
public ListBackupsRequest.Builder setPageTokenBytes(ByteString value) 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;
| Name | Description |
| value | ByteStringThe bytes for pageToken to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setParent(String value)
public ListBackupsRequest.Builder setParent(String value) 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) = { ... }
| Name | Description |
| value | StringThe parent to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setParentBytes(ByteString value)
public ListBackupsRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Name | Description |
| value | ByteStringThe bytes for parent to set. |
| Type | Description |
| ListBackupsRequest.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ListBackupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| ListBackupsRequest.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| ListBackupsRequest.Builder |