com.amazonaws.services.simplesystemsmanagement.model.DocumentDescription Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssm Show documentation
/*
* Copyright 2011-2016 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;
/**
*
* Describes an SSM document.
*
*/
public class DocumentDescription implements Serializable, Cloneable {
/**
*
* The SHA1 hash of the document, which you can use for verification purposes.
*
*/
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;
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*/
private String hashType;
/**
*
* The name of the SSM document.
*
*/
private String name;
/**
*
* The AWS user account of the person who created the document.
*
*/
private String owner;
/**
*
* The date when the SSM document was created.
*
*/
private java.util.Date createdDate;
/**
*
* The status of the SSM document.
*
*/
private String status;
/**
*
* 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 OS platforms compatible with this SSM document.
*
*/
private com.amazonaws.internal.SdkInternalList platformTypes;
/**
*
* The SHA1 hash of the document, which you can use for verification purposes.
*
*
* @param sha1
* The SHA1 hash of the document, which you can use for verification purposes.
*/
public void setSha1(String sha1) {
this.sha1 = sha1;
}
/**
*
* The SHA1 hash of the document, which you can use for verification purposes.
*
*
* @return The SHA1 hash of the document, which you can use for verification purposes.
*/
public String getSha1() {
return this.sha1;
}
/**
*
* The SHA1 hash of the document, which you can use for verification purposes.
*
*
* @param sha1
* The SHA1 hash of the document, which you can use for verification purposes.
* @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;
}
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*
* @param hashType
* Sha256 or Sha1.
*
* Sha1 hashes have been deprecated.
*
* @see DocumentHashType
*/
public void setHashType(String hashType) {
this.hashType = hashType;
}
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*
* @return Sha256 or Sha1.
*
* Sha1 hashes have been deprecated.
*
* @see DocumentHashType
*/
public String getHashType() {
return this.hashType;
}
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*
* @param hashType
* 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;
}
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*
* @param hashType
* Sha256 or Sha1.
*
* Sha1 hashes have been deprecated.
*
* @see DocumentHashType
*/
public void setHashType(DocumentHashType hashType) {
this.hashType = hashType.toString();
}
/**
*
* Sha256 or Sha1.
*
*
*
* Sha1 hashes have been deprecated.
*
*
*
* @param hashType
* 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) {
setHashType(hashType);
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 AWS user account of the person who created the document.
*
*
* @param owner
* The AWS user account of the person who created the document.
*/
public void setOwner(String owner) {
this.owner = owner;
}
/**
*
* The AWS user account of the person who created the document.
*
*
* @return The AWS user account of the person who created the document.
*/
public String getOwner() {
return this.owner;
}
/**
*
* The AWS user account of the person who created the document.
*
*
* @param owner
* The AWS user account of the person who 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 SSM document was created.
*
*
* @param createdDate
* The date when the SSM document was created.
*/
public void setCreatedDate(java.util.Date createdDate) {
this.createdDate = createdDate;
}
/**
*
* The date when the SSM document was created.
*
*
* @return The date when the SSM document was created.
*/
public java.util.Date getCreatedDate() {
return this.createdDate;
}
/**
*
* The date when the SSM document was created.
*
*
* @param createdDate
* The date when the SSM 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) {
this.status = status.toString();
}
/**
*
* 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) {
setStatus(status);
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 OS platforms compatible with this SSM document.
*
*
* @return The list of 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 OS platforms compatible with this SSM document.
*
*
* @param platformTypes
* The list of 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 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 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 OS platforms compatible with this SSM document.
*
*
* @param platformTypes
* The list of 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 OS platforms compatible with this SSM document.
*
*
* @param platformTypes
* The list of 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;
}
/**
* Returns a string representation of this object; useful for testing and debugging.
*
* @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: " + getSha1() + ",");
if (getHash() != null)
sb.append("Hash: " + getHash() + ",");
if (getHashType() != null)
sb.append("HashType: " + getHashType() + ",");
if (getName() != null)
sb.append("Name: " + getName() + ",");
if (getOwner() != null)
sb.append("Owner: " + getOwner() + ",");
if (getCreatedDate() != null)
sb.append("CreatedDate: " + getCreatedDate() + ",");
if (getStatus() != null)
sb.append("Status: " + getStatus() + ",");
if (getDescription() != null)
sb.append("Description: " + getDescription() + ",");
if (getParameters() != null)
sb.append("Parameters: " + getParameters() + ",");
if (getPlatformTypes() != null)
sb.append("PlatformTypes: " + getPlatformTypes());
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.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.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;
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 + ((getOwner() == null) ? 0 : getOwner().hashCode());
hashCode = prime * hashCode + ((getCreatedDate() == null) ? 0 : getCreatedDate().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().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());
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);
}
}
}