com.amazonaws.services.backup.model.CreateReportPlanRequest Maven / Gradle / Ivy
/*
* 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;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class CreateReportPlanRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The unique name of the report plan. The name must be 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 of 1,024 characters.
*
*/
private String reportPlanDescription;
/**
*
* A structure that 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;
/**
*
* 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;
/**
*
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*
*/
private java.util.Map reportPlanTags;
/**
*
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*
*/
private String idempotencyToken;
/**
*
* The unique name of the report plan. The name must be 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. The name must be 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. The name must be 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. The name must be 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. The name must be 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. The name must be 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 CreateReportPlanRequest withReportPlanName(String reportPlanName) {
setReportPlanName(reportPlanName);
return this;
}
/**
*
* An optional description of the report plan with a maximum of 1,024 characters.
*
*
* @param reportPlanDescription
* An optional description of the report plan with a maximum of 1,024 characters.
*/
public void setReportPlanDescription(String reportPlanDescription) {
this.reportPlanDescription = reportPlanDescription;
}
/**
*
* An optional description of the report plan with a maximum of 1,024 characters.
*
*
* @return An optional description of the report plan with a maximum of 1,024 characters.
*/
public String getReportPlanDescription() {
return this.reportPlanDescription;
}
/**
*
* An optional description of the report plan with a maximum of 1,024 characters.
*
*
* @param reportPlanDescription
* An optional description of the report plan with a maximum of 1,024 characters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReportPlanRequest withReportPlanDescription(String reportPlanDescription) {
setReportPlanDescription(reportPlanDescription);
return this;
}
/**
*
* A structure that 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
* A structure that 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;
}
/**
*
* A structure that 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 A structure that 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;
}
/**
*
* A structure that 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
* A structure that 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 CreateReportPlanRequest withReportDeliveryChannel(ReportDeliveryChannel reportDeliveryChannel) {
setReportDeliveryChannel(reportDeliveryChannel);
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 CreateReportPlanRequest withReportSetting(ReportSetting reportSetting) {
setReportSetting(reportSetting);
return this;
}
/**
*
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*
*
* @return Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value
* pair.
*/
public java.util.Map getReportPlanTags() {
return reportPlanTags;
}
/**
*
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*
*
* @param reportPlanTags
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value
* pair.
*/
public void setReportPlanTags(java.util.Map reportPlanTags) {
this.reportPlanTags = reportPlanTags;
}
/**
*
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value pair.
*
*
* @param reportPlanTags
* Metadata that you can assign to help organize the report plans that you create. Each tag is a key-value
* pair.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReportPlanRequest withReportPlanTags(java.util.Map reportPlanTags) {
setReportPlanTags(reportPlanTags);
return this;
}
/**
* Add a single ReportPlanTags entry
*
* @see CreateReportPlanRequest#withReportPlanTags
* @returns a reference to this object so that method calls can be chained together.
*/
public CreateReportPlanRequest addReportPlanTagsEntry(String key, String value) {
if (null == this.reportPlanTags) {
this.reportPlanTags = new java.util.HashMap();
}
if (this.reportPlanTags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.reportPlanTags.put(key, value);
return this;
}
/**
* Removes all the entries added into ReportPlanTags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReportPlanRequest clearReportPlanTagsEntries() {
this.reportPlanTags = null;
return this;
}
/**
*
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*
*
* @param idempotencyToken
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results
* in a success message with no action taken.
*/
public void setIdempotencyToken(String idempotencyToken) {
this.idempotencyToken = idempotencyToken;
}
/**
*
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*
*
* @return A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results
* in a success message with no action taken.
*/
public String getIdempotencyToken() {
return this.idempotencyToken;
}
/**
*
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results in a
* success message with no action taken.
*
*
* @param idempotencyToken
* A customer-chosen string that you can use to distinguish between otherwise identical calls to
* CreateReportPlanInput. Retrying a successful request with the same idempotency token results
* in a success message with no action taken.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateReportPlanRequest withIdempotencyToken(String idempotencyToken) {
setIdempotencyToken(idempotencyToken);
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 (getReportPlanName() != null)
sb.append("ReportPlanName: ").append(getReportPlanName()).append(",");
if (getReportPlanDescription() != null)
sb.append("ReportPlanDescription: ").append(getReportPlanDescription()).append(",");
if (getReportDeliveryChannel() != null)
sb.append("ReportDeliveryChannel: ").append(getReportDeliveryChannel()).append(",");
if (getReportSetting() != null)
sb.append("ReportSetting: ").append(getReportSetting()).append(",");
if (getReportPlanTags() != null)
sb.append("ReportPlanTags: ").append(getReportPlanTags()).append(",");
if (getIdempotencyToken() != null)
sb.append("IdempotencyToken: ").append(getIdempotencyToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateReportPlanRequest == false)
return false;
CreateReportPlanRequest other = (CreateReportPlanRequest) obj;
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.getReportDeliveryChannel() == null ^ this.getReportDeliveryChannel() == null)
return false;
if (other.getReportDeliveryChannel() != null && other.getReportDeliveryChannel().equals(this.getReportDeliveryChannel()) == 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.getReportPlanTags() == null ^ this.getReportPlanTags() == null)
return false;
if (other.getReportPlanTags() != null && other.getReportPlanTags().equals(this.getReportPlanTags()) == false)
return false;
if (other.getIdempotencyToken() == null ^ this.getIdempotencyToken() == null)
return false;
if (other.getIdempotencyToken() != null && other.getIdempotencyToken().equals(this.getIdempotencyToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getReportPlanName() == null) ? 0 : getReportPlanName().hashCode());
hashCode = prime * hashCode + ((getReportPlanDescription() == null) ? 0 : getReportPlanDescription().hashCode());
hashCode = prime * hashCode + ((getReportDeliveryChannel() == null) ? 0 : getReportDeliveryChannel().hashCode());
hashCode = prime * hashCode + ((getReportSetting() == null) ? 0 : getReportSetting().hashCode());
hashCode = prime * hashCode + ((getReportPlanTags() == null) ? 0 : getReportPlanTags().hashCode());
hashCode = prime * hashCode + ((getIdempotencyToken() == null) ? 0 : getIdempotencyToken().hashCode());
return hashCode;
}
@Override
public CreateReportPlanRequest clone() {
return (CreateReportPlanRequest) super.clone();
}
}