com.google.firestore.admin.v1

Interface DatabaseOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Database, Database.Builder

public interface DatabaseOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
Database.DatabaseType	getType() The type of the database.
int	getTypeValue() The type of the database.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

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

string name = 1;

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

string name = 1;

Returns:

The bytes for name.

getLocationId

String getLocationId()

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

string location_id = 9;

Returns:

The locationId.

getLocationIdBytes

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;

Returns:

The bytes for locationId.

getTypeValue

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:

The enum numeric value on the wire for type.

getType

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:

The type.

getConcurrencyModeValue

int getConcurrencyModeValue()

 The concurrency control mode to use for this database.
 

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

Returns:

The enum numeric value on the wire for concurrencyMode.

getConcurrencyMode

Database.ConcurrencyMode getConcurrencyMode()

 The concurrency control mode to use for this database.
 

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

Returns:

The concurrencyMode.

getAppEngineIntegrationModeValue

int getAppEngineIntegrationModeValue()

 The App Engine integration mode to use for this database.
 

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

Returns:

The enum numeric value on the wire for appEngineIntegrationMode.

getAppEngineIntegrationMode

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:

The appEngineIntegrationMode.

getKeyPrefix

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:

The keyPrefix.

getKeyPrefixBytes

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

Returns:

The bytes for keyPrefix.

getEtag

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:

The etag.

getEtagBytes

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;

Returns:

The bytes for etag.