com.amazonaws.services.simplesystemsmanagement.model.UpdateDocumentRequest Maven / Gradle / Ivy
/*
* 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.AmazonWebServiceRequest;
/**
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class UpdateDocumentRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* A valid JSON or YAML string.
*
*/
private String content;
/**
*
* A list of key-value pairs that describe attachments to a version of a document.
*
*/
private com.amazonaws.internal.SdkInternalList attachments;
/**
*
* The name of the SSM document that you want to update.
*
*/
private String name;
/**
*
* The friendly name of the SSM document that you want to update. This value can differ for each version of the
* document. If you don't specify a value for this parameter in your request, the existing value is applied to the
* new document version.
*
*/
private String displayName;
/**
*
* An optional field specifying the version of the artifact you are updating with the document. For example, 12.6.
* This value is unique across all versions of a document, and can't be changed.
*
*/
private String versionName;
/**
*
* The version of the document that you want to update. Currently, Systems Manager supports updating only the latest
* version of the document. You can specify the version number of the latest version or use the $LATEST
* variable.
*
*
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*
*/
private String documentVersion;
/**
*
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON
* is the default format.
*
*/
private String documentFormat;
/**
*
* Specify a new target type for the document.
*
*/
private String targetType;
/**
*
* A valid JSON or YAML string.
*
*
* @param content
* A valid JSON or YAML string.
*/
public void setContent(String content) {
this.content = content;
}
/**
*
* A valid JSON or YAML string.
*
*
* @return A valid JSON or YAML string.
*/
public String getContent() {
return this.content;
}
/**
*
* A valid JSON or YAML string.
*
*
* @param content
* A valid JSON or YAML string.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withContent(String content) {
setContent(content);
return this;
}
/**
*
* A list of key-value pairs that describe attachments to a version of a document.
*
*
* @return A list of key-value pairs that describe attachments to a version of a document.
*/
public java.util.List getAttachments() {
if (attachments == null) {
attachments = new com.amazonaws.internal.SdkInternalList();
}
return attachments;
}
/**
*
* A list of key-value pairs that describe attachments to a version of a document.
*
*
* @param attachments
* A list of key-value pairs that describe attachments to a version of a document.
*/
public void setAttachments(java.util.Collection attachments) {
if (attachments == null) {
this.attachments = null;
return;
}
this.attachments = new com.amazonaws.internal.SdkInternalList(attachments);
}
/**
*
* A list of key-value pairs that describe attachments to a version of a document.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setAttachments(java.util.Collection)} or {@link #withAttachments(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param attachments
* A list of key-value pairs that describe attachments to a version of a document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withAttachments(AttachmentsSource... attachments) {
if (this.attachments == null) {
setAttachments(new com.amazonaws.internal.SdkInternalList(attachments.length));
}
for (AttachmentsSource ele : attachments) {
this.attachments.add(ele);
}
return this;
}
/**
*
* A list of key-value pairs that describe attachments to a version of a document.
*
*
* @param attachments
* A list of key-value pairs that describe attachments to a version of a document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withAttachments(java.util.Collection attachments) {
setAttachments(attachments);
return this;
}
/**
*
* The name of the SSM document that you want to update.
*
*
* @param name
* The name of the SSM document that you want to update.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the SSM document that you want to update.
*
*
* @return The name of the SSM document that you want to update.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the SSM document that you want to update.
*
*
* @param name
* The name of the SSM document that you want to update.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withName(String name) {
setName(name);
return this;
}
/**
*
* The friendly name of the SSM document that you want to update. This value can differ for each version of the
* document. If you don't specify a value for this parameter in your request, the existing value is applied to the
* new document version.
*
*
* @param displayName
* The friendly name of the SSM document that you want to update. This value can differ for each version of
* the document. If you don't specify a value for this parameter in your request, the existing value is
* applied to the new document version.
*/
public void setDisplayName(String displayName) {
this.displayName = displayName;
}
/**
*
* The friendly name of the SSM document that you want to update. This value can differ for each version of the
* document. If you don't specify a value for this parameter in your request, the existing value is applied to the
* new document version.
*
*
* @return The friendly name of the SSM document that you want to update. This value can differ for each version of
* the document. If you don't specify a value for this parameter in your request, the existing value is
* applied to the new document version.
*/
public String getDisplayName() {
return this.displayName;
}
/**
*
* The friendly name of the SSM document that you want to update. This value can differ for each version of the
* document. If you don't specify a value for this parameter in your request, the existing value is applied to the
* new document version.
*
*
* @param displayName
* The friendly name of the SSM document that you want to update. This value can differ for each version of
* the document. If you don't specify a value for this parameter in your request, the existing value is
* applied to the new document version.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withDisplayName(String displayName) {
setDisplayName(displayName);
return this;
}
/**
*
* An optional field specifying the version of the artifact you are updating with the document. For example, 12.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 you are updating with the document. For example,
* 12.6. This value is unique across all versions of a document, and can't be changed.
*/
public void setVersionName(String versionName) {
this.versionName = versionName;
}
/**
*
* An optional field specifying the version of the artifact you are updating with the document. For example, 12.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 you are updating with the document. For example,
* 12.6. This value is unique across all versions of a document, and can't be changed.
*/
public String getVersionName() {
return this.versionName;
}
/**
*
* An optional field specifying the version of the artifact you are updating with the document. For example, 12.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 you are updating with the document. For example,
* 12.6. This value is unique across all versions of a document, and can't be changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withVersionName(String versionName) {
setVersionName(versionName);
return this;
}
/**
*
* The version of the document that you want to update. Currently, Systems Manager supports updating only the latest
* version of the document. You can specify the version number of the latest version or use the $LATEST
* variable.
*
*
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*
*
* @param documentVersion
* The version of the document that you want to update. Currently, Systems Manager supports updating only the
* latest version of the document. You can specify the version number of the latest version or use the
* $LATEST variable.
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*/
public void setDocumentVersion(String documentVersion) {
this.documentVersion = documentVersion;
}
/**
*
* The version of the document that you want to update. Currently, Systems Manager supports updating only the latest
* version of the document. You can specify the version number of the latest version or use the $LATEST
* variable.
*
*
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*
*
* @return The version of the document that you want to update. Currently, Systems Manager supports updating only
* the latest version of the document. You can specify the version number of the latest version or use the
* $LATEST variable.
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*/
public String getDocumentVersion() {
return this.documentVersion;
}
/**
*
* The version of the document that you want to update. Currently, Systems Manager supports updating only the latest
* version of the document. You can specify the version number of the latest version or use the $LATEST
* variable.
*
*
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
*
*
* @param documentVersion
* The version of the document that you want to update. Currently, Systems Manager supports updating only the
* latest version of the document. You can specify the version number of the latest version or use the
* $LATEST variable.
*
* If you change a document version for a State Manager association, Systems Manager immediately runs the
* association unless you previously specifed the apply-only-at-cron-interval parameter.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withDocumentVersion(String documentVersion) {
setDocumentVersion(documentVersion);
return this;
}
/**
*
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON
* is the default format.
*
*
* @param documentFormat
* Specify the document format for the new document version. Systems Manager supports JSON and YAML
* documents. JSON is the default format.
* @see DocumentFormat
*/
public void setDocumentFormat(String documentFormat) {
this.documentFormat = documentFormat;
}
/**
*
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON
* is the default format.
*
*
* @return Specify the document format for the new document version. Systems Manager supports JSON and YAML
* documents. JSON is the default format.
* @see DocumentFormat
*/
public String getDocumentFormat() {
return this.documentFormat;
}
/**
*
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON
* is the default format.
*
*
* @param documentFormat
* Specify the document format for the new document version. Systems Manager supports JSON and YAML
* documents. JSON is the default format.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentFormat
*/
public UpdateDocumentRequest withDocumentFormat(String documentFormat) {
setDocumentFormat(documentFormat);
return this;
}
/**
*
* Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON
* is the default format.
*
*
* @param documentFormat
* Specify the document format for the new document version. Systems Manager supports JSON and YAML
* documents. JSON is the default format.
* @return Returns a reference to this object so that method calls can be chained together.
* @see DocumentFormat
*/
public UpdateDocumentRequest withDocumentFormat(DocumentFormat documentFormat) {
this.documentFormat = documentFormat.toString();
return this;
}
/**
*
* Specify a new target type for the document.
*
*
* @param targetType
* Specify a new target type for the document.
*/
public void setTargetType(String targetType) {
this.targetType = targetType;
}
/**
*
* Specify a new target type for the document.
*
*
* @return Specify a new target type for the document.
*/
public String getTargetType() {
return this.targetType;
}
/**
*
* Specify a new target type for the document.
*
*
* @param targetType
* Specify a new target type for the document.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public UpdateDocumentRequest withTargetType(String targetType) {
setTargetType(targetType);
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 (getContent() != null)
sb.append("Content: ").append(getContent()).append(",");
if (getAttachments() != null)
sb.append("Attachments: ").append(getAttachments()).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 (getDocumentVersion() != null)
sb.append("DocumentVersion: ").append(getDocumentVersion()).append(",");
if (getDocumentFormat() != null)
sb.append("DocumentFormat: ").append(getDocumentFormat()).append(",");
if (getTargetType() != null)
sb.append("TargetType: ").append(getTargetType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof UpdateDocumentRequest == false)
return false;
UpdateDocumentRequest other = (UpdateDocumentRequest) obj;
if (other.getContent() == null ^ this.getContent() == null)
return false;
if (other.getContent() != null && other.getContent().equals(this.getContent()) == false)
return false;
if (other.getAttachments() == null ^ this.getAttachments() == null)
return false;
if (other.getAttachments() != null && other.getAttachments().equals(this.getAttachments()) == 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.getDocumentVersion() == null ^ this.getDocumentVersion() == null)
return false;
if (other.getDocumentVersion() != null && other.getDocumentVersion().equals(this.getDocumentVersion()) == 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;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getContent() == null) ? 0 : getContent().hashCode());
hashCode = prime * hashCode + ((getAttachments() == null) ? 0 : getAttachments().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 + ((getDocumentVersion() == null) ? 0 : getDocumentVersion().hashCode());
hashCode = prime * hashCode + ((getDocumentFormat() == null) ? 0 : getDocumentFormat().hashCode());
hashCode = prime * hashCode + ((getTargetType() == null) ? 0 : getTargetType().hashCode());
return hashCode;
}
@Override
public UpdateDocumentRequest clone() {
return (UpdateDocumentRequest) super.clone();
}
}