Class BackupPlan.Builder (0.30.0)

public static final class BackupPlan.Builder extends GeneratedMessageV3.Builder<BackupPlan.Builder> implements BackupPlanOrBuilder

Defines the configuration and scheduling for a "line" of Backups.

Protobuf type google.cloud.gkebackup.v1.BackupPlan

Implements

BackupPlanOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackupPlan.Builder
Overrides

build()

public BackupPlan build()
Returns
TypeDescription
BackupPlan

buildPartial()

public BackupPlan buildPartial()
Returns
TypeDescription
BackupPlan

clear()

public BackupPlan.Builder clear()
Returns
TypeDescription
BackupPlan.Builder
Overrides

clearBackupConfig()

public BackupPlan.Builder clearBackupConfig()

Defines the configuration of Backups created via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.Builder

clearBackupSchedule()

public BackupPlan.Builder clearBackupSchedule()

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.Builder

clearCluster()

public BackupPlan.Builder clearCluster()

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
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearCreateTime()

public BackupPlan.Builder clearCreateTime()

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

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

Returns
TypeDescription
BackupPlan.Builder

clearDeactivated()

public BackupPlan.Builder clearDeactivated()

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
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearDescription()

public BackupPlan.Builder clearDescription()

User specified descriptive string for this BackupPlan.

string description = 5;

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearEtag()

public BackupPlan.Builder clearEtag()

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
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public BackupPlan.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
BackupPlan.Builder
Overrides

clearLabels()

public BackupPlan.Builder clearLabels()
Returns
TypeDescription
BackupPlan.Builder

clearName()

public BackupPlan.Builder clearName()

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

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

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public BackupPlan.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
BackupPlan.Builder
Overrides

clearProtectedPodCount()

public BackupPlan.Builder clearProtectedPodCount()

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
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearRetentionPolicy()

public BackupPlan.Builder clearRetentionPolicy()

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Returns
TypeDescription
BackupPlan.Builder

clearState()

public BackupPlan.Builder clearState()

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearStateReason()

public BackupPlan.Builder clearStateReason()

Output only. Human-readable description of why BackupPlan is in the current state

string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearUid()

public BackupPlan.Builder clearUid()

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

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

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

clearUpdateTime()

public BackupPlan.Builder clearUpdateTime()

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

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

Returns
TypeDescription
BackupPlan.Builder

clone()

public BackupPlan.Builder clone()
Returns
TypeDescription
BackupPlan.Builder
Overrides

containsLabels(String key)

public boolean containsLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

getBackupConfig()

public BackupPlan.BackupConfig getBackupConfig()

Defines the configuration of Backups created via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.BackupConfig

The backupConfig.

getBackupConfigBuilder()

public BackupPlan.BackupConfig.Builder getBackupConfigBuilder()

Defines the configuration of Backups created via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.BackupConfig.Builder

getBackupConfigOrBuilder()

public BackupPlan.BackupConfigOrBuilder getBackupConfigOrBuilder()

Defines the configuration of Backups created via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.BackupConfigOrBuilder

getBackupSchedule()

public BackupPlan.Schedule getBackupSchedule()

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.Schedule

The backupSchedule.

getBackupScheduleBuilder()

public BackupPlan.Schedule.Builder getBackupScheduleBuilder()

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.Schedule.Builder

getBackupScheduleOrBuilder()

public BackupPlan.ScheduleOrBuilder getBackupScheduleOrBuilder()

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Returns
TypeDescription
BackupPlan.ScheduleOrBuilder

getCluster()

public 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
TypeDescription
String

The cluster.

getClusterBytes()

public 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
TypeDescription
ByteString

The bytes for cluster.

getCreateTime()

public 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
TypeDescription
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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

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

Returns
TypeDescription
Builder

getCreateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

getDeactivated()

public 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
TypeDescription
boolean

The deactivated.

getDefaultInstanceForType()

public BackupPlan getDefaultInstanceForType()
Returns
TypeDescription
BackupPlan

getDescription()

public String getDescription()

User specified descriptive string for this BackupPlan.

string description = 5;

Returns
TypeDescription
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

User specified descriptive string for this BackupPlan.

string description = 5;

Returns
TypeDescription
ByteString

The bytes for description.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getEtag()

public 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
TypeDescription
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

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
TypeDescription
ByteString

The bytes for etag.

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

A set of custom labels supplied by user.

map<string, string> labels = 8;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

A set of custom labels supplied by user.

map<string, string> labels = 8;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMutableLabels() (deprecated)

public Map<String,String> getMutableLabels()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getName()

public 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
TypeDescription
String

The name.

getNameBytes()

public 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
TypeDescription
ByteString

The bytes for name.

getProtectedPodCount()

public 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
TypeDescription
int

The protectedPodCount.

getRetentionPolicy()

public BackupPlan.RetentionPolicy getRetentionPolicy()

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Returns
TypeDescription
BackupPlan.RetentionPolicy

The retentionPolicy.

getRetentionPolicyBuilder()

public BackupPlan.RetentionPolicy.Builder getRetentionPolicyBuilder()

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Returns
TypeDescription
BackupPlan.RetentionPolicy.Builder

getRetentionPolicyOrBuilder()

public BackupPlan.RetentionPolicyOrBuilder getRetentionPolicyOrBuilder()

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Returns
TypeDescription
BackupPlan.RetentionPolicyOrBuilder

getState()

public BackupPlan.State getState()

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
BackupPlan.State

The state.

getStateReason()

public String getStateReason()

Output only. Human-readable description of why BackupPlan is in the current state

string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
String

The stateReason.

getStateReasonBytes()

public ByteString getStateReasonBytes()

Output only. Human-readable description of why BackupPlan is in the current state

string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
ByteString

The bytes for stateReason.

getStateValue()

public int getStateValue()

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
TypeDescription
int

The enum numeric value on the wire for state.

getUid()

public String getUid()

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

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

Returns
TypeDescription
String

The uid.

getUidBytes()

public ByteString getUidBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for uid.

getUpdateTime()

public 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
TypeDescription
Timestamp

The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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

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

Returns
TypeDescription
Builder

getUpdateTimeOrBuilder()

public 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
TypeDescription
TimestampOrBuilder

hasBackupConfig()

public boolean hasBackupConfig()

Defines the configuration of Backups created via this BackupPlan.

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

Returns
TypeDescription
boolean

Whether the backupConfig field is set.

hasBackupSchedule()

public boolean hasBackupSchedule()

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Returns
TypeDescription
boolean

Whether the backupSchedule field is set.

hasCreateTime()

public 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
TypeDescription
boolean

Whether the createTime field is set.

hasRetentionPolicy()

public boolean hasRetentionPolicy()

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Returns
TypeDescription
boolean

Whether the retentionPolicy field is set.

hasUpdateTime()

public 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
TypeDescription
boolean

Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeBackupConfig(BackupPlan.BackupConfig value)

public BackupPlan.Builder mergeBackupConfig(BackupPlan.BackupConfig value)

Defines the configuration of Backups created via this BackupPlan.

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

Parameter
NameDescription
valueBackupPlan.BackupConfig
Returns
TypeDescription
BackupPlan.Builder

mergeBackupSchedule(BackupPlan.Schedule value)

public BackupPlan.Builder mergeBackupSchedule(BackupPlan.Schedule value)

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Parameter
NameDescription
valueBackupPlan.Schedule
Returns
TypeDescription
BackupPlan.Builder

mergeCreateTime(Timestamp value)

public BackupPlan.Builder mergeCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BackupPlan.Builder

mergeFrom(BackupPlan other)

public BackupPlan.Builder mergeFrom(BackupPlan other)
Parameter
NameDescription
otherBackupPlan
Returns
TypeDescription
BackupPlan.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public BackupPlan.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
BackupPlan.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public BackupPlan.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
BackupPlan.Builder
Overrides

mergeRetentionPolicy(BackupPlan.RetentionPolicy value)

public BackupPlan.Builder mergeRetentionPolicy(BackupPlan.RetentionPolicy value)

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Parameter
NameDescription
valueBackupPlan.RetentionPolicy
Returns
TypeDescription
BackupPlan.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackupPlan.Builder
Overrides

mergeUpdateTime(Timestamp value)

public BackupPlan.Builder mergeUpdateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BackupPlan.Builder

putAllLabels(Map<String,String> values)

public BackupPlan.Builder putAllLabels(Map<String,String> values)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
BackupPlan.Builder

putLabels(String key, String value)

public BackupPlan.Builder putLabels(String key, String value)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
BackupPlan.Builder

removeLabels(String key)

public BackupPlan.Builder removeLabels(String key)

A set of custom labels supplied by user.

map<string, string> labels = 8;

Parameter
NameDescription
keyString
Returns
TypeDescription
BackupPlan.Builder

setBackupConfig(BackupPlan.BackupConfig value)

public BackupPlan.Builder setBackupConfig(BackupPlan.BackupConfig value)

Defines the configuration of Backups created via this BackupPlan.

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

Parameter
NameDescription
valueBackupPlan.BackupConfig
Returns
TypeDescription
BackupPlan.Builder

setBackupConfig(BackupPlan.BackupConfig.Builder builderForValue)

public BackupPlan.Builder setBackupConfig(BackupPlan.BackupConfig.Builder builderForValue)

Defines the configuration of Backups created via this BackupPlan.

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

Parameter
NameDescription
builderForValueBackupPlan.BackupConfig.Builder
Returns
TypeDescription
BackupPlan.Builder

setBackupSchedule(BackupPlan.Schedule value)

public BackupPlan.Builder setBackupSchedule(BackupPlan.Schedule value)

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Parameter
NameDescription
valueBackupPlan.Schedule
Returns
TypeDescription
BackupPlan.Builder

setBackupSchedule(BackupPlan.Schedule.Builder builderForValue)

public BackupPlan.Builder setBackupSchedule(BackupPlan.Schedule.Builder builderForValue)

Defines a schedule for automatic Backup creation via this BackupPlan.

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

Parameter
NameDescription
builderForValueBackupPlan.Schedule.Builder
Returns
TypeDescription
BackupPlan.Builder

setCluster(String value)

public BackupPlan.Builder setCluster(String value)

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) = { ... }

Parameter
NameDescription
valueString

The cluster to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setClusterBytes(ByteString value)

public BackupPlan.Builder setClusterBytes(ByteString value)

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) = { ... }

Parameter
NameDescription
valueByteString

The bytes for cluster to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public BackupPlan.Builder setCreateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BackupPlan.Builder

setCreateTime(Timestamp.Builder builderForValue)

public BackupPlan.Builder setCreateTime(Timestamp.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BackupPlan.Builder

setDeactivated(boolean value)

public BackupPlan.Builder setDeactivated(boolean value)

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;

Parameter
NameDescription
valueboolean

The deactivated to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setDescription(String value)

public BackupPlan.Builder setDescription(String value)

User specified descriptive string for this BackupPlan.

string description = 5;

Parameter
NameDescription
valueString

The description to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public BackupPlan.Builder setDescriptionBytes(ByteString value)

User specified descriptive string for this BackupPlan.

string description = 5;

Parameter
NameDescription
valueByteString

The bytes for description to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setEtag(String value)

public BackupPlan.Builder setEtag(String value)

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];

Parameter
NameDescription
valueString

The etag to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setEtagBytes(ByteString value)

public BackupPlan.Builder setEtagBytes(ByteString value)

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];

Parameter
NameDescription
valueByteString

The bytes for etag to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public BackupPlan.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
BackupPlan.Builder
Overrides

setName(String value)

public BackupPlan.Builder setName(String value)

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

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

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setNameBytes(ByteString value)

public BackupPlan.Builder setNameBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setProtectedPodCount(int value)

public BackupPlan.Builder setProtectedPodCount(int value)

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];

Parameter
NameDescription
valueint

The protectedPodCount to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public BackupPlan.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
BackupPlan.Builder
Overrides

setRetentionPolicy(BackupPlan.RetentionPolicy value)

public BackupPlan.Builder setRetentionPolicy(BackupPlan.RetentionPolicy value)

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Parameter
NameDescription
valueBackupPlan.RetentionPolicy
Returns
TypeDescription
BackupPlan.Builder

setRetentionPolicy(BackupPlan.RetentionPolicy.Builder builderForValue)

public BackupPlan.Builder setRetentionPolicy(BackupPlan.RetentionPolicy.Builder builderForValue)

RetentionPolicy governs lifecycle of Backups created under this plan.

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

Parameter
NameDescription
builderForValueBackupPlan.RetentionPolicy.Builder
Returns
TypeDescription
BackupPlan.Builder

setState(BackupPlan.State value)

public BackupPlan.Builder setState(BackupPlan.State value)

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueBackupPlan.State

The state to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setStateReason(String value)

public BackupPlan.Builder setStateReason(String value)

Output only. Human-readable description of why BackupPlan is in the current state

string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueString

The stateReason to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setStateReasonBytes(ByteString value)

public BackupPlan.Builder setStateReasonBytes(ByteString value)

Output only. Human-readable description of why BackupPlan is in the current state

string state_reason = 15 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueByteString

The bytes for stateReason to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setStateValue(int value)

public BackupPlan.Builder setStateValue(int value)

Output only. State of the BackupPlan. This State field reflects the various stages a BackupPlan can be in during the Create operation. It will be set to "DEACTIVATED" if the BackupPlan is deactivated on an Update

.google.cloud.gkebackup.v1.BackupPlan.State state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setUid(String value)

public BackupPlan.Builder setUid(String value)

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

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

Parameter
NameDescription
valueString

The uid to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setUidBytes(ByteString value)

public BackupPlan.Builder setUidBytes(ByteString value)

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

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

Parameter
NameDescription
valueByteString

The bytes for uid to set.

Returns
TypeDescription
BackupPlan.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final BackupPlan.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
BackupPlan.Builder
Overrides

setUpdateTime(Timestamp value)

public BackupPlan.Builder setUpdateTime(Timestamp value)

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

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

Parameter
NameDescription
valueTimestamp
Returns
TypeDescription
BackupPlan.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public BackupPlan.Builder setUpdateTime(Timestamp.Builder builderForValue)

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

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

Parameter
NameDescription
builderForValueBuilder
Returns
TypeDescription
BackupPlan.Builder