Class GetCapacityManagerSupportabilityScoresRequest

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.GetCapacityManagerSupportabilityScoresRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCapacityManagerSupportabilityScoresRequest.Builder,GetCapacityManagerSupportabilityScoresRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetCapacityManagerSupportabilityScoresRequest extends Ec2Request implements ToCopyableBuilder<GetCapacityManagerSupportabilityScoresRequest.Builder,GetCapacityManagerSupportabilityScoresRequest>

  • Method Details

    • marketType

      public final SupportabilityMarketType marketType()

      The capacity market to score.

      If the service returns an enum value that is not available in the current SDK version, marketType will return SupportabilityMarketType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from marketTypeAsString().

      Returns:
      The capacity market to score.
      See Also:

    • marketTypeAsString

      public final String marketTypeAsString()

      The capacity market to score.

      If the service returns an enum value that is not available in the current SDK version, marketType will return SupportabilityMarketType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from marketTypeAsString().

      Returns:
      The capacity market to score.
      See Also:

    • capacityAmount

      public final Integer capacityAmount()

      The amount of capacity that you need, in the unit that you specify for CapacityUnit. Each score is relative to this amount.

      Returns:
      The amount of capacity that you need, in the unit that you specify for CapacityUnit. Each score is relative to this amount.

    • capacityUnit

      public final CapacityUnit capacityUnit()

      The unit for CapacityAmount.

      If the service returns an enum value that is not available in the current SDK version, capacityUnit will return CapacityUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from capacityUnitAsString().

      Returns:
      The unit for CapacityAmount.
      See Also:

    • capacityUnitAsString

      public final String capacityUnitAsString()

      The unit for CapacityAmount.

      If the service returns an enum value that is not available in the current SDK version, capacityUnit will return CapacityUnit.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from capacityUnitAsString().

      Returns:
      The unit for CapacityAmount.
      See Also:

    • hasCapacityAvailabilityZoneIds

      public final boolean hasCapacityAvailabilityZoneIds()
      For responses, this returns true if the service returned a value for the CapacityAvailabilityZoneIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

    • capacityAvailabilityZoneIds

      public final List<String> capacityAvailabilityZoneIds()

      The IDs of the Availability Zones to score, such as use1-az1. You can specify Availability Zones in different Regions. You can specify up to 10 Availability Zones.

      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 hasCapacityAvailabilityZoneIds() method.

      Returns:
      The IDs of the Availability Zones to score, such as use1-az1. You can specify Availability Zones in different Regions. You can specify up to 10 Availability Zones.

    • 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 the isEmpty() 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 to score. You can specify up to 50 instance types.

      Specify either InstanceTypes or InstanceRequirementsWithMetadata, but not both.

      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 to score. You can specify up to 50 instance types.

      Specify either InstanceTypes or InstanceRequirementsWithMetadata, but not both.

    • instanceRequirementsWithMetadata

      public final InstanceRequirementsWithMetadataRequest instanceRequirementsWithMetadata()

      The attributes that the instance types must have, such as vCPU and memory ranges. Capacity Manager resolves the attributes into matching instance types and scores each one.

      Specify either InstanceTypes or InstanceRequirementsWithMetadata, but not both.

      Returns:
      The attributes that the instance types must have, such as vCPU and memory ranges. Capacity Manager resolves the attributes into matching instance types and scores each one.

      Specify either InstanceTypes or InstanceRequirementsWithMetadata, but not both.

    • 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 is UnauthorizedOperation.

      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 is UnauthorizedOperation.

    • toBuilder

      public GetCapacityManagerSupportabilityScoresRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCapacityManagerSupportabilityScoresRequest.Builder,GetCapacityManagerSupportabilityScoresRequest>
      Specified by:
      toBuilder in class Ec2Request
      Returns:
      a builder for type T

    • builder

      public static GetCapacityManagerSupportabilityScoresRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCapacityManagerSupportabilityScoresRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.