Class Database.Builder (3.13.2)

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

Implements

DatabaseOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Database.Builder
Overrides

build()

public Database build()
Returns
TypeDescription
Database

buildPartial()

public Database buildPartial()
Returns
TypeDescription
Database

clear()

public Database.Builder clear()
Returns
TypeDescription
Database.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Database.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Database.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Database.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
Database.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Database.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Database.Builder
Overrides

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
TypeDescription
Database.Builder

This builder for chaining.

clone()

public Database.Builder clone()
Returns
TypeDescription
Database.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for concurrencyMode.

getDefaultInstanceForType()

public Database getDefaultInstanceForType()
Returns
TypeDescription
Database

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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

The bytes for etag.

getKeyPrefix()

public String getKeyPrefix()

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

The keyPrefix.

getKeyPrefixBytes()

public ByteString getKeyPrefixBytes()

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

The bytes for locationId.

getName()

public String getName()

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

string name = 1;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

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

string name = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Database other)

public Database.Builder mergeFrom(Database other)
Parameter
NameDescription
otherDatabase
Returns
TypeDescription
Database.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Database.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Database.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Database.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Database.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Database.Builder
Overrides

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
NameDescription
valueDatabase.AppEngineIntegrationMode

The appEngineIntegrationMode to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for appEngineIntegrationMode to set.

Returns
TypeDescription
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
NameDescription
valueDatabase.ConcurrencyMode

The concurrencyMode to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for concurrencyMode to set.

Returns
TypeDescription
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
NameDescription
valueString

The etag to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
Database.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Database.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Database.Builder
Overrides

setKeyPrefix(String value)

public Database.Builder setKeyPrefix(String value)

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];

Parameter
NameDescription
valueString

The keyPrefix to set.

Returns
TypeDescription
Database.Builder

This builder for chaining.

setKeyPrefixBytes(ByteString value)

public Database.Builder setKeyPrefixBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for keyPrefix to set.

Returns
TypeDescription
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
NameDescription
valueString

The locationId to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for locationId to set.

Returns
TypeDescription
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
NameDescription
valueString

The name to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Database.Builder
Overrides

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
NameDescription
valueDatabase.DatabaseType

The type to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for type to set.

Returns
TypeDescription
Database.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Database.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Database.Builder
Overrides