Class ListInstancePartitionsRequest.Builder (6.108.0)

public static final class ListInstancePartitionsRequest.Builder extends GeneratedMessage.Builder<ListInstancePartitionsRequest.Builder> implements ListInstancePartitionsRequestOrBuilder

The request for ListInstancePartitions.

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

build()

public ListInstancePartitionsRequest build()
Returns
Type Description
ListInstancePartitionsRequest

buildPartial()

public ListInstancePartitionsRequest buildPartial()
Returns
Type Description
ListInstancePartitionsRequest

clear()

public ListInstancePartitionsRequest.Builder clear()
Returns
Type Description
ListInstancePartitionsRequest.Builder
Overrides

clearInstancePartitionDeadline()

public ListInstancePartitionsRequest.Builder clearInstancePartitionDeadline()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListInstancePartitionsRequest.Builder

clearPageSize()

public ListInstancePartitionsRequest.Builder clearPageSize()

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

int32 page_size = 2;

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

clearPageToken()

public ListInstancePartitionsRequest.Builder clearPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

string page_token = 3;

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

clearParent()

public ListInstancePartitionsRequest.Builder clearParent()

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

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

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public ListInstancePartitionsRequest getDefaultInstanceForType()
Returns
Type Description
ListInstancePartitionsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getInstancePartitionDeadline()

public Timestamp getInstancePartitionDeadline()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Timestamp

The instancePartitionDeadline.

getInstancePartitionDeadlineBuilder()

public Timestamp.Builder getInstancePartitionDeadlineBuilder()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Builder

getInstancePartitionDeadlineOrBuilder()

public TimestampOrBuilder getInstancePartitionDeadlineOrBuilder()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TimestampOrBuilder

getPageSize()

public int getPageSize()

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

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

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 whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

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

Returns
Type Description
ByteString

The bytes for parent.

hasInstancePartitionDeadline()

public boolean hasInstancePartitionDeadline()

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the instancePartitionDeadline field is set.

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListInstancePartitionsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListInstancePartitionsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListInstancePartitionsRequest.Builder
Overrides

mergeFrom(ListInstancePartitionsRequest other)

public ListInstancePartitionsRequest.Builder mergeFrom(ListInstancePartitionsRequest other)
Parameter
Name Description
other ListInstancePartitionsRequest
Returns
Type Description
ListInstancePartitionsRequest.Builder

mergeInstancePartitionDeadline(Timestamp value)

public ListInstancePartitionsRequest.Builder mergeInstancePartitionDeadline(Timestamp value)

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
ListInstancePartitionsRequest.Builder

setInstancePartitionDeadline(Timestamp value)

public ListInstancePartitionsRequest.Builder setInstancePartitionDeadline(Timestamp value)

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value Timestamp
Returns
Type Description
ListInstancePartitionsRequest.Builder

setInstancePartitionDeadline(Timestamp.Builder builderForValue)

public ListInstancePartitionsRequest.Builder setInstancePartitionDeadline(Timestamp.Builder builderForValue)

Optional. Deadline used while retrieving metadata for instance partitions. Instance partitions whose metadata cannot be retrieved within this deadline will be added to unreachable in ListInstancePartitionsResponse.

.google.protobuf.Timestamp instance_partition_deadline = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
ListInstancePartitionsRequest.Builder

setPageSize(int value)

public ListInstancePartitionsRequest.Builder setPageSize(int value)

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

int32 page_size = 2;

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListInstancePartitionsRequest.Builder setPageToken(String value)

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

string page_token = 3;

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListInstancePartitionsRequest.Builder setPageTokenBytes(ByteString value)

If non-empty, page_token should contain a next_page_token from a previous ListInstancePartitionsResponse.

string page_token = 3;

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

setParent(String value)

public ListInstancePartitionsRequest.Builder setParent(String value)

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

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

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListInstancePartitionsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListInstancePartitionsRequest.Builder setParentBytes(ByteString value)

Required. The instance whose instance partitions should be listed. Values are of the form projects/<project>/instances/<instance>. Use {instance} = '-' to list instance partitions for all Instances in a project, e.g., projects/myproject/instances/-.

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
ListInstancePartitionsRequest.Builder

This builder for chaining.