com.amazonaws.services.ec2.model.StopInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.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.StopInstancesRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class StopInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest {
/**
*
* The IDs of the instances.
*
*/
private com.amazonaws.internal.SdkInternalList instanceIds;
/**
*
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
* successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the
* Amazon EC2 User Guide.
*
*
* Default: false
*
*/
private Boolean hibernate;
/**
*
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system
* metadata. If you use this option, you must perform file system check and repair procedures. This option is not
* recommended for Windows instances.
*
*
* Default: false
*
*/
private Boolean force;
/**
* Default constructor for StopInstancesRequest object. Callers should use the setter or fluent setter (with...)
* methods to initialize the object after creating it.
*/
public StopInstancesRequest() {
}
/**
* Constructs a new StopInstancesRequest object. Callers should use the setter or fluent setter (with...) methods to
* initialize any additional object members.
*
* @param instanceIds
* The IDs of the instances.
*/
public StopInstancesRequest(java.util.List instanceIds) {
setInstanceIds(instanceIds);
}
/**
*
* The IDs of the instances.
*
*
* @return The IDs of the instances.
*/
public java.util.List getInstanceIds() {
if (instanceIds == null) {
instanceIds = new com.amazonaws.internal.SdkInternalList();
}
return instanceIds;
}
/**
*
* The IDs of the instances.
*
*
* @param instanceIds
* The IDs of the instances.
*/
public void setInstanceIds(java.util.Collection instanceIds) {
if (instanceIds == null) {
this.instanceIds = null;
return;
}
this.instanceIds = new com.amazonaws.internal.SdkInternalList(instanceIds);
}
/**
*
* The IDs of the instances.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInstanceIds(java.util.Collection)} or {@link #withInstanceIds(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param instanceIds
* The IDs of the instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StopInstancesRequest withInstanceIds(String... instanceIds) {
if (this.instanceIds == null) {
setInstanceIds(new com.amazonaws.internal.SdkInternalList(instanceIds.length));
}
for (String ele : instanceIds) {
this.instanceIds.add(ele);
}
return this;
}
/**
*
* The IDs of the instances.
*
*
* @param instanceIds
* The IDs of the instances.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StopInstancesRequest withInstanceIds(java.util.Collection instanceIds) {
setInstanceIds(instanceIds);
return this;
}
/**
*
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
* successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the
* Amazon EC2 User Guide.
*
*
* Default: false
*
*
* @param hibernate
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot
* hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in
* the Amazon EC2 User Guide.
*
* Default: false
*/
public void setHibernate(Boolean hibernate) {
this.hibernate = hibernate;
}
/**
*
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
* successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the
* Amazon EC2 User Guide.
*
*
* Default: false
*
*
* @return Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot
* hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in
* the Amazon EC2 User Guide.
*
* Default: false
*/
public Boolean getHibernate() {
return this.hibernate;
}
/**
*
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
* successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the
* Amazon EC2 User Guide.
*
*
* Default: false
*
*
* @param hibernate
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot
* hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in
* the Amazon EC2 User Guide.
*
* Default: false
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StopInstancesRequest withHibernate(Boolean hibernate) {
setHibernate(hibernate);
return this;
}
/**
*
* Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot hibernate
* successfully, a normal shutdown occurs. For more information, see Hibernate your instance in the
* Amazon EC2 User Guide.
*
*
* Default: false
*
*
* @return Hibernates the instance if the instance was enabled for hibernation at launch. If the instance cannot
* hibernate successfully, a normal shutdown occurs. For more information, see Hibernate your instance in
* the Amazon EC2 User Guide.
*
* Default: false
*/
public Boolean isHibernate() {
return this.hibernate;
}
/**
*
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system
* metadata. If you use this option, you must perform file system check and repair procedures. This option is not
* recommended for Windows instances.
*
*
* Default: false
*
*
* @param force
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file
* system metadata. If you use this option, you must perform file system check and repair procedures. This
* option is not recommended for Windows instances.
*
* Default: false
*/
public void setForce(Boolean force) {
this.force = force;
}
/**
*
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system
* metadata. If you use this option, you must perform file system check and repair procedures. This option is not
* recommended for Windows instances.
*
*
* Default: false
*
*
* @return Forces the instances to stop. The instances do not have an opportunity to flush file system caches or
* file system metadata. If you use this option, you must perform file system check and repair procedures.
* This option is not recommended for Windows instances.
*
* Default: false
*/
public Boolean getForce() {
return this.force;
}
/**
*
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system
* metadata. If you use this option, you must perform file system check and repair procedures. This option is not
* recommended for Windows instances.
*
*
* Default: false
*
*
* @param force
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file
* system metadata. If you use this option, you must perform file system check and repair procedures. This
* option is not recommended for Windows instances.
*
* Default: false
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StopInstancesRequest withForce(Boolean force) {
setForce(force);
return this;
}
/**
*
* Forces the instances to stop. The instances do not have an opportunity to flush file system caches or file system
* metadata. If you use this option, you must perform file system check and repair procedures. This option is not
* recommended for Windows instances.
*
*
* Default: false
*
*
* @return Forces the instances to stop. The instances do not have an opportunity to flush file system caches or
* file system metadata. If you use this option, you must perform file system check and repair procedures.
* This option is not recommended for Windows instances.
*
* Default: false
*/
public Boolean isForce() {
return this.force;
}
/**
* This method is intended for internal use only. Returns the marshaled request configured with additional
* parameters to enable operation dry-run.
*/
@Override
public Request getDryRunRequest() {
Request request = new StopInstancesRequestMarshaller().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 (getInstanceIds() != null)
sb.append("InstanceIds: ").append(getInstanceIds()).append(",");
if (getHibernate() != null)
sb.append("Hibernate: ").append(getHibernate()).append(",");
if (getForce() != null)
sb.append("Force: ").append(getForce());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof StopInstancesRequest == false)
return false;
StopInstancesRequest other = (StopInstancesRequest) obj;
if (other.getInstanceIds() == null ^ this.getInstanceIds() == null)
return false;
if (other.getInstanceIds() != null && other.getInstanceIds().equals(this.getInstanceIds()) == false)
return false;
if (other.getHibernate() == null ^ this.getHibernate() == null)
return false;
if (other.getHibernate() != null && other.getHibernate().equals(this.getHibernate()) == false)
return false;
if (other.getForce() == null ^ this.getForce() == null)
return false;
if (other.getForce() != null && other.getForce().equals(this.getForce()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceIds() == null) ? 0 : getInstanceIds().hashCode());
hashCode = prime * hashCode + ((getHibernate() == null) ? 0 : getHibernate().hashCode());
hashCode = prime * hashCode + ((getForce() == null) ? 0 : getForce().hashCode());
return hashCode;
}
@Override
public StopInstancesRequest clone() {
return (StopInstancesRequest) super.clone();
}
}