public static final class ListBackupsRequest.Builder extends GeneratedMessageV3.Builder<ListBackupsRequest.Builder> implements ListBackupsRequestOrBuilderThe request for ListBackups.
Protobuf type google.spanner.admin.database.v1.ListBackupsRequest
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupsRequest.BuilderImplements
ListBackupsRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
build()
public ListBackupsRequest build()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
buildPartial()
public ListBackupsRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
clear()
public ListBackupsRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
clearField(Descriptors.FieldDescriptor field)
public ListBackupsRequest.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
clearFilter()
public ListBackupsRequest.Builder clearFilter()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_schedulesYou 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_timeof the backup is before 2018-03-28T14:50:00Z.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"- The backup
expire_timeis before 2018-03-28T14:50:00Z.
- The backup
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 |
ListBackupsRequest.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ListBackupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
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 = 3;
| Returns | |
|---|---|
| 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 = 4;
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
clearParent()
public ListBackupsRequest.Builder clearParent() 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 |
ListBackupsRequest.Builder |
This builder for chaining. |
clone()
public ListBackupsRequest.Builder clone()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
getDefaultInstanceForType()
public ListBackupsRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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_schedulesYou 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_timeof the backup is before 2018-03-28T14:50:00Z.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"- The backup
expire_timeis before 2018-03-28T14:50:00Z.
- The backup
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_schedulesYou 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_timeof the backup is before 2018-03-28T14:50:00Z.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"- The backup
expire_timeis before 2018-03-28T14:50:00Z.
- The backup
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()
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 = 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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ListBackupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ListBackupsRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
mergeFrom(ListBackupsRequest other)
public ListBackupsRequest.Builder mergeFrom(ListBackupsRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListBackupsRequest |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setField(Descriptors.FieldDescriptor field, Object value)
public ListBackupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setFilter(String value)
public ListBackupsRequest.Builder setFilter(String value)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_schedulesYou 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_timeof the backup is before 2018-03-28T14:50:00Z.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"- The backup
expire_timeis before 2018-03-28T14:50:00Z.
- The backup
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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe filter to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setFilterBytes(ByteString value)
public ListBackupsRequest.Builder setFilterBytes(ByteString value)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_schedulesYou 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_timeof the backup is before 2018-03-28T14:50:00Z.
- The backup name contains the string "howl" and
expire_time < \"2018-03-28T14:50:00Z\"- The backup
expire_timeis before 2018-03-28T14:50:00Z.
- The backup
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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for filter to set. |
| Returns | |
|---|---|
| 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 = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe pageSize to set. |
| Returns | |
|---|---|
| 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 = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pageToken to set. |
| Returns | |
|---|---|
| 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 = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pageToken to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setParent(String value)
public ListBackupsRequest.Builder setParent(String value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public ListBackupsRequest.Builder setParentBytes(ByteString value) 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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| 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)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ListBackupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ListBackupsRequest.Builder |
|