/* * Copyright 2018-2023 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; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *

* Contains detailed information about a report plan. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ReportPlan implements Serializable, Cloneable, StructuredPojo { /** *

* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *

*/ private String reportPlanArn; /** *

* The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). *

*/ private String reportPlanName; /** *

* An optional description of the report plan with a maximum 1,024 characters. *

*/ private String reportPlanDescription; /** *

* Identifies the report template for the report. Reports are built using a report template. The report templates * are: *

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this * API resource also describes the report coverage by Amazon Web Services Regions and frameworks. *

*/ private ReportSetting reportSetting; /** *

* Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key * prefix, and the formats of your reports. *

*/ private ReportDeliveryChannel reportDeliveryChannel; /** *

* The deployment status of a report plan. The statuses are: *

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED *

*/ private String deploymentStatus; /** *

* The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value * of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents * Friday, January 26, 2018 12:11:30.087 AM. *

*/ private java.util.Date creationTime; /** *

* The date and time that a report job associated with this report plan last attempted to run, in Unix format and * Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

*/ private java.util.Date lastAttemptedExecutionTime; /** *

* The date and time that a report job associated with this report plan last successfully ran, in Unix format and * Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

*/ private java.util.Date lastSuccessfulExecutionTime; /** *

* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *

* * @param reportPlanArn * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. */ public void setReportPlanArn(String reportPlanArn) { this.reportPlanArn = reportPlanArn; } /** *

* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *

* * @return An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. */ public String getReportPlanArn() { return this.reportPlanArn; } /** *

* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource * type. *

* * @param reportPlanArn * An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the * resource type. * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withReportPlanArn(String reportPlanArn) { setReportPlanArn(reportPlanArn); return this; } /** *

* The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). *

* * @param reportPlanName * The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). */ public void setReportPlanName(String reportPlanName) { this.reportPlanName = reportPlanName; } /** *

* The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). *

* * @return The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). */ public String getReportPlanName() { return this.reportPlanName; } /** *

* The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). *

* * @param reportPlanName * The unique name of the report plan. This name is between 1 and 256 characters starting with a letter, and * consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_). * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withReportPlanName(String reportPlanName) { setReportPlanName(reportPlanName); return this; } /** *

* An optional description of the report plan with a maximum 1,024 characters. *

* * @param reportPlanDescription * An optional description of the report plan with a maximum 1,024 characters. */ public void setReportPlanDescription(String reportPlanDescription) { this.reportPlanDescription = reportPlanDescription; } /** *

* An optional description of the report plan with a maximum 1,024 characters. *

* * @return An optional description of the report plan with a maximum 1,024 characters. */ public String getReportPlanDescription() { return this.reportPlanDescription; } /** *

* An optional description of the report plan with a maximum 1,024 characters. *

* * @param reportPlanDescription * An optional description of the report plan with a maximum 1,024 characters. * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withReportPlanDescription(String reportPlanDescription) { setReportPlanDescription(reportPlanDescription); return this; } /** *

* Identifies the report template for the report. Reports are built using a report template. The report templates * are: *

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this * API resource also describes the report coverage by Amazon Web Services Regions and frameworks. *

* * @param reportSetting * Identifies the report template for the report. Reports are built using a report template. The report * templates are:

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or * CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web * Services Regions and frameworks. */ public void setReportSetting(ReportSetting reportSetting) { this.reportSetting = reportSetting; } /** *

* Identifies the report template for the report. Reports are built using a report template. The report templates * are: *

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this * API resource also describes the report coverage by Amazon Web Services Regions and frameworks. *

* * @return Identifies the report template for the report. Reports are built using a report template. The report * templates are:

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or * CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon * Web Services Regions and frameworks. */ public ReportSetting getReportSetting() { return this.reportSetting; } /** *

* Identifies the report template for the report. Reports are built using a report template. The report templates * are: *

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT, this * API resource also describes the report coverage by Amazon Web Services Regions and frameworks. *

* * @param reportSetting * Identifies the report template for the report. Reports are built using a report template. The report * templates are:

*

* RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | RESTORE_JOB_REPORT *

*

* If the report template is RESOURCE_COMPLIANCE_REPORT or * CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage by Amazon Web * Services Regions and frameworks. * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withReportSetting(ReportSetting reportSetting) { setReportSetting(reportSetting); return this; } /** *

* Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key * prefix, and the formats of your reports. *

* * @param reportDeliveryChannel * Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, * S3 key prefix, and the formats of your reports. */ public void setReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel) { this.reportDeliveryChannel = reportDeliveryChannel; } /** *

* Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key * prefix, and the formats of your reports. *

* * @return Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket * name, S3 key prefix, and the formats of your reports. */ public ReportDeliveryChannel getReportDeliveryChannel() { return this.reportDeliveryChannel; } /** *

* Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key * prefix, and the formats of your reports. *

* * @param reportDeliveryChannel * Contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, * S3 key prefix, and the formats of your reports. * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel) { setReportDeliveryChannel(reportDeliveryChannel); return this; } /** *

* The deployment status of a report plan. The statuses are: *

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED *

* * @param deploymentStatus * The deployment status of a report plan. The statuses are:

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED */ public void setDeploymentStatus(String deploymentStatus) { this.deploymentStatus = deploymentStatus; } /** *

* The deployment status of a report plan. The statuses are: *

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED *

* * @return The deployment status of a report plan. The statuses are:

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED */ public String getDeploymentStatus() { return this.deploymentStatus; } /** *

* The deployment status of a report plan. The statuses are: *

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED *

* * @param deploymentStatus * The deployment status of a report plan. The statuses are:

*

* CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED * @return Returns a reference to this object so that method calls can be chained together. */ public ReportPlan withDeploymentStatus(String deploymentStatus) { setDeploymentStatus(deploymentStatus); return this; } /** *

* The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value * of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents * Friday, January 26, 2018 12:11:30.087 AM. *

* * @param creationTime * The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The * value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 * represents Friday, January 26, 2018 12:11:30.087 AM. */ public void setCreationTime(java.util.Date creationTime) { this.creationTime = creationTime; } /** *

* The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value * of CreationTime 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 report plan is created, in Unix format and Coordinated Universal Time (UTC). The * value of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 * represents Friday, January 26, 2018 12:11:30.087 AM. */ public java.util.Date getCreationTime() { return this.creationTime; } /** *

* The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The value * of CreationTime is accurate to milliseconds. For example, the value 1516925490.087 represents * Friday, January 26, 2018 12:11:30.087 AM. *

* * @param creationTime * The date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC). The * value of CreationTime 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 ReportPlan withCreationTime(java.util.Date creationTime) { setCreationTime(creationTime); return this; } /** *

* The date and time that a report job associated with this report plan last attempted to run, in Unix format and * Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

* * @param lastAttemptedExecutionTime * The date and time that a report job associated with this report plan last attempted to run, in Unix format * and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. */ public void setLastAttemptedExecutionTime(java.util.Date lastAttemptedExecutionTime) { this.lastAttemptedExecutionTime = lastAttemptedExecutionTime; } /** *

* The date and time that a report job associated with this report plan last attempted to run, in Unix format and * Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime 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 report job associated with this report plan last attempted to run, in Unix * format and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is * accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 * 12:11:30.087 AM. */ public java.util.Date getLastAttemptedExecutionTime() { return this.lastAttemptedExecutionTime; } /** *

* The date and time that a report job associated with this report plan last attempted to run, in Unix format and * Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

* * @param lastAttemptedExecutionTime * The date and time that a report job associated with this report plan last attempted to run, in Unix format * and Coordinated Universal Time (UTC). The value of LastAttemptedExecutionTime 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 ReportPlan withLastAttemptedExecutionTime(java.util.Date lastAttemptedExecutionTime) { setLastAttemptedExecutionTime(lastAttemptedExecutionTime); return this; } /** *

* The date and time that a report job associated with this report plan last successfully ran, in Unix format and * Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

* * @param lastSuccessfulExecutionTime * The date and time that a report job associated with this report plan last successfully ran, in Unix format * and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. */ public void setLastSuccessfulExecutionTime(java.util.Date lastSuccessfulExecutionTime) { this.lastSuccessfulExecutionTime = lastSuccessfulExecutionTime; } /** *

* The date and time that a report job associated with this report plan last successfully ran, in Unix format and * Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime 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 report job associated with this report plan last successfully ran, in Unix * format and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is * accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 * 12:11:30.087 AM. */ public java.util.Date getLastSuccessfulExecutionTime() { return this.lastSuccessfulExecutionTime; } /** *

* The date and time that a report job associated with this report plan last successfully ran, in Unix format and * Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime is accurate to * milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. *

* * @param lastSuccessfulExecutionTime * The date and time that a report job associated with this report plan last successfully ran, in Unix format * and Coordinated Universal Time (UTC). The value of LastSuccessfulExecutionTime 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 ReportPlan withLastSuccessfulExecutionTime(java.util.Date lastSuccessfulExecutionTime) { setLastSuccessfulExecutionTime(lastSuccessfulExecutionTime); 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 (getReportPlanArn() != null) sb.append("ReportPlanArn: ").append(getReportPlanArn()).append(","); if (getReportPlanName() != null) sb.append("ReportPlanName: ").append(getReportPlanName()).append(","); if (getReportPlanDescription() != null) sb.append("ReportPlanDescription: ").append(getReportPlanDescription()).append(","); if (getReportSetting() != null) sb.append("ReportSetting: ").append(getReportSetting()).append(","); if (getReportDeliveryChannel() != null) sb.append("ReportDeliveryChannel: ").append(getReportDeliveryChannel()).append(","); if (getDeploymentStatus() != null) sb.append("DeploymentStatus: ").append(getDeploymentStatus()).append(","); if (getCreationTime() != null) sb.append("CreationTime: ").append(getCreationTime()).append(","); if (getLastAttemptedExecutionTime() != null) sb.append("LastAttemptedExecutionTime: ").append(getLastAttemptedExecutionTime()).append(","); if (getLastSuccessfulExecutionTime() != null) sb.append("LastSuccessfulExecutionTime: ").append(getLastSuccessfulExecutionTime()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ReportPlan == false) return false; ReportPlan other = (ReportPlan) obj; if (other.getReportPlanArn() == null ^ this.getReportPlanArn() == null) return false; if (other.getReportPlanArn() != null && other.getReportPlanArn().equals(this.getReportPlanArn()) == false) return false; if (other.getReportPlanName() == null ^ this.getReportPlanName() == null) return false; if (other.getReportPlanName() != null && other.getReportPlanName().equals(this.getReportPlanName()) == false) return false; if (other.getReportPlanDescription() == null ^ this.getReportPlanDescription() == null) return false; if (other.getReportPlanDescription() != null && other.getReportPlanDescription().equals(this.getReportPlanDescription()) == false) return false; if (other.getReportSetting() == null ^ this.getReportSetting() == null) return false; if (other.getReportSetting() != null && other.getReportSetting().equals(this.getReportSetting()) == false) return false; if (other.getReportDeliveryChannel() == null ^ this.getReportDeliveryChannel() == null) return false; if (other.getReportDeliveryChannel() != null && other.getReportDeliveryChannel().equals(this.getReportDeliveryChannel()) == false) return false; if (other.getDeploymentStatus() == null ^ this.getDeploymentStatus() == null) return false; if (other.getDeploymentStatus() != null && other.getDeploymentStatus().equals(this.getDeploymentStatus()) == false) return false; if (other.getCreationTime() == null ^ this.getCreationTime() == null) return false; if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false) return false; if (other.getLastAttemptedExecutionTime() == null ^ this.getLastAttemptedExecutionTime() == null) return false; if (other.getLastAttemptedExecutionTime() != null && other.getLastAttemptedExecutionTime().equals(this.getLastAttemptedExecutionTime()) == false) return false; if (other.getLastSuccessfulExecutionTime() == null ^ this.getLastSuccessfulExecutionTime() == null) return false; if (other.getLastSuccessfulExecutionTime() != null && other.getLastSuccessfulExecutionTime().equals(this.getLastSuccessfulExecutionTime()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getReportPlanArn() == null) ? 0 : getReportPlanArn().hashCode()); hashCode = prime * hashCode + ((getReportPlanName() == null) ? 0 : getReportPlanName().hashCode()); hashCode = prime * hashCode + ((getReportPlanDescription() == null) ? 0 : getReportPlanDescription().hashCode()); hashCode = prime * hashCode + ((getReportSetting() == null) ? 0 : getReportSetting().hashCode()); hashCode = prime * hashCode + ((getReportDeliveryChannel() == null) ? 0 : getReportDeliveryChannel().hashCode()); hashCode = prime * hashCode + ((getDeploymentStatus() == null) ? 0 : getDeploymentStatus().hashCode()); hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode()); hashCode = prime * hashCode + ((getLastAttemptedExecutionTime() == null) ? 0 : getLastAttemptedExecutionTime().hashCode()); hashCode = prime * hashCode + ((getLastSuccessfulExecutionTime() == null) ? 0 : getLastSuccessfulExecutionTime().hashCode()); return hashCode; } @Override public ReportPlan clone() { try { return (ReportPlan) super.clone(); } catch (CloneNotSupportedException e) { throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e); } } @com.amazonaws.annotation.SdkInternalApi @Override public void marshall(ProtocolMarshaller protocolMarshaller) { com.amazonaws.services.backup.model.transform.ReportPlanMarshaller.getInstance().marshall(this, protocolMarshaller); } }