com.amazonaws.services.identitymanagement.model.PolicyVersion Maven / Gradle / Ivy
Show all versions of aws-java-sdk-iam Show documentation
/*
* Copyright 2020-2025 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.identitymanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Contains information about a version of a managed policy.
*
*
* This data type is used as a response element in the CreatePolicyVersion, GetPolicyVersion,
* ListPolicyVersions, and GetAccountAuthorizationDetails operations.
*
*
* For more information about managed policies, refer to Managed policies and inline
* policies in the IAM User Guide.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class PolicyVersion implements Serializable, Cloneable {
/**
*
* The policy document.
*
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy
* back to plain JSON text. For example, if you use Java, you can use the decode method of the
* java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
* functionality.
*
*/
private String document;
/**
*
* The identifier for the policy version.
*
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created, the
* first policy version is v1.
*
*/
private String versionId;
/**
*
* Specifies whether the policy version is set as the policy's default version.
*
*/
private Boolean isDefaultVersion;
/**
*
* The date and time, in ISO 8601 date-time format, when the policy
* version was created.
*
*/
private java.util.Date createDate;
/**
*
* The policy document.
*
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy
* back to plain JSON text. For example, if you use Java, you can use the decode method of the
* java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
* functionality.
*
*
* @param document
* The policy document.
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the
* policy back to plain JSON text. For example, if you use Java, you can use the decode method
* of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide
* similar functionality.
*/
public void setDocument(String document) {
this.document = document;
}
/**
*
* The policy document.
*
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy
* back to plain JSON text. For example, if you use Java, you can use the decode method of the
* java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
* functionality.
*
*
* @return The policy document.
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the
* policy back to plain JSON text. For example, if you use Java, you can use the decode method
* of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide
* similar functionality.
*/
public String getDocument() {
return this.document;
}
/**
*
* The policy document.
*
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the policy
* back to plain JSON text. For example, if you use Java, you can use the decode method of the
* java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide similar
* functionality.
*
*
* @param document
* The policy document.
*
* The policy document is returned in the response to the GetPolicyVersion and
* GetAccountAuthorizationDetails operations. It is not returned in the response to the
* CreatePolicyVersion or ListPolicyVersions operations.
*
*
* The policy document returned in this structure is URL-encoded compliant with RFC 3986. You can use a URL decoding method to convert the
* policy back to plain JSON text. For example, if you use Java, you can use the decode method
* of the java.net.URLDecoder utility class in the Java SDK. Other languages and SDKs provide
* similar functionality.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyVersion withDocument(String document) {
setDocument(document);
return this;
}
/**
*
* The identifier for the policy version.
*
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created, the
* first policy version is v1.
*
*
* @param versionId
* The identifier for the policy version.
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created,
* the first policy version is v1.
*/
public void setVersionId(String versionId) {
this.versionId = versionId;
}
/**
*
* The identifier for the policy version.
*
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created, the
* first policy version is v1.
*
*
* @return The identifier for the policy version.
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created,
* the first policy version is v1.
*/
public String getVersionId() {
return this.versionId;
}
/**
*
* The identifier for the policy version.
*
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created, the
* first policy version is v1.
*
*
* @param versionId
* The identifier for the policy version.
*
* Policy version identifiers always begin with v (always lowercase). When a policy is created,
* the first policy version is v1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyVersion withVersionId(String versionId) {
setVersionId(versionId);
return this;
}
/**
*
* Specifies whether the policy version is set as the policy's default version.
*
*
* @param isDefaultVersion
* Specifies whether the policy version is set as the policy's default version.
*/
public void setIsDefaultVersion(Boolean isDefaultVersion) {
this.isDefaultVersion = isDefaultVersion;
}
/**
*
* Specifies whether the policy version is set as the policy's default version.
*
*
* @return Specifies whether the policy version is set as the policy's default version.
*/
public Boolean getIsDefaultVersion() {
return this.isDefaultVersion;
}
/**
*
* Specifies whether the policy version is set as the policy's default version.
*
*
* @param isDefaultVersion
* Specifies whether the policy version is set as the policy's default version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyVersion withIsDefaultVersion(Boolean isDefaultVersion) {
setIsDefaultVersion(isDefaultVersion);
return this;
}
/**
*
* Specifies whether the policy version is set as the policy's default version.
*
*
* @return Specifies whether the policy version is set as the policy's default version.
*/
public Boolean isDefaultVersion() {
return this.isDefaultVersion;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the policy
* version was created.
*
*
* @param createDate
* The date and time, in ISO 8601 date-time format, when the
* policy version was created.
*/
public void setCreateDate(java.util.Date createDate) {
this.createDate = createDate;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the policy
* version was created.
*
*
* @return The date and time, in ISO 8601 date-time format, when the
* policy version was created.
*/
public java.util.Date getCreateDate() {
return this.createDate;
}
/**
*
* The date and time, in ISO 8601 date-time format, when the policy
* version was created.
*
*
* @param createDate
* The date and time, in ISO 8601 date-time format, when the
* policy version was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PolicyVersion withCreateDate(java.util.Date createDate) {
setCreateDate(createDate);
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 (getDocument() != null)
sb.append("Document: ").append(getDocument()).append(",");
if (getVersionId() != null)
sb.append("VersionId: ").append(getVersionId()).append(",");
if (getIsDefaultVersion() != null)
sb.append("IsDefaultVersion: ").append(getIsDefaultVersion()).append(",");
if (getCreateDate() != null)
sb.append("CreateDate: ").append(getCreateDate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PolicyVersion == false)
return false;
PolicyVersion other = (PolicyVersion) obj;
if (other.getDocument() == null ^ this.getDocument() == null)
return false;
if (other.getDocument() != null && other.getDocument().equals(this.getDocument()) == false)
return false;
if (other.getVersionId() == null ^ this.getVersionId() == null)
return false;
if (other.getVersionId() != null && other.getVersionId().equals(this.getVersionId()) == false)
return false;
if (other.getIsDefaultVersion() == null ^ this.getIsDefaultVersion() == null)
return false;
if (other.getIsDefaultVersion() != null && other.getIsDefaultVersion().equals(this.getIsDefaultVersion()) == false)
return false;
if (other.getCreateDate() == null ^ this.getCreateDate() == null)
return false;
if (other.getCreateDate() != null && other.getCreateDate().equals(this.getCreateDate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getDocument() == null) ? 0 : getDocument().hashCode());
hashCode = prime * hashCode + ((getVersionId() == null) ? 0 : getVersionId().hashCode());
hashCode = prime * hashCode + ((getIsDefaultVersion() == null) ? 0 : getIsDefaultVersion().hashCode());
hashCode = prime * hashCode + ((getCreateDate() == null) ? 0 : getCreateDate().hashCode());
return hashCode;
}
@Override
public PolicyVersion clone() {
try {
return (PolicyVersion) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}