Class ListDatabasesResponse.Builder (3.25.1)

public static final class ListDatabasesResponse.Builder extends GeneratedMessageV3.Builder<ListDatabasesResponse.Builder> implements ListDatabasesResponseOrBuilder

The list of databases for a project.

Protobuf type google.firestore.admin.v1.ListDatabasesResponse

Static Methods

getDescriptor()

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

Methods

addAllDatabases(Iterable<? extends Database> values)

public ListDatabasesResponse.Builder addAllDatabases(Iterable<? extends Database> values)

The databases in the project.

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

Parameter
Name Description
values Iterable<? extends com.google.firestore.admin.v1.Database>
Returns
Type Description
ListDatabasesResponse.Builder

addAllUnreachable(Iterable<String> values)

public ListDatabasesResponse.Builder addAllUnreachable(Iterable<String> values)

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
values Iterable<String>

The unreachable to add.

Returns
Type Description
ListDatabasesResponse.Builder

This builder for chaining.

addDatabases(Database value)

public ListDatabasesResponse.Builder addDatabases(Database value)

The databases in the project.

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

Parameter
Name Description
value Database
Returns
Type Description
ListDatabasesResponse.Builder

addDatabases(Database.Builder builderForValue)

public ListDatabasesResponse.Builder addDatabases(Database.Builder builderForValue)

The databases in the project.

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

Parameter
Name Description
builderForValue Database.Builder
Returns
Type Description
ListDatabasesResponse.Builder

addDatabases(int index, Database value)

public ListDatabasesResponse.Builder addDatabases(int index, Database value)

The databases in the project.

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

Parameters
Name Description
index int
value Database
Returns
Type Description
ListDatabasesResponse.Builder

addDatabases(int index, Database.Builder builderForValue)

public ListDatabasesResponse.Builder addDatabases(int index, Database.Builder builderForValue)

The databases in the project.

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

Parameters
Name Description
index int
builderForValue Database.Builder
Returns
Type Description
ListDatabasesResponse.Builder

addDatabasesBuilder()

public Database.Builder addDatabasesBuilder()

The databases in the project.

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

Returns
Type Description
Database.Builder

addDatabasesBuilder(int index)

public Database.Builder addDatabasesBuilder(int index)

The databases in the project.

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

Parameter
Name Description
index int
Returns
Type Description
Database.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListDatabasesResponse.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

addUnreachable(String value)

public ListDatabasesResponse.Builder addUnreachable(String value)

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
value String

The unreachable to add.

Returns
Type Description
ListDatabasesResponse.Builder

This builder for chaining.

addUnreachableBytes(ByteString value)

public ListDatabasesResponse.Builder addUnreachableBytes(ByteString value)

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
value ByteString

The bytes of the unreachable to add.

Returns
Type Description
ListDatabasesResponse.Builder

This builder for chaining.

build()

public ListDatabasesResponse build()
Returns
Type Description
ListDatabasesResponse

buildPartial()

public ListDatabasesResponse buildPartial()
Returns
Type Description
ListDatabasesResponse

clear()

public ListDatabasesResponse.Builder clear()
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

clearDatabases()

public ListDatabasesResponse.Builder clearDatabases()

The databases in the project.

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

Returns
Type Description
ListDatabasesResponse.Builder

clearField(Descriptors.FieldDescriptor field)

public ListDatabasesResponse.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListDatabasesResponse.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

clearUnreachable()

public ListDatabasesResponse.Builder clearUnreachable()

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

This builder for chaining.

clone()

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

getDatabasesBuilder(int index)

public Database.Builder getDatabasesBuilder(int index)

The databases in the project.

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

Parameter
Name Description
index int
Returns
Type Description
Database.Builder

getDatabasesBuilderList()

public List<Database.Builder> getDatabasesBuilderList()

The databases in the project.

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

Returns
Type Description
List<Builder>

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListDatabasesResponse other)

public ListDatabasesResponse.Builder mergeFrom(ListDatabasesResponse other)
Parameter
Name Description
other ListDatabasesResponse
Returns
Type Description
ListDatabasesResponse.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListDatabasesResponse.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListDatabasesResponse.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListDatabasesResponse.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListDatabasesResponse.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

removeDatabases(int index)

public ListDatabasesResponse.Builder removeDatabases(int index)

The databases in the project.

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

Parameter
Name Description
index int
Returns
Type Description
ListDatabasesResponse.Builder

setDatabases(int index, Database value)

public ListDatabasesResponse.Builder setDatabases(int index, Database value)

The databases in the project.

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

Parameters
Name Description
index int
value Database
Returns
Type Description
ListDatabasesResponse.Builder

setDatabases(int index, Database.Builder builderForValue)

public ListDatabasesResponse.Builder setDatabases(int index, Database.Builder builderForValue)

The databases in the project.

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

Parameters
Name Description
index int
builderForValue Database.Builder
Returns
Type Description
ListDatabasesResponse.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public ListDatabasesResponse.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListDatabasesResponse.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListDatabasesResponse.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListDatabasesResponse.Builder
Overrides

setUnreachable(int index, String value)

public ListDatabasesResponse.Builder setUnreachable(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The unreachable to set.

Returns
Type Description
ListDatabasesResponse.Builder

This builder for chaining.