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.BuilderImplements
DatabaseOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Database.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Database.Builder |
build()
public Database build()| Type | Description |
| Database |
buildPartial()
public Database buildPartial()| Type | Description |
| Database |
clear()
public Database.Builder clear()| Type | Description |
| Database.Builder |
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;
| 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;
| 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;
| Type | Description |
| Database.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Database.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Database.Builder |
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];
| 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;
| 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;
| Type | Description |
| Database.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Database.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Database.Builder |
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;
| Type | Description |
| Database.Builder | This builder for chaining. |
clone()
public Database.Builder clone()| Type | Description |
| Database.Builder |
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;
| 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;
| 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;
| 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;
| Type | Description |
| int | The enum numeric value on the wire for concurrencyMode. |
getDefaultInstanceForType()
public Database getDefaultInstanceForType()| Type | Description |
| Database |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| 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;
| Type | Description |
| 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];
| Type | Description |
| 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];
| 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;
| 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;
| 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;
| Type | Description |
| String | The name. |
getNameBytes()
public ByteString getNameBytes() The resource name of the Database.
Format: projects/{project}/databases/{database}
string name = 1;
| 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;
| 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;
| Type | Description |
| int | The enum numeric value on the wire for type. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(Database other)
public Database.Builder mergeFrom(Database other)| Name | Description |
| other | Database |
| Type | Description |
| Database.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Database.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Database.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Database.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Database.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Database.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Database.Builder |
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;
| Name | Description |
| value | Database.AppEngineIntegrationModeThe appEngineIntegrationMode to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for appEngineIntegrationMode to set. |
| 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;
| Name | Description |
| value | Database.ConcurrencyModeThe concurrencyMode to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for concurrencyMode to set. |
| 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;
| Name | Description |
| value | StringThe etag to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for etag to set. |
| Type | Description |
| Database.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Database.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Database.Builder |
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];
| Name | Description |
| value | StringThe keyPrefix to set. |
| Type | Description |
| 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];
| Name | Description |
| value | ByteStringThe bytes for keyPrefix to set. |
| 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;
| Name | Description |
| value | StringThe locationId to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for locationId to set. |
| 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;
| Name | Description |
| value | StringThe name to set. |
| 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;
| Name | Description |
| value | ByteStringThe bytes for name to set. |
| 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)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| Database.Builder |
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;
| Name | Description |
| value | Database.DatabaseTypeThe type to set. |
| 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;
| Name | Description |
| value | intThe enum numeric value on the wire for type to set. |
| Type | Description |
| Database.Builder | This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final Database.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Database.Builder |