Class ListInstancesRequest.Builder (0.1.0)

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

Message for requesting list of Instances

Protobuf type google.cloud.alloydb.v1beta.ListInstancesRequest

Inheritance

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

Implements

ListInstancesRequestOrBuilder

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)

GeneratedMessageV3.Builder.internalGetMutableMapField(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 ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

build()

public ListInstancesRequest build()

Returns

Type	Description
`ListInstancesRequest`

buildPartial()

public ListInstancesRequest buildPartial()

Returns

Type	Description
`ListInstancesRequest`

clear()

public ListInstancesRequest.Builder clear()

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
`field`	`FieldDescriptor`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

clearFilter()

public ListInstancesRequest.Builder clearFilter()

Optional. Filtering results

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
`oneof`	`OneofDescriptor`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

clearOrderBy()

public ListInstancesRequest.Builder clearOrderBy()

Optional. Hint for how to order the results

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

clearPageSize()

public ListInstancesRequest.Builder clearPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

clearPageToken()

public ListInstancesRequest.Builder clearPageToken()

A token identifying a page of results the server should return.

string page_token = 3;

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

clearParent()

public ListInstancesRequest.Builder clearParent()

Required. The name of the parent resource. For the required format, see the comment on the Instance.name field. Additionally, you can perform an aggregated list operation by specifying a value with one of the following formats:

projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-

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

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

clone()

public ListInstancesRequest.Builder clone()

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public ListInstancesRequest getDefaultInstanceForType()

Returns

Type	Description
`ListInstancesRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFilter()

public String getFilter()

Optional. Filtering results

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`String`	The filter.

getFilterBytes()

public ByteString getFilterBytes()

Optional. Filtering results

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`ByteString`	The bytes for filter.

getOrderBy()

public String getOrderBy()

Optional. Hint for how to order the results

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`String`	The orderBy.

getOrderByBytes()

public ByteString getOrderByBytes()

Optional. Hint for how to order the results

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`ByteString`	The bytes for orderBy.

getPageSize()

public int getPageSize()

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
`int`	The pageSize.

getPageToken()

public String getPageToken()

A token identifying a page of results the server should return.

string page_token = 3;

Returns

Type	Description
`String`	The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

A token identifying a page of results the server should return.

string page_token = 3;

Returns

Type	Description
`ByteString`	The bytes for pageToken.

getParent()

public String getParent()

projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-

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

Returns

Type	Description
`String`	The parent.

getParentBytes()

public ByteString getParentBytes()

projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-

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(ListInstancesRequest other)

public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)

Parameter

Name	Description
`other`	`ListInstancesRequest`

Returns

Type	Description
`ListInstancesRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

Exceptions

Type	Description
`IOException`

mergeFrom(Message other)

public ListInstancesRequest.Builder mergeFrom(Message other)

Parameter

Name	Description
`other`	`Message`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

setFilter(String value)

public ListInstancesRequest.Builder setFilter(String value)

Optional. Filtering results

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`String` The filter to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setFilterBytes(ByteString value)

public ListInstancesRequest.Builder setFilterBytes(ByteString value)

Optional. Filtering results

string filter = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`ByteString` The bytes for filter to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setOrderBy(String value)

public ListInstancesRequest.Builder setOrderBy(String value)

Optional. Hint for how to order the results

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`String` The orderBy to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setOrderByBytes(ByteString value)

public ListInstancesRequest.Builder setOrderByBytes(ByteString value)

Optional. Hint for how to order the results

string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`ByteString` The bytes for orderBy to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setPageSize(int value)

public ListInstancesRequest.Builder setPageSize(int value)

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
`value`	`int` The pageSize to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setPageToken(String value)

public ListInstancesRequest.Builder setPageToken(String value)

A token identifying a page of results the server should return.

string page_token = 3;

Parameter

Name	Description
`value`	`String` The pageToken to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)

A token identifying a page of results the server should return.

string page_token = 3;

Parameter

Name	Description
`value`	`ByteString` The bytes for pageToken to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setParent(String value)

public ListInstancesRequest.Builder setParent(String value)

projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-

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

Parameter

Name	Description
`value`	`String` The parent to set.

Returns

Type	Description
`ListInstancesRequest.Builder`	This builder for chaining.

setParentBytes(ByteString value)

public ListInstancesRequest.Builder setParentBytes(ByteString value)

projects/{project}/locations/-/clusters/-
projects/{project}/locations/{region}/clusters/-

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
`ListInstancesRequest.Builder`	This builder for chaining.

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

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

Parameters

Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
`unknownFields`	`UnknownFieldSet`

Returns

Type	Description
`ListInstancesRequest.Builder`

Overrides

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