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
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RestoreVerificationPlan.Builder newBuilder()
newBuilder(RestoreVerificationPlan prototype)
public static RestoreVerificationPlan.Builder newBuilder(RestoreVerificationPlan prototype)
public static RestoreVerificationPlan parseDelimitedFrom(InputStream input)
public static RestoreVerificationPlan parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RestoreVerificationPlan parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestoreVerificationPlan parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RestoreVerificationPlan parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreVerificationPlan parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreVerificationPlan parseFrom(CodedInputStream input)
public static RestoreVerificationPlan parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RestoreVerificationPlan parseFrom(InputStream input)
public static RestoreVerificationPlan parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RestoreVerificationPlan parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestoreVerificationPlan parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RestoreVerificationPlan> parser()
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
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];
getDefaultInstanceForType()
public RestoreVerificationPlan getDefaultInstanceForType()
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];
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];
getLabels() (deprecated)
public Map<String,String> getLabels()
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];
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];
| 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()
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()
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];
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];
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];
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];
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
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()
Overrides
newBuilderForType()
public RestoreVerificationPlan.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected RestoreVerificationPlan.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public RestoreVerificationPlan.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides