com.google.firestore.admin.v1

Class Database

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.admin.v1.Database

All Implemented Interfaces:

DatabaseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Database
extends com.google.protobuf.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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Database.AppEngineIntegrationMode The type of App Engine integration mode.
static class	Database.Builder A Cloud Firestore Database.
static class	Database.ConcurrencyMode The type of concurrency control mode for transactions.
static class	Database.DatabaseType The type of the database.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER
static int	CONCURRENCY_MODE_FIELD_NUMBER
static int	ETAG_FIELD_NUMBER
static int	KEY_PREFIX_FIELD_NUMBER
static int	LOCATION_ID_FIELD_NUMBER
static int	NAME_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Database.AppEngineIntegrationMode	getAppEngineIntegrationMode() The App Engine integration mode to use for this database.
int	getAppEngineIntegrationModeValue() The App Engine integration mode to use for this database.
Database.ConcurrencyMode	getConcurrencyMode() The concurrency control mode to use for this database.
int	getConcurrencyModeValue() The concurrency control mode to use for this database.
static Database	getDefaultInstance()
Database	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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.
com.google.protobuf.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	getKeyPrefix() Output only.
com.google.protobuf.ByteString	getKeyPrefixBytes() Output only.
String	getLocationId() The location of the database.
com.google.protobuf.ByteString	getLocationIdBytes() The location of the database.
String	getName() The resource name of the Database.
com.google.protobuf.ByteString	getNameBytes() The resource name of the Database.
com.google.protobuf.Parser<Database>	getParserForType()
int	getSerializedSize()
Database.DatabaseType	getType() The type of the database.
int	getTypeValue() The type of the database.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Database.Builder	newBuilder()
static Database.Builder	newBuilder(Database prototype)
Database.Builder	newBuilderForType()
protected Database.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Database	parseDelimitedFrom(InputStream input)
static Database	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database	parseFrom(byte[] data)
static Database	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database	parseFrom(ByteBuffer data)
static Database	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database	parseFrom(com.google.protobuf.ByteString data)
static Database	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database	parseFrom(com.google.protobuf.CodedInputStream input)
static Database	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Database	parseFrom(InputStream input)
static Database	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Database>	parser()
Database.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

LOCATION_ID_FIELD_NUMBER

public static final int LOCATION_ID_FIELD_NUMBER

See Also:

Constant Field Values

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CONCURRENCY_MODE_FIELD_NUMBER

public static final int CONCURRENCY_MODE_FIELD_NUMBER

See Also:

Constant Field Values

APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER

public static final int APP_ENGINE_INTEGRATION_MODE_FIELD_NUMBER

See Also:

Constant Field Values

KEY_PREFIX_FIELD_NUMBER

public static final int KEY_PREFIX_FIELD_NUMBER

See Also:

Constant Field Values

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

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

string name = 1;

Specified by:

getName in interface DatabaseOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Specified by:

getNameBytes in interface DatabaseOrBuilder

Returns:

The bytes for name.

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;

Specified by:

getLocationId in interface DatabaseOrBuilder

Returns:

The locationId.

getLocationIdBytes

public com.google.protobuf.ByteString getLocationIdBytes()

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

string location_id = 9;

Specified by:

getLocationIdBytes in interface DatabaseOrBuilder

Returns:

The bytes for locationId.

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;

Specified by:

getTypeValue in interface DatabaseOrBuilder

Returns:

The enum numeric value on the wire for type.

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;

Specified by:

getType in interface DatabaseOrBuilder

Returns:

The type.

getConcurrencyModeValue

public int getConcurrencyModeValue()

 The concurrency control mode to use for this database.
 

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

Specified by:

getConcurrencyModeValue in interface DatabaseOrBuilder

Returns:

The enum numeric value on the wire for concurrencyMode.

getConcurrencyMode

public Database.ConcurrencyMode getConcurrencyMode()

 The concurrency control mode to use for this database.
 

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

Specified by:

getConcurrencyMode in interface DatabaseOrBuilder

Returns:

The concurrencyMode.

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;

Specified by:

getAppEngineIntegrationModeValue in interface DatabaseOrBuilder

Returns:

The enum numeric value on the wire for appEngineIntegrationMode.

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;

Specified by:

getAppEngineIntegrationMode in interface DatabaseOrBuilder

Returns:

The appEngineIntegrationMode.

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

Specified by:

getKeyPrefix in interface DatabaseOrBuilder

Returns:

The keyPrefix.

getKeyPrefixBytes

public com.google.protobuf.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];

Specified by:

getKeyPrefixBytes in interface DatabaseOrBuilder

Returns:

The bytes for keyPrefix.

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;

Specified by:

getEtag in interface DatabaseOrBuilder

Returns:

The etag.

getEtagBytes

public com.google.protobuf.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;

Specified by:

getEtagBytes in interface DatabaseOrBuilder

Returns:

The bytes for etag.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Database parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Database parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Database parseFrom(InputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Database parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Database parseDelimitedFrom(InputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static Database parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Database parseFrom(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public Database.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Database.Builder newBuilder()

newBuilder

public static Database.Builder newBuilder(Database prototype)

toBuilder

public Database.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Database.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Database getDefaultInstance()

parser

public static com.google.protobuf.Parser<Database> parser()

getParserForType

public com.google.protobuf.Parser<Database> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Database getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder