Class ListInstancesResponse (6.74.1)

public final class ListInstancesResponse extends GeneratedMessageV3 implements ListInstancesResponseOrBuilder

The response for ListInstances.

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

Static Fields

INSTANCES_FIELD_NUMBER

public static final int INSTANCES_FIELD_NUMBER
Field Value
Type Description
int

NEXT_PAGE_TOKEN_FIELD_NUMBER

public static final int NEXT_PAGE_TOKEN_FIELD_NUMBER
Field Value
Type Description
int

UNREACHABLE_FIELD_NUMBER

public static final int UNREACHABLE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ListInstancesResponse getDefaultInstance()
Returns
Type Description
ListInstancesResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ListInstancesResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public ListInstancesResponse getDefaultInstanceForType()
Returns
Type Description
ListInstancesResponse

getInstances(int index)

public Instance getInstances(int index)

The list of requested instances.

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

Parameter
Name Description
index int
Returns
Type Description
Instance

getInstancesCount()

public int getInstancesCount()

The list of requested instances.

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

Returns
Type Description
int

getInstancesList()

public List<Instance> getInstancesList()

The list of requested instances.

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

Returns
Type Description
List<Instance>

getInstancesOrBuilder(int index)

public InstanceOrBuilder getInstancesOrBuilder(int index)

The list of requested instances.

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

Parameter
Name Description
index int
Returns
Type Description
InstanceOrBuilder

getInstancesOrBuilderList()

public List<? extends InstanceOrBuilder> getInstancesOrBuilderList()

The list of requested instances.

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

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

getNextPageToken()

public String getNextPageToken()

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

string next_page_token = 2;

Returns
Type Description
String

The nextPageToken.

getNextPageTokenBytes()

public ByteString getNextPageTokenBytes()

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

string next_page_token = 2;

Returns
Type Description
ByteString

The bytes for nextPageToken.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnreachable(int index)

public String getUnreachable(int index)

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
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The unreachable at the given index.

getUnreachableBytes(int index)

public ByteString getUnreachableBytes(int index)

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
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the unreachable at the given index.

getUnreachableCount()

public int getUnreachableCount()

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
Type Description
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

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
Type Description
ProtocolStringList

A list containing the unreachable.

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 ListInstancesResponse.Builder newBuilderForType()
Returns
Type Description
ListInstancesResponse.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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