Class ListInstancePartitionsRequest (6.87.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
TypeDescription
int

PAGE_SIZE_FIELD_NUMBER

public static final int PAGE_SIZE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_TOKEN_FIELD_NUMBER

public static final int PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ListInstancePartitionsRequest getDefaultInstance()
Returns
TypeDescription
ListInstancePartitionsRequest

getDescriptor()

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

newBuilder()

public static ListInstancePartitionsRequest.Builder newBuilder()
Returns
TypeDescription
ListInstancePartitionsRequest.Builder

newBuilder(ListInstancePartitionsRequest )

public static ListInstancePartitionsRequest.Builder newBuilder(ListInstancePartitionsRequest )
Parameter
NameDescription
ListInstancePartitionsRequest
Returns
TypeDescription
ListInstancePartitionsRequest.Builder

parseDelimitedFrom(InputStream input)

public static ListInstancePartitionsRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ListInstancePartitionsRequest parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ListInstancePartitionsRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ListInstancePartitionsRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ListInstancePartitionsRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ListInstancePartitionsRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ListInstancePartitionsRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancePartitionsRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ListInstancePartitionsRequest> parser()
Returns
TypeDescription
Parser<ListInstancePartitionsRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ListInstancePartitionsRequest getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for parent.

getParserForType()

public Parser<ListInstancePartitionsRequest> getParserForType()
Returns
TypeDescription
Parser<ListInstancePartitionsRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

Whether the instancePartitionDeadline field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ListInstancePartitionsRequest.Builder newBuilderForType()
Returns
TypeDescription
ListInstancePartitionsRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ListInstancePartitionsRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListInstancePartitionsRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ListInstancePartitionsRequest.Builder toBuilder()
Returns
TypeDescription
ListInstancePartitionsRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException