public final class Database extends GeneratedMessageV3 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
Static Fields
APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER
public static final int APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CONCURRENCY_MODE_FIELD_NUMBER
public static final int CONCURRENCY_MODE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ETAG_FIELD_NUMBER
public static final int ETAG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
KEY_PREFIX_FIELD_NUMBER
public static final int KEY_PREFIX_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LOCATION_ID_FIELD_NUMBER
public static final int LOCATION_ID_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Database getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Database.Builder newBuilder()
newBuilder(Database prototype)
public static Database.Builder newBuilder(Database prototype)
| Parameter |
|---|
| Name | Description |
prototype | Database
|
public static Database parseDelimitedFrom(InputStream input)
public static Database parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Database parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Database parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(CodedInputStream input)
public static Database parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(InputStream input)
public static Database parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Database parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Database parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Database> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
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;
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;
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()
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()
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 |
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 |
|---|
| Type | Description |
ByteString | The bytes for keyPrefix.
|
getLocationId()
public String getLocationId()
| Returns |
|---|
| Type | Description |
String | The locationId.
|
getLocationIdBytes()
public ByteString getLocationIdBytes()
| Returns |
|---|
| Type | Description |
ByteString | The bytes for locationId.
|
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.
|
getParserForType()
public Parser<Database> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getType()
public Database.DatabaseType getType()
getTypeValue()
public int getTypeValue()
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Database.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Database.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Database.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
