Class GetSpotPlacementScoresRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.GetSpotPlacementScoresRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<GetSpotPlacementScoresRequest.Builder,GetSpotPlacementScoresRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetSpotPlacementScoresRequest extends Ec2Request implements ToCopyableBuilder<GetSpotPlacementScoresRequest.Builder,GetSpotPlacementScoresRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
GetSpotPlacementScoresRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static GetSpotPlacementScoresRequest.Builder
builder()
Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasInstanceTypes()
For responses, this returns true if the service returned a value for the InstanceTypes property.boolean
hasRegionNames()
For responses, this returns true if the service returned a value for the RegionNames property.InstanceRequirementsWithMetadataRequest
instanceRequirementsWithMetadata()
The attributes for the instance types.List<String>
instanceTypes()
The instance types.Integer
maxResults()
The maximum number of items to return for this request.String
nextToken()
The token returned from a previous paginated request.List<String>
regionNames()
The Regions used to narrow down the list of Regions to be scored.List<SdkField<?>>
sdkFields()
static Class<? extends GetSpotPlacementScoresRequest.Builder>
serializableBuilderClass()
Boolean
singleAvailabilityZone()
Specifytrue
so that the response returns a list of scored Availability Zones.Integer
targetCapacity()
The target capacity.TargetCapacityUnitType
targetCapacityUnitType()
The unit for the target capacity.String
targetCapacityUnitTypeAsString()
The unit for the target capacity.GetSpotPlacementScoresRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
hasInstanceTypes
public final boolean hasInstanceTypes()
For responses, this returns true if the service returned a value for the InstanceTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
instanceTypes
public final List<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 specifyInstanceRequirementsWithMetadata
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasInstanceTypes()
method.- 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 specifyInstanceRequirementsWithMetadata
.
-
targetCapacity
public final Integer targetCapacity()
The target capacity.
- Returns:
- The target capacity.
-
targetCapacityUnitType
public final TargetCapacityUnitType targetCapacityUnitType()
The unit for the target capacity.
If the service returns an enum value that is not available in the current SDK version,
targetCapacityUnitType
will returnTargetCapacityUnitType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetCapacityUnitTypeAsString()
.- Returns:
- The unit for the target capacity.
- See Also:
TargetCapacityUnitType
-
targetCapacityUnitTypeAsString
public final String targetCapacityUnitTypeAsString()
The unit for the target capacity.
If the service returns an enum value that is not available in the current SDK version,
targetCapacityUnitType
will returnTargetCapacityUnitType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtargetCapacityUnitTypeAsString()
.- Returns:
- The unit for the target capacity.
- See Also:
TargetCapacityUnitType
-
singleAvailabilityZone
public final 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.
- 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.
-
hasRegionNames
public final boolean hasRegionNames()
For responses, this returns true if the service returned a value for the RegionNames property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
regionNames
public final List<String> regionNames()
The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
us-east-1
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasRegionNames()
method.- Returns:
- The Regions used to narrow down the list of Regions to be scored. Enter the Region code, for example,
us-east-1
.
-
instanceRequirementsWithMetadata
public final 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 specifyInstanceTypes
.- 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 specifyInstanceTypes
.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
maxResults
public final Integer 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.
- Returns:
- 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.
-
nextToken
public final String nextToken()
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Returns:
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
-
toBuilder
public GetSpotPlacementScoresRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<GetSpotPlacementScoresRequest.Builder,GetSpotPlacementScoresRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static GetSpotPlacementScoresRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetSpotPlacementScoresRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final 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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-