Class RestoreDatabaseRequest (3.21.4)

public final class RestoreDatabaseRequest extends GeneratedMessageV3 implements RestoreDatabaseRequestOrBuilder

The request message for FirestoreAdmin.RestoreDatabase.

Protobuf type google.firestore.admin.v1.RestoreDatabaseRequest

Static Fields

BACKUP_FIELD_NUMBER

public static final int BACKUP_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 RestoreDatabaseRequest getDefaultInstance()
Returns
Type Description
RestoreDatabaseRequest

getDescriptor()

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

newBuilder()

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

newBuilder(RestoreDatabaseRequest prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackup()

public String getBackup()

Required. Backup to restore from. Must be from the same project as the parent.

Format is: projects/{project_id}/locations/{location}/backups/{backup}

string backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The backup.

getBackupBytes()

public ByteString getBackupBytes()

Required. Backup to restore from. Must be from the same project as the parent.

Format is: projects/{project_id}/locations/{location}/backups/{backup}

string backup = 3 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for backup.

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 database id must not be associated with an existing database.

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 = 2 [(.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 database id must not be associated with an existing database.

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 = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for databaseId.

getDefaultInstanceForType()

public RestoreDatabaseRequest getDefaultInstanceForType()
Returns
Type Description
RestoreDatabaseRequest

getParent()

public String getParent()

Required. The project to restore the database in. Format is 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. The project to restore the database in. Format is 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<RestoreDatabaseRequest> getParserForType()
Returns
Type Description
Parser<RestoreDatabaseRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 RestoreDatabaseRequest.Builder newBuilderForType()
Returns
Type Description
RestoreDatabaseRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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