com.amazonaws.services.simplesystemsmanagement.model.DocumentVersionInfo Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm 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.simplesystemsmanagement.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* Version information about the document.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class DocumentVersionInfo implements Serializable, Cloneable, StructuredPojo {
/**
*
* The document name.
*
*/
private String name;
/**
*
* The friendly name of the SSM document. This value can differ for each version of the document. If you want to
* update this value, see UpdateDocument.
*
*/
private String displayName;
/**
*
* The document version.
*
*/
private String documentVersion;
/**
*
* The version of the artifact associated with the document. For example, 12.6. This value is unique across all
* versions of a document, and can't be changed.
*
*/
private String versionName;
/**
*
* The date the document was created.
*
*/
private java.util.Date createdDate;
/**
*
* An identifier for the default version of the document.
*
*/
private Boolean isDefaultVersion;
/**
*
* The document format, either JSON or YAML.
*
*/
private String documentFormat;
/**
*
* The status of the SSM document, such as Creating, Active, Failed, and
* Deleting.
*
*/
private String status;
/**
*
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*
*/
private String statusInformation;
/**
*
* The current status of the approval review for the latest version of the document.
*
*/
private String reviewStatus;
/**
*
* The document name.
*
*
* @param name
* The document name.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The document name.
*
*
* @return The document name.
*/
public String getName() {
return this.name;
}
/**
*
* The document name.
*
*
* @param name
* The document name.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withName(String name) {
setName(name);
return this;
}
/**
*
* The friendly name of the SSM document. This value can differ for each version of the document. If you want to
* update this value, see UpdateDocument.
*
*
* @param displayName
* The friendly name of the SSM document. This value can differ for each version of the document. If you want
* to update this value, see UpdateDocument.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The friendly name of the SSM document. This value can differ for each version of the document. If you want to
* update this value, see UpdateDocument.
*
*
* @return The friendly name of the SSM document. This value can differ for each version of the document. If you
* want to update this value, see UpdateDocument.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The friendly name of the SSM document. This value can differ for each version of the document. If you want to
* update this value, see UpdateDocument.
*
*
* @param displayName
* The friendly name of the SSM document. This value can differ for each version of the document. If you want
* to update this value, see UpdateDocument.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* The document version.
*
*
* @param documentVersion
* The document version.
*/
public void setDocumentVersion(String documentVersion) {
this.documentVersion = documentVersion;
}
/**
*
* The document version.
*
*
* @return The document version.
*/
public String getDocumentVersion() {
return this.documentVersion;
}
/**
*
* The document version.
*
*
* @param documentVersion
* The document version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withDocumentVersion(String documentVersion) {
setDocumentVersion(documentVersion);
return this;
}
/**
*
* The version of the artifact associated with the document. For example, 12.6. This value is unique across all
* versions of a document, and can't be changed.
*
*
* @param versionName
* The version of the artifact associated with the document. For example, 12.6. This value is unique across
* all versions of a document, and can't be changed.
*/
public void setVersionName(String versionName) {
this.versionName = versionName;
}
/**
*
* The version of the artifact associated with the document. For example, 12.6. This value is unique across all
* versions of a document, and can't be changed.
*
*
* @return The version of the artifact associated with the document. For example, 12.6. This value is unique across
* all versions of a document, and can't be changed.
*/
public String getVersionName() {
return this.versionName;
}
/**
*
* The version of the artifact associated with the document. For example, 12.6. This value is unique across all
* versions of a document, and can't be changed.
*
*
* @param versionName
* The version of the artifact associated with the document. For example, 12.6. This value is unique across
* all versions of a document, and can't be changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withVersionName(String versionName) {
setVersionName(versionName);
return this;
}
/**
*
* The date the document was created.
*
*
* @param createdDate
* The date the document was created.
*/
public void setCreatedDate(java.util.Date createdDate) {
this.createdDate = createdDate;
}
/**
*
* The date the document was created.
*
*
* @return The date the document was created.
*/
public java.util.Date getCreatedDate() {
return this.createdDate;
}
/**
*
* The date the document was created.
*
*
* @param createdDate
* The date the document was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withCreatedDate(java.util.Date createdDate) {
setCreatedDate(createdDate);
return this;
}
/**
*
* An identifier for the default version of the document.
*
*
* @param isDefaultVersion
* An identifier for the default version of the document.
*/
public void setIsDefaultVersion(Boolean isDefaultVersion) {
this.isDefaultVersion = isDefaultVersion;
}
/**
*
* An identifier for the default version of the document.
*
*
* @return An identifier for the default version of the document.
*/
public Boolean getIsDefaultVersion() {
return this.isDefaultVersion;
}
/**
*
* An identifier for the default version of the document.
*
*
* @param isDefaultVersion
* An identifier for the default version of the document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withIsDefaultVersion(Boolean isDefaultVersion) {
setIsDefaultVersion(isDefaultVersion);
return this;
}
/**
*
* An identifier for the default version of the document.
*
*
* @return An identifier for the default version of the document.
*/
public Boolean isDefaultVersion() {
return this.isDefaultVersion;
}
/**
*
* The document format, either JSON or YAML.
*
*
* @param documentFormat
* The document format, either JSON or YAML.
* @see DocumentFormat
*/
public void setDocumentFormat(String documentFormat) {
this.documentFormat = documentFormat;
}
/**
*
* The document format, either JSON or YAML.
*
*
* @return The document format, either JSON or YAML.
* @see DocumentFormat
*/
public String getDocumentFormat() {
return this.documentFormat;
}
/**
*
* The document format, either JSON or YAML.
*
*
* @param documentFormat
* The document format, either JSON or YAML.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentFormat
*/
public DocumentVersionInfo withDocumentFormat(String documentFormat) {
setDocumentFormat(documentFormat);
return this;
}
/**
*
* The document format, either JSON or YAML.
*
*
* @param documentFormat
* The document format, either JSON or YAML.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentFormat
*/
public DocumentVersionInfo withDocumentFormat(DocumentFormat documentFormat) {
this.documentFormat = documentFormat.toString();
return this;
}
/**
*
* The status of the SSM document, such as Creating, Active, Failed, and
* Deleting.
*
*
* @param status
* The status of the SSM document, such as Creating, Active, Failed,
* and Deleting.
* @see DocumentStatus
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the SSM document, such as Creating, Active, Failed, and
* Deleting.
*
*
* @return The status of the SSM document, such as Creating, Active, Failed,
* and Deleting.
* @see DocumentStatus
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the SSM document, such as Creating, Active, Failed, and
* Deleting.
*
*
* @param status
* The status of the SSM document, such as Creating, Active, Failed,
* and Deleting.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentStatus
*/
public DocumentVersionInfo withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* The status of the SSM document, such as Creating, Active, Failed, and
* Deleting.
*
*
* @param status
* The status of the SSM document, such as Creating, Active, Failed,
* and Deleting.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentStatus
*/
public DocumentVersionInfo withStatus(DocumentStatus status) {
this.status = status.toString();
return this;
}
/**
*
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*
*
* @param statusInformation
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*/
public void setStatusInformation(String statusInformation) {
this.statusInformation = statusInformation;
}
/**
*
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*
*
* @return A message returned by Amazon Web Services Systems Manager that explains the Status value.
* For example, a Failed status might be explained by the StatusInformation
* message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*/
public String getStatusInformation() {
return this.statusInformation;
}
/**
*
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
*
*
* @param statusInformation
* A message returned by Amazon Web Services Systems Manager that explains the Status value. For
* example, a Failed status might be explained by the StatusInformation message,
* "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentVersionInfo withStatusInformation(String statusInformation) {
setStatusInformation(statusInformation);
return this;
}
/**
*
* The current status of the approval review for the latest version of the document.
*
*
* @param reviewStatus
* The current status of the approval review for the latest version of the document.
* @see ReviewStatus
*/
public void setReviewStatus(String reviewStatus) {
this.reviewStatus = reviewStatus;
}
/**
*
* The current status of the approval review for the latest version of the document.
*
*
* @return The current status of the approval review for the latest version of the document.
* @see ReviewStatus
*/
public String getReviewStatus() {
return this.reviewStatus;
}
/**
*
* The current status of the approval review for the latest version of the document.
*
*
* @param reviewStatus
* The current status of the approval review for the latest version of the document.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReviewStatus
*/
public DocumentVersionInfo withReviewStatus(String reviewStatus) {
setReviewStatus(reviewStatus);
return this;
}
/**
*
* The current status of the approval review for the latest version of the document.
*
*
* @param reviewStatus
* The current status of the approval review for the latest version of the document.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ReviewStatus
*/
public DocumentVersionInfo withReviewStatus(ReviewStatus reviewStatus) {
this.reviewStatus = reviewStatus.toString();
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 (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDisplayName() != null)
sb.append("DisplayName: ").append(getDisplayName()).append(",");
if (getDocumentVersion() != null)
sb.append("DocumentVersion: ").append(getDocumentVersion()).append(",");
if (getVersionName() != null)
sb.append("VersionName: ").append(getVersionName()).append(",");
if (getCreatedDate() != null)
sb.append("CreatedDate: ").append(getCreatedDate()).append(",");
if (getIsDefaultVersion() != null)
sb.append("IsDefaultVersion: ").append(getIsDefaultVersion()).append(",");
if (getDocumentFormat() != null)
sb.append("DocumentFormat: ").append(getDocumentFormat()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getStatusInformation() != null)
sb.append("StatusInformation: ").append(getStatusInformation()).append(",");
if (getReviewStatus() != null)
sb.append("ReviewStatus: ").append(getReviewStatus());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof DocumentVersionInfo == false)
return false;
DocumentVersionInfo other = (DocumentVersionInfo) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDisplayName() == null ^ this.getDisplayName() == null)
return false;
if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false)
return false;
if (other.getDocumentVersion() == null ^ this.getDocumentVersion() == null)
return false;
if (other.getDocumentVersion() != null && other.getDocumentVersion().equals(this.getDocumentVersion()) == false)
return false;
if (other.getVersionName() == null ^ this.getVersionName() == null)
return false;
if (other.getVersionName() != null && other.getVersionName().equals(this.getVersionName()) == false)
return false;
if (other.getCreatedDate() == null ^ this.getCreatedDate() == null)
return false;
if (other.getCreatedDate() != null && other.getCreatedDate().equals(this.getCreatedDate()) == 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.getDocumentFormat() == null ^ this.getDocumentFormat() == null)
return false;
if (other.getDocumentFormat() != null && other.getDocumentFormat().equals(this.getDocumentFormat()) == 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.getStatusInformation() == null ^ this.getStatusInformation() == null)
return false;
if (other.getStatusInformation() != null && other.getStatusInformation().equals(this.getStatusInformation()) == false)
return false;
if (other.getReviewStatus() == null ^ this.getReviewStatus() == null)
return false;
if (other.getReviewStatus() != null && other.getReviewStatus().equals(this.getReviewStatus()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode());
hashCode = prime * hashCode + ((getDocumentVersion() == null) ? 0 : getDocumentVersion().hashCode());
hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode());
hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode());
hashCode = prime * hashCode + ((getIsDefaultVersion() == null) ? 0 : getIsDefaultVersion().hashCode());
hashCode = prime * hashCode + ((getDocumentFormat() == null) ? 0 : getDocumentFormat().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getStatusInformation() == null) ? 0 : getStatusInformation().hashCode());
hashCode = prime * hashCode + ((getReviewStatus() == null) ? 0 : getReviewStatus().hashCode());
return hashCode;
}
@Override
public DocumentVersionInfo clone() {
try {
return (DocumentVersionInfo) 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.simplesystemsmanagement.model.transform.DocumentVersionInfoMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}