Class Database.Builder (3.5.0)

public static final class Database.Builder extends GeneratedMessageV3.Builder<Database.Builder> implements DatabaseOrBuilder

A Cloud Firestore Database. Currently only one database is allowed per cloud project; this database must have a database_id of '(default)'.

Protobuf type google.firestore.admin.v1.Database

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Database.Builder

Implements

DatabaseOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Database build()

Returns

Type	Description
Database

buildPartial()

public Database buildPartial()

Returns

Type	Description
Database

clear()

public Database.Builder clear()

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAppEngineIntegrationMode()

public Database.Builder clearAppEngineIntegrationMode()

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Returns

Type	Description
Database.Builder	This builder for chaining.

clearConcurrencyMode()

public Database.Builder clearConcurrencyMode()

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Returns

Type	Description
Database.Builder	This builder for chaining.

clearEtag()

public Database.Builder clearEtag()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 99;

Returns

Type	Description
Database.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Database.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearKeyPrefix()

public Database.Builder clearKeyPrefix()

Output only. The key_prefix for this database. This key_prefix is used, in combination with the project id ("<key prefix>~<project id>") to construct the application id that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).

string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Database.Builder	This builder for chaining.

clearLocationId()

public Database.Builder clearLocationId()

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Returns

Type	Description
Database.Builder	This builder for chaining.

clearName()

public Database.Builder clearName()

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Returns

Type	Description
Database.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Database.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearType()

public Database.Builder clearType()

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

.google.firestore.admin.v1.Database.DatabaseType type = 10;

Returns

Type	Description
Database.Builder	This builder for chaining.

clone()

public Database.Builder clone()

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAppEngineIntegrationMode()

public Database.AppEngineIntegrationMode getAppEngineIntegrationMode()

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Returns

Type	Description
Database.AppEngineIntegrationMode	The appEngineIntegrationMode.

getAppEngineIntegrationModeValue()

public int getAppEngineIntegrationModeValue()

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Returns

Type	Description
int	The enum numeric value on the wire for appEngineIntegrationMode.

getConcurrencyMode()

public Database.ConcurrencyMode getConcurrencyMode()

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Returns

Type	Description
Database.ConcurrencyMode	The concurrencyMode.

getConcurrencyModeValue()

public int getConcurrencyModeValue()

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Returns

Type	Description
int	The enum numeric value on the wire for concurrencyMode.

getDefaultInstanceForType()

public Database getDefaultInstanceForType()

Returns

Type	Description
Database

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getEtag()

public String getEtag()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 99;

Returns

Type	Description
String	The etag.

getEtagBytes()

public ByteString getEtagBytes()

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 99;

Returns

Type	Description
ByteString	The bytes for etag.

getKeyPrefix()

public String getKeyPrefix()

string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
String	The keyPrefix.

getKeyPrefixBytes()

public ByteString getKeyPrefixBytes()

string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
ByteString	The bytes for keyPrefix.

getLocationId()

public String getLocationId()

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Returns

Type	Description
String	The locationId.

getLocationIdBytes()

public ByteString getLocationIdBytes()

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Returns

Type	Description
ByteString	The bytes for locationId.

getName()

public String getName()

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getType()

public Database.DatabaseType getType()

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

.google.firestore.admin.v1.Database.DatabaseType type = 10;

Returns

Type	Description
Database.DatabaseType	The type.

getTypeValue()

public int getTypeValue()

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

.google.firestore.admin.v1.Database.DatabaseType type = 10;

Returns

Type	Description
int	The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Database other)

public Database.Builder mergeFrom(Database other)

Parameter

Name	Description
other	`Database`

Returns

Type	Description
Database.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Database.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Database.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Database.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Database.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAppEngineIntegrationMode(Database.AppEngineIntegrationMode value)

public Database.Builder setAppEngineIntegrationMode(Database.AppEngineIntegrationMode value)

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Parameter

Name	Description
value	`Database.AppEngineIntegrationMode` The appEngineIntegrationMode to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setAppEngineIntegrationModeValue(int value)

public Database.Builder setAppEngineIntegrationModeValue(int value)

The App Engine integration mode to use for this database.

.google.firestore.admin.v1.Database.AppEngineIntegrationMode app_engine_integration_mode = 19;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for appEngineIntegrationMode to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setConcurrencyMode(Database.ConcurrencyMode value)

public Database.Builder setConcurrencyMode(Database.ConcurrencyMode value)

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Parameter

Name	Description
value	`Database.ConcurrencyMode` The concurrencyMode to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setConcurrencyModeValue(int value)

public Database.Builder setConcurrencyModeValue(int value)

The concurrency control mode to use for this database.

.google.firestore.admin.v1.Database.ConcurrencyMode concurrency_mode = 15;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for concurrencyMode to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setEtag(String value)

public Database.Builder setEtag(String value)

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 99;

Parameter

Name	Description
value	`String` The etag to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setEtagBytes(ByteString value)

public Database.Builder setEtagBytes(ByteString value)

This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.

string etag = 99;

Parameter

Name	Description
value	`ByteString` The bytes for etag to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setKeyPrefix(String value)

public Database.Builder setKeyPrefix(String value)

string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`String` The keyPrefix to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setKeyPrefixBytes(ByteString value)

public Database.Builder setKeyPrefixBytes(ByteString value)

string key_prefix = 20 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`ByteString` The bytes for keyPrefix to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setLocationId(String value)

public Database.Builder setLocationId(String value)

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Parameter

Name	Description
value	`String` The locationId to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setLocationIdBytes(ByteString value)

public Database.Builder setLocationIdBytes(ByteString value)

The location of the database. Available databases are listed at https://cloud.google.com/firestore/docs/locations.

string location_id = 9;

Parameter

Name	Description
value	`ByteString` The bytes for locationId to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setName(String value)

public Database.Builder setName(String value)

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Database.Builder setNameBytes(ByteString value)

The resource name of the Database. Format: projects/{project}/databases/{database}

string name = 1;

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setType(Database.DatabaseType value)

public Database.Builder setType(Database.DatabaseType value)

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

.google.firestore.admin.v1.Database.DatabaseType type = 10;

Parameter

Name	Description
value	`Database.DatabaseType` The type to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setTypeValue(int value)

public Database.Builder setTypeValue(int value)

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

.google.firestore.admin.v1.Database.DatabaseType type = 10;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for type to set.

Returns

Type	Description
Database.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Database.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)