com.google.spanner.admin.database.v1

Class ListBackupsRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

com.google.spanner.admin.database.v1.ListBackupsRequest.Builder

All Implemented Interfaces:

Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, ListBackupsRequestOrBuilder, Cloneable

Enclosing class:

ListBackupsRequest

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

 The request for [ListBackups][google.spanner.admin.database.v1.DatabaseAdmin.ListBackups].
 

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

Method Summary

Modifier and Type	Method and Description
ListBackupsRequest.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
ListBackupsRequest	build()
ListBackupsRequest	buildPartial()
ListBackupsRequest.Builder	clear()
ListBackupsRequest.Builder	clearField(Descriptors.FieldDescriptor field)
ListBackupsRequest.Builder	clearFilter() An expression that filters the list of returned backups.
ListBackupsRequest.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
ListBackupsRequest.Builder	clearPageSize() Number of backups to be returned in the response.
ListBackupsRequest.Builder	clearPageToken() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
ListBackupsRequest.Builder	clearParent() Required.
ListBackupsRequest.Builder	clone()
ListBackupsRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getFilter() An expression that filters the list of returned backups.
ByteString	getFilterBytes() An expression that filters the list of returned backups.
int	getPageSize() Number of backups to be returned in the response.
String	getPageToken() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
ByteString	getPageTokenBytes() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
String	getParent() Required.
ByteString	getParentBytes() Required.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListBackupsRequest.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ListBackupsRequest.Builder	mergeFrom(ListBackupsRequest other)
ListBackupsRequest.Builder	mergeFrom(Message other)
ListBackupsRequest.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
ListBackupsRequest.Builder	setField(Descriptors.FieldDescriptor field, Object value)
ListBackupsRequest.Builder	setFilter(String value) An expression that filters the list of returned backups.
ListBackupsRequest.Builder	setFilterBytes(ByteString value) An expression that filters the list of returned backups.
ListBackupsRequest.Builder	setPageSize(int value) Number of backups to be returned in the response.
ListBackupsRequest.Builder	setPageToken(String value) If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
ListBackupsRequest.Builder	setPageTokenBytes(ByteString value) If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same `filter`.
ListBackupsRequest.Builder	setParent(String value) Required.
ListBackupsRequest.Builder	setParentBytes(ByteString value) Required.
ListBackupsRequest.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
ListBackupsRequest.Builder	setUnknownFields(UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

clear

public ListBackupsRequest.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

getDefaultInstanceForType

public ListBackupsRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ListBackupsRequest build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ListBackupsRequest buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public ListBackupsRequest.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

setField

public ListBackupsRequest.Builder setField(Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

clearField

public ListBackupsRequest.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

clearOneof

public ListBackupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

setRepeatedField

public ListBackupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                                   int index,
                                                   Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

addRepeatedField

public ListBackupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                                   Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

mergeFrom

public ListBackupsRequest.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListBackupsRequest.Builder>

mergeFrom

public ListBackupsRequest.Builder mergeFrom(ListBackupsRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

mergeFrom

public ListBackupsRequest.Builder mergeFrom(CodedInputStream input,
                                            ExtensionRegistryLite extensionRegistry)
                                     throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListBackupsRequest.Builder>

Throws:

IOException

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) = { ... }

Specified by:

getParent in interface ListBackupsRequestOrBuilder

Returns:

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) = { ... }

Specified by:

getParentBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for parent.

setParent

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) = { ... }

Parameters:

value - The parent to set.

Returns:

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:

This builder for chaining.

setParentBytes

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) = { ... }

Parameters:

value - The bytes for parent to set.

Returns:

This builder for chaining.

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][google.spanner.admin.database.v1.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;

Specified by:

getFilter in interface ListBackupsRequestOrBuilder

Returns:

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][google.spanner.admin.database.v1.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;

Specified by:

getFilterBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for filter.

setFilter

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][google.spanner.admin.database.v1.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;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

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][google.spanner.admin.database.v1.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:

This builder for chaining.

setFilterBytes

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][google.spanner.admin.database.v1.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;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

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;

Specified by:

getPageSize in interface ListBackupsRequestOrBuilder

Returns:

The pageSize.

setPageSize

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;

Parameters:

value - The pageSize to set.

Returns:

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 = 3;

Returns:

This builder for chaining.

getPageToken

public String getPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
 previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
 `filter`.
 

string page_token = 4;

Specified by:

getPageToken in interface ListBackupsRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public ByteString getPageTokenBytes()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
 previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
 `filter`.
 

string page_token = 4;

Specified by:

getPageTokenBytes in interface ListBackupsRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListBackupsRequest.Builder setPageToken(String value)

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
 previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
 `filter`.
 

string page_token = 4;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListBackupsRequest.Builder clearPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
 previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
 `filter`.
 

string page_token = 4;

Returns:

This builder for chaining.

setPageTokenBytes

public ListBackupsRequest.Builder setPageTokenBytes(ByteString value)

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.database.v1.ListBackupsResponse.next_page_token] from a
 previous [ListBackupsResponse][google.spanner.admin.database.v1.ListBackupsResponse] to the same `parent` and with the same
 `filter`.
 

string page_token = 4;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListBackupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>

mergeUnknownFields

public final ListBackupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<ListBackupsRequest.Builder>