Class ListBackupsRequest.Builder (6.56.0)

Version 6.56.0

• 6.80.1 (latest)
• 6.79.0
• 6.77.0
• 6.74.1
• 6.72.0
• 6.71.0
• 6.69.0
• 6.68.0
• 6.66.0
• 6.65.1
• 6.62.0
• 6.60.0
• 6.58.0
• 6.57.0
• 6.56.0
• 6.55.0
• 6.54.0
• 6.53.0
• 6.52.1
• 6.51.0
• 6.50.1
• 6.49.0
• 6.25.1
• 6.24.0
• 6.23.4
• 6.22.0
• 6.21.2
• 6.20.0
• 6.19.1
• 6.18.0
• 6.17.4
• 6.14.1

public static final class ListBackupsRequest.Builder extends GeneratedMessageV3.Builder<ListBackupsRequest.Builder> implements ListBackupsRequestOrBuilder

The request for ListBackups.

Protobuf type google.spanner.admin.database.v1.ListBackupsRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ListBackupsRequest.Builder

Implements

ListBackupsRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListBackupsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
ListBackupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

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:

• name
• database
• state
• create_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;

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListBackupsRequest getDefaultInstanceForType()

Returns
Type	Description
ListBackupsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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:

• name
• database
• state
• create_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;

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:

• name
• database
• state
• create_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;

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public ListBackupsRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
ListBackupsRequest.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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:

• name
• database
• state
• create_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;

Parameter
Name	Description
value	String The 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:

• name
• database
• state
• create_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;

Parameter
Name	Description
value	ByteString The 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	int The 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	String The 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	ByteString The 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	String The 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	ByteString The 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

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final ListBackupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
ListBackupsRequest.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)