All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.simplesystemsmanagement.model.DocumentDescription Maven / Gradle / Ivy

Go to download

The AWS Java SDK for AWS Simple Systems Management Service holds the client classes that are used for communicating with the AWS Simple Systems Management Service

The newest version!
/*
 * 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;

/**
 * 

* Describes an Amazon Web Services Systems Manager document (SSM document). *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class DocumentDescription implements Serializable, Cloneable, StructuredPojo { /** *

* The SHA1 hash of the document, which you can use for verification. *

*/ private String sha1; /** *

* The Sha256 or Sha1 hash created by the system when the document was created. *

* *

* Sha1 hashes have been deprecated. *

*
*/ private String hash; /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
*/ private String hashType; /** *

* The name of the SSM document. *

*/ 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 version of the artifact associated with the document. *

*/ private String versionName; /** *

* The Amazon Web Services user that created the document. *

*/ private String owner; /** *

* The date when the document was created. *

*/ private java.util.Date createdDate; /** *

* The status of the SSM document. *

*/ 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 document version. *

*/ private String documentVersion; /** *

* A description of the document. *

*/ private String description; /** *

* A description of the parameters for a document. *

*/ private com.amazonaws.internal.SdkInternalList parameters; /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

*/ private com.amazonaws.internal.SdkInternalList platformTypes; /** *

* The type of document. *

*/ private String documentType; /** *

* The schema version. *

*/ private String schemaVersion; /** *

* The latest version of the document. *

*/ private String latestVersion; /** *

* The default version. *

*/ private String defaultVersion; /** *

* 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. *

*/ private String targetType; /** *

* The tags, or metadata, that have been applied to the document. *

*/ private com.amazonaws.internal.SdkInternalList tags; /** *

* Details about the document attachments, including names, locations, sizes, and so on. *

*/ private com.amazonaws.internal.SdkInternalList attachmentsInformation; /** *

* A list of SSM documents required by a document. For example, an ApplicationConfiguration document * requires an ApplicationConfigurationSchema document. *

*/ private com.amazonaws.internal.SdkInternalList requires; /** *

* The user in your organization who created the document. *

*/ private String author; /** *

* Details about the review of a document. *

*/ private com.amazonaws.internal.SdkInternalList reviewInformation; /** *

* The version of the document currently approved for use in the organization. *

*/ private String approvedVersion; /** *

* The version of the document that is currently under review. *

*/ private String pendingReviewVersion; /** *

* The current status of the review. *

*/ private String reviewStatus; /** *

* The classification of a document to help you identify and categorize its use. *

*/ private com.amazonaws.internal.SdkInternalList category; /** *

* The value that identifies a document's category. *

*/ private com.amazonaws.internal.SdkInternalList categoryEnum; /** *

* The SHA1 hash of the document, which you can use for verification. *

* * @param sha1 * The SHA1 hash of the document, which you can use for verification. */ public void setSha1(String sha1) { this.sha1 = sha1; } /** *

* The SHA1 hash of the document, which you can use for verification. *

* * @return The SHA1 hash of the document, which you can use for verification. */ public String getSha1() { return this.sha1; } /** *

* The SHA1 hash of the document, which you can use for verification. *

* * @param sha1 * The SHA1 hash of the document, which you can use for verification. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withSha1(String sha1) { setSha1(sha1); return this; } /** *

* The Sha256 or Sha1 hash created by the system when the document was created. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hash * The Sha256 or Sha1 hash created by the system when the document was created.

*

* Sha1 hashes have been deprecated. *

*/ public void setHash(String hash) { this.hash = hash; } /** *

* The Sha256 or Sha1 hash created by the system when the document was created. *

* *

* Sha1 hashes have been deprecated. *

*
* * @return The Sha256 or Sha1 hash created by the system when the document was created.

*

* Sha1 hashes have been deprecated. *

*/ public String getHash() { return this.hash; } /** *

* The Sha256 or Sha1 hash created by the system when the document was created. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hash * The Sha256 or Sha1 hash created by the system when the document was created.

*

* Sha1 hashes have been deprecated. *

* @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withHash(String hash) { setHash(hash); return this; } /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hashType * The hash type of the document. Valid values include Sha256 or Sha1.

*

* Sha1 hashes have been deprecated. *

* @see DocumentHashType */ public void setHashType(String hashType) { this.hashType = hashType; } /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
* * @return The hash type of the document. Valid values include Sha256 or Sha1.

*

* Sha1 hashes have been deprecated. *

* @see DocumentHashType */ public String getHashType() { return this.hashType; } /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hashType * The hash type of the document. Valid values include Sha256 or Sha1.

*

* Sha1 hashes have been deprecated. *

* @return Returns a reference to this object so that method calls can be chained together. * @see DocumentHashType */ public DocumentDescription withHashType(String hashType) { setHashType(hashType); return this; } /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hashType * The hash type of the document. Valid values include Sha256 or Sha1.

*

* Sha1 hashes have been deprecated. *

* @see DocumentHashType */ public void setHashType(DocumentHashType hashType) { withHashType(hashType); } /** *

* The hash type of the document. Valid values include Sha256 or Sha1. *

* *

* Sha1 hashes have been deprecated. *

*
* * @param hashType * The hash type of the document. Valid values include Sha256 or Sha1.

*

* Sha1 hashes have been deprecated. *

* @return Returns a reference to this object so that method calls can be chained together. * @see DocumentHashType */ public DocumentDescription withHashType(DocumentHashType hashType) { this.hashType = hashType.toString(); return this; } /** *

* 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 DocumentDescription 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 DocumentDescription withDisplayName(String displayName) { setDisplayName(displayName); return this; } /** *

* The version of the artifact associated with the document. *

* * @param versionName * The version of the artifact associated with the document. */ public void setVersionName(String versionName) { this.versionName = versionName; } /** *

* The version of the artifact associated with the document. *

* * @return The version of the artifact associated with the document. */ public String getVersionName() { return this.versionName; } /** *

* The version of the artifact associated with the document. *

* * @param versionName * The version of the artifact associated with the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withVersionName(String versionName) { setVersionName(versionName); 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 DocumentDescription withOwner(String owner) { setOwner(owner); return this; } /** *

* The date when the document was created. *

* * @param createdDate * The date when the document was created. */ public void setCreatedDate(java.util.Date createdDate) { this.createdDate = createdDate; } /** *

* The date when the document was created. *

* * @return The date when the document was created. */ public java.util.Date getCreatedDate() { return this.createdDate; } /** *

* The date when the document was created. *

* * @param createdDate * The date when the document was created. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withCreatedDate(java.util.Date createdDate) { setCreatedDate(createdDate); return this; } /** *

* The status of the SSM document. *

* * @param status * The status of the SSM document. * @see DocumentStatus */ public void setStatus(String status) { this.status = status; } /** *

* The status of the SSM document. *

* * @return The status of the SSM document. * @see DocumentStatus */ public String getStatus() { return this.status; } /** *

* The status of the SSM document. *

* * @param status * The status of the SSM document. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentStatus */ public DocumentDescription withStatus(String status) { setStatus(status); return this; } /** *

* The status of the SSM document. *

* * @param status * The status of the SSM document. * @see DocumentStatus */ public void setStatus(DocumentStatus status) { withStatus(status); } /** *

* The status of the SSM document. *

* * @param status * The status of the SSM document. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentStatus */ public DocumentDescription 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 DocumentDescription withStatusInformation(String statusInformation) { setStatusInformation(statusInformation); 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 DocumentDescription withDocumentVersion(String documentVersion) { setDocumentVersion(documentVersion); return this; } /** *

* A description of the document. *

* * @param description * A description of the document. */ public void setDescription(String description) { this.description = description; } /** *

* A description of the document. *

* * @return A description of the document. */ public String getDescription() { return this.description; } /** *

* A description of the document. *

* * @param description * A description of the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withDescription(String description) { setDescription(description); return this; } /** *

* A description of the parameters for a document. *

* * @return A description of the parameters for a document. */ public java.util.List getParameters() { if (parameters == null) { parameters = new com.amazonaws.internal.SdkInternalList(); } return parameters; } /** *

* A description of the parameters for a document. *

* * @param parameters * A description of the parameters for a document. */ public void setParameters(java.util.Collection parameters) { if (parameters == null) { this.parameters = null; return; } this.parameters = new com.amazonaws.internal.SdkInternalList(parameters); } /** *

* A description of the parameters for a document. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setParameters(java.util.Collection)} or {@link #withParameters(java.util.Collection)} if you want to * override the existing values. *

* * @param parameters * A description of the parameters for a document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withParameters(DocumentParameter... parameters) { if (this.parameters == null) { setParameters(new com.amazonaws.internal.SdkInternalList(parameters.length)); } for (DocumentParameter ele : parameters) { this.parameters.add(ele); } return this; } /** *

* A description of the parameters for a document. *

* * @param parameters * A description of the parameters for a document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withParameters(java.util.Collection parameters) { setParameters(parameters); return this; } /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

* * @return The list of operating system (OS) platforms compatible with this SSM document. * @see PlatformType */ public java.util.List getPlatformTypes() { if (platformTypes == null) { platformTypes = new com.amazonaws.internal.SdkInternalList(); } return platformTypes; } /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

* * @param platformTypes * The list of operating system (OS) platforms compatible with this SSM document. * @see PlatformType */ public void setPlatformTypes(java.util.Collection platformTypes) { if (platformTypes == null) { this.platformTypes = null; return; } this.platformTypes = new com.amazonaws.internal.SdkInternalList(platformTypes); } /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

*

* 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 list of operating system (OS) platforms compatible with this SSM document. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentDescription withPlatformTypes(String... platformTypes) { if (this.platformTypes == null) { setPlatformTypes(new com.amazonaws.internal.SdkInternalList(platformTypes.length)); } for (String ele : platformTypes) { this.platformTypes.add(ele); } return this; } /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

* * @param platformTypes * The list of operating system (OS) platforms compatible with this SSM document. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentDescription withPlatformTypes(java.util.Collection platformTypes) { setPlatformTypes(platformTypes); return this; } /** *

* The list of operating system (OS) platforms compatible with this SSM document. *

* * @param platformTypes * The list of operating system (OS) platforms compatible with this SSM document. * @return Returns a reference to this object so that method calls can be chained together. * @see PlatformType */ public DocumentDescription withPlatformTypes(PlatformType... platformTypes) { com.amazonaws.internal.SdkInternalList platformTypesCopy = new com.amazonaws.internal.SdkInternalList(platformTypes.length); for (PlatformType value : platformTypes) { platformTypesCopy.add(value.toString()); } if (getPlatformTypes() == null) { setPlatformTypes(platformTypesCopy); } else { getPlatformTypes().addAll(platformTypesCopy); } return this; } /** *

* The type of document. *

* * @param documentType * The type of document. * @see DocumentType */ public void setDocumentType(String documentType) { this.documentType = documentType; } /** *

* The type of document. *

* * @return The type of document. * @see DocumentType */ public String getDocumentType() { return this.documentType; } /** *

* The type of document. *

* * @param documentType * The type of document. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentType */ public DocumentDescription withDocumentType(String documentType) { setDocumentType(documentType); return this; } /** *

* The type of document. *

* * @param documentType * The type of document. * @see DocumentType */ public void setDocumentType(DocumentType documentType) { withDocumentType(documentType); } /** *

* The type of document. *

* * @param documentType * The type of document. * @return Returns a reference to this object so that method calls can be chained together. * @see DocumentType */ public DocumentDescription 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 DocumentDescription withSchemaVersion(String schemaVersion) { setSchemaVersion(schemaVersion); return this; } /** *

* The latest version of the document. *

* * @param latestVersion * The latest version of the document. */ public void setLatestVersion(String latestVersion) { this.latestVersion = latestVersion; } /** *

* The latest version of the document. *

* * @return The latest version of the document. */ public String getLatestVersion() { return this.latestVersion; } /** *

* The latest version of the document. *

* * @param latestVersion * The latest version of the document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withLatestVersion(String latestVersion) { setLatestVersion(latestVersion); return this; } /** *

* The default version. *

* * @param defaultVersion * The default version. */ public void setDefaultVersion(String defaultVersion) { this.defaultVersion = defaultVersion; } /** *

* The default version. *

* * @return The default version. */ public String getDefaultVersion() { return this.defaultVersion; } /** *

* The default version. *

* * @param defaultVersion * The default version. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withDefaultVersion(String defaultVersion) { setDefaultVersion(defaultVersion); 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 DocumentDescription 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 DocumentDescription 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. *

* * @param 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. */ 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. *

* * @return 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. */ 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. *

* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription 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 getTags() { if (tags == null) { tags = new com.amazonaws.internal.SdkInternalList(); } return tags; } /** *

* 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 tags) { if (tags == null) { this.tags = null; return; } this.tags = new com.amazonaws.internal.SdkInternalList(tags); } /** *

* 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 DocumentDescription withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList(tags.length)); } for (Tag ele : tags) { this.tags.add(ele); } return this; } /** *

* 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 DocumentDescription withTags(java.util.Collection tags) { setTags(tags); return this; } /** *

* Details about the document attachments, including names, locations, sizes, and so on. *

* * @return Details about the document attachments, including names, locations, sizes, and so on. */ public java.util.List getAttachmentsInformation() { if (attachmentsInformation == null) { attachmentsInformation = new com.amazonaws.internal.SdkInternalList(); } return attachmentsInformation; } /** *

* Details about the document attachments, including names, locations, sizes, and so on. *

* * @param attachmentsInformation * Details about the document attachments, including names, locations, sizes, and so on. */ public void setAttachmentsInformation(java.util.Collection attachmentsInformation) { if (attachmentsInformation == null) { this.attachmentsInformation = null; return; } this.attachmentsInformation = new com.amazonaws.internal.SdkInternalList(attachmentsInformation); } /** *

* Details about the document attachments, including names, locations, sizes, and so on. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setAttachmentsInformation(java.util.Collection)} or * {@link #withAttachmentsInformation(java.util.Collection)} if you want to override the existing values. *

* * @param attachmentsInformation * Details about the document attachments, including names, locations, sizes, and so on. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withAttachmentsInformation(AttachmentInformation... attachmentsInformation) { if (this.attachmentsInformation == null) { setAttachmentsInformation(new com.amazonaws.internal.SdkInternalList(attachmentsInformation.length)); } for (AttachmentInformation ele : attachmentsInformation) { this.attachmentsInformation.add(ele); } return this; } /** *

* Details about the document attachments, including names, locations, sizes, and so on. *

* * @param attachmentsInformation * Details about the document attachments, including names, locations, sizes, and so on. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withAttachmentsInformation(java.util.Collection attachmentsInformation) { setAttachmentsInformation(attachmentsInformation); return this; } /** *

* A list of SSM documents required by a document. For example, an ApplicationConfiguration document * requires an ApplicationConfigurationSchema document. *

* * @return A list of SSM documents required by a document. For example, an ApplicationConfiguration * document requires an ApplicationConfigurationSchema document. */ public java.util.List getRequires() { if (requires == null) { requires = new com.amazonaws.internal.SdkInternalList(); } return requires; } /** *

* A list of SSM documents required by a document. For example, an ApplicationConfiguration document * requires an ApplicationConfigurationSchema document. *

* * @param requires * A list of SSM documents required by a document. For example, an ApplicationConfiguration * document requires an ApplicationConfigurationSchema document. */ public void setRequires(java.util.Collection requires) { if (requires == null) { this.requires = null; return; } this.requires = new com.amazonaws.internal.SdkInternalList(requires); } /** *

* 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, an ApplicationConfiguration * document requires an ApplicationConfigurationSchema document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withRequires(DocumentRequires... requires) { if (this.requires == null) { setRequires(new com.amazonaws.internal.SdkInternalList(requires.length)); } for (DocumentRequires ele : requires) { this.requires.add(ele); } return this; } /** *

* A list of SSM documents required by a document. For example, an ApplicationConfiguration document * requires an ApplicationConfigurationSchema document. *

* * @param requires * A list of SSM documents required by a document. For example, an ApplicationConfiguration * document requires an ApplicationConfigurationSchema document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withRequires(java.util.Collection requires) { setRequires(requires); 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 DocumentDescription withAuthor(String author) { setAuthor(author); return this; } /** *

* Details about the review of a document. *

* * @return Details about the review of a document. */ public java.util.List getReviewInformation() { if (reviewInformation == null) { reviewInformation = new com.amazonaws.internal.SdkInternalList(); } return reviewInformation; } /** *

* Details about the review of a document. *

* * @param reviewInformation * Details about the review of a document. */ public void setReviewInformation(java.util.Collection reviewInformation) { if (reviewInformation == null) { this.reviewInformation = null; return; } this.reviewInformation = new com.amazonaws.internal.SdkInternalList(reviewInformation); } /** *

* Details about the review of a document. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setReviewInformation(java.util.Collection)} or {@link #withReviewInformation(java.util.Collection)} if * you want to override the existing values. *

* * @param reviewInformation * Details about the review of a document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withReviewInformation(ReviewInformation... reviewInformation) { if (this.reviewInformation == null) { setReviewInformation(new com.amazonaws.internal.SdkInternalList(reviewInformation.length)); } for (ReviewInformation ele : reviewInformation) { this.reviewInformation.add(ele); } return this; } /** *

* Details about the review of a document. *

* * @param reviewInformation * Details about the review of a document. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withReviewInformation(java.util.Collection reviewInformation) { setReviewInformation(reviewInformation); return this; } /** *

* The version of the document currently approved for use in the organization. *

* * @param approvedVersion * The version of the document currently approved for use in the organization. */ public void setApprovedVersion(String approvedVersion) { this.approvedVersion = approvedVersion; } /** *

* The version of the document currently approved for use in the organization. *

* * @return The version of the document currently approved for use in the organization. */ public String getApprovedVersion() { return this.approvedVersion; } /** *

* The version of the document currently approved for use in the organization. *

* * @param approvedVersion * The version of the document currently approved for use in the organization. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withApprovedVersion(String approvedVersion) { setApprovedVersion(approvedVersion); return this; } /** *

* The version of the document that is currently under review. *

* * @param pendingReviewVersion * The version of the document that is currently under review. */ public void setPendingReviewVersion(String pendingReviewVersion) { this.pendingReviewVersion = pendingReviewVersion; } /** *

* The version of the document that is currently under review. *

* * @return The version of the document that is currently under review. */ public String getPendingReviewVersion() { return this.pendingReviewVersion; } /** *

* The version of the document that is currently under review. *

* * @param pendingReviewVersion * The version of the document that is currently under review. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withPendingReviewVersion(String pendingReviewVersion) { setPendingReviewVersion(pendingReviewVersion); return this; } /** *

* The current status of the review. *

* * @param reviewStatus * The current status of the review. * @see ReviewStatus */ public void setReviewStatus(String reviewStatus) { this.reviewStatus = reviewStatus; } /** *

* The current status of the review. *

* * @return The current status of the review. * @see ReviewStatus */ public String getReviewStatus() { return this.reviewStatus; } /** *

* The current status of the review. *

* * @param reviewStatus * The current status of the review. * @return Returns a reference to this object so that method calls can be chained together. * @see ReviewStatus */ public DocumentDescription withReviewStatus(String reviewStatus) { setReviewStatus(reviewStatus); return this; } /** *

* The current status of the review. *

* * @param reviewStatus * The current status of the review. * @see ReviewStatus */ public void setReviewStatus(ReviewStatus reviewStatus) { withReviewStatus(reviewStatus); } /** *

* The current status of the review. *

* * @param reviewStatus * The current status of the review. * @return Returns a reference to this object so that method calls can be chained together. * @see ReviewStatus */ public DocumentDescription withReviewStatus(ReviewStatus reviewStatus) { this.reviewStatus = reviewStatus.toString(); return this; } /** *

* The classification of a document to help you identify and categorize its use. *

* * @return The classification of a document to help you identify and categorize its use. */ public java.util.List getCategory() { if (category == null) { category = new com.amazonaws.internal.SdkInternalList(); } return category; } /** *

* The classification of a document to help you identify and categorize its use. *

* * @param category * The classification of a document to help you identify and categorize its use. */ public void setCategory(java.util.Collection category) { if (category == null) { this.category = null; return; } this.category = new com.amazonaws.internal.SdkInternalList(category); } /** *

* The classification of a document to help you identify and categorize its use. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setCategory(java.util.Collection)} or {@link #withCategory(java.util.Collection)} if you want to override * the existing values. *

* * @param category * The classification of a document to help you identify and categorize its use. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withCategory(String... category) { if (this.category == null) { setCategory(new com.amazonaws.internal.SdkInternalList(category.length)); } for (String ele : category) { this.category.add(ele); } return this; } /** *

* The classification of a document to help you identify and categorize its use. *

* * @param category * The classification of a document to help you identify and categorize its use. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withCategory(java.util.Collection category) { setCategory(category); return this; } /** *

* The value that identifies a document's category. *

* * @return The value that identifies a document's category. */ public java.util.List getCategoryEnum() { if (categoryEnum == null) { categoryEnum = new com.amazonaws.internal.SdkInternalList(); } return categoryEnum; } /** *

* The value that identifies a document's category. *

* * @param categoryEnum * The value that identifies a document's category. */ public void setCategoryEnum(java.util.Collection categoryEnum) { if (categoryEnum == null) { this.categoryEnum = null; return; } this.categoryEnum = new com.amazonaws.internal.SdkInternalList(categoryEnum); } /** *

* The value that identifies a document's category. *

*

* NOTE: This method appends the values to the existing list (if any). Use * {@link #setCategoryEnum(java.util.Collection)} or {@link #withCategoryEnum(java.util.Collection)} if you want to * override the existing values. *

* * @param categoryEnum * The value that identifies a document's category. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withCategoryEnum(String... categoryEnum) { if (this.categoryEnum == null) { setCategoryEnum(new com.amazonaws.internal.SdkInternalList(categoryEnum.length)); } for (String ele : categoryEnum) { this.categoryEnum.add(ele); } return this; } /** *

* The value that identifies a document's category. *

* * @param categoryEnum * The value that identifies a document's category. * @return Returns a reference to this object so that method calls can be chained together. */ public DocumentDescription withCategoryEnum(java.util.Collection categoryEnum) { setCategoryEnum(categoryEnum); 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 (getSha1() != null) sb.append("Sha1: ").append(getSha1()).append(","); if (getHash() != null) sb.append("Hash: ").append(getHash()).append(","); if (getHashType() != null) sb.append("HashType: ").append(getHashType()).append(","); if (getName() != null) sb.append("Name: ").append(getName()).append(","); if (getDisplayName() != null) sb.append("DisplayName: ").append(getDisplayName()).append(","); if (getVersionName() != null) sb.append("VersionName: ").append(getVersionName()).append(","); if (getOwner() != null) sb.append("Owner: ").append(getOwner()).append(","); if (getCreatedDate() != null) sb.append("CreatedDate: ").append(getCreatedDate()).append(","); if (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getStatusInformation() != null) sb.append("StatusInformation: ").append(getStatusInformation()).append(","); if (getDocumentVersion() != null) sb.append("DocumentVersion: ").append(getDocumentVersion()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getParameters() != null) sb.append("Parameters: ").append(getParameters()).append(","); if (getPlatformTypes() != null) sb.append("PlatformTypes: ").append(getPlatformTypes()).append(","); if (getDocumentType() != null) sb.append("DocumentType: ").append(getDocumentType()).append(","); if (getSchemaVersion() != null) sb.append("SchemaVersion: ").append(getSchemaVersion()).append(","); if (getLatestVersion() != null) sb.append("LatestVersion: ").append(getLatestVersion()).append(","); if (getDefaultVersion() != null) sb.append("DefaultVersion: ").append(getDefaultVersion()).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 (getAttachmentsInformation() != null) sb.append("AttachmentsInformation: ").append(getAttachmentsInformation()).append(","); if (getRequires() != null) sb.append("Requires: ").append(getRequires()).append(","); if (getAuthor() != null) sb.append("Author: ").append(getAuthor()).append(","); if (getReviewInformation() != null) sb.append("ReviewInformation: ").append(getReviewInformation()).append(","); if (getApprovedVersion() != null) sb.append("ApprovedVersion: ").append(getApprovedVersion()).append(","); if (getPendingReviewVersion() != null) sb.append("PendingReviewVersion: ").append(getPendingReviewVersion()).append(","); if (getReviewStatus() != null) sb.append("ReviewStatus: ").append(getReviewStatus()).append(","); if (getCategory() != null) sb.append("Category: ").append(getCategory()).append(","); if (getCategoryEnum() != null) sb.append("CategoryEnum: ").append(getCategoryEnum()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof DocumentDescription == false) return false; DocumentDescription other = (DocumentDescription) obj; if (other.getSha1() == null ^ this.getSha1() == null) return false; if (other.getSha1() != null && other.getSha1().equals(this.getSha1()) == false) return false; if (other.getHash() == null ^ this.getHash() == null) return false; if (other.getHash() != null && other.getHash().equals(this.getHash()) == false) return false; if (other.getHashType() == null ^ this.getHashType() == null) return false; if (other.getHashType() != null && other.getHashType().equals(this.getHashType()) == false) return false; 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.getVersionName() == null ^ this.getVersionName() == null) return false; if (other.getVersionName() != null && other.getVersionName().equals(this.getVersionName()) == 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.getCreatedDate() == null ^ this.getCreatedDate() == null) return false; if (other.getCreatedDate() != null && other.getCreatedDate().equals(this.getCreatedDate()) == 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.getDocumentVersion() == null ^ this.getDocumentVersion() == null) return false; if (other.getDocumentVersion() != null && other.getDocumentVersion().equals(this.getDocumentVersion()) == false) return false; if (other.getDescription() == null ^ this.getDescription() == null) return false; if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false) return false; if (other.getParameters() == null ^ this.getParameters() == null) return false; if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == 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.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.getLatestVersion() == null ^ this.getLatestVersion() == null) return false; if (other.getLatestVersion() != null && other.getLatestVersion().equals(this.getLatestVersion()) == false) return false; if (other.getDefaultVersion() == null ^ this.getDefaultVersion() == null) return false; if (other.getDefaultVersion() != null && other.getDefaultVersion().equals(this.getDefaultVersion()) == 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.getAttachmentsInformation() == null ^ this.getAttachmentsInformation() == null) return false; if (other.getAttachmentsInformation() != null && other.getAttachmentsInformation().equals(this.getAttachmentsInformation()) == 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.getAuthor() == null ^ this.getAuthor() == null) return false; if (other.getAuthor() != null && other.getAuthor().equals(this.getAuthor()) == false) return false; if (other.getReviewInformation() == null ^ this.getReviewInformation() == null) return false; if (other.getReviewInformation() != null && other.getReviewInformation().equals(this.getReviewInformation()) == false) return false; if (other.getApprovedVersion() == null ^ this.getApprovedVersion() == null) return false; if (other.getApprovedVersion() != null && other.getApprovedVersion().equals(this.getApprovedVersion()) == false) return false; if (other.getPendingReviewVersion() == null ^ this.getPendingReviewVersion() == null) return false; if (other.getPendingReviewVersion() != null && other.getPendingReviewVersion().equals(this.getPendingReviewVersion()) == 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.getCategory() == null ^ this.getCategory() == null) return false; if (other.getCategory() != null && other.getCategory().equals(this.getCategory()) == false) return false; if (other.getCategoryEnum() == null ^ this.getCategoryEnum() == null) return false; if (other.getCategoryEnum() != null && other.getCategoryEnum().equals(this.getCategoryEnum()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getSha1() == null) ? 0 : getSha1().hashCode()); hashCode = prime * hashCode + ((getHash() == null) ? 0 : getHash().hashCode()); hashCode = prime * hashCode + ((getHashType() == null) ? 0 : getHashType().hashCode()); hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode()); hashCode = prime * hashCode + ((getDisplayName() == null) ? 0 : getDisplayName().hashCode()); hashCode = prime * hashCode + ((getVersionName() == null) ? 0 : getVersionName().hashCode()); hashCode = prime * hashCode + ((getOwner() == null) ? 0 : getOwner().hashCode()); hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode()); hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getStatusInformation() == null) ? 0 : getStatusInformation().hashCode()); hashCode = prime * hashCode + ((getDocumentVersion() == null) ? 0 : getDocumentVersion().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode()); hashCode = prime * hashCode + ((getPlatformTypes() == null) ? 0 : getPlatformTypes().hashCode()); hashCode = prime * hashCode + ((getDocumentType() == null) ? 0 : getDocumentType().hashCode()); hashCode = prime * hashCode + ((getSchemaVersion() == null) ? 0 : getSchemaVersion().hashCode()); hashCode = prime * hashCode + ((getLatestVersion() == null) ? 0 : getLatestVersion().hashCode()); hashCode = prime * hashCode + ((getDefaultVersion() == null) ? 0 : getDefaultVersion().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 + ((getAttachmentsInformation() == null) ? 0 : getAttachmentsInformation().hashCode()); hashCode = prime * hashCode + ((getRequires() == null) ? 0 : getRequires().hashCode()); hashCode = prime * hashCode + ((getAuthor() == null) ? 0 : getAuthor().hashCode()); hashCode = prime * hashCode + ((getReviewInformation() == null) ? 0 : getReviewInformation().hashCode()); hashCode = prime * hashCode + ((getApprovedVersion() == null) ? 0 : getApprovedVersion().hashCode()); hashCode = prime * hashCode + ((getPendingReviewVersion() == null) ? 0 : getPendingReviewVersion().hashCode()); hashCode = prime * hashCode + ((getReviewStatus() == null) ? 0 : getReviewStatus().hashCode()); hashCode = prime * hashCode + ((getCategory() == null) ? 0 : getCategory().hashCode()); hashCode = prime * hashCode + ((getCategoryEnum() == null) ? 0 : getCategoryEnum().hashCode()); return hashCode; } @Override public DocumentDescription clone() { try { return (DocumentDescription) 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.DocumentDescriptionMarshaller.getInstance().marshall(this, protocolMarshaller); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy