Class ListInstancesRequest.Builder (2.40.0)

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

Request for ListInstances.

Protobuf type google.cloud.redis.v1beta1.ListInstancesRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

build()

public ListInstancesRequest build()
Returns
TypeDescription
ListInstancesRequest

buildPartial()

public ListInstancesRequest buildPartial()
Returns
TypeDescription
ListInstancesRequest

clear()

public ListInstancesRequest.Builder clear()
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListInstancesRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListInstancesRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

clearPageSize()

public ListInstancesRequest.Builder clearPageSize()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

int32 page_size = 2;

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearPageToken()

public ListInstancesRequest.Builder clearPageToken()

The next_page_token value returned from a previous ListInstances request, if any.

string page_token = 3;

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clearParent()

public ListInstancesRequest.Builder clearParent()

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

clone()

public ListInstancesRequest.Builder clone()
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

getDefaultInstanceForType()

public ListInstancesRequest getDefaultInstanceForType()
Returns
TypeDescription
ListInstancesRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getPageSize()

public int getPageSize()

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

int32 page_size = 2;

Returns
TypeDescription
int

The pageSize.

getPageToken()

public String getPageToken()

The next_page_token value returned from a previous ListInstances request, if any.

string page_token = 3;

Returns
TypeDescription
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

The next_page_token value returned from a previous ListInstances request, if any.

string page_token = 3;

Returns
TypeDescription
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Returns
TypeDescription
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Returns
TypeDescription
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ListInstancesRequest other)

public ListInstancesRequest.Builder mergeFrom(ListInstancesRequest other)
Parameter
NameDescription
otherListInstancesRequest
Returns
TypeDescription
ListInstancesRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancesRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public ListInstancesRequest.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListInstancesRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setPageSize(int value)

public ListInstancesRequest.Builder setPageSize(int value)

The maximum number of items to return.

If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's next_page_token to determine if there are more instances left to be queried.

int32 page_size = 2;

Parameter
NameDescription
valueint

The pageSize to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInstancesRequest.Builder setPageToken(String value)

The next_page_token value returned from a previous ListInstances request, if any.

string page_token = 3;

Parameter
NameDescription
valueString

The pageToken to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancesRequest.Builder setPageTokenBytes(ByteString value)

The next_page_token value returned from a previous ListInstances request, if any.

string page_token = 3;

Parameter
NameDescription
valueByteString

The bytes for pageToken to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setParent(String value)

public ListInstancesRequest.Builder setParent(String value)

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Parameter
NameDescription
valueString

The parent to set.

Returns
TypeDescription
ListInstancesRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListInstancesRequest.Builder setParentBytes(ByteString value)

Required. The resource name of the instance location using the form: projects/{project_id}/locations/{location_id} where location_id refers to a GCP region.

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

Parameter
NameDescription
valueByteString

The bytes for parent to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListInstancesRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
ListInstancesRequest.Builder
Overrides