Represents a RestoreBackupRequest.
Package
@google-cloud/backupdrConstructors
(constructor)(properties)
constructor(properties?: google.cloud.backupdr.v1.IRestoreBackupRequest);Constructs a new RestoreBackupRequest.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRestoreBackupRequest
Properties to set |
Properties
clearOverridesFieldMask
public clearOverridesFieldMask?: (google.protobuf.IFieldMask|null);RestoreBackupRequest clearOverridesFieldMask.
computeInstanceRestoreProperties
public computeInstanceRestoreProperties?: (google.cloud.backupdr.v1.IComputeInstanceRestoreProperties|null);RestoreBackupRequest computeInstanceRestoreProperties.
computeInstanceTargetEnvironment
public computeInstanceTargetEnvironment?: (google.cloud.backupdr.v1.IComputeInstanceTargetEnvironment|null);RestoreBackupRequest computeInstanceTargetEnvironment.
diskRestoreProperties
public diskRestoreProperties?: (google.cloud.backupdr.v1.IDiskRestoreProperties|null);RestoreBackupRequest diskRestoreProperties.
diskTargetEnvironment
public diskTargetEnvironment?: (google.cloud.backupdr.v1.IDiskTargetEnvironment|null);RestoreBackupRequest diskTargetEnvironment.
instanceProperties
public instanceProperties?: ("computeInstanceRestoreProperties"|"diskRestoreProperties");RestoreBackupRequest instanceProperties.
name
public name: string;RestoreBackupRequest name.
regionDiskTargetEnvironment
public regionDiskTargetEnvironment?: (google.cloud.backupdr.v1.IRegionDiskTargetEnvironment|null);RestoreBackupRequest regionDiskTargetEnvironment.
requestId
public requestId: string;RestoreBackupRequest requestId.
targetEnvironment
public targetEnvironment?: ("computeInstanceTargetEnvironment"|"diskTargetEnvironment"|"regionDiskTargetEnvironment");RestoreBackupRequest targetEnvironment.
Methods
create(properties)
public static create(properties?: google.cloud.backupdr.v1.IRestoreBackupRequest): google.cloud.backupdr.v1.RestoreBackupRequest;Creates a new RestoreBackupRequest instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRestoreBackupRequest
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RestoreBackupRequest |
RestoreBackupRequest instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.backupdr.v1.RestoreBackupRequest;Decodes a RestoreBackupRequest 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 |
RestoreBackupRequest |
RestoreBackupRequest |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.backupdr.v1.RestoreBackupRequest;Decodes a RestoreBackupRequest message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RestoreBackupRequest |
RestoreBackupRequest |
encode(message, writer)
public static encode(message: google.cloud.backupdr.v1.IRestoreBackupRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RestoreBackupRequest message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRestoreBackupRequest
RestoreBackupRequest 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.cloud.backupdr.v1.IRestoreBackupRequest, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RestoreBackupRequest message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRestoreBackupRequest
RestoreBackupRequest 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.cloud.backupdr.v1.RestoreBackupRequest;Creates a RestoreBackupRequest 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 |
RestoreBackupRequest |
RestoreBackupRequest |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RestoreBackupRequest
| 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 RestoreBackupRequest to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.backupdr.v1.RestoreBackupRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RestoreBackupRequest message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RestoreBackupRequest
RestoreBackupRequest |
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 RestoreBackupRequest message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|