Class protos.google.spanner.executor.v1.RestoreCloudDatabaseAction (0.2.0)

Represents a RestoreCloudDatabaseAction.

Implements

Package

@google-cloud/spanner-api

Constructors

(constructor)(properties)

constructor(properties?: google.spanner.executor.v1.IRestoreCloudDatabaseAction);

Constructs a new RestoreCloudDatabaseAction.

Parameter
Name Description
properties IRestoreCloudDatabaseAction

Properties to set

Properties

backupId

public backupId: string;

RestoreCloudDatabaseAction backupId.

backupInstanceId

public backupInstanceId: string;

RestoreCloudDatabaseAction backupInstanceId.

databaseId

public databaseId: string;

RestoreCloudDatabaseAction databaseId.

databaseInstanceId

public databaseInstanceId: string;

RestoreCloudDatabaseAction databaseInstanceId.

encryptionConfig

public encryptionConfig?: (google.spanner.admin.database.v1.IEncryptionConfig|null);

RestoreCloudDatabaseAction encryptionConfig.

projectId

public projectId: string;

RestoreCloudDatabaseAction projectId.

Methods

create(properties)

public static create(properties?: google.spanner.executor.v1.IRestoreCloudDatabaseAction): google.spanner.executor.v1.RestoreCloudDatabaseAction;

Creates a new RestoreCloudDatabaseAction instance using the specified properties.

Parameter
Name Description
properties IRestoreCloudDatabaseAction

Properties to set

Returns
Type Description
RestoreCloudDatabaseAction

RestoreCloudDatabaseAction instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.spanner.executor.v1.RestoreCloudDatabaseAction;

Decodes a RestoreCloudDatabaseAction message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
RestoreCloudDatabaseAction

RestoreCloudDatabaseAction

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.spanner.executor.v1.RestoreCloudDatabaseAction;

Decodes a RestoreCloudDatabaseAction message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
RestoreCloudDatabaseAction

RestoreCloudDatabaseAction

encode(message, writer)

public static encode(message: google.spanner.executor.v1.IRestoreCloudDatabaseAction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RestoreCloudDatabaseAction message. Does not implicitly messages.

Parameters
Name Description
message IRestoreCloudDatabaseAction

RestoreCloudDatabaseAction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.spanner.executor.v1.IRestoreCloudDatabaseAction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified RestoreCloudDatabaseAction message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IRestoreCloudDatabaseAction

RestoreCloudDatabaseAction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.spanner.executor.v1.RestoreCloudDatabaseAction;

Creates a RestoreCloudDatabaseAction message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
RestoreCloudDatabaseAction

RestoreCloudDatabaseAction

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for RestoreCloudDatabaseAction

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this RestoreCloudDatabaseAction to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.spanner.executor.v1.RestoreCloudDatabaseAction, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a RestoreCloudDatabaseAction message. Also converts values to other types if specified.

Parameters
Name Description
message RestoreCloudDatabaseAction

RestoreCloudDatabaseAction

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a RestoreCloudDatabaseAction message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not