Class protos.google.cloud.backupdr.v1beta.PreparePhaseInfo (0.14.0)

Represents a PreparePhaseInfo.

Implements

Package

@google-cloud/backupdr

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.backupdr.v1beta.IPreparePhaseInfo);

Constructs a new PreparePhaseInfo.

Parameter
Name Description
properties IPreparePhaseInfo

Properties to set

Properties

backup

public backup: string;

PreparePhaseInfo backup.

backupSelectionConfig

public backupSelectionConfig?: (google.cloud.backupdr.v1beta.IBackupSelectionConfig|null);

PreparePhaseInfo backupSelectionConfig.

endTime

public endTime?: (google.protobuf.ITimestamp|null);

PreparePhaseInfo endTime.

error

public error?: (google.rpc.IStatus|null);

PreparePhaseInfo error.

isBackupExplicitlyPassed

public isBackupExplicitlyPassed: boolean;

PreparePhaseInfo isBackupExplicitlyPassed.

phaseState

public phaseState: (google.cloud.backupdr.v1beta.PhaseState|keyof typeof google.cloud.backupdr.v1beta.PhaseState);

PreparePhaseInfo phaseState.

restoreVerificationPlanAssociation

public restoreVerificationPlanAssociation: string;

PreparePhaseInfo restoreVerificationPlanAssociation.

startTime

public startTime?: (google.protobuf.ITimestamp|null);

PreparePhaseInfo startTime.

Methods

create(properties)

public static create(properties?: google.cloud.backupdr.v1beta.IPreparePhaseInfo): google.cloud.backupdr.v1beta.PreparePhaseInfo;

Creates a new PreparePhaseInfo instance using the specified properties.

Parameter
Name Description
properties IPreparePhaseInfo

Properties to set

Returns
Type Description
PreparePhaseInfo

PreparePhaseInfo instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.backupdr.v1beta.PreparePhaseInfo;

Decodes a PreparePhaseInfo 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
PreparePhaseInfo

PreparePhaseInfo

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.backupdr.v1beta.PreparePhaseInfo;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
PreparePhaseInfo

PreparePhaseInfo

encode(message, writer)

public static encode(message: google.cloud.backupdr.v1beta.IPreparePhaseInfo, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PreparePhaseInfo message. Does not implicitly messages.

Parameters
Name Description
message IPreparePhaseInfo

PreparePhaseInfo 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.v1beta.IPreparePhaseInfo, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IPreparePhaseInfo

PreparePhaseInfo 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.v1beta.PreparePhaseInfo;

Creates a PreparePhaseInfo 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
PreparePhaseInfo

PreparePhaseInfo

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for PreparePhaseInfo

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 PreparePhaseInfo to JSON.

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

JSON object

toObject(message, options)

public static toObject(message: google.cloud.backupdr.v1beta.PreparePhaseInfo, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name Description
message PreparePhaseInfo

PreparePhaseInfo

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 PreparePhaseInfo 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