Class RestoreVerificationPlan (0.62.0)

public final class RestoreVerificationPlan extends GeneratedMessage implements RestoreVerificationPlanOrBuilder

A RestoreVerificationPlan specifies the scheduling and clean-up template for automated restore verification. It contains a schedule to dictate when the verifications should run, and a RestoreVerificationCleanupRule for post-verification resource deletion.

Protobuf type google.cloud.backupdr.v1.RestoreVerificationPlan

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FAILURE_CLEANUP_RULE_FIELD_NUMBER

public static final int FAILURE_CLEANUP_RULE_FIELD_NUMBER
Field Value
Type Description
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

SCHEDULE_FIELD_NUMBER

public static final int SCHEDULE_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

SUCCESS_CLEANUP_RULE_FIELD_NUMBER

public static final int SUCCESS_CLEANUP_RULE_FIELD_NUMBER
Field Value
Type Description
int

TIME_ZONE_FIELD_NUMBER

public static final int TIME_ZONE_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static RestoreVerificationPlan getDefaultInstance()
Returns
Type Description
RestoreVerificationPlan

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static RestoreVerificationPlan.Builder newBuilder()
Returns
Type Description
RestoreVerificationPlan.Builder

newBuilder(RestoreVerificationPlan prototype)

public static RestoreVerificationPlan.Builder newBuilder(RestoreVerificationPlan prototype)
Parameter
Name Description
prototype RestoreVerificationPlan
Returns
Type Description
RestoreVerificationPlan.Builder

parseDelimitedFrom(InputStream input)

public static RestoreVerificationPlan parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static RestoreVerificationPlan parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static RestoreVerificationPlan parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static RestoreVerificationPlan parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static RestoreVerificationPlan parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static RestoreVerificationPlan parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static RestoreVerificationPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
RestoreVerificationPlan
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<RestoreVerificationPlan> parser()
Returns
Type Description
Parser<RestoreVerificationPlan>

Methods

containsLabels(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

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

getDefaultInstanceForType()

public RestoreVerificationPlan getDefaultInstanceForType()
Returns
Type Description
RestoreVerificationPlan

getDescription()

public 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 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 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 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 Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type Description
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Optional. User-defined labels.

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

Returns
Type Description
int

getLabelsMap()

public 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 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 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 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 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.

getParserForType()

public Parser<RestoreVerificationPlan> getParserForType()
Returns
Type Description
Parser<RestoreVerificationPlan>
Overrides

getSchedule()

public 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public RestoreVerificationPlan.Builder newBuilderForType()
Returns
Type Description
RestoreVerificationPlan.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected RestoreVerificationPlan.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
RestoreVerificationPlan.Builder
Overrides

toBuilder()

public RestoreVerificationPlan.Builder toBuilder()
Returns
Type Description
RestoreVerificationPlan.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException