Class StartSessionRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.emr.model.EmrRequest
software.amazon.awssdk.services.emr.model.StartSessionRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartSessionRequest extends EmrRequest implements ToCopyableBuilder<StartSessionRequest.Builder,StartSessionRequest>

Input to the StartSession operation.

  • Method Details

    • name

      public final String name()

      An optional name for the session.

      Returns:
      An optional name for the session.

    • clusterId

      public final String clusterId()

      The ID of the cluster on which to start the session.

      Returns:
      The ID of the cluster on which to start the session.

    • executionRoleArn

      public final String executionRoleArn()

      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

      Returns:
      The execution role ARN for the session. Amazon EMR uses this role to access Amazon Web Services resources on your behalf during session execution.

    • hasEngineConfigurations

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

    • engineConfigurations

      public final List<Configuration> engineConfigurations()

      The configuration overrides for the session. Only runtime configuration overrides are supported.

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

      Returns:
      The configuration overrides for the session. Only runtime configuration overrides are supported.

    • monitoringConfiguration

      public final SessionMonitoringConfiguration monitoringConfiguration()

      The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.

      Returns:
      The monitoring configuration that controls where session logs are published, such as Amazon S3, CloudWatch, or managed logging.

    • sessionIdleTimeoutInMinutes

      public final Long sessionIdleTimeoutInMinutes()

      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.

      Returns:
      The idle timeout, in minutes. If the session is idle for this duration, Amazon EMR EC2 automatically terminates it.

    • clientRequestToken

      public final String clientRequestToken()

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.

      Returns:
      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you retry a request that completed successfully using the same client request token, the service returns the original response without performing the operation again.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      The tags to assign to the session.

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

      Returns:
      The tags to assign to the session.

    • toBuilder

      public StartSessionRequest.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<StartSessionRequest.Builder,StartSessionRequest>
      Specified by:
      toBuilder in class EmrRequest
      Returns:
      a builder for type T

    • builder

      public static StartSessionRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartSessionRequest.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.