com.amazonaws.services.ec2.model.ModifySpotFleetRequestRequest 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.ModifySpotFleetRequestRequestMarshaller;
/**
*
* Contains the parameters for ModifySpotFleetRequest.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModifySpotFleetRequestRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*/
private String excessCapacityTerminationPolicy;
/**
*
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*
*/
private com.amazonaws.internal.SdkInternalList launchTemplateConfigs;
/**
*
* The ID of the Spot Fleet request.
*
*/
private String spotFleetRequestId;
/**
*
* The size of the fleet.
*
*/
private Integer targetCapacity;
/**
*
* The number of On-Demand Instances in the fleet.
*
*/
private Integer onDemandTargetCapacity;
/**
*
* Reserved.
*
*/
private String context;
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*
* @param excessCapacityTerminationPolicy
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request
* is decreased below the current size of the Spot Fleet.
*
* Supported only for fleets of type maintain.
* @see ExcessCapacityTerminationPolicy
*/
public void setExcessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) {
this.excessCapacityTerminationPolicy = excessCapacityTerminationPolicy;
}
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*
* @return Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request
* is decreased below the current size of the Spot Fleet.
*
* Supported only for fleets of type maintain.
* @see ExcessCapacityTerminationPolicy
*/
public String getExcessCapacityTerminationPolicy() {
return this.excessCapacityTerminationPolicy;
}
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*
* @param excessCapacityTerminationPolicy
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request
* is decreased below the current size of the Spot Fleet.
*
* Supported only for fleets of type maintain.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExcessCapacityTerminationPolicy
*/
public ModifySpotFleetRequestRequest withExcessCapacityTerminationPolicy(String excessCapacityTerminationPolicy) {
setExcessCapacityTerminationPolicy(excessCapacityTerminationPolicy);
return this;
}
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*
* @param excessCapacityTerminationPolicy
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request
* is decreased below the current size of the Spot Fleet.
*
* Supported only for fleets of type maintain.
* @see ExcessCapacityTerminationPolicy
*/
public void setExcessCapacityTerminationPolicy(ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy) {
withExcessCapacityTerminationPolicy(excessCapacityTerminationPolicy);
}
/**
*
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request is
* decreased below the current size of the Spot Fleet.
*
*
* Supported only for fleets of type maintain.
*
*
* @param excessCapacityTerminationPolicy
* Indicates whether running instances should be terminated if the target capacity of the Spot Fleet request
* is decreased below the current size of the Spot Fleet.
*
* Supported only for fleets of type maintain.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ExcessCapacityTerminationPolicy
*/
public ModifySpotFleetRequestRequest withExcessCapacityTerminationPolicy(ExcessCapacityTerminationPolicy excessCapacityTerminationPolicy) {
this.excessCapacityTerminationPolicy = excessCapacityTerminationPolicy.toString();
return this;
}
/**
*
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*
*
* @return The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*/
public java.util.List getLaunchTemplateConfigs() {
if (launchTemplateConfigs == null) {
launchTemplateConfigs = new com.amazonaws.internal.SdkInternalList();
}
return launchTemplateConfigs;
}
/**
*
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*
*
* @param launchTemplateConfigs
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*/
public void setLaunchTemplateConfigs(java.util.Collection launchTemplateConfigs) {
if (launchTemplateConfigs == null) {
this.launchTemplateConfigs = null;
return;
}
this.launchTemplateConfigs = new com.amazonaws.internal.SdkInternalList(launchTemplateConfigs);
}
/**
*
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setLaunchTemplateConfigs(java.util.Collection)} or
* {@link #withLaunchTemplateConfigs(java.util.Collection)} if you want to override the existing values.
*
*
* @param launchTemplateConfigs
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withLaunchTemplateConfigs(LaunchTemplateConfig... launchTemplateConfigs) {
if (this.launchTemplateConfigs == null) {
setLaunchTemplateConfigs(new com.amazonaws.internal.SdkInternalList(launchTemplateConfigs.length));
}
for (LaunchTemplateConfig ele : launchTemplateConfigs) {
this.launchTemplateConfigs.add(ele);
}
return this;
}
/**
*
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
*
*
* @param launchTemplateConfigs
* The launch template and overrides. You can only use this parameter if you specified a launch template (
* LaunchTemplateConfigs) in your Spot Fleet request. If you specified
* LaunchSpecifications in your Spot Fleet request, then omit this parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withLaunchTemplateConfigs(java.util.Collection launchTemplateConfigs) {
setLaunchTemplateConfigs(launchTemplateConfigs);
return this;
}
/**
*
* The ID of the Spot Fleet request.
*
*
* @param spotFleetRequestId
* The ID of the Spot Fleet request.
*/
public void setSpotFleetRequestId(String spotFleetRequestId) {
this.spotFleetRequestId = spotFleetRequestId;
}
/**
*
* The ID of the Spot Fleet request.
*
*
* @return The ID of the Spot Fleet request.
*/
public String getSpotFleetRequestId() {
return this.spotFleetRequestId;
}
/**
*
* The ID of the Spot Fleet request.
*
*
* @param spotFleetRequestId
* The ID of the Spot Fleet request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withSpotFleetRequestId(String spotFleetRequestId) {
setSpotFleetRequestId(spotFleetRequestId);
return this;
}
/**
*
* The size of the fleet.
*
*
* @param targetCapacity
* The size of the fleet.
*/
public void setTargetCapacity(Integer targetCapacity) {
this.targetCapacity = targetCapacity;
}
/**
*
* The size of the fleet.
*
*
* @return The size of the fleet.
*/
public Integer getTargetCapacity() {
return this.targetCapacity;
}
/**
*
* The size of the fleet.
*
*
* @param targetCapacity
* The size of the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withTargetCapacity(Integer targetCapacity) {
setTargetCapacity(targetCapacity);
return this;
}
/**
*
* The number of On-Demand Instances in the fleet.
*
*
* @param onDemandTargetCapacity
* The number of On-Demand Instances in the fleet.
*/
public void setOnDemandTargetCapacity(Integer onDemandTargetCapacity) {
this.onDemandTargetCapacity = onDemandTargetCapacity;
}
/**
*
* The number of On-Demand Instances in the fleet.
*
*
* @return The number of On-Demand Instances in the fleet.
*/
public Integer getOnDemandTargetCapacity() {
return this.onDemandTargetCapacity;
}
/**
*
* The number of On-Demand Instances in the fleet.
*
*
* @param onDemandTargetCapacity
* The number of On-Demand Instances in the fleet.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withOnDemandTargetCapacity(Integer onDemandTargetCapacity) {
setOnDemandTargetCapacity(onDemandTargetCapacity);
return this;
}
/**
*
* Reserved.
*
*
* @param context
* Reserved.
*/
public void setContext(String context) {
this.context = context;
}
/**
*
* Reserved.
*
*
* @return Reserved.
*/
public String getContext() {
return this.context;
}
/**
*
* Reserved.
*
*
* @param context
* Reserved.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ModifySpotFleetRequestRequest withContext(String context) {
setContext(context);
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 ModifySpotFleetRequestRequestMarshaller().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 (getExcessCapacityTerminationPolicy() != null)
sb.append("ExcessCapacityTerminationPolicy: ").append(getExcessCapacityTerminationPolicy()).append(",");
if (getLaunchTemplateConfigs() != null)
sb.append("LaunchTemplateConfigs: ").append(getLaunchTemplateConfigs()).append(",");
if (getSpotFleetRequestId() != null)
sb.append("SpotFleetRequestId: ").append(getSpotFleetRequestId()).append(",");
if (getTargetCapacity() != null)
sb.append("TargetCapacity: ").append(getTargetCapacity()).append(",");
if (getOnDemandTargetCapacity() != null)
sb.append("OnDemandTargetCapacity: ").append(getOnDemandTargetCapacity()).append(",");
if (getContext() != null)
sb.append("Context: ").append(getContext());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ModifySpotFleetRequestRequest == false)
return false;
ModifySpotFleetRequestRequest other = (ModifySpotFleetRequestRequest) obj;
if (other.getExcessCapacityTerminationPolicy() == null ^ this.getExcessCapacityTerminationPolicy() == null)
return false;
if (other.getExcessCapacityTerminationPolicy() != null
&& other.getExcessCapacityTerminationPolicy().equals(this.getExcessCapacityTerminationPolicy()) == false)
return false;
if (other.getLaunchTemplateConfigs() == null ^ this.getLaunchTemplateConfigs() == null)
return false;
if (other.getLaunchTemplateConfigs() != null && other.getLaunchTemplateConfigs().equals(this.getLaunchTemplateConfigs()) == false)
return false;
if (other.getSpotFleetRequestId() == null ^ this.getSpotFleetRequestId() == null)
return false;
if (other.getSpotFleetRequestId() != null && other.getSpotFleetRequestId().equals(this.getSpotFleetRequestId()) == false)
return false;
if (other.getTargetCapacity() == null ^ this.getTargetCapacity() == null)
return false;
if (other.getTargetCapacity() != null && other.getTargetCapacity().equals(this.getTargetCapacity()) == false)
return false;
if (other.getOnDemandTargetCapacity() == null ^ this.getOnDemandTargetCapacity() == null)
return false;
if (other.getOnDemandTargetCapacity() != null && other.getOnDemandTargetCapacity().equals(this.getOnDemandTargetCapacity()) == false)
return false;
if (other.getContext() == null ^ this.getContext() == null)
return false;
if (other.getContext() != null && other.getContext().equals(this.getContext()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getExcessCapacityTerminationPolicy() == null) ? 0 : getExcessCapacityTerminationPolicy().hashCode());
hashCode = prime * hashCode + ((getLaunchTemplateConfigs() == null) ? 0 : getLaunchTemplateConfigs().hashCode());
hashCode = prime * hashCode + ((getSpotFleetRequestId() == null) ? 0 : getSpotFleetRequestId().hashCode());
hashCode = prime * hashCode + ((getTargetCapacity() == null) ? 0 : getTargetCapacity().hashCode());
hashCode = prime * hashCode + ((getOnDemandTargetCapacity() == null) ? 0 : getOnDemandTargetCapacity().hashCode());
hashCode = prime * hashCode + ((getContext() == null) ? 0 : getContext().hashCode());
return hashCode;
}
@Override
public ModifySpotFleetRequestRequest clone() {
return (ModifySpotFleetRequestRequest) super.clone();
}
}