Class protos.google.cloud.metastore.v1beta.Backup (1.1.6)

Represents a Backup.

Package

@google-cloud/dataproc-metastore!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.metastore.v1beta.IBackup);

Constructs a new Backup.

Parameter

Name	Description
properties	`IBackup` Properties to set

Properties

createTime

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

Backup createTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

description

public description: string;

Backup description.

Property Value

Type	Description
string

endTime

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

Backup endTime.

Property Value

Type	Description
(google.protobuf.ITimestamp\|null)

name

public name: string;

Backup name.

Property Value

Type	Description
string

serviceRevision

public serviceRevision?: (google.cloud.metastore.v1beta.IService|null);

Backup serviceRevision.

Property Value

Type	Description
(google.cloud.metastore.v1beta.IService\|null)

state

public state: (google.cloud.metastore.v1beta.Backup.State|keyof typeof google.cloud.metastore.v1beta.Backup.State);

Backup state.

Property Value

Type	Description
(google.cloud.metastore.v1beta.Backup.State\|keyof typeof google.cloud.metastore.v1beta.Backup.State)

Methods

create(properties)

public static create(properties?: google.cloud.metastore.v1beta.IBackup): google.cloud.metastore.v1beta.Backup;

Creates a new Backup instance using the specified properties.

Parameter

Name	Description
properties	`IBackup` Properties to set

Returns

Type	Description
google.cloud.metastore.v1beta.Backup	Backup instance

decode(reader, length)

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

Decodes a Backup message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.metastore.v1beta.Backup	Backup

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.metastore.v1beta.Backup	Backup

encode(message, writer)

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

Encodes the specified Backup message. Does not implicitly messages.

Parameters

Name	Description
message	`IBackup` Backup 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.metastore.v1beta.IBackup, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IBackup` Backup 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.metastore.v1beta.Backup;

Creates a Backup 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
google.cloud.metastore.v1beta.Backup	Backup

toJSON()

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

Converts this Backup to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.metastore.v1beta.Backup` Backup
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 Backup 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