Java tutorial
/* * Copyright 2014-2019 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.ec2.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.ModifyImageAttributeRequestMarshaller; /** * <p> * Contains the parameters for ModifyImageAttribute. * </p> */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class ModifyImageAttributeRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<ModifyImageAttributeRequest> { /** * <p> * The name of the attribute to modify. The valid values are <code>description</code>, <code>launchPermission</code> * , and <code>productCodes</code>. * </p> */ private String attribute; /** * <p> * A new description for the AMI. * </p> */ private String description; /** * <p> * The ID of the AMI. * </p> */ private String imageId; /** * <p> * A new launch permission for the AMI. * </p> */ private LaunchPermissionModifications launchPermission; /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> */ private String operationType; /** * <p> * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * </p> */ private com.amazonaws.internal.SdkInternalList<String> productCodes; /** * <p> * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> */ private com.amazonaws.internal.SdkInternalList<String> userGroups; /** * <p> * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> */ private com.amazonaws.internal.SdkInternalList<String> userIds; /** * <p> * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. * </p> */ private String value; /** * Default constructor for ModifyImageAttributeRequest object. Callers should use the setter or fluent setter * (with...) methods to initialize the object after creating it. */ public ModifyImageAttributeRequest() { } /** * Constructs a new ModifyImageAttributeRequest object. Callers should use the setter or fluent setter (with...) * methods to initialize any additional object members. * * @param imageId * The ID of the AMI. * @param attribute * The name of the attribute to modify. The valid values are <code>description</code>, * <code>launchPermission</code>, and <code>productCodes</code>. */ public ModifyImageAttributeRequest(String imageId, String attribute) { setImageId(imageId); setAttribute(attribute); } /** * <p> * The name of the attribute to modify. The valid values are <code>description</code>, <code>launchPermission</code> * , and <code>productCodes</code>. * </p> * * @param attribute * The name of the attribute to modify. The valid values are <code>description</code>, * <code>launchPermission</code>, and <code>productCodes</code>. */ public void setAttribute(String attribute) { this.attribute = attribute; } /** * <p> * The name of the attribute to modify. The valid values are <code>description</code>, <code>launchPermission</code> * , and <code>productCodes</code>. * </p> * * @return The name of the attribute to modify. The valid values are <code>description</code>, * <code>launchPermission</code>, and <code>productCodes</code>. */ public String getAttribute() { return this.attribute; } /** * <p> * The name of the attribute to modify. The valid values are <code>description</code>, <code>launchPermission</code> * , and <code>productCodes</code>. * </p> * * @param attribute * The name of the attribute to modify. The valid values are <code>description</code>, * <code>launchPermission</code>, and <code>productCodes</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withAttribute(String attribute) { setAttribute(attribute); return this; } /** * <p> * A new description for the AMI. * </p> * * @param description * A new description for the AMI. */ public void setDescription(String description) { this.description = description; } /** * <p> * A new description for the AMI. * </p> * * @return A new description for the AMI. */ public String getDescription() { return this.description; } /** * <p> * A new description for the AMI. * </p> * * @param description * A new description for the AMI. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withDescription(String description) { setDescription(description); return this; } /** * <p> * The ID of the AMI. * </p> * * @param imageId * The ID of the AMI. */ public void setImageId(String imageId) { this.imageId = imageId; } /** * <p> * The ID of the AMI. * </p> * * @return The ID of the AMI. */ public String getImageId() { return this.imageId; } /** * <p> * The ID of the AMI. * </p> * * @param imageId * The ID of the AMI. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withImageId(String imageId) { setImageId(imageId); return this; } /** * <p> * A new launch permission for the AMI. * </p> * * @param launchPermission * A new launch permission for the AMI. */ public void setLaunchPermission(LaunchPermissionModifications launchPermission) { this.launchPermission = launchPermission; } /** * <p> * A new launch permission for the AMI. * </p> * * @return A new launch permission for the AMI. */ public LaunchPermissionModifications getLaunchPermission() { return this.launchPermission; } /** * <p> * A new launch permission for the AMI. * </p> * * @param launchPermission * A new launch permission for the AMI. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withLaunchPermission(LaunchPermissionModifications launchPermission) { setLaunchPermission(launchPermission); return this; } /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param operationType * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @see OperationType */ public void setOperationType(String operationType) { this.operationType = operationType; } /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @return The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @see OperationType */ public String getOperationType() { return this.operationType; } /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param operationType * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. * @see OperationType */ public ModifyImageAttributeRequest withOperationType(String operationType) { setOperationType(operationType); return this; } /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param operationType * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @see OperationType */ public void setOperationType(OperationType operationType) { withOperationType(operationType); } /** * <p> * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param operationType * The operation type. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. * @see OperationType */ public ModifyImageAttributeRequest withOperationType(OperationType operationType) { this.operationType = operationType.toString(); return this; } /** * <p> * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * </p> * * @return The DevPay product codes. After you add a product code to an AMI, it can't be removed. */ public java.util.List<String> getProductCodes() { if (productCodes == null) { productCodes = new com.amazonaws.internal.SdkInternalList<String>(); } return productCodes; } /** * <p> * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * </p> * * @param productCodes * The DevPay product codes. After you add a product code to an AMI, it can't be removed. */ public void setProductCodes(java.util.Collection<String> productCodes) { if (productCodes == null) { this.productCodes = null; return; } this.productCodes = new com.amazonaws.internal.SdkInternalList<String>(productCodes); } /** * <p> * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * </p> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setProductCodes(java.util.Collection)} or {@link #withProductCodes(java.util.Collection)} if you want to * override the existing values. * </p> * * @param productCodes * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withProductCodes(String... productCodes) { if (this.productCodes == null) { setProductCodes(new com.amazonaws.internal.SdkInternalList<String>(productCodes.length)); } for (String ele : productCodes) { this.productCodes.add(ele); } return this; } /** * <p> * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * </p> * * @param productCodes * The DevPay product codes. After you add a product code to an AMI, it can't be removed. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withProductCodes(java.util.Collection<String> productCodes) { setProductCodes(productCodes); return this; } /** * <p> * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @return The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. */ public java.util.List<String> getUserGroups() { if (userGroups == null) { userGroups = new com.amazonaws.internal.SdkInternalList<String>(); } return userGroups; } /** * <p> * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param userGroups * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. */ public void setUserGroups(java.util.Collection<String> userGroups) { if (userGroups == null) { this.userGroups = null; return; } this.userGroups = new com.amazonaws.internal.SdkInternalList<String>(userGroups); } /** * <p> * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setUserGroups(java.util.Collection)} or {@link #withUserGroups(java.util.Collection)} if you want to * override the existing values. * </p> * * @param userGroups * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withUserGroups(String... userGroups) { if (this.userGroups == null) { setUserGroups(new com.amazonaws.internal.SdkInternalList<String>(userGroups.length)); } for (String ele : userGroups) { this.userGroups.add(ele); } return this; } /** * <p> * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param userGroups * The user groups. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withUserGroups(java.util.Collection<String> userGroups) { setUserGroups(userGroups); return this; } /** * <p> * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @return The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. */ public java.util.List<String> getUserIds() { if (userIds == null) { userIds = new com.amazonaws.internal.SdkInternalList<String>(); } return userIds; } /** * <p> * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param userIds * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. */ public void setUserIds(java.util.Collection<String> userIds) { if (userIds == null) { this.userIds = null; return; } this.userIds = new com.amazonaws.internal.SdkInternalList<String>(userIds); } /** * <p> * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * <p> * <b>NOTE:</b> This method appends the values to the existing list (if any). Use * {@link #setUserIds(java.util.Collection)} or {@link #withUserIds(java.util.Collection)} if you want to override * the existing values. * </p> * * @param userIds * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withUserIds(String... userIds) { if (this.userIds == null) { setUserIds(new com.amazonaws.internal.SdkInternalList<String>(userIds.length)); } for (String ele : userIds) { this.userIds.add(ele); } return this; } /** * <p> * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * </p> * * @param userIds * The AWS account IDs. This parameter can be used only when the <code>Attribute</code> parameter is * <code>launchPermission</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withUserIds(java.util.Collection<String> userIds) { setUserIds(userIds); return this; } /** * <p> * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. * </p> * * @param value * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. */ public void setValue(String value) { this.value = value; } /** * <p> * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. * </p> * * @return The value of the attribute being modified. This parameter can be used only when the * <code>Attribute</code> parameter is <code>description</code> or <code>productCodes</code>. */ public String getValue() { return this.value; } /** * <p> * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. * </p> * * @param value * The value of the attribute being modified. This parameter can be used only when the <code>Attribute</code> * parameter is <code>description</code> or <code>productCodes</code>. * @return Returns a reference to this object so that method calls can be chained together. */ public ModifyImageAttributeRequest withValue(String value) { setValue(value); return this; } /** * This method is intended for internal use only. Returns the marshaled request configured with additional * parameters to enable operation dry-run. */ @Override public Request<ModifyImageAttributeRequest> getDryRunRequest() { Request<ModifyImageAttributeRequest> request = new ModifyImageAttributeRequestMarshaller().marshall(this); request.addParameter("DryRun", Boolean.toString(true)); return request; } /** * 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 (getAttribute() != null) sb.append("Attribute: ").append(getAttribute()).append(","); if (getDescription() != null) sb.append("Description: ").append(getDescription()).append(","); if (getImageId() != null) sb.append("ImageId: ").append(getImageId()).append(","); if (getLaunchPermission() != null) sb.append("LaunchPermission: ").append(getLaunchPermission()).append(","); if (getOperationType() != null) sb.append("OperationType: ").append(getOperationType()).append(","); if (getProductCodes() != null) sb.append("ProductCodes: ").append(getProductCodes()).append(","); if (getUserGroups() != null) sb.append("UserGroups: ").append(getUserGroups()).append(","); if (getUserIds() != null) sb.append("UserIds: ").append(getUserIds()).append(","); if (getValue() != null) sb.append("Value: ").append(getValue()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof ModifyImageAttributeRequest == false) return false; ModifyImageAttributeRequest other = (ModifyImageAttributeRequest) obj; if (other.getAttribute() == null ^ this.getAttribute() == null) return false; if (other.getAttribute() != null && other.getAttribute().equals(this.getAttribute()) == 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.getImageId() == null ^ this.getImageId() == null) return false; if (other.getImageId() != null && other.getImageId().equals(this.getImageId()) == false) return false; if (other.getLaunchPermission() == null ^ this.getLaunchPermission() == null) return false; if (other.getLaunchPermission() != null && other.getLaunchPermission().equals(this.getLaunchPermission()) == false) return false; if (other.getOperationType() == null ^ this.getOperationType() == null) return false; if (other.getOperationType() != null && other.getOperationType().equals(this.getOperationType()) == false) return false; if (other.getProductCodes() == null ^ this.getProductCodes() == null) return false; if (other.getProductCodes() != null && other.getProductCodes().equals(this.getProductCodes()) == false) return false; if (other.getUserGroups() == null ^ this.getUserGroups() == null) return false; if (other.getUserGroups() != null && other.getUserGroups().equals(this.getUserGroups()) == false) return false; if (other.getUserIds() == null ^ this.getUserIds() == null) return false; if (other.getUserIds() != null && other.getUserIds().equals(this.getUserIds()) == false) return false; if (other.getValue() == null ^ this.getValue() == null) return false; if (other.getValue() != null && other.getValue().equals(this.getValue()) == false) return false; return true; } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getAttribute() == null) ? 0 : getAttribute().hashCode()); hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode()); hashCode = prime * hashCode + ((getImageId() == null) ? 0 : getImageId().hashCode()); hashCode = prime * hashCode + ((getLaunchPermission() == null) ? 0 : getLaunchPermission().hashCode()); hashCode = prime * hashCode + ((getOperationType() == null) ? 0 : getOperationType().hashCode()); hashCode = prime * hashCode + ((getProductCodes() == null) ? 0 : getProductCodes().hashCode()); hashCode = prime * hashCode + ((getUserGroups() == null) ? 0 : getUserGroups().hashCode()); hashCode = prime * hashCode + ((getUserIds() == null) ? 0 : getUserIds().hashCode()); hashCode = prime * hashCode + ((getValue() == null) ? 0 : getValue().hashCode()); return hashCode; } @Override public ModifyImageAttributeRequest clone() { return (ModifyImageAttributeRequest) super.clone(); } }