
com.amazonaws.services.accessanalyzer.model.PolicyGeneration Maven / Gradle / Ivy
/*
* 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.accessanalyzer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Contains details about the policy generation status and properties.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PolicyGeneration implements Serializable, Cloneable, StructuredPojo {
/**
*
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used
* with CancelPolicyGeneration
to cancel the policy generation request.
*
*/
private String jobId;
/**
*
* The ARN of the IAM entity (user or role) for which you are generating a policy.
*
*/
private String principalArn;
/**
*
* The status of the policy generation request.
*
*/
private String status;
/**
*
* A timestamp of when the policy generation started.
*
*/
private java.util.Date startedOn;
/**
*
* A timestamp of when the policy generation was completed.
*
*/
private java.util.Date completedOn;
/**
*
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used
* with CancelPolicyGeneration
to cancel the policy generation request.
*
*
* @param jobId
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or
* used with CancelPolicyGeneration
to cancel the policy generation request.
*/
public void setJobId(String jobId) {
this.jobId = jobId;
}
/**
*
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used
* with CancelPolicyGeneration
to cancel the policy generation request.
*
*
* @return The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or
* used with CancelPolicyGeneration
to cancel the policy generation request.
*/
public String getJobId() {
return this.jobId;
}
/**
*
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or used
* with CancelPolicyGeneration
to cancel the policy generation request.
*
*
* @param jobId
* The JobId
that is returned by the StartPolicyGeneration
operation. The
* JobId
can be used with GetGeneratedPolicy
to retrieve the generated policies or
* used with CancelPolicyGeneration
to cancel the policy generation request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyGeneration withJobId(String jobId) {
setJobId(jobId);
return this;
}
/**
*
* The ARN of the IAM entity (user or role) for which you are generating a policy.
*
*
* @param principalArn
* The ARN of the IAM entity (user or role) for which you are generating a policy.
*/
public void setPrincipalArn(String principalArn) {
this.principalArn = principalArn;
}
/**
*
* The ARN of the IAM entity (user or role) for which you are generating a policy.
*
*
* @return The ARN of the IAM entity (user or role) for which you are generating a policy.
*/
public String getPrincipalArn() {
return this.principalArn;
}
/**
*
* The ARN of the IAM entity (user or role) for which you are generating a policy.
*
*
* @param principalArn
* The ARN of the IAM entity (user or role) for which you are generating a policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyGeneration withPrincipalArn(String principalArn) {
setPrincipalArn(principalArn);
return this;
}
/**
*
* The status of the policy generation request.
*
*
* @param status
* The status of the policy generation request.
* @see JobStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the policy generation request.
*
*
* @return The status of the policy generation request.
* @see JobStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the policy generation request.
*
*
* @param status
* The status of the policy generation request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public PolicyGeneration withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the policy generation request.
*
*
* @param status
* The status of the policy generation request.
* @return Returns a reference to this object so that method calls can be chained together.
* @see JobStatus
*/
public PolicyGeneration withStatus(JobStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A timestamp of when the policy generation started.
*
*
* @param startedOn
* A timestamp of when the policy generation started.
*/
public void setStartedOn(java.util.Date startedOn) {
this.startedOn = startedOn;
}
/**
*
* A timestamp of when the policy generation started.
*
*
* @return A timestamp of when the policy generation started.
*/
public java.util.Date getStartedOn() {
return this.startedOn;
}
/**
*
* A timestamp of when the policy generation started.
*
*
* @param startedOn
* A timestamp of when the policy generation started.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyGeneration withStartedOn(java.util.Date startedOn) {
setStartedOn(startedOn);
return this;
}
/**
*
* A timestamp of when the policy generation was completed.
*
*
* @param completedOn
* A timestamp of when the policy generation was completed.
*/
public void setCompletedOn(java.util.Date completedOn) {
this.completedOn = completedOn;
}
/**
*
* A timestamp of when the policy generation was completed.
*
*
* @return A timestamp of when the policy generation was completed.
*/
public java.util.Date getCompletedOn() {
return this.completedOn;
}
/**
*
* A timestamp of when the policy generation was completed.
*
*
* @param completedOn
* A timestamp of when the policy generation was completed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyGeneration withCompletedOn(java.util.Date completedOn) {
setCompletedOn(completedOn);
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 (getJobId() != null)
sb.append("JobId: ").append(getJobId()).append(",");
if (getPrincipalArn() != null)
sb.append("PrincipalArn: ").append(getPrincipalArn()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStartedOn() != null)
sb.append("StartedOn: ").append(getStartedOn()).append(",");
if (getCompletedOn() != null)
sb.append("CompletedOn: ").append(getCompletedOn());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PolicyGeneration == false)
return false;
PolicyGeneration other = (PolicyGeneration) obj;
if (other.getJobId() == null ^ this.getJobId() == null)
return false;
if (other.getJobId() != null && other.getJobId().equals(this.getJobId()) == false)
return false;
if (other.getPrincipalArn() == null ^ this.getPrincipalArn() == null)
return false;
if (other.getPrincipalArn() != null && other.getPrincipalArn().equals(this.getPrincipalArn()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getStartedOn() == null ^ this.getStartedOn() == null)
return false;
if (other.getStartedOn() != null && other.getStartedOn().equals(this.getStartedOn()) == false)
return false;
if (other.getCompletedOn() == null ^ this.getCompletedOn() == null)
return false;
if (other.getCompletedOn() != null && other.getCompletedOn().equals(this.getCompletedOn()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getJobId() == null) ? 0 : getJobId().hashCode());
hashCode = prime * hashCode + ((getPrincipalArn() == null) ? 0 : getPrincipalArn().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStartedOn() == null) ? 0 : getStartedOn().hashCode());
hashCode = prime * hashCode + ((getCompletedOn() == null) ? 0 : getCompletedOn().hashCode());
return hashCode;
}
@Override
public PolicyGeneration clone() {
try {
return (PolicyGeneration) 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.accessanalyzer.model.transform.PolicyGenerationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}