com.amazonaws.services.ec2.model.GetSpotPlacementScoresRequest 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.GetSpotPlacementScoresRequestMarshaller;
/**
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetSpotPlacementScoresRequest extends AmazonWebServiceRequest implements Serializable, Cloneable,
DryRunSupportedRequest {
/**
*
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge with and
* without instance storage), the returned placement score will always be low.
*
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*
*/
private com.amazonaws.internal.SdkInternalList instanceTypes;
/**
*
* The target capacity.
*
*/
private Integer targetCapacity;
/**
*
* The unit for the target capacity.
*
*
* Default: units (translates to number of instances)
*
*/
private String targetCapacityUnitType;
/**
*
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single
* Availability Zone.
*
*/
private Boolean singleAvailabilityZone;
/**
*
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*
*/
private com.amazonaws.internal.SdkInternalList regionNames;
/**
*
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance
* types with those attributes.
*
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
*
*/
private InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata;
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*/
private Integer maxResults;
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*/
private String nextToken;
/**
*
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge with and
* without instance storage), the returned placement score will always be low.
*
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*
*
* @return The instance types. We recommend that you specify at least three instance types. If you specify one or
* two instance types, or specify variations of a single instance type (for example, an
* m3.xlarge with and without instance storage), the returned placement score will always be
* low.
*
* If you specify InstanceTypes, you can't specify
* InstanceRequirementsWithMetadata.
*/
public java.util.List getInstanceTypes() {
if (instanceTypes == null) {
instanceTypes = new com.amazonaws.internal.SdkInternalList();
}
return instanceTypes;
}
/**
*
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge with and
* without instance storage), the returned placement score will always be low.
*
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*
*
* @param instanceTypes
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge
* with and without instance storage), the returned placement score will always be low.
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*/
public void setInstanceTypes(java.util.Collection instanceTypes) {
if (instanceTypes == null) {
this.instanceTypes = null;
return;
}
this.instanceTypes = new com.amazonaws.internal.SdkInternalList(instanceTypes);
}
/**
*
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge with and
* without instance storage), the returned placement score will always be low.
*
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInstanceTypes(java.util.Collection)} or {@link #withInstanceTypes(java.util.Collection)} if you want
* to override the existing values.
*
*
* @param instanceTypes
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge
* with and without instance storage), the returned placement score will always be low.
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withInstanceTypes(String... instanceTypes) {
if (this.instanceTypes == null) {
setInstanceTypes(new com.amazonaws.internal.SdkInternalList(instanceTypes.length));
}
for (String ele : instanceTypes) {
this.instanceTypes.add(ele);
}
return this;
}
/**
*
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge with and
* without instance storage), the returned placement score will always be low.
*
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
*
*
* @param instanceTypes
* The instance types. We recommend that you specify at least three instance types. If you specify one or two
* instance types, or specify variations of a single instance type (for example, an m3.xlarge
* with and without instance storage), the returned placement score will always be low.
*
* If you specify InstanceTypes, you can't specify InstanceRequirementsWithMetadata.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withInstanceTypes(java.util.Collection instanceTypes) {
setInstanceTypes(instanceTypes);
return this;
}
/**
*
* The target capacity.
*
*
* @param targetCapacity
* The target capacity.
*/
public void setTargetCapacity(Integer targetCapacity) {
this.targetCapacity = targetCapacity;
}
/**
*
* The target capacity.
*
*
* @return The target capacity.
*/
public Integer getTargetCapacity() {
return this.targetCapacity;
}
/**
*
* The target capacity.
*
*
* @param targetCapacity
* The target capacity.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withTargetCapacity(Integer targetCapacity) {
setTargetCapacity(targetCapacity);
return this;
}
/**
*
* The unit for the target capacity.
*
*
* Default: units (translates to number of instances)
*
*
* @param targetCapacityUnitType
* The unit for the target capacity.
*
* Default: units (translates to number of instances)
* @see TargetCapacityUnitType
*/
public void setTargetCapacityUnitType(String targetCapacityUnitType) {
this.targetCapacityUnitType = targetCapacityUnitType;
}
/**
*
* The unit for the target capacity.
*
*
* Default: units (translates to number of instances)
*
*
* @return The unit for the target capacity.
*
* Default: units (translates to number of instances)
* @see TargetCapacityUnitType
*/
public String getTargetCapacityUnitType() {
return this.targetCapacityUnitType;
}
/**
*
* The unit for the target capacity.
*
*
* Default: units (translates to number of instances)
*
*
* @param targetCapacityUnitType
* The unit for the target capacity.
*
* Default: units (translates to number of instances)
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetCapacityUnitType
*/
public GetSpotPlacementScoresRequest withTargetCapacityUnitType(String targetCapacityUnitType) {
setTargetCapacityUnitType(targetCapacityUnitType);
return this;
}
/**
*
* The unit for the target capacity.
*
*
* Default: units (translates to number of instances)
*
*
* @param targetCapacityUnitType
* The unit for the target capacity.
*
* Default: units (translates to number of instances)
* @return Returns a reference to this object so that method calls can be chained together.
* @see TargetCapacityUnitType
*/
public GetSpotPlacementScoresRequest withTargetCapacityUnitType(TargetCapacityUnitType targetCapacityUnitType) {
this.targetCapacityUnitType = targetCapacityUnitType.toString();
return this;
}
/**
*
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single
* Availability Zone.
*
*
* @param singleAvailabilityZone
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a
* single Availability Zone.
*/
public void setSingleAvailabilityZone(Boolean singleAvailabilityZone) {
this.singleAvailabilityZone = singleAvailabilityZone;
}
/**
*
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single
* Availability Zone.
*
*
* @return Specify true so that the response returns a list of scored Availability Zones. Otherwise,
* the response returns a list of scored Regions.
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a
* single Availability Zone.
*/
public Boolean getSingleAvailabilityZone() {
return this.singleAvailabilityZone;
}
/**
*
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single
* Availability Zone.
*
*
* @param singleAvailabilityZone
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a
* single Availability Zone.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withSingleAvailabilityZone(Boolean singleAvailabilityZone) {
setSingleAvailabilityZone(singleAvailabilityZone);
return this;
}
/**
*
* Specify true so that the response returns a list of scored Availability Zones. Otherwise, the
* response returns a list of scored Regions.
*
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a single
* Availability Zone.
*
*
* @return Specify true so that the response returns a list of scored Availability Zones. Otherwise,
* the response returns a list of scored Regions.
*
* A list of scored Availability Zones is useful if you want to launch all of your Spot capacity into a
* single Availability Zone.
*/
public Boolean isSingleAvailabilityZone() {
return this.singleAvailabilityZone;
}
/**
*
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*
*
* @return The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*/
public java.util.List getRegionNames() {
if (regionNames == null) {
regionNames = new com.amazonaws.internal.SdkInternalList();
}
return regionNames;
}
/**
*
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*
*
* @param regionNames
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*/
public void setRegionNames(java.util.Collection regionNames) {
if (regionNames == null) {
this.regionNames = null;
return;
}
this.regionNames = new com.amazonaws.internal.SdkInternalList(regionNames);
}
/**
*
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setRegionNames(java.util.Collection)} or {@link #withRegionNames(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param regionNames
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withRegionNames(String... regionNames) {
if (this.regionNames == null) {
setRegionNames(new com.amazonaws.internal.SdkInternalList(regionNames.length));
}
for (String ele : regionNames) {
this.regionNames.add(ele);
}
return this;
}
/**
*
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
*
*
* @param regionNames
* The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
* us-east-1.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withRegionNames(java.util.Collection regionNames) {
setRegionNames(regionNames);
return this;
}
/**
*
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance
* types with those attributes.
*
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
*
*
* @param instanceRequirementsWithMetadata
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify
* instance types with those attributes.
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
*/
public void setInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata) {
this.instanceRequirementsWithMetadata = instanceRequirementsWithMetadata;
}
/**
*
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance
* types with those attributes.
*
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
*
*
* @return The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify
* instance types with those attributes.
*
* If you specify InstanceRequirementsWithMetadata, you can't specify
* InstanceTypes.
*/
public InstanceRequirementsWithMetadataRequest getInstanceRequirementsWithMetadata() {
return this.instanceRequirementsWithMetadata;
}
/**
*
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify instance
* types with those attributes.
*
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
*
*
* @param instanceRequirementsWithMetadata
* The attributes for the instance types. When you specify instance attributes, Amazon EC2 will identify
* instance types with those attributes.
*
* If you specify InstanceRequirementsWithMetadata, you can't specify InstanceTypes.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata) {
setInstanceRequirementsWithMetadata(instanceRequirementsWithMetadata);
return this;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @return The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of items to return for this request. To get the next page of items, make another request with
* the token returned in the output. For more information, see Pagination.
*
*
* @param maxResults
* The maximum number of items to return for this request. To get the next page of items, make another
* request with the token returned in the output. For more information, see Pagination.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @return The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* The token returned from a previous paginated request. Pagination continues from the end of the items returned by
* the previous request.
*
*
* @param nextToken
* The token returned from a previous paginated request. Pagination continues from the end of the items
* returned by the previous request.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetSpotPlacementScoresRequest withNextToken(String nextToken) {
setNextToken(nextToken);
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 GetSpotPlacementScoresRequestMarshaller().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 (getInstanceTypes() != null)
sb.append("InstanceTypes: ").append(getInstanceTypes()).append(",");
if (getTargetCapacity() != null)
sb.append("TargetCapacity: ").append(getTargetCapacity()).append(",");
if (getTargetCapacityUnitType() != null)
sb.append("TargetCapacityUnitType: ").append(getTargetCapacityUnitType()).append(",");
if (getSingleAvailabilityZone() != null)
sb.append("SingleAvailabilityZone: ").append(getSingleAvailabilityZone()).append(",");
if (getRegionNames() != null)
sb.append("RegionNames: ").append(getRegionNames()).append(",");
if (getInstanceRequirementsWithMetadata() != null)
sb.append("InstanceRequirementsWithMetadata: ").append(getInstanceRequirementsWithMetadata()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetSpotPlacementScoresRequest == false)
return false;
GetSpotPlacementScoresRequest other = (GetSpotPlacementScoresRequest) obj;
if (other.getInstanceTypes() == null ^ this.getInstanceTypes() == null)
return false;
if (other.getInstanceTypes() != null && other.getInstanceTypes().equals(this.getInstanceTypes()) == 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.getTargetCapacityUnitType() == null ^ this.getTargetCapacityUnitType() == null)
return false;
if (other.getTargetCapacityUnitType() != null && other.getTargetCapacityUnitType().equals(this.getTargetCapacityUnitType()) == false)
return false;
if (other.getSingleAvailabilityZone() == null ^ this.getSingleAvailabilityZone() == null)
return false;
if (other.getSingleAvailabilityZone() != null && other.getSingleAvailabilityZone().equals(this.getSingleAvailabilityZone()) == false)
return false;
if (other.getRegionNames() == null ^ this.getRegionNames() == null)
return false;
if (other.getRegionNames() != null && other.getRegionNames().equals(this.getRegionNames()) == false)
return false;
if (other.getInstanceRequirementsWithMetadata() == null ^ this.getInstanceRequirementsWithMetadata() == null)
return false;
if (other.getInstanceRequirementsWithMetadata() != null
&& other.getInstanceRequirementsWithMetadata().equals(this.getInstanceRequirementsWithMetadata()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getInstanceTypes() == null) ? 0 : getInstanceTypes().hashCode());
hashCode = prime * hashCode + ((getTargetCapacity() == null) ? 0 : getTargetCapacity().hashCode());
hashCode = prime * hashCode + ((getTargetCapacityUnitType() == null) ? 0 : getTargetCapacityUnitType().hashCode());
hashCode = prime * hashCode + ((getSingleAvailabilityZone() == null) ? 0 : getSingleAvailabilityZone().hashCode());
hashCode = prime * hashCode + ((getRegionNames() == null) ? 0 : getRegionNames().hashCode());
hashCode = prime * hashCode + ((getInstanceRequirementsWithMetadata() == null) ? 0 : getInstanceRequirementsWithMetadata().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
return hashCode;
}
@Override
public GetSpotPlacementScoresRequest clone() {
return (GetSpotPlacementScoresRequest) super.clone();
}
}