com.amazonaws.services.wellarchitected.model.GetConsolidatedReportRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wellarchitected 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.wellarchitected.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 GetConsolidatedReportRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The format of the consolidated report.
*
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
is
* returned.
*
*/
private String format;
/**
*
* Set to true
to have shared resources included in the report.
*
*/
private Boolean includeSharedResources;
private String nextToken;
/**
*
* The maximum number of results to return for this request.
*
*/
private Integer maxResults;
/**
*
* The format of the consolidated report.
*
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
is
* returned.
*
*
* @param format
* The format of the consolidated report.
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
* is returned.
* @see ReportFormat
*/
public void setFormat(String format) {
this.format = format;
}
/**
*
* The format of the consolidated report.
*
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
is
* returned.
*
*
* @return The format of the consolidated report.
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
* is returned.
* @see ReportFormat
*/
public String getFormat() {
return this.format;
}
/**
*
* The format of the consolidated report.
*
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
is
* returned.
*
*
* @param format
* The format of the consolidated report.
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
* is returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportFormat
*/
public GetConsolidatedReportRequest withFormat(String format) {
setFormat(format);
return this;
}
/**
*
* The format of the consolidated report.
*
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
is
* returned.
*
*
* @param format
* The format of the consolidated report.
*
* For PDF
, Base64String
is returned. For JSON
, Metrics
* is returned.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReportFormat
*/
public GetConsolidatedReportRequest withFormat(ReportFormat format) {
this.format = format.toString();
return this;
}
/**
*
* Set to true
to have shared resources included in the report.
*
*
* @param includeSharedResources
* Set to true
to have shared resources included in the report.
*/
public void setIncludeSharedResources(Boolean includeSharedResources) {
this.includeSharedResources = includeSharedResources;
}
/**
*
* Set to true
to have shared resources included in the report.
*
*
* @return Set to true
to have shared resources included in the report.
*/
public Boolean getIncludeSharedResources() {
return this.includeSharedResources;
}
/**
*
* Set to true
to have shared resources included in the report.
*
*
* @param includeSharedResources
* Set to true
to have shared resources included in the report.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConsolidatedReportRequest withIncludeSharedResources(Boolean includeSharedResources) {
setIncludeSharedResources(includeSharedResources);
return this;
}
/**
*
* Set to true
to have shared resources included in the report.
*
*
* @return Set to true
to have shared resources included in the report.
*/
public Boolean isIncludeSharedResources() {
return this.includeSharedResources;
}
/**
* @param nextToken
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
* @return
*/
public String getNextToken() {
return this.nextToken;
}
/**
* @param nextToken
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConsolidatedReportRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The maximum number of results to return for this request.
*
*
* @param maxResults
* The maximum number of results to return for this request.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return for this request.
*
*
* @return The maximum number of results to return for this request.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return for this request.
*
*
* @param maxResults
* The maximum number of results to return for this request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetConsolidatedReportRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
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 (getFormat() != null)
sb.append("Format: ").append(getFormat()).append(",");
if (getIncludeSharedResources() != null)
sb.append("IncludeSharedResources: ").append(getIncludeSharedResources()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetConsolidatedReportRequest == false)
return false;
GetConsolidatedReportRequest other = (GetConsolidatedReportRequest) obj;
if (other.getFormat() == null ^ this.getFormat() == null)
return false;
if (other.getFormat() != null && other.getFormat().equals(this.getFormat()) == false)
return false;
if (other.getIncludeSharedResources() == null ^ this.getIncludeSharedResources() == null)
return false;
if (other.getIncludeSharedResources() != null && other.getIncludeSharedResources().equals(this.getIncludeSharedResources()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFormat() == null) ? 0 : getFormat().hashCode());
hashCode = prime * hashCode + ((getIncludeSharedResources() == null) ? 0 : getIncludeSharedResources().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
return hashCode;
}
@Override
public GetConsolidatedReportRequest clone() {
return (GetConsolidatedReportRequest) super.clone();
}
}