com.google.spanner.admin.instance.v1

Class ListInstancesRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

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

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

com.google.spanner.admin.instance.v1.ListInstancesRequest.Builder

All Implemented Interfaces:

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

Enclosing class:

ListInstancesRequest

public static final class ListInstancesRequest.Builder
extends GeneratedMessageV3.Builder<ListInstancesRequest.Builder>
implements ListInstancesRequestOrBuilder

 The request for [ListInstances][google.spanner.admin.instance.v1.InstanceAdmin.ListInstances].
 

Protobuf type google.spanner.admin.instance.v1.ListInstancesRequest

Method Summary

Modifier and Type	Method and Description
ListInstancesRequest.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
ListInstancesRequest	build()
ListInstancesRequest	buildPartial()
ListInstancesRequest.Builder	clear()
ListInstancesRequest.Builder	clearField(Descriptors.FieldDescriptor field)
ListInstancesRequest.Builder	clearFilter() An expression for filtering the results of the request.
ListInstancesRequest.Builder	clearOneof(Descriptors.OneofDescriptor oneof)
ListInstancesRequest.Builder	clearPageSize() Number of instances to be returned in the response.
ListInstancesRequest.Builder	clearPageToken() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
ListInstancesRequest.Builder	clearParent() Required.
ListInstancesRequest.Builder	clone()
ListInstancesRequest	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getFilter() An expression for filtering the results of the request.
ByteString	getFilterBytes() An expression for filtering the results of the request.
int	getPageSize() Number of instances to be returned in the response.
String	getPageToken() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
ByteString	getPageTokenBytes() If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
String	getParent() Required.
ByteString	getParentBytes() Required.
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
ListInstancesRequest.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
ListInstancesRequest.Builder	mergeFrom(ListInstancesRequest other)
ListInstancesRequest.Builder	mergeFrom(Message other)
ListInstancesRequest.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
ListInstancesRequest.Builder	setField(Descriptors.FieldDescriptor field, Object value)
ListInstancesRequest.Builder	setFilter(String value) An expression for filtering the results of the request.
ListInstancesRequest.Builder	setFilterBytes(ByteString value) An expression for filtering the results of the request.
ListInstancesRequest.Builder	setPageSize(int value) Number of instances to be returned in the response.
ListInstancesRequest.Builder	setPageToken(String value) If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
ListInstancesRequest.Builder	setPageTokenBytes(ByteString value) If non-empty, `page_token` should contain a [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
ListInstancesRequest.Builder	setParent(String value) Required.
ListInstancesRequest.Builder	setParentBytes(ByteString value) Required.
ListInstancesRequest.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
ListInstancesRequest.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<ListInstancesRequest.Builder>

clear

public ListInstancesRequest.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<ListInstancesRequest.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<ListInstancesRequest.Builder>

getDefaultInstanceForType

public ListInstancesRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public ListInstancesRequest build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public ListInstancesRequest buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public ListInstancesRequest.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

setField

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

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

clearField

public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

clearOneof

public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

setRepeatedField

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

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

addRepeatedField

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

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

mergeFrom

public ListInstancesRequest.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<ListInstancesRequest.Builder>

mergeFrom

public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

mergeFrom

public ListInstancesRequest.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<ListInstancesRequest.Builder>

Throws:

IOException

getParent

public String getParent()

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParent in interface ListInstancesRequestOrBuilder

Returns:

The parent.

getParentBytes

public ByteString getParentBytes()

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Specified by:

getParentBytes in interface ListInstancesRequestOrBuilder

Returns:

The bytes for parent.

setParent

public ListInstancesRequest.Builder setParent(String value)

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

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 ListInstancesRequest.Builder clearParent()

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

This builder for chaining.

setParentBytes

public ListInstancesRequest.Builder setParentBytes(ByteString value)

 Required. The name of the project for which a list of instances is
 requested. Values are of the form `projects/<project>`.
 

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.

getPageSize

public int getPageSize()

 Number of instances to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
 

int32 page_size = 2;

Specified by:

getPageSize in interface ListInstancesRequestOrBuilder

Returns:

The pageSize.

setPageSize

public ListInstancesRequest.Builder setPageSize(int value)

 Number of instances to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
 

int32 page_size = 2;

Parameters:

value - The pageSize to set.

Returns:

This builder for chaining.

clearPageSize

public ListInstancesRequest.Builder clearPageSize()

 Number of instances to be returned in the response. If 0 or less, defaults
 to the server's maximum allowed page size.
 

int32 page_size = 2;

Returns:

This builder for chaining.

getPageToken

public String getPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
 previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
 

string page_token = 3;

Specified by:

getPageToken in interface ListInstancesRequestOrBuilder

Returns:

The pageToken.

getPageTokenBytes

public ByteString getPageTokenBytes()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
 previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
 

string page_token = 3;

Specified by:

getPageTokenBytes in interface ListInstancesRequestOrBuilder

Returns:

The bytes for pageToken.

setPageToken

public ListInstancesRequest.Builder setPageToken(String value)

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
 previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
 

string page_token = 3;

Parameters:

value - The pageToken to set.

Returns:

This builder for chaining.

clearPageToken

public ListInstancesRequest.Builder clearPageToken()

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
 previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
 

string page_token = 3;

Returns:

This builder for chaining.

setPageTokenBytes

public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)

 If non-empty, `page_token` should contain a
 [next_page_token][google.spanner.admin.instance.v1.ListInstancesResponse.next_page_token] from a
 previous [ListInstancesResponse][google.spanner.admin.instance.v1.ListInstancesResponse].
 

string page_token = 3;

Parameters:

value - The bytes for pageToken to set.

Returns:

This builder for chaining.

getFilter

public String getFilter()

 An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `name`
   * `display_name`
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `name:*` --> The instance has a name.
   * `name:Howl` --> The instance's name contains the string "howl".
   * `name:HOWL` --> Equivalent to above.
   * `NAME:howl` --> Equivalent to above.
   * `labels.env:*` --> The instance has the label "env".
   * `labels.env:dev` --> The instance has the label "env" and the value of
                        the label contains the string "dev".
   * `name:howl labels.env:dev` --> The instance's name contains "howl" and
                                  it has the label "env" with its value
                                  containing "dev".
 

string filter = 4;

Specified by:

getFilter in interface ListInstancesRequestOrBuilder

Returns:

The filter.

getFilterBytes

public ByteString getFilterBytes()

 An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `name`
   * `display_name`
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `name:*` --> The instance has a name.
   * `name:Howl` --> The instance's name contains the string "howl".
   * `name:HOWL` --> Equivalent to above.
   * `NAME:howl` --> Equivalent to above.
   * `labels.env:*` --> The instance has the label "env".
   * `labels.env:dev` --> The instance has the label "env" and the value of
                        the label contains the string "dev".
   * `name:howl labels.env:dev` --> The instance's name contains "howl" and
                                  it has the label "env" with its value
                                  containing "dev".
 

string filter = 4;

Specified by:

getFilterBytes in interface ListInstancesRequestOrBuilder

Returns:

The bytes for filter.

setFilter

public ListInstancesRequest.Builder setFilter(String value)

 An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `name`
   * `display_name`
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `name:*` --> The instance has a name.
   * `name:Howl` --> The instance's name contains the string "howl".
   * `name:HOWL` --> Equivalent to above.
   * `NAME:howl` --> Equivalent to above.
   * `labels.env:*` --> The instance has the label "env".
   * `labels.env:dev` --> The instance has the label "env" and the value of
                        the label contains the string "dev".
   * `name:howl labels.env:dev` --> The instance's name contains "howl" and
                                  it has the label "env" with its value
                                  containing "dev".
 

string filter = 4;

Parameters:

value - The filter to set.

Returns:

This builder for chaining.

clearFilter

public ListInstancesRequest.Builder clearFilter()

 An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `name`
   * `display_name`
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `name:*` --> The instance has a name.
   * `name:Howl` --> The instance's name contains the string "howl".
   * `name:HOWL` --> Equivalent to above.
   * `NAME:howl` --> Equivalent to above.
   * `labels.env:*` --> The instance has the label "env".
   * `labels.env:dev` --> The instance has the label "env" and the value of
                        the label contains the string "dev".
   * `name:howl labels.env:dev` --> The instance's name contains "howl" and
                                  it has the label "env" with its value
                                  containing "dev".
 

string filter = 4;

Returns:

This builder for chaining.

setFilterBytes

public ListInstancesRequest.Builder setFilterBytes(ByteString value)

 An expression for filtering the results of the request. Filter rules are
 case insensitive. The fields eligible for filtering are:
   * `name`
   * `display_name`
   * `labels.key` where key is the name of a label
 Some examples of using filters are:
   * `name:*` --> The instance has a name.
   * `name:Howl` --> The instance's name contains the string "howl".
   * `name:HOWL` --> Equivalent to above.
   * `NAME:howl` --> Equivalent to above.
   * `labels.env:*` --> The instance has the label "env".
   * `labels.env:dev` --> The instance has the label "env" and the value of
                        the label contains the string "dev".
   * `name:howl labels.env:dev` --> The instance's name contains "howl" and
                                  it has the label "env" with its value
                                  containing "dev".
 

string filter = 4;

Parameters:

value - The bytes for filter to set.

Returns:

This builder for chaining.

setUnknownFields

public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>

mergeUnknownFields

public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<ListInstancesRequest.Builder>