Class InstanceGroup

java.lang.Object
software.amazon.awssdk.services.emr.model.InstanceGroup
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>
@Generated("software.amazon.awssdk:codegen") public final class InstanceGroup extends Object implements SdkPojo, Serializable, ToCopyableBuilder<InstanceGroup.Builder,InstanceGroup>

This entity represents an instance group, which is a group of instances that have common purpose. For example, CORE instance group is used for HDFS.

See Also:

  • Method Details

    • id

      public final String id()

      The identifier of the instance group.

      Returns:
      The identifier of the instance group.

    • name

      public final String name()

      The name of the instance group.

      Returns:
      The name of the instance group.

    • market

      public final MarketType market()

      The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

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

      Returns:
      The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
      See Also:

    • marketAsString

      public final String marketAsString()

      The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.

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

      Returns:
      The marketplace to provision instances for this group. Valid values are ON_DEMAND or SPOT.
      See Also:

    • instanceGroupType

      public final InstanceGroupType instanceGroupType()

      The type of the instance group. Valid values are MASTER, CORE or TASK.

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

      Returns:
      The type of the instance group. Valid values are MASTER, CORE or TASK.
      See Also:

    • instanceGroupTypeAsString

      public final String instanceGroupTypeAsString()

      The type of the instance group. Valid values are MASTER, CORE or TASK.

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

      Returns:
      The type of the instance group. Valid values are MASTER, CORE or TASK.
      See Also:

    • bidPrice

      public final String bidPrice()

      If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

      Returns:
      If specified, indicates that the instance group uses Spot Instances. This is the maximum price you are willing to pay for Spot Instances. Specify OnDemandPrice to set the amount equal to the On-Demand price, or specify an amount in USD.

    • instanceType

      public final String instanceType()

      The Amazon EC2 instance type for all instances in the instance group.

      Returns:
      The Amazon EC2 instance type for all instances in the instance group.

    • requestedInstanceCount

      public final Integer requestedInstanceCount()

      The target number of instances for the instance group.

      Returns:
      The target number of instances for the instance group.

    • runningInstanceCount

      public final Integer runningInstanceCount()

      The number of instances currently running in this instance group.

      Returns:
      The number of instances currently running in this instance group.

    • status

      public final InstanceGroupStatus status()

      The current status of the instance group.

      Returns:
      The current status of the instance group.

    • hasConfigurations

      public final boolean hasConfigurations()
      For responses, this returns true if the service returned a value for the Configurations 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.

    • configurations

      public final List<Configuration> configurations()

      Amazon EMR releases 4.x or later.

      The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

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

      Returns:

      Amazon EMR releases 4.x or later.

      The list of configurations supplied for an Amazon EMR cluster instance group. You can specify a separate configuration for each instance group (master, core, and task).

    • configurationsVersion

      public final Long configurationsVersion()

      The version number of the requested configuration specification for this instance group.

      Returns:
      The version number of the requested configuration specification for this instance group.

    • hasLastSuccessfullyAppliedConfigurations

      public final boolean hasLastSuccessfullyAppliedConfigurations()
      For responses, this returns true if the service returned a value for the LastSuccessfullyAppliedConfigurations 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.

    • lastSuccessfullyAppliedConfigurations

      public final List<Configuration> lastSuccessfullyAppliedConfigurations()

      A list of configurations that were successfully applied for an instance group last time.

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

      Returns:
      A list of configurations that were successfully applied for an instance group last time.

    • lastSuccessfullyAppliedConfigurationsVersion

      public final Long lastSuccessfullyAppliedConfigurationsVersion()

      The version number of a configuration specification that was successfully applied for an instance group last time.

      Returns:
      The version number of a configuration specification that was successfully applied for an instance group last time.

    • hasEbsBlockDevices

      public final boolean hasEbsBlockDevices()
      For responses, this returns true if the service returned a value for the EbsBlockDevices 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.

    • ebsBlockDevices

      public final List<EbsBlockDevice> ebsBlockDevices()

      The EBS block devices that are mapped to this instance group.

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

      Returns:
      The EBS block devices that are mapped to this instance group.

    • ebsOptimized

      public final Boolean ebsOptimized()

      If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

      Returns:
      If the instance group is EBS-optimized. An Amazon EBS-optimized instance uses an optimized configuration stack and provides additional, dedicated capacity for Amazon EBS I/O.

    • shrinkPolicy

      public final ShrinkPolicy shrinkPolicy()

      Policy for customizing shrink operations.

      Returns:
      Policy for customizing shrink operations.

    • autoScalingPolicy

      public final AutoScalingPolicyDescription autoScalingPolicy()

      An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

      Returns:
      An automatic scaling policy for a core instance group or task instance group in an Amazon EMR cluster. The automatic scaling policy defines how an instance group dynamically adds and terminates Amazon EC2 instances in response to the value of a CloudWatch metric. See PutAutoScalingPolicy.

    • customAmiId

      public final String customAmiId()

      The custom AMI ID to use for the provisioned instance group.

      Returns:
      The custom AMI ID to use for the provisioned instance group.

    • toBuilder

      public InstanceGroup.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<InstanceGroup.Builder,InstanceGroup>
      Returns:
      a builder for type T

    • builder

      public static InstanceGroup.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

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