Class ListInstancePartitionsRequest (6.83.0)

public final class ListInstancePartitionsRequest extends GeneratedMessageV3 implements ListInstancePartitionsRequestOrBuilder

The request for ListInstancePartitions.

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

Static Fields

INSTANCE_PARTITION_DEADLINE_FIELD_NUMBER

public static final int INSTANCE_PARTITION_DEADLINE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
Type Description
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListInstancePartitionsRequest getDefaultInstance()
Returns
Type Description
ListInstancePartitionsRequest

getDescriptor()

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

newBuilder()

public static ListInstancePartitionsRequest.Builder newBuilder()
Returns
Type Description
ListInstancePartitionsRequest.Builder

newBuilder(ListInstancePartitionsRequest prototype)

public static ListInstancePartitionsRequest.Builder newBuilder(ListInstancePartitionsRequest prototype)
Parameter
Name Description
prototype ListInstancePartitionsRequest
Returns
Type Description
ListInstancePartitionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListInstancePartitionsRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ListInstancePartitionsRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListInstancePartitionsRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListInstancePartitionsRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ListInstancePartitionsRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ListInstancePartitionsRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListInstancePartitionsRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ListInstancePartitionsRequest> parser()
Returns
Type Description
Parser<ListInstancePartitionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ListInstancePartitionsRequest getDefaultInstanceForType()
Returns
Type Description
ListInstancePartitionsRequest

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.

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

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

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

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<ListInstancePartitionsRequest> getParserForType()
Returns
Type Description
Parser<ListInstancePartitionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ListInstancePartitionsRequest.Builder newBuilderForType()
Returns
Type Description
ListInstancePartitionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListInstancePartitionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ListInstancePartitionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ListInstancePartitionsRequest.Builder toBuilder()
Returns
Type Description
ListInstancePartitionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException