com.amazonaws.services.ec2.model

Class GetSpotPlacementScoresRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.GetSpotPlacementScoresRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<GetSpotPlacementScoresRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetSpotPlacementScoresRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<GetSpotPlacementScoresRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
GetSpotPlacementScoresRequest()

Method Summary

Modifier and Type	Method and Description
GetSpotPlacementScoresRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Request<GetSpotPlacementScoresRequest>	getDryRunRequest() This method is intended for internal use only.
InstanceRequirementsWithMetadataRequest	getInstanceRequirementsWithMetadata() The attributes for the instance types.
List<String>	getInstanceTypes() The instance types.
Integer	getMaxResults() The maximum number of results to return in a single call.
String	getNextToken() The token for the next set of results.
List<String>	getRegionNames() The Regions used to narrow down the list of Regions to be scored.
Boolean	getSingleAvailabilityZone() Specify true so that the response returns a list of scored Availability Zones.
Integer	getTargetCapacity() The target capacity.
String	getTargetCapacityUnitType() The unit for the target capacity.
int	hashCode()
Boolean	isSingleAvailabilityZone() Specify true so that the response returns a list of scored Availability Zones.
void	setInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata) The attributes for the instance types.
void	setInstanceTypes(Collection<String> instanceTypes) The instance types.
void	setMaxResults(Integer maxResults) The maximum number of results to return in a single call.
void	setNextToken(String nextToken) The token for the next set of results.
void	setRegionNames(Collection<String> regionNames) The Regions used to narrow down the list of Regions to be scored.
void	setSingleAvailabilityZone(Boolean singleAvailabilityZone) Specify true so that the response returns a list of scored Availability Zones.
void	setTargetCapacity(Integer targetCapacity) The target capacity.
void	setTargetCapacityUnitType(String targetCapacityUnitType) The unit for the target capacity.
String	toString() Returns a string representation of this object.
GetSpotPlacementScoresRequest	withInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata) The attributes for the instance types.
GetSpotPlacementScoresRequest	withInstanceTypes(Collection<String> instanceTypes) The instance types.
GetSpotPlacementScoresRequest	withInstanceTypes(String... instanceTypes) The instance types.
GetSpotPlacementScoresRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a single call.
GetSpotPlacementScoresRequest	withNextToken(String nextToken) The token for the next set of results.
GetSpotPlacementScoresRequest	withRegionNames(Collection<String> regionNames) The Regions used to narrow down the list of Regions to be scored.
GetSpotPlacementScoresRequest	withRegionNames(String... regionNames) The Regions used to narrow down the list of Regions to be scored.
GetSpotPlacementScoresRequest	withSingleAvailabilityZone(Boolean singleAvailabilityZone) Specify true so that the response returns a list of scored Availability Zones.
GetSpotPlacementScoresRequest	withTargetCapacity(Integer targetCapacity) The target capacity.
GetSpotPlacementScoresRequest	withTargetCapacityUnitType(String targetCapacityUnitType) The unit for the target capacity.
GetSpotPlacementScoresRequest	withTargetCapacityUnitType(TargetCapacityUnitType targetCapacityUnitType) The unit for the target capacity.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

GetSpotPlacementScoresRequest

public GetSpotPlacementScoresRequest()

Method Detail

getInstanceTypes

public List<String> getInstanceTypes()

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.

Returns:

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.

setInstanceTypes

public void setInstanceTypes(Collection<String> 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.

Parameters:

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.

withInstanceTypes

public GetSpotPlacementScoresRequest withInstanceTypes(String... 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 setInstanceTypes(java.util.Collection) or withInstanceTypes(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withInstanceTypes

public GetSpotPlacementScoresRequest withInstanceTypes(Collection<String> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetCapacity

public void setTargetCapacity(Integer targetCapacity)

The target capacity.

Parameters:

targetCapacity - The target capacity.

getTargetCapacity

public Integer getTargetCapacity()

The target capacity.

Returns:

The target capacity.

withTargetCapacity

public GetSpotPlacementScoresRequest withTargetCapacity(Integer targetCapacity)

The target capacity.

Parameters:

targetCapacity - The target capacity.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTargetCapacityUnitType

public void setTargetCapacityUnitType(String targetCapacityUnitType)

The unit for the target capacity.

Default: units (translates to number of instances)

Parameters:

targetCapacityUnitType - The unit for the target capacity.

Default: units (translates to number of instances)

See Also:

TargetCapacityUnitType

getTargetCapacityUnitType

public String getTargetCapacityUnitType()

The unit for the target capacity.

Default: units (translates to number of instances)

Returns:

The unit for the target capacity.

Default: units (translates to number of instances)

See Also:

TargetCapacityUnitType

withTargetCapacityUnitType

public GetSpotPlacementScoresRequest withTargetCapacityUnitType(String targetCapacityUnitType)

The unit for the target capacity.

Default: units (translates to number of instances)

Parameters:

targetCapacityUnitType - The unit for the target capacity.

Default: units (translates to number of instances)

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetCapacityUnitType

withTargetCapacityUnitType

public GetSpotPlacementScoresRequest withTargetCapacityUnitType(TargetCapacityUnitType targetCapacityUnitType)

The unit for the target capacity.

Default: units (translates to number of instances)

Parameters:

targetCapacityUnitType - The unit for the target capacity.

Default: units (translates to number of instances)

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

TargetCapacityUnitType

setSingleAvailabilityZone

public void setSingleAvailabilityZone(Boolean 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.

Parameters:

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.

getSingleAvailabilityZone

public Boolean getSingleAvailabilityZone()

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.

Returns:

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.

withSingleAvailabilityZone

public GetSpotPlacementScoresRequest withSingleAvailabilityZone(Boolean 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

isSingleAvailabilityZone

public Boolean isSingleAvailabilityZone()

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.

Returns:

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.

getRegionNames

public List<String> getRegionNames()

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Returns:

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

setRegionNames

public void setRegionNames(Collection<String> regionNames)

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Parameters:

regionNames - The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

withRegionNames

public GetSpotPlacementScoresRequest withRegionNames(String... 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 setRegionNames(java.util.Collection) or withRegionNames(java.util.Collection) if you want to override the existing values.

Parameters:

regionNames - The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Returns:

Returns a reference to this object so that method calls can be chained together.

withRegionNames

public GetSpotPlacementScoresRequest withRegionNames(Collection<String> regionNames)

The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Parameters:

regionNames - The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example, us-east-1.

Returns:

Returns a reference to this object so that method calls can be chained together.

setInstanceRequirementsWithMetadata

public void setInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest 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.

Parameters:

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.

getInstanceRequirementsWithMetadata

public InstanceRequirementsWithMetadataRequest getInstanceRequirementsWithMetadata()

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.

Returns:

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.

withInstanceRequirementsWithMetadata

public GetSpotPlacementScoresRequest withInstanceRequirementsWithMetadata(InstanceRequirementsWithMetadataRequest 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

Parameters:

maxResults - The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

getMaxResults

public Integer getMaxResults()

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

Returns:

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

withMaxResults

public GetSpotPlacementScoresRequest withMaxResults(Integer maxResults)

The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

Parameters:

maxResults - The maximum number of results to return in a single call. Specify a value between 1 and
 1000. The default value is 1000. To retrieve the remaining results, make another call with
 the returned NextToken value.

Returns:

Returns a reference to this object so that method calls can be chained together.

setNextToken

public void setNextToken(String nextToken)

The token for the next set of results.

Parameters:

nextToken - The token for the next set of results.

getNextToken

public String getNextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

withNextToken

public GetSpotPlacementScoresRequest withNextToken(String nextToken)

The token for the next set of results.

Parameters:

nextToken - The token for the next set of results.

Returns:

Returns a reference to this object so that method calls can be chained together.

getDryRunRequest

public Request<GetSpotPlacementScoresRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<GetSpotPlacementScoresRequest>

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public GetSpotPlacementScoresRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()