Represents a BackupPlan.
Package
@google-cloud/gke-backupConstructors
(constructor)(properties)
constructor(properties?: google.cloud.gkebackup.v1.IBackupPlan);Constructs a new BackupPlan.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupPlan
Properties to set |
Properties
backupConfig
public backupConfig?: (google.cloud.gkebackup.v1.BackupPlan.IBackupConfig|null);BackupPlan backupConfig.
backupSchedule
public backupSchedule?: (google.cloud.gkebackup.v1.BackupPlan.ISchedule|null);BackupPlan backupSchedule.
cluster
public cluster: string;BackupPlan cluster.
createTime
public createTime?: (google.protobuf.ITimestamp|null);BackupPlan createTime.
deactivated
public deactivated: boolean;BackupPlan deactivated.
description
public description: string;BackupPlan description.
etag
public etag: string;BackupPlan etag.
labels
public labels: { [k: string]: string };BackupPlan labels.
name
public name: string;BackupPlan name.
protectedPodCount
public protectedPodCount: number;BackupPlan protectedPodCount.
retentionPolicy
public retentionPolicy?: (google.cloud.gkebackup.v1.BackupPlan.IRetentionPolicy|null);BackupPlan retentionPolicy.
uid
public uid: string;BackupPlan uid.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);BackupPlan updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.gkebackup.v1.IBackupPlan): google.cloud.gkebackup.v1.BackupPlan;Creates a new BackupPlan instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IBackupPlan
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.gkebackup.v1.BackupPlan | BackupPlan instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.gkebackup.v1.BackupPlan;Decodes a BackupPlan 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.gkebackup.v1.BackupPlan | BackupPlan |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.gkebackup.v1.BackupPlan;Decodes a BackupPlan 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.gkebackup.v1.BackupPlan | BackupPlan |
encode(message, writer)
public static encode(message: google.cloud.gkebackup.v1.IBackupPlan, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupPlan message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupPlan
BackupPlan 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.IBackupPlan, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified BackupPlan message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IBackupPlan
BackupPlan 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.BackupPlan;Creates a BackupPlan 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.gkebackup.v1.BackupPlan | BackupPlan |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for BackupPlan
| 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 BackupPlan to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.gkebackup.v1.BackupPlan, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a BackupPlan message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.gkebackup.v1.BackupPlan
BackupPlan |
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 BackupPlan message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|