Class ListInstancesResponse (6.89.0)

publicfinalclassListInstancesResponseextendsGeneratedMessageV3implementsListInstancesResponseOrBuilder

The response for ListInstances.

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

Static Fields

INSTANCES_FIELD_NUMBER

publicstaticfinalintINSTANCES_FIELD_NUMBER
Field Value
TypeDescription
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

publicstaticfinalintNEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

UNREACHABLE_FIELD_NUMBER

publicstaticfinalintUNREACHABLE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticListInstancesResponsegetDefaultInstance()
Returns
TypeDescription
ListInstancesResponse

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticListInstancesResponse.BuildernewBuilder()
Returns
TypeDescription
ListInstancesResponse.Builder

newBuilder(ListInstancesResponse prototype)

publicstaticListInstancesResponse.BuildernewBuilder(ListInstancesResponseprototype)
Parameter
NameDescription
prototypeListInstancesResponse
Returns
TypeDescription
ListInstancesResponse.Builder

parseDelimitedFrom(InputStream input)

publicstaticListInstancesResponseparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticListInstancesResponseparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticListInstancesResponseparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticListInstancesResponseparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticListInstancesResponseparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticListInstancesResponseparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticListInstancesResponseparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ListInstancesResponse
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<ListInstancesResponse>parser()
Returns
TypeDescription
Parser<ListInstancesResponse>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

publicListInstancesResponsegetDefaultInstanceForType()
Returns
TypeDescription
ListInstancesResponse

getInstances(int index)

publicInstancegetInstances(intindex)

The list of requested instances.

repeated .google.spanner.admin.instance.v1.Instance instances = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
Instance

getInstancesCount()

publicintgetInstancesCount()

The list of requested instances.

repeated .google.spanner.admin.instance.v1.Instance instances = 1;

Returns
TypeDescription
int

getInstancesList()

publicList<Instance>getInstancesList()

The list of requested instances.

repeated .google.spanner.admin.instance.v1.Instance instances = 1;

Returns
TypeDescription
List<Instance>

getInstancesOrBuilder(int index)

publicInstanceOrBuildergetInstancesOrBuilder(intindex)

The list of requested instances.

repeated .google.spanner.admin.instance.v1.Instance instances = 1;

Parameter
NameDescription
indexint
Returns
TypeDescription
InstanceOrBuilder

getInstancesOrBuilderList()

publicList<?extendsInstanceOrBuilder>getInstancesOrBuilderList()

The list of requested instances.

repeated .google.spanner.admin.instance.v1.Instance instances = 1;

Returns
TypeDescription
List<? extends com.google.spanner.admin.instance.v1.InstanceOrBuilder>

getNextPageToken()

publicStringgetNextPageToken()

next_page_token can be sent in a subsequent ListInstances call to fetch more of the matching instances.

string next_page_token = 2;

Returns
TypeDescription
String

The nextPageToken.

getNextPageTokenBytes()

publicByteStringgetNextPageTokenBytes()

next_page_token can be sent in a subsequent ListInstances call to fetch more of the matching instances.

string next_page_token = 2;

Returns
TypeDescription
ByteString

The bytes for nextPageToken.

getParserForType()

publicParser<ListInstancesResponse>getParserForType()
Returns
TypeDescription
Parser<ListInstancesResponse>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

getUnreachable(int index)

publicStringgetUnreachable(intindex)

The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline.

repeated string unreachable = 3;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The unreachable at the given index.

getUnreachableBytes(int index)

publicByteStringgetUnreachableBytes(intindex)

The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline.

repeated string unreachable = 3;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

publicintgetUnreachableCount()

The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline.

repeated string unreachable = 3;

Returns
TypeDescription
int

The count of unreachable.

getUnreachableList()

publicProtocolStringListgetUnreachableList()

The list of unreachable instances. It includes the names of instances whose metadata could not be retrieved within instance_deadline.

repeated string unreachable = 3;

Returns
TypeDescription
ProtocolStringList

A list containing the unreachable.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicListInstancesResponse.BuildernewBuilderForType()
Returns
TypeDescription
ListInstancesResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedListInstancesResponse.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ListInstancesResponse.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicListInstancesResponse.BuildertoBuilder()
Returns
TypeDescription
ListInstancesResponse.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException