Interface RestoreVerificationPlanOrBuilder (0.62.0)

public interface RestoreVerificationPlanOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

Optional. User-defined labels.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. When the RestoreVerificationPlan 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. When the RestoreVerificationPlan was created.

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

Returns
Type Description
TimestampOrBuilder

getDescription()

public abstract String getDescription()

Optional. The description of the RestoreVerificationPlan resource.

The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public abstract ByteString getDescriptionBytes()

Optional. The description of the RestoreVerificationPlan resource.

The description allows for additional details about RestoreVerificationPlan and its use cases to be provided. An example description is the following: "This is a restore verification plan that performs a daily verification and cleans up the resources immediately after." The description must be at most 2048 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getFailureCleanupRule()

public abstract RestoreVerificationCleanupRule getFailureCleanupRule()

Optional. The cleanup rule to apply if the restore verification fails.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule failure_cleanup_rule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreVerificationCleanupRule

The failureCleanupRule.

getFailureCleanupRuleOrBuilder()

public abstract RestoreVerificationCleanupRuleOrBuilder getFailureCleanupRuleOrBuilder()

Optional. The cleanup rule to apply if the restore verification fails.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule failure_cleanup_rule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreVerificationCleanupRuleOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

Optional. User-defined labels.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

Optional. User-defined labels.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

Optional. User-defined labels.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

Optional. User-defined labels.

map<string, string> labels = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getName()

public abstract String getName()

Output only. Identifier. The resource name of the RestoreVerificationPlan.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

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

Returns
Type Description
String

The name.

getNameBytes()

public abstract ByteString getNameBytes()

Output only. Identifier. The resource name of the RestoreVerificationPlan.

Format: projects/{project}/locations/{location}/restoreVerificationPlans/{restoreVerificationPlan}

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

Returns
Type Description
ByteString

The bytes for name.

getSchedule()

public abstract String getSchedule()

Required. Describes the schedule on which the restore verification will be executed.

The schedule is specified as a Crontab string.

string schedule = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The schedule.

getScheduleBytes()

public abstract ByteString getScheduleBytes()

Required. Describes the schedule on which the restore verification will be executed.

The schedule is specified as a Crontab string.

string schedule = 7 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for schedule.

getState()

public abstract RestoreVerificationPlan.State getState()

Output only. The State for the RestoreVerificationPlan.

.google.cloud.backupdr.v1.RestoreVerificationPlan.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
RestoreVerificationPlan.State

The state.

getStateValue()

public abstract int getStateValue()

Output only. The State for the RestoreVerificationPlan.

.google.cloud.backupdr.v1.RestoreVerificationPlan.State state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getSuccessCleanupRule()

public abstract RestoreVerificationCleanupRule getSuccessCleanupRule()

Optional. The cleanup rule to apply if the restore verification succeeds.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule success_cleanup_rule = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreVerificationCleanupRule

The successCleanupRule.

getSuccessCleanupRuleOrBuilder()

public abstract RestoreVerificationCleanupRuleOrBuilder getSuccessCleanupRuleOrBuilder()

Optional. The cleanup rule to apply if the restore verification succeeds.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule success_cleanup_rule = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
RestoreVerificationCleanupRuleOrBuilder

getTimeZone()

public abstract String getTimeZone()

Optional. Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

string time_zone = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The timeZone.

getTimeZoneBytes()

public abstract ByteString getTimeZoneBytes()

Optional. Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the tz database, like "America/New_York" or "UTC". Defaults to UTC if not specified.

string time_zone = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for timeZone.

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. When the RestoreVerificationPlan 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. When the RestoreVerificationPlan was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. When the RestoreVerificationPlan was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasFailureCleanupRule()

public abstract boolean hasFailureCleanupRule()

Optional. The cleanup rule to apply if the restore verification fails.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule failure_cleanup_rule = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the failureCleanupRule field is set.

hasSuccessCleanupRule()

public abstract boolean hasSuccessCleanupRule()

Optional. The cleanup rule to apply if the restore verification succeeds.

.google.cloud.backupdr.v1.RestoreVerificationCleanupRule success_cleanup_rule = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the successCleanupRule field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. When the RestoreVerificationPlan 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.