Class CreateDatabaseRequest (3.26.3)

public final class CreateDatabaseRequest extends GeneratedMessageV3 implements CreateDatabaseRequestOrBuilder

The request for FirestoreAdmin.CreateDatabase.

Protobuf type google.firestore.admin.v1.CreateDatabaseRequest

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
Type Description
int

DATABASE_ID_FIELD_NUMBER

public static final int DATABASE_ID_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static CreateDatabaseRequest getDefaultInstance()
Returns
Type Description
CreateDatabaseRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static CreateDatabaseRequest.Builder newBuilder()
Returns
Type Description
CreateDatabaseRequest.Builder

newBuilder(CreateDatabaseRequest prototype)

public static CreateDatabaseRequest.Builder newBuilder(CreateDatabaseRequest prototype)
Parameter
Name Description
prototype CreateDatabaseRequest
Returns
Type Description
CreateDatabaseRequest.Builder

parseDelimitedFrom(InputStream input)

public static CreateDatabaseRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static CreateDatabaseRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static CreateDatabaseRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static CreateDatabaseRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static CreateDatabaseRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static CreateDatabaseRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static CreateDatabaseRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
CreateDatabaseRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<CreateDatabaseRequest> parser()
Returns
Type Description
Parser<CreateDatabaseRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatabase()

public Database getDatabase()

Required. The Database to create.

.google.firestore.admin.v1.Database database = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Database

The database.

getDatabaseId()

public String getDatabaseId()

Required. The ID to use for the database, which will become the final component of the database's resource name.

This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

"(default)" database ID is also valid.

string database_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The databaseId.

getDatabaseIdBytes()

public ByteString getDatabaseIdBytes()

Required. The ID to use for the database, which will become the final component of the database's resource name.

This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/.

"(default)" database ID is also valid.

string database_id = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for databaseId.

getDatabaseOrBuilder()

public DatabaseOrBuilder getDatabaseOrBuilder()

Required. The Database to create.

.google.firestore.admin.v1.Database database = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DatabaseOrBuilder

getDefaultInstanceForType()

public CreateDatabaseRequest getDefaultInstanceForType()
Returns
Type Description
CreateDatabaseRequest

getParent()

public String getParent()

Required. A parent name of the form projects/{project_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

Required. A parent name of the form projects/{project_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getParserForType()

public Parser<CreateDatabaseRequest> getParserForType()
Returns
Type Description
Parser<CreateDatabaseRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDatabase()

public boolean hasDatabase()

Required. The Database to create.

.google.firestore.admin.v1.Database database = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the database field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public CreateDatabaseRequest.Builder newBuilderForType()
Returns
Type Description
CreateDatabaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected CreateDatabaseRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
CreateDatabaseRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public CreateDatabaseRequest.Builder toBuilder()
Returns
Type Description
CreateDatabaseRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException