Class EngineConfiguration

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

Contains data processing unit (DPU) configuration settings and parameter mappings for a notebook engine.

See Also:

  • Method Details

    • coordinatorDpuSize

      public final Integer coordinatorDpuSize()

      The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

      Returns:
      The number of DPUs to use for the coordinator. A coordinator is a special executor that orchestrates processing work and manages other executors in a notebook session. The default is 1.

    • maxConcurrentDpus

      public final Integer maxConcurrentDpus()

      The maximum number of DPUs that can run concurrently.

      Returns:
      The maximum number of DPUs that can run concurrently.

    • defaultExecutorDpuSize

      public final Integer defaultExecutorDpuSize()

      The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

      Returns:
      The default number of DPUs to use for executors. An executor is the smallest unit of compute that a notebook session can request from Athena. The default is 1.

    • hasAdditionalConfigs

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

    • additionalConfigs

      public final Map<String,String> additionalConfigs()

      Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

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

      Returns:
      Contains additional notebook engine MAP<string, string> parameter mappings in the form of key-value pairs. To specify an Athena notebook that the Jupyter server will download and serve, specify a value for the StartSessionRequest$NotebookVersion field, and then add a key named NotebookId to AdditionalConfigs that has the value of the Athena notebook ID.

    • hasSparkProperties

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

    • sparkProperties

      public final Map<String,String> sparkProperties()

      Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

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

      Returns:
      Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.

    • toBuilder

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

    • builder

      public static EngineConfiguration.Builder builder()

    • serializableBuilderClass

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