Represents a Restore.
Package
@google-cloud/gke-backupConstructors
(constructor)(properties)
constructor(properties?: google.cloud.gkebackup.v1.IRestore);Constructs a new Restore.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRestore
Properties to set |
Properties
backup
public backup: string;Restore backup.
cluster
public cluster: string;Restore cluster.
completeTime
public completeTime?: (google.protobuf.ITimestamp|null);Restore completeTime.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Restore createTime.
description
public description: string;Restore description.
etag
public etag: string;Restore etag.
labels
public labels: { [k: string]: string };Restore labels.
name
public name: string;Restore name.
resourcesExcludedCount
public resourcesExcludedCount: number;Restore resourcesExcludedCount.
resourcesFailedCount
public resourcesFailedCount: number;Restore resourcesFailedCount.
resourcesRestoredCount
public resourcesRestoredCount: number;Restore resourcesRestoredCount.
restoreConfig
public restoreConfig?: (google.cloud.gkebackup.v1.IRestoreConfig|null);Restore restoreConfig.
state
public state: (google.cloud.gkebackup.v1.Restore.State|keyof typeof google.cloud.gkebackup.v1.Restore.State);Restore state.
stateReason
public stateReason: string;Restore stateReason.
uid
public uid: string;Restore uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Restore updateTime.
volumesRestoredCount
public volumesRestoredCount: number;Restore volumesRestoredCount.
Methods
create(properties)
public static create(properties?: google.cloud.gkebackup.v1.IRestore): google.cloud.gkebackup.v1.Restore;Creates a new Restore instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRestore
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Restore | Restore instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkebackup.v1.Restore;Decodes a Restore 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 |
Restore | Restore |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkebackup.v1.Restore;Decodes a Restore message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Restore | Restore |
encode(message, writer)
public static encode(message: google.cloud.gkebackup.v1.IRestore, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Restore message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRestore
Restore 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.gkebackup.v1.IRestore, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Restore message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRestore
Restore 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.gkebackup.v1.Restore;Creates a Restore 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 |
Restore | Restore |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Restore
| 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 Restore to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.gkebackup.v1.Restore, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Restore message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Restore
Restore |
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 Restore message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|