com.amazonaws.services.auditmanager.model.Assessment Maven / Gradle / Ivy
Show all versions of aws-java-sdk-auditmanager 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.auditmanager.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An entity that defines the scope of audit evidence collected by Audit Manager. An Audit Manager assessment is an
* implementation of an Audit Manager framework.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Assessment implements Serializable, Cloneable, StructuredPojo {
/**
*
* The Amazon Resource Name (ARN) of the assessment.
*
*/
private String arn;
/**
*
* The Amazon Web Services account that's associated with the assessment.
*
*/
private AWSAccount awsAccount;
/**
*
* The metadata for the assessment.
*
*/
private AssessmentMetadata metadata;
/**
*
* The framework that the assessment was created from.
*
*/
private AssessmentFramework framework;
/**
*
* The tags that are associated with the assessment.
*
*/
private java.util.Map tags;
/**
*
* The Amazon Resource Name (ARN) of the assessment.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the assessment.
*/
public void setArn(String arn) {
this.arn = arn;
}
/**
*
* The Amazon Resource Name (ARN) of the assessment.
*
*
* @return The Amazon Resource Name (ARN) of the assessment.
*/
public String getArn() {
return this.arn;
}
/**
*
* The Amazon Resource Name (ARN) of the assessment.
*
*
* @param arn
* The Amazon Resource Name (ARN) of the assessment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment withArn(String arn) {
setArn(arn);
return this;
}
/**
*
* The Amazon Web Services account that's associated with the assessment.
*
*
* @param awsAccount
* The Amazon Web Services account that's associated with the assessment.
*/
public void setAwsAccount(AWSAccount awsAccount) {
this.awsAccount = awsAccount;
}
/**
*
* The Amazon Web Services account that's associated with the assessment.
*
*
* @return The Amazon Web Services account that's associated with the assessment.
*/
public AWSAccount getAwsAccount() {
return this.awsAccount;
}
/**
*
* The Amazon Web Services account that's associated with the assessment.
*
*
* @param awsAccount
* The Amazon Web Services account that's associated with the assessment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment withAwsAccount(AWSAccount awsAccount) {
setAwsAccount(awsAccount);
return this;
}
/**
*
* The metadata for the assessment.
*
*
* @param metadata
* The metadata for the assessment.
*/
public void setMetadata(AssessmentMetadata metadata) {
this.metadata = metadata;
}
/**
*
* The metadata for the assessment.
*
*
* @return The metadata for the assessment.
*/
public AssessmentMetadata getMetadata() {
return this.metadata;
}
/**
*
* The metadata for the assessment.
*
*
* @param metadata
* The metadata for the assessment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment withMetadata(AssessmentMetadata metadata) {
setMetadata(metadata);
return this;
}
/**
*
* The framework that the assessment was created from.
*
*
* @param framework
* The framework that the assessment was created from.
*/
public void setFramework(AssessmentFramework framework) {
this.framework = framework;
}
/**
*
* The framework that the assessment was created from.
*
*
* @return The framework that the assessment was created from.
*/
public AssessmentFramework getFramework() {
return this.framework;
}
/**
*
* The framework that the assessment was created from.
*
*
* @param framework
* The framework that the assessment was created from.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment withFramework(AssessmentFramework framework) {
setFramework(framework);
return this;
}
/**
*
* The tags that are associated with the assessment.
*
*
* @return The tags that are associated with the assessment.
*/
public java.util.Map getTags() {
return tags;
}
/**
*
* The tags that are associated with the assessment.
*
*
* @param tags
* The tags that are associated with the assessment.
*/
public void setTags(java.util.Map tags) {
this.tags = tags;
}
/**
*
* The tags that are associated with the assessment.
*
*
* @param tags
* The tags that are associated with the assessment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment withTags(java.util.Map tags) {
setTags(tags);
return this;
}
/**
* Add a single Tags entry
*
* @see Assessment#withTags
* @returns a reference to this object so that method calls can be chained together.
*/
public Assessment addTagsEntry(String key, String value) {
if (null == this.tags) {
this.tags = new java.util.HashMap();
}
if (this.tags.containsKey(key))
throw new IllegalArgumentException("Duplicated keys (" + key.toString() + ") are provided.");
this.tags.put(key, value);
return this;
}
/**
* Removes all the entries added into Tags.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Assessment clearTagsEntries() {
this.tags = null;
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 (getArn() != null)
sb.append("Arn: ").append(getArn()).append(",");
if (getAwsAccount() != null)
sb.append("AwsAccount: ").append(getAwsAccount()).append(",");
if (getMetadata() != null)
sb.append("Metadata: ").append(getMetadata()).append(",");
if (getFramework() != null)
sb.append("Framework: ").append("***Sensitive Data Redacted***").append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Assessment == false)
return false;
Assessment other = (Assessment) obj;
if (other.getArn() == null ^ this.getArn() == null)
return false;
if (other.getArn() != null && other.getArn().equals(this.getArn()) == false)
return false;
if (other.getAwsAccount() == null ^ this.getAwsAccount() == null)
return false;
if (other.getAwsAccount() != null && other.getAwsAccount().equals(this.getAwsAccount()) == false)
return false;
if (other.getMetadata() == null ^ this.getMetadata() == null)
return false;
if (other.getMetadata() != null && other.getMetadata().equals(this.getMetadata()) == false)
return false;
if (other.getFramework() == null ^ this.getFramework() == null)
return false;
if (other.getFramework() != null && other.getFramework().equals(this.getFramework()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getArn() == null) ? 0 : getArn().hashCode());
hashCode = prime * hashCode + ((getAwsAccount() == null) ? 0 : getAwsAccount().hashCode());
hashCode = prime * hashCode + ((getMetadata() == null) ? 0 : getMetadata().hashCode());
hashCode = prime * hashCode + ((getFramework() == null) ? 0 : getFramework().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
return hashCode;
}
@Override
public Assessment clone() {
try {
return (Assessment) 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.auditmanager.model.transform.AssessmentMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}