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