Class AutoProtectionPolicy (0.58.0)

public final class AutoProtectionPolicy extends GeneratedMessage implements AutoProtectionPolicyOrBuilder

An AutoprotectionPolicy is a policy resource designed to automate backup management, moving from manual per-resource protection to a bulk approach. The policy dynamically discovers and applies a specified backup plan to all eligible resources that match its defined scope and criteria.

Protobuf type google.cloud.backupdr.v1beta.AutoProtectionPolicy

Static Fields

BACKUP_PLAN_DETAILS_FIELD_NUMBER

public static final int BACKUP_PLAN_DETAILS_FIELD_NUMBER
Field Value
Type Description
int

BINDING_SUMMARY_FIELD_NUMBER

public static final int BINDING_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

CRITERIA_FIELD_NUMBER

public static final int CRITERIA_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ETAG_FIELD_NUMBER

public static final int ETAG_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

POLICY_EVALUATION_SUMMARY_FIELD_NUMBER

public static final int POLICY_EVALUATION_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_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 AutoProtectionPolicy getDefaultInstance()
Returns
Type Description
AutoProtectionPolicy

getDescriptor()

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

newBuilder()

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

newBuilder(AutoProtectionPolicy prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getBackupPlanDetails(int index)

public BackupPlanDetail getBackupPlanDetails(int index)

Required. The backup plan details for matching resources.

repeated .google.cloud.backupdr.v1beta.BackupPlanDetail backup_plan_details = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
BackupPlanDetail

getBackupPlanDetailsCount()

public int getBackupPlanDetailsCount()

Required. The backup plan details for matching resources.

repeated .google.cloud.backupdr.v1beta.BackupPlanDetail backup_plan_details = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

getBackupPlanDetailsList()

public List<BackupPlanDetail> getBackupPlanDetailsList()

Required. The backup plan details for matching resources.

repeated .google.cloud.backupdr.v1beta.BackupPlanDetail backup_plan_details = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<BackupPlanDetail>

getBackupPlanDetailsOrBuilder(int index)

public BackupPlanDetailOrBuilder getBackupPlanDetailsOrBuilder(int index)

Required. The backup plan details for matching resources.

repeated .google.cloud.backupdr.v1beta.BackupPlanDetail backup_plan_details = 3 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
index int
Returns
Type Description
BackupPlanDetailOrBuilder

getBackupPlanDetailsOrBuilderList()

public List<? extends BackupPlanDetailOrBuilder> getBackupPlanDetailsOrBuilderList()

Required. The backup plan details for matching resources.

repeated .google.cloud.backupdr.v1beta.BackupPlanDetail backup_plan_details = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
List<? extends com.google.cloud.backupdr.v1beta.BackupPlanDetailOrBuilder>

getBindingSummary()

public BindingSummary getBindingSummary()

Output only. Summary of total count of different containers covered through this policy.

.google.cloud.backupdr.v1beta.BindingSummary binding_summary = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BindingSummary

The bindingSummary.

getBindingSummaryOrBuilder()

public BindingSummaryOrBuilder getBindingSummaryOrBuilder()

Output only. Summary of total count of different containers covered through this policy.

.google.cloud.backupdr.v1beta.BindingSummary binding_summary = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
BindingSummaryOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The timestamp when the policy was created.

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

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The timestamp when the policy was created.

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

Returns
Type Description
TimestampOrBuilder

getCriteria()

public Criteria getCriteria()

Required. The criteria for matching resources.

.google.cloud.backupdr.v1beta.Criteria criteria = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
Criteria

The criteria.

getCriteriaOrBuilder()

public CriteriaOrBuilder getCriteriaOrBuilder()

Required. The criteria for matching resources.

.google.cloud.backupdr.v1beta.Criteria criteria = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
CriteriaOrBuilder

getDefaultInstanceForType()

public AutoProtectionPolicy getDefaultInstanceForType()
Returns
Type Description
AutoProtectionPolicy

getDescription()

public String getDescription()

Optional. A description of the policy.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. A description of the policy.

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

Returns
Type Description
ByteString

The bytes for description.

getEtag()

public String getEtag()

Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.

string etag = 6;

Returns
Type Description
String

The etag.

getEtagBytes()

public ByteString getEtagBytes()

Output only. The etag for the policy. If this is provided on update, it must match the server's etag, otherwise the request will be rejected with an ABORTED error.

string etag = 6;

Returns
Type Description
ByteString

The bytes for etag.

getName()

public String getName()

Identifier. The resource name of the AutoprotectionPolicy. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

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

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Identifier. The resource name of the AutoprotectionPolicy. Format: projects/{project}/locations/{location}/autoProtectionPolicies/{auto_protection_policy}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getPolicyEvaluationSummary()

public PolicyEvaluationSummary getPolicyEvaluationSummary()

Output only. Summary of last policy application when job was run per workload type.

.google.cloud.backupdr.v1beta.PolicyEvaluationSummary policy_evaluation_summary = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyEvaluationSummary

The policyEvaluationSummary.

getPolicyEvaluationSummaryOrBuilder()

public PolicyEvaluationSummaryOrBuilder getPolicyEvaluationSummaryOrBuilder()

Output only. Summary of last policy application when job was run per workload type.

.google.cloud.backupdr.v1beta.PolicyEvaluationSummary policy_evaluation_summary = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
PolicyEvaluationSummaryOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getState()

public AutoProtectionPolicy.State getState()

Output only. The current state of the AutoprotectionPolicy.

.google.cloud.backupdr.v1beta.AutoProtectionPolicy.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
AutoProtectionPolicy.State

The state.

getStateValue()

public int getStateValue()

Output only. The current state of the AutoprotectionPolicy.

.google.cloud.backupdr.v1beta.AutoProtectionPolicy.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The timestamp when the policy was last updated.

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

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The timestamp when the policy was last updated.

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

Returns
Type Description
TimestampOrBuilder

hasBindingSummary()

public boolean hasBindingSummary()

Output only. Summary of total count of different containers covered through this policy.

.google.cloud.backupdr.v1beta.BindingSummary binding_summary = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the bindingSummary field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The timestamp when the policy was created.

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

Returns
Type Description
boolean

Whether the createTime field is set.

hasCriteria()

public boolean hasCriteria()

Required. The criteria for matching resources.

.google.cloud.backupdr.v1beta.Criteria criteria = 4 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the criteria field is set.

hasPolicyEvaluationSummary()

public boolean hasPolicyEvaluationSummary()

Output only. Summary of last policy application when job was run per workload type.

.google.cloud.backupdr.v1beta.PolicyEvaluationSummary policy_evaluation_summary = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the policyEvaluationSummary field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The timestamp when the policy was last updated.

.google.protobuf.Timestamp update_time = 10 [(.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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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