Class ListDatabasesResponse (3.22.0)

public final class ListDatabasesResponse extends GeneratedMessageV3 implements ListDatabasesResponseOrBuilder

The list of databases for a project.

Protobuf type google.firestore.admin.v1.ListDatabasesResponse

Static Fields

DATABASES_FIELD_NUMBER

public static final int DATABASES_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 ListDatabasesResponse getDefaultInstance()
Returns
Type Description
ListDatabasesResponse

getDescriptor()

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

newBuilder()

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

newBuilder(ListDatabasesResponse prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDatabases(int index)

public Database getDatabases(int index)

The databases in the project.

repeated .google.firestore.admin.v1.Database databases = 1;

Parameter
Name Description
index int
Returns
Type Description
Database

getDatabasesCount()

public int getDatabasesCount()

The databases in the project.

repeated .google.firestore.admin.v1.Database databases = 1;

Returns
Type Description
int

getDatabasesList()

public List<Database> getDatabasesList()

The databases in the project.

repeated .google.firestore.admin.v1.Database databases = 1;

Returns
Type Description
List<Database>

getDatabasesOrBuilder(int index)

public DatabaseOrBuilder getDatabasesOrBuilder(int index)

The databases in the project.

repeated .google.firestore.admin.v1.Database databases = 1;

Parameter
Name Description
index int
Returns
Type Description
DatabaseOrBuilder

getDatabasesOrBuilderList()

public List<? extends DatabaseOrBuilder> getDatabasesOrBuilderList()

The databases in the project.

repeated .google.firestore.admin.v1.Database databases = 1;

Returns
Type Description
List<? extends com.google.firestore.admin.v1.DatabaseOrBuilder>

getDefaultInstanceForType()

public ListDatabasesResponse getDefaultInstanceForType()
Returns
Type Description
ListDatabasesResponse

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnreachable(int index)

public String getUnreachable(int index)

In the event that data about individual databases cannot be listed they will be recorded here.

An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location.

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)

In the event that data about individual databases cannot be listed they will be recorded here.

An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location.

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()

In the event that data about individual databases cannot be listed they will be recorded here.

An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location.

repeated string unreachable = 3;

Returns
Type Description
int

The count of unreachable.

getUnreachableList()

public ProtocolStringList getUnreachableList()

In the event that data about individual databases cannot be listed they will be recorded here.

An example entry might be: projects/some_project/locations/some_location This can happen if the Cloud Region that the Database resides in is currently unavailable. In this case we can't fetch all the details about the database. You may be able to get a more detailed error message (or possibly fetch the resource) by sending a 'Get' request for the resource or a 'List' request for the specific location.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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