Interface BackupPlanOrBuilder (0.13.0)

public interface BackupPlanOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`boolean`

getBackupConfig()

public abstract BackupPlan.BackupConfig getBackupConfig()

Defines the configuration of Backups created via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;

Returns
Type	Description
`BackupPlan.BackupConfig`	The backupConfig.

getBackupConfigOrBuilder()

public abstract BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()

Defines the configuration of Backups created via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;

Returns
Type	Description
`BackupPlan.BackupConfigOrBuilder`

getBackupSchedule()

public abstract BackupPlan.Schedule getBackupSchedule()

Defines a schedule for automatic Backup creation via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;

Returns
Type	Description
`BackupPlan.Schedule`	The backupSchedule.

getBackupScheduleOrBuilder()

public abstract BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()

Defines a schedule for automatic Backup creation via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;

Returns
Type	Description
`BackupPlan.ScheduleOrBuilder`

getCluster()

public abstract String getCluster()

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*

string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The cluster.

getClusterBytes()

public abstract ByteString getClusterBytes()

Required. Immutable. The source cluster from which Backups will be created via this BackupPlan. Valid formats:

projects/*/locations/*/clusters/*
projects/*/zones/*/clusters/*

string cluster = 6 [(.google.api.field_behavior) = IMMUTABLE, (.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for cluster.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The timestamp when this BackupPlan resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when this BackupPlan resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

getDeactivated()

public abstract boolean getDeactivated()

This flag indicates whether this BackupPlan has been deactivated. Setting this field to True locks the BackupPlan such that no further updates will be allowed (except deletes), including the deactivated field itself. It also prevents any new Backups from being created via this BackupPlan (including scheduled Backups). Default: False

bool deactivated = 11;

Returns
Type	Description
`boolean`	The deactivated.

getDescription()

public abstract String getDescription()

User specified descriptive string for this BackupPlan.

string description = 5;

Returns
Type	Description
`String`	The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

User specified descriptive string for this BackupPlan.

string description = 5;

Returns
Type	Description
`ByteString`	The bytes for description.

getEtag()

public abstract String getEtag()

Output only. etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a backup plan from overwriting each other. It is strongly suggested that systems make use of the 'etag' in the read-modify-write cycle to perform BackupPlan updates in order to avoid race conditions: An etag is returned in the response to GetBackupPlan, and systems are expected to put that etag in the request to UpdateBackupPlan or DeleteBackupPlan to ensure that their change will be applied to the same version of the resource.

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The etag.

getEtagBytes()

public abstract ByteString getEtagBytes()

string etag = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for etag.

getLabels()

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
`Map<String,String>`

getLabelsCount()

public abstract int getLabelsCount()

A set of custom labels supplied by user.

map<string, string> labels = 8;

Returns
Type	Description
`int`

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

A set of custom labels supplied by user.

map<string, string> labels = 8;

Returns
Type	Description
`Map<String,String>`

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameters
Name	Description
`key`	`String`
`defaultValue`	`String`

Returns
Type	Description
`String`

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
Name	Description
`key`	`String`

Returns
Type	Description
`String`

getName()

public abstract String getName()

Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. The full name of the BackupPlan resource. Format: projects/*/locations/*/backupPlans/*

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for name.

getProtectedPodCount()

public abstract int getProtectedPodCount()

Output only. The number of Kubernetes Pods backed up in the last successful Backup created via this BackupPlan.

int32 protected_pod_count = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`int`	The protectedPodCount.

getRetentionPolicy()

public abstract BackupPlan.RetentionPolicy getRetentionPolicy()

RetentionPolicy governs lifecycle of Backups created under this plan.

.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;

Returns
Type	Description
`BackupPlan.RetentionPolicy`	The retentionPolicy.

getRetentionPolicyOrBuilder()

public abstract BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()

RetentionPolicy governs lifecycle of Backups created under this plan.

.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;

Returns
Type	Description
`BackupPlan.RetentionPolicyOrBuilder`

getUid()

public abstract String getUid()

Output only. Server generated global unique identifier of UUID format.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`String`	The uid.

getUidBytes()

public abstract ByteString getUidBytes()

Output only. Server generated global unique identifier of UUID format.

string uid = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`ByteString`	The bytes for uid.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The timestamp when this BackupPlan resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`Timestamp`	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when this BackupPlan resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`TimestampOrBuilder`

hasBackupConfig()

public abstract boolean hasBackupConfig()

Defines the configuration of Backups created via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.BackupConfig backup_config = 12;

Returns
Type	Description
`boolean`	Whether the backupConfig field is set.

hasBackupSchedule()

public abstract boolean hasBackupSchedule()

Defines a schedule for automatic Backup creation via this BackupPlan.

.google.cloud.gkebackup.v1.BackupPlan.Schedule backup_schedule = 9;

Returns
Type	Description
`boolean`	Whether the backupSchedule field is set.

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The timestamp when this BackupPlan resource was created.

.google.protobuf.Timestamp create_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the createTime field is set.

hasRetentionPolicy()

public abstract boolean hasRetentionPolicy()

RetentionPolicy governs lifecycle of Backups created under this plan.

.google.cloud.gkebackup.v1.BackupPlan.RetentionPolicy retention_policy = 7;

Returns
Type	Description
`boolean`	Whether the retentionPolicy field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The timestamp when this BackupPlan resource was last updated.

.google.protobuf.Timestamp update_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
`boolean`	Whether the updateTime field is set.