Class protos.google.cloud.sql.v1.BackupRun (0.11.0)

Represents a BackupRun.

Package

@google-cloud/sql

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.sql.v1.IBackupRun);

Constructs a new BackupRun.

Parameter
Name Description
properties IBackupRun

Properties to set

Properties

backupKind

public backupKind: (google.cloud.sql.v1.SqlBackupKind|keyof typeof google.cloud.sql.v1.SqlBackupKind);

BackupRun backupKind.

description

public description: string;

BackupRun description.

diskEncryptionConfiguration

public diskEncryptionConfiguration?: (google.cloud.sql.v1.IDiskEncryptionConfiguration|null);

BackupRun diskEncryptionConfiguration.

diskEncryptionStatus

public diskEncryptionStatus?: (google.cloud.sql.v1.IDiskEncryptionStatus|null);

BackupRun diskEncryptionStatus.

endTime

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

BackupRun endTime.

enqueuedTime

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

BackupRun enqueuedTime.

error

public error?: (google.cloud.sql.v1.IOperationError|null);

BackupRun error.

id

public id: (number|Long|string);

BackupRun id.

instance

public instance: string;

BackupRun instance.

kind

public kind: string;

BackupRun kind.

location

public location: string;

BackupRun location.

public selfLink: string;

BackupRun selfLink.

startTime

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

BackupRun startTime.

status

public status: (google.cloud.sql.v1.SqlBackupRunStatus|keyof typeof google.cloud.sql.v1.SqlBackupRunStatus);

BackupRun status.

timeZone

public timeZone: string;

BackupRun timeZone.

type

public type: (google.cloud.sql.v1.SqlBackupRunType|keyof typeof google.cloud.sql.v1.SqlBackupRunType);

BackupRun type.

windowStartTime

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

BackupRun windowStartTime.

Methods

create(properties)

public static create(properties?: google.cloud.sql.v1.IBackupRun): google.cloud.sql.v1.BackupRun;

Creates a new BackupRun instance using the specified properties.

Parameter
Name Description
properties IBackupRun

Properties to set

Returns
Type Description
BackupRun

BackupRun instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.sql.v1.BackupRun;

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

BackupRun

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.sql.v1.BackupRun;

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
BackupRun

BackupRun

encode(message, writer)

public static encode(message: google.cloud.sql.v1.IBackupRun, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified BackupRun message. Does not implicitly messages.

Parameters
Name Description
message IBackupRun

BackupRun 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.sql.v1.IBackupRun, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message IBackupRun

BackupRun 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.sql.v1.BackupRun;

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

BackupRun

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for BackupRun

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

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

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message BackupRun

BackupRun

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