/* * 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.simplesystemsmanagement.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* Describes the name of a SSM document. *
* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DocumentIdentifier implements Serializable, Cloneable, StructuredPojo { /** ** The name of the SSM document. *
*/ private String name; /** ** The date the SSM document was created. *
*/ private java.util.Date createdDate; /** ** An optional field where you can specify a friendly name for 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 Amazon Web Services user that created the document. *
*/ private String owner; /** ** An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. *
*/ private String versionName; /** ** The operating system platform. *
*/ private com.amazonaws.internal.SdkInternalList* The document version. *
*/ private String documentVersion; /** ** The document type. *
*/ private String documentType; /** ** The schema version. *
*/ private String schemaVersion; /** ** The document format, either JSON or YAML. *
*/ private String documentFormat; /** *
* The target type which defines the kinds of resources the document can run on. For example,
* /AWS::EC2::Instance
. For a list of valid resource types, see Amazon
* Web Services resource and property types reference in the CloudFormation User Guide.
*
* The tags, or metadata, that have been applied to the document. *
*/ private com.amazonaws.internal.SdkInternalList
* A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
* requires an ApplicationConfigurationSchema
document.
*
* The current status of a document review. *
*/ private String reviewStatus; /** ** The user in your organization who created the document. *
*/ private String author; /** ** The name of the SSM document. *
* * @param name * The name of the SSM document. */ public void setName(String name) { this.name = name; } /** ** The name of the SSM document. *
* * @return The name of the SSM document. */ public String getName() { return this.name; } /** ** The name of the SSM document. *
* * @param name * The name of the SSM document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withName(String name) { setName(name); return this; } /** ** The date the SSM document was created. *
* * @param createdDate * The date the SSM document was created. */ public void setCreatedDate(java.util.Date createdDate) { this.createdDate = createdDate; } /** ** The date the SSM document was created. *
* * @return The date the SSM document was created. */ public java.util.Date getCreatedDate() { return this.createdDate; } /** ** The date the SSM document was created. *
* * @param createdDate * The date the SSM document was created. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withCreatedDate(java.util.Date createdDate) { setCreatedDate(createdDate); return this; } /** ** An optional field where you can specify a friendly name for the SSM document. This value can differ for each * version of the document. If you want to update this value, see UpdateDocument. *
* * @param displayName * An optional field where you can specify a friendly name for 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; } /** ** An optional field where you can specify a friendly name for the SSM document. This value can differ for each * version of the document. If you want to update this value, see UpdateDocument. *
* * @return An optional field where you can specify a friendly name for 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; } /** ** An optional field where you can specify a friendly name for the SSM document. This value can differ for each * version of the document. If you want to update this value, see UpdateDocument. *
* * @param displayName * An optional field where you can specify a friendly name for 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 DocumentIdentifier withDisplayName(String displayName) { setDisplayName(displayName); return this; } /** ** The Amazon Web Services user that created the document. *
* * @param owner * The Amazon Web Services user that created the document. */ public void setOwner(String owner) { this.owner = owner; } /** ** The Amazon Web Services user that created the document. *
* * @return The Amazon Web Services user that created the document. */ public String getOwner() { return this.owner; } /** ** The Amazon Web Services user that created the document. *
* * @param owner * The Amazon Web Services user that created the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withOwner(String owner) { setOwner(owner); return this; } /** ** An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. *
* * @param versionName * An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. */ public void setVersionName(String versionName) { this.versionName = versionName; } /** ** An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. *
* * @return An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. */ public String getVersionName() { return this.versionName; } /** ** An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 6". This value is unique across all versions of a document, and can't be changed. *
* * @param versionName * An optional field specifying the version of the artifact associated with the document. For example, * "Release 12, Update 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 DocumentIdentifier withVersionName(String versionName) { setVersionName(versionName); return this; } /** ** The operating system platform. *
* * @return The operating system platform. * @see PlatformType */ public java.util.List* The operating system platform. *
* * @param platformTypes * The operating system platform. * @see PlatformType */ public void setPlatformTypes(java.util.Collection* The operating system platform. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setPlatformTypes(java.util.Collection)} or {@link #withPlatformTypes(java.util.Collection)} if you want * to override the existing values. *
* * @param platformTypes * The operating system platform. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentIdentifier withPlatformTypes(String... platformTypes) { if (this.platformTypes == null) { setPlatformTypes(new com.amazonaws.internal.SdkInternalList* The operating system platform. *
* * @param platformTypes * The operating system platform. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentIdentifier withPlatformTypes(java.util.Collection* The operating system platform. *
* * @param platformTypes * The operating system platform. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentIdentifier withPlatformTypes(PlatformType... platformTypes) { com.amazonaws.internal.SdkInternalList* 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 DocumentIdentifier withDocumentVersion(String documentVersion) { setDocumentVersion(documentVersion); return this; } /** ** The document type. *
* * @param documentType * The document type. * @see DocumentType */ public void setDocumentType(String documentType) { this.documentType = documentType; } /** ** The document type. *
* * @return The document type. * @see DocumentType */ public String getDocumentType() { return this.documentType; } /** ** The document type. *
* * @param documentType * The document type. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentType */ public DocumentIdentifier withDocumentType(String documentType) { setDocumentType(documentType); return this; } /** ** The document type. *
* * @param documentType * The document type. * @see DocumentType */ public void setDocumentType(DocumentType documentType) { withDocumentType(documentType); } /** ** The document type. *
* * @param documentType * The document type. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentType */ public DocumentIdentifier withDocumentType(DocumentType documentType) { this.documentType = documentType.toString(); return this; } /** ** The schema version. *
* * @param schemaVersion * The schema version. */ public void setSchemaVersion(String schemaVersion) { this.schemaVersion = schemaVersion; } /** ** The schema version. *
* * @return The schema version. */ public String getSchemaVersion() { return this.schemaVersion; } /** ** The schema version. *
* * @param schemaVersion * The schema version. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withSchemaVersion(String schemaVersion) { setSchemaVersion(schemaVersion); return this; } /** ** 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 DocumentIdentifier withDocumentFormat(String documentFormat) { setDocumentFormat(documentFormat); return this; } /** ** The document format, either JSON or YAML. *
* * @param documentFormat * The document format, either JSON or YAML. * @see DocumentFormat */ public void setDocumentFormat(DocumentFormat documentFormat) { withDocumentFormat(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 DocumentIdentifier withDocumentFormat(DocumentFormat documentFormat) { this.documentFormat = documentFormat.toString(); return this; } /** *
* The target type which defines the kinds of resources the document can run on. For example,
* /AWS::EC2::Instance
. For a list of valid resource types, see Amazon
* Web Services resource and property types reference in the CloudFormation User Guide.
*
/AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
*/
public void setTargetType(String targetType) {
this.targetType = targetType;
}
/**
*
* The target type which defines the kinds of resources the document can run on. For example,
* /AWS::EC2::Instance
. For a list of valid resource types, see Amazon
* Web Services resource and property types reference in the CloudFormation User Guide.
*
/AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
*/
public String getTargetType() {
return this.targetType;
}
/**
*
* The target type which defines the kinds of resources the document can run on. For example,
* /AWS::EC2::Instance
. For a list of valid resource types, see Amazon
* Web Services resource and property types reference in the CloudFormation User Guide.
*
/AWS::EC2::Instance
. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentIdentifier withTargetType(String targetType) {
setTargetType(targetType);
return this;
}
/**
* * The tags, or metadata, that have been applied to the document. *
* * @return The tags, or metadata, that have been applied to the document. */ public java.util.List* The tags, or metadata, that have been applied to the document. *
* * @param tags * The tags, or metadata, that have been applied to the document. */ public void setTags(java.util.Collection* The tags, or metadata, that have been applied to the document. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param tags * The tags, or metadata, that have been applied to the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList* The tags, or metadata, that have been applied to the document. *
* * @param tags * The tags, or metadata, that have been applied to the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withTags(java.util.Collection
* A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
* requires an ApplicationConfigurationSchema
document.
*
ApplicationConfiguration
* document requires an ApplicationConfigurationSchema
document.
*/
public java.util.List
* A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
* requires an ApplicationConfigurationSchema
document.
*
ApplicationConfiguration
* document requires an ApplicationConfigurationSchema
document.
*/
public void setRequires(java.util.Collection
* A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
* requires an ApplicationConfigurationSchema
document.
*
* NOTE: This method appends the values to the existing list (if any). Use * {@link #setRequires(java.util.Collection)} or {@link #withRequires(java.util.Collection)} if you want to override * the existing values. *
* * @param requires * A list of SSM documents required by a document. For example, anApplicationConfiguration
* document requires an ApplicationConfigurationSchema
document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentIdentifier withRequires(DocumentRequires... requires) {
if (this.requires == null) {
setRequires(new com.amazonaws.internal.SdkInternalList
* A list of SSM documents required by a document. For example, an ApplicationConfiguration
document
* requires an ApplicationConfigurationSchema
document.
*
ApplicationConfiguration
* document requires an ApplicationConfigurationSchema
document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public DocumentIdentifier withRequires(java.util.Collection* The current status of a document review. *
* * @param reviewStatus * The current status of a document review. * @see ReviewStatus */ public void setReviewStatus(String reviewStatus) { this.reviewStatus = reviewStatus; } /** ** The current status of a document review. *
* * @return The current status of a document review. * @see ReviewStatus */ public String getReviewStatus() { return this.reviewStatus; } /** ** The current status of a document review. *
* * @param reviewStatus * The current status of a document review. * @return Returns a reference to this object so that method calls can be chained together. * @see ReviewStatus */ public DocumentIdentifier withReviewStatus(String reviewStatus) { setReviewStatus(reviewStatus); return this; } /** ** The current status of a document review. *
* * @param reviewStatus * The current status of a document review. * @see ReviewStatus */ public void setReviewStatus(ReviewStatus reviewStatus) { withReviewStatus(reviewStatus); } /** ** The current status of a document review. *
* * @param reviewStatus * The current status of a document review. * @return Returns a reference to this object so that method calls can be chained together. * @see ReviewStatus */ public DocumentIdentifier withReviewStatus(ReviewStatus reviewStatus) { this.reviewStatus = reviewStatus.toString(); return this; } /** ** The user in your organization who created the document. *
* * @param author * The user in your organization who created the document. */ public void setAuthor(String author) { this.author = author; } /** ** The user in your organization who created the document. *
* * @return The user in your organization who created the document. */ public String getAuthor() { return this.author; } /** ** The user in your organization who created the document. *
* * @param author * The user in your organization who created the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentIdentifier withAuthor(String author) { setAuthor(author); 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 (getCreatedDate() != null) sb.append("CreatedDate: ").append(getCreatedDate()).append(","); if (getDisplayName() != null) sb.append("DisplayName: ").append(getDisplayName()).append(","); if (getOwner() != null) sb.append("Owner: ").append(getOwner()).append(","); if (getVersionName() != null) sb.append("VersionName: ").append(getVersionName()).append(","); if (getPlatformTypes() != null) sb.append("PlatformTypes: ").append(getPlatformTypes()).append(","); if (getDocumentVersion() != null) sb.append("DocumentVersion: ").append(getDocumentVersion()).append(","); if (getDocumentType() != null) sb.append("DocumentType: ").append(getDocumentType()).append(","); if (getSchemaVersion() != null) sb.append("SchemaVersion: ").append(getSchemaVersion()).append(","); if (getDocumentFormat() != null) sb.append("DocumentFormat: ").append(getDocumentFormat()).append(","); if (getTargetType() != null) sb.append("TargetType: ").append(getTargetType()).append(","); if (getTags() != null) sb.append("Tags: ").append(getTags()).append(","); if (getRequires() != null) sb.append("Requires: ").append(getRequires()).append(","); if (getReviewStatus() != null) sb.append("ReviewStatus: ").append(getReviewStatus()).append(","); if (getAuthor() != null) sb.append("Author: ").append(getAuthor()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DocumentIdentifier == false) return false; DocumentIdentifier other = (DocumentIdentifier) obj; if (other.getName() == null ^ this.getName() == null) return false; if (other.getName() != null && other.getName().equals(this.getName()) == 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.getDisplayName() == null ^ this.getDisplayName() == null) return false; if (other.getDisplayName() != null && other.getDisplayName().equals(this.getDisplayName()) == false) return false; if (other.getOwner() == null ^ this.getOwner() == null) return false; if (other.getOwner() != null && other.getOwner().equals(this.getOwner()) == 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.getPlatformTypes() == null ^ this.getPlatformTypes() == null) return false; if (other.getPlatformTypes() != null && other.getPlatformTypes().equals(this.getPlatformTypes()) == 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.getDocumentType() == null ^ this.getDocumentType() == null) return false; if (other.getDocumentType() != null && other.getDocumentType().equals(this.getDocumentType()) == false) return false; if (other.getSchemaVersion() == null ^ this.getSchemaVersion() == null) return false; if (other.getSchemaVersion() != null && other.getSchemaVersion().equals(this.getSchemaVersion()) == 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.getTargetType() == null ^ this.getTargetType() == null) return false; if (other.getTargetType() != null && other.getTargetType().equals(this.getTargetType()) == false) return false; if (other.getTags() == null ^ this.getTags() == null) return false; if (other.getTags() != null && other.getTags().equals(this.getTags()) == false) return false; if (other.getRequires() == null ^ this.getRequires() == null) return false; if (other.getRequires() != null && other.getRequires().equals(this.getRequires()) == false) return false; if (other.getReviewStatus() == null ^ this.getReviewStatus() == null) return false; if (other.getReviewStatus() != null && other.getReviewStatus().equals(this.getReviewStatus()) == false) return false; if (other.getAuthor() == null ^ this.getAuthor() == null) return false; if (other.getAuthor() != null && other.getAuthor().equals(this.getAuthor()) == 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 + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode()); hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode()); hashCode = prime * hashCode + ((getOwner() == null) ? 0 : getOwner().hashCode()); hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode()); hashCode = prime * hashCode + ((getPlatformTypes() == null) ? 0 : getPlatformTypes().hashCode()); hashCode = prime * hashCode + ((getDocumentVersion() == null) ? 0 : getDocumentVersion().hashCode()); hashCode = prime * hashCode + ((getDocumentType() == null) ? 0 : getDocumentType().hashCode()); hashCode = prime * hashCode + ((getSchemaVersion() == null) ? 0 : getSchemaVersion().hashCode()); hashCode = prime * hashCode + ((getDocumentFormat() == null) ? 0 : getDocumentFormat().hashCode()); hashCode = prime * hashCode + ((getTargetType() == null) ? 0 : getTargetType().hashCode()); hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode()); hashCode = prime * hashCode + ((getRequires() == null) ? 0 : getRequires().hashCode()); hashCode = prime * hashCode + ((getReviewStatus() == null) ? 0 : getReviewStatus().hashCode()); hashCode = prime * hashCode + ((getAuthor() == null) ? 0 : getAuthor().hashCode()); return hashCode; } @Override public DocumentIdentifier clone() { try { return (DocumentIdentifier) 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.DocumentIdentifierMarshaller.getInstance().marshall(this, protocolMarshaller); } }