com.amazonaws.services.ec2.model.RunScheduledInstancesRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* 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.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.RunScheduledInstancesRequestMarshaller;
/**
*
* Contains the parameters for RunScheduledInstances.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class RunScheduledInstancesRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
* Idempotency.
*
*/
private String clientToken;
/**
*
* The number of instances.
*
*
* Default: 1
*
*/
private Integer instanceCount;
/**
*
* The launch specification. You must match the instance type, Availability Zone, network, and platform of the
* schedule that you purchased.
*
*/
private ScheduledInstancesLaunchSpecification launchSpecification;
/**
*
* The Scheduled Instance ID.
*
*/
private String scheduledInstanceId;
/**
*
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see
* Ensuring
* Idempotency.
*/
public void setClientToken(String clientToken) {
this.clientToken = clientToken;
}
/**
*
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
* Idempotency.
*
*
* @return Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see
* Ensuring
* Idempotency.
*/
public String getClientToken() {
return this.clientToken;
}
/**
*
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see Ensuring
* Idempotency.
*
*
* @param clientToken
* Unique, case-sensitive identifier that ensures the idempotency of the request. For more information, see
* Ensuring
* Idempotency.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RunScheduledInstancesRequest withClientToken(String clientToken) {
setClientToken(clientToken);
return this;
}
/**
*
* The number of instances.
*
*
* Default: 1
*
*
* @param instanceCount
* The number of instances.
*
* Default: 1
*/
public void setInstanceCount(Integer instanceCount) {
this.instanceCount = instanceCount;
}
/**
*
* The number of instances.
*
*
* Default: 1
*
*
* @return The number of instances.
*
* Default: 1
*/
public Integer getInstanceCount() {
return this.instanceCount;
}
/**
*
* The number of instances.
*
*
* Default: 1
*
*
* @param instanceCount
* The number of instances.
*
* Default: 1
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RunScheduledInstancesRequest withInstanceCount(Integer instanceCount) {
setInstanceCount(instanceCount);
return this;
}
/**
*
* The launch specification. You must match the instance type, Availability Zone, network, and platform of the
* schedule that you purchased.
*
*
* @param launchSpecification
* The launch specification. You must match the instance type, Availability Zone, network, and platform of
* the schedule that you purchased.
*/
public void setLaunchSpecification(ScheduledInstancesLaunchSpecification launchSpecification) {
this.launchSpecification = launchSpecification;
}
/**
*
* The launch specification. You must match the instance type, Availability Zone, network, and platform of the
* schedule that you purchased.
*
*
* @return The launch specification. You must match the instance type, Availability Zone, network, and platform of
* the schedule that you purchased.
*/
public ScheduledInstancesLaunchSpecification getLaunchSpecification() {
return this.launchSpecification;
}
/**
*
* The launch specification. You must match the instance type, Availability Zone, network, and platform of the
* schedule that you purchased.
*
*
* @param launchSpecification
* The launch specification. You must match the instance type, Availability Zone, network, and platform of
* the schedule that you purchased.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RunScheduledInstancesRequest withLaunchSpecification(ScheduledInstancesLaunchSpecification launchSpecification) {
setLaunchSpecification(launchSpecification);
return this;
}
/**
*
* The Scheduled Instance ID.
*
*
* @param scheduledInstanceId
* The Scheduled Instance ID.
*/
public void setScheduledInstanceId(String scheduledInstanceId) {
this.scheduledInstanceId = scheduledInstanceId;
}
/**
*
* The Scheduled Instance ID.
*
*
* @return The Scheduled Instance ID.
*/
public String getScheduledInstanceId() {
return this.scheduledInstanceId;
}
/**
*
* The Scheduled Instance ID.
*
*
* @param scheduledInstanceId
* The Scheduled Instance ID.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public RunScheduledInstancesRequest withScheduledInstanceId(String scheduledInstanceId) {
setScheduledInstanceId(scheduledInstanceId);
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 getDryRunRequest() {
Request request = new RunScheduledInstancesRequestMarshaller().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 (getClientToken() != null)
sb.append("ClientToken: ").append(getClientToken()).append(",");
if (getInstanceCount() != null)
sb.append("InstanceCount: ").append(getInstanceCount()).append(",");
if (getLaunchSpecification() != null)
sb.append("LaunchSpecification: ").append("***Sensitive Data Redacted***").append(",");
if (getScheduledInstanceId() != null)
sb.append("ScheduledInstanceId: ").append(getScheduledInstanceId());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof RunScheduledInstancesRequest == false)
return false;
RunScheduledInstancesRequest other = (RunScheduledInstancesRequest) obj;
if (other.getClientToken() == null ^ this.getClientToken() == null)
return false;
if (other.getClientToken() != null && other.getClientToken().equals(this.getClientToken()) == false)
return false;
if (other.getInstanceCount() == null ^ this.getInstanceCount() == null)
return false;
if (other.getInstanceCount() != null && other.getInstanceCount().equals(this.getInstanceCount()) == false)
return false;
if (other.getLaunchSpecification() == null ^ this.getLaunchSpecification() == null)
return false;
if (other.getLaunchSpecification() != null && other.getLaunchSpecification().equals(this.getLaunchSpecification()) == false)
return false;
if (other.getScheduledInstanceId() == null ^ this.getScheduledInstanceId() == null)
return false;
if (other.getScheduledInstanceId() != null && other.getScheduledInstanceId().equals(this.getScheduledInstanceId()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientToken() == null) ? 0 : getClientToken().hashCode());
hashCode = prime * hashCode + ((getInstanceCount() == null) ? 0 : getInstanceCount().hashCode());
hashCode = prime * hashCode + ((getLaunchSpecification() == null) ? 0 : getLaunchSpecification().hashCode());
hashCode = prime * hashCode + ((getScheduledInstanceId() == null) ? 0 : getScheduledInstanceId().hashCode());
return hashCode;
}
@Override
public RunScheduledInstancesRequest clone() {
return (RunScheduledInstancesRequest) super.clone();
}
}