com.amazonaws.services.backup.model.GetBackupPlanResult Maven / Gradle / Ivy
Show all versions of aws-java-sdk-backup Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.backup.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetBackupPlanResult extends com.amazonaws.AmazonWebServiceResult implements Serializable, Cloneable {
/**
*
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*
*/
private BackupPlan backupPlan;
/**
*
* Uniquely identifies a backup plan.
*
*/
private String backupPlanId;
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*
*/
private String backupPlanArn;
/**
*
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot
* be edited.
*
*/
private String versionId;
/**
*
* A unique string that identifies the request and allows failed requests to be retried without the risk of running
* the operation twice.
*
*/
private String creatorRequestId;
/**
*
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
* of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date creationDate;
/**
*
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value
* of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date deletionDate;
/**
*
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and
* Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*/
private java.util.Date lastExecutionDate;
/**
*
* Contains a list of BackupOptions
for each resource type. The list is populated only if the advanced
* option is set for the backup plan.
*
*/
private java.util.List advancedBackupSettings;
/**
*
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*
*
* @param backupPlan
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*/
public void setBackupPlan(BackupPlan backupPlan) {
this.backupPlan = backupPlan;
}
/**
*
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*
*
* @return Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*/
public BackupPlan getBackupPlan() {
return this.backupPlan;
}
/**
*
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
*
*
* @param backupPlan
* Specifies the body of a backup plan. Includes a BackupPlanName
and one or more sets of
* Rules
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withBackupPlan(BackupPlan backupPlan) {
setBackupPlan(backupPlan);
return this;
}
/**
*
* Uniquely identifies a backup plan.
*
*
* @param backupPlanId
* Uniquely identifies a backup plan.
*/
public void setBackupPlanId(String backupPlanId) {
this.backupPlanId = backupPlanId;
}
/**
*
* Uniquely identifies a backup plan.
*
*
* @return Uniquely identifies a backup plan.
*/
public String getBackupPlanId() {
return this.backupPlanId;
}
/**
*
* Uniquely identifies a backup plan.
*
*
* @param backupPlanId
* Uniquely identifies a backup plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withBackupPlanId(String backupPlanId) {
setBackupPlanId(backupPlanId);
return this;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*
*
* @param backupPlanArn
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*/
public void setBackupPlanArn(String backupPlanArn) {
this.backupPlanArn = backupPlanArn;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*
*
* @return An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*/
public String getBackupPlanArn() {
return this.backupPlanArn;
}
/**
*
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
*
*
* @param backupPlanArn
* An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,
* arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50
.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withBackupPlanArn(String backupPlanArn) {
setBackupPlanArn(backupPlanArn);
return this;
}
/**
*
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot
* be edited.
*
*
* @param versionId
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs
* cannot be edited.
*/
public void setVersionId(String versionId) {
this.versionId = versionId;
}
/**
*
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot
* be edited.
*
*
* @return Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs
* cannot be edited.
*/
public String getVersionId() {
return this.versionId;
}
/**
*
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs cannot
* be edited.
*
*
* @param versionId
* Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes long. Version IDs
* cannot be edited.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withVersionId(String versionId) {
setVersionId(versionId);
return this;
}
/**
*
* A unique string that identifies the request and allows failed requests to be retried without the risk of running
* the operation twice.
*
*
* @param creatorRequestId
* A unique string that identifies the request and allows failed requests to be retried without the risk of
* running the operation twice.
*/
public void setCreatorRequestId(String creatorRequestId) {
this.creatorRequestId = creatorRequestId;
}
/**
*
* A unique string that identifies the request and allows failed requests to be retried without the risk of running
* the operation twice.
*
*
* @return A unique string that identifies the request and allows failed requests to be retried without the risk of
* running the operation twice.
*/
public String getCreatorRequestId() {
return this.creatorRequestId;
}
/**
*
* A unique string that identifies the request and allows failed requests to be retried without the risk of running
* the operation twice.
*
*
* @param creatorRequestId
* A unique string that identifies the request and allows failed requests to be retried without the risk of
* running the operation twice.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withCreatorRequestId(String creatorRequestId) {
setCreatorRequestId(creatorRequestId);
return this;
}
/**
*
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
* of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param creationDate
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setCreationDate(java.util.Date creationDate) {
this.creationDate = creationDate;
}
/**
*
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
* of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getCreationDate() {
return this.creationDate;
}
/**
*
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The value
* of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param creationDate
* The date and time that a backup plan is created, in Unix format and Coordinated Universal Time (UTC). The
* value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withCreationDate(java.util.Date creationDate) {
setCreationDate(creationDate);
return this;
}
/**
*
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value
* of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param deletionDate
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The
* value of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setDeletionDate(java.util.Date deletionDate) {
this.deletionDate = deletionDate;
}
/**
*
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value
* of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The
* value of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getDeletionDate() {
return this.deletionDate;
}
/**
*
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The value
* of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents
* Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param deletionDate
* The date and time that a backup plan is deleted, in Unix format and Coordinated Universal Time (UTC). The
* value of DeletionDate
is accurate to milliseconds. For example, the value 1516925490.087
* represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withDeletionDate(java.util.Date deletionDate) {
setDeletionDate(deletionDate);
return this;
}
/**
*
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and
* Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param lastExecutionDate
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format
* and Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public void setLastExecutionDate(java.util.Date lastExecutionDate) {
this.lastExecutionDate = lastExecutionDate;
}
/**
*
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and
* Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @return The last time a job to back up resources was run with this backup plan. A date and time, in Unix format
* and Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*/
public java.util.Date getLastExecutionDate() {
return this.lastExecutionDate;
}
/**
*
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format and
* Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to milliseconds. For
* example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
*
*
* @param lastExecutionDate
* The last time a job to back up resources was run with this backup plan. A date and time, in Unix format
* and Coordinated Universal Time (UTC). The value of LastExecutionDate
is accurate to
* milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withLastExecutionDate(java.util.Date lastExecutionDate) {
setLastExecutionDate(lastExecutionDate);
return this;
}
/**
*
* Contains a list of BackupOptions
for each resource type. The list is populated only if the advanced
* option is set for the backup plan.
*
*
* @return Contains a list of BackupOptions
for each resource type. The list is populated only if the
* advanced option is set for the backup plan.
*/
public java.util.List getAdvancedBackupSettings() {
return advancedBackupSettings;
}
/**
*
* Contains a list of BackupOptions
for each resource type. The list is populated only if the advanced
* option is set for the backup plan.
*
*
* @param advancedBackupSettings
* Contains a list of BackupOptions
for each resource type. The list is populated only if the
* advanced option is set for the backup plan.
*/
public void setAdvancedBackupSettings(java.util.Collection advancedBackupSettings) {
if (advancedBackupSettings == null) {
this.advancedBackupSettings = null;
return;
}
this.advancedBackupSettings = new java.util.ArrayList(advancedBackupSettings);
}
/**
*
* Contains a list of BackupOptions
for each resource type. The list is populated only if the advanced
* option is set for the backup plan.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAdvancedBackupSettings(java.util.Collection)} or
* {@link #withAdvancedBackupSettings(java.util.Collection)} if you want to override the existing values.
*
*
* @param advancedBackupSettings
* Contains a list of BackupOptions
for each resource type. The list is populated only if the
* advanced option is set for the backup plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withAdvancedBackupSettings(AdvancedBackupSetting... advancedBackupSettings) {
if (this.advancedBackupSettings == null) {
setAdvancedBackupSettings(new java.util.ArrayList(advancedBackupSettings.length));
}
for (AdvancedBackupSetting ele : advancedBackupSettings) {
this.advancedBackupSettings.add(ele);
}
return this;
}
/**
*
* Contains a list of BackupOptions
for each resource type. The list is populated only if the advanced
* option is set for the backup plan.
*
*
* @param advancedBackupSettings
* Contains a list of BackupOptions
for each resource type. The list is populated only if the
* advanced option is set for the backup plan.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetBackupPlanResult withAdvancedBackupSettings(java.util.Collection advancedBackupSettings) {
setAdvancedBackupSettings(advancedBackupSettings);
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getBackupPlan() != null)
sb.append("BackupPlan: ").append(getBackupPlan()).append(",");
if (getBackupPlanId() != null)
sb.append("BackupPlanId: ").append(getBackupPlanId()).append(",");
if (getBackupPlanArn() != null)
sb.append("BackupPlanArn: ").append(getBackupPlanArn()).append(",");
if (getVersionId() != null)
sb.append("VersionId: ").append(getVersionId()).append(",");
if (getCreatorRequestId() != null)
sb.append("CreatorRequestId: ").append(getCreatorRequestId()).append(",");
if (getCreationDate() != null)
sb.append("CreationDate: ").append(getCreationDate()).append(",");
if (getDeletionDate() != null)
sb.append("DeletionDate: ").append(getDeletionDate()).append(",");
if (getLastExecutionDate() != null)
sb.append("LastExecutionDate: ").append(getLastExecutionDate()).append(",");
if (getAdvancedBackupSettings() != null)
sb.append("AdvancedBackupSettings: ").append(getAdvancedBackupSettings());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetBackupPlanResult == false)
return false;
GetBackupPlanResult other = (GetBackupPlanResult) obj;
if (other.getBackupPlan() == null ^ this.getBackupPlan() == null)
return false;
if (other.getBackupPlan() != null && other.getBackupPlan().equals(this.getBackupPlan()) == false)
return false;
if (other.getBackupPlanId() == null ^ this.getBackupPlanId() == null)
return false;
if (other.getBackupPlanId() != null && other.getBackupPlanId().equals(this.getBackupPlanId()) == false)
return false;
if (other.getBackupPlanArn() == null ^ this.getBackupPlanArn() == null)
return false;
if (other.getBackupPlanArn() != null && other.getBackupPlanArn().equals(this.getBackupPlanArn()) == false)
return false;
if (other.getVersionId() == null ^ this.getVersionId() == null)
return false;
if (other.getVersionId() != null && other.getVersionId().equals(this.getVersionId()) == false)
return false;
if (other.getCreatorRequestId() == null ^ this.getCreatorRequestId() == null)
return false;
if (other.getCreatorRequestId() != null && other.getCreatorRequestId().equals(this.getCreatorRequestId()) == false)
return false;
if (other.getCreationDate() == null ^ this.getCreationDate() == null)
return false;
if (other.getCreationDate() != null && other.getCreationDate().equals(this.getCreationDate()) == false)
return false;
if (other.getDeletionDate() == null ^ this.getDeletionDate() == null)
return false;
if (other.getDeletionDate() != null && other.getDeletionDate().equals(this.getDeletionDate()) == false)
return false;
if (other.getLastExecutionDate() == null ^ this.getLastExecutionDate() == null)
return false;
if (other.getLastExecutionDate() != null && other.getLastExecutionDate().equals(this.getLastExecutionDate()) == false)
return false;
if (other.getAdvancedBackupSettings() == null ^ this.getAdvancedBackupSettings() == null)
return false;
if (other.getAdvancedBackupSettings() != null && other.getAdvancedBackupSettings().equals(this.getAdvancedBackupSettings()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getBackupPlan() == null) ? 0 : getBackupPlan().hashCode());
hashCode = prime * hashCode + ((getBackupPlanId() == null) ? 0 : getBackupPlanId().hashCode());
hashCode = prime * hashCode + ((getBackupPlanArn() == null) ? 0 : getBackupPlanArn().hashCode());
hashCode = prime * hashCode + ((getVersionId() == null) ? 0 : getVersionId().hashCode());
hashCode = prime * hashCode + ((getCreatorRequestId() == null) ? 0 : getCreatorRequestId().hashCode());
hashCode = prime * hashCode + ((getCreationDate() == null) ? 0 : getCreationDate().hashCode());
hashCode = prime * hashCode + ((getDeletionDate() == null) ? 0 : getDeletionDate().hashCode());
hashCode = prime * hashCode + ((getLastExecutionDate() == null) ? 0 : getLastExecutionDate().hashCode());
hashCode = prime * hashCode + ((getAdvancedBackupSettings() == null) ? 0 : getAdvancedBackupSettings().hashCode());
return hashCode;
}
@Override
public GetBackupPlanResult clone() {
try {
return (GetBackupPlanResult) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}