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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
EngineConfiguration.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Map<String,String>
additionalConfigs()
Contains additional notebook engineMAP<string, string>
parameter mappings in the form of key-value pairs.static EngineConfiguration.Builder
builder()
Integer
coordinatorDpuSize()
The number of DPUs to use for the coordinator.Integer
defaultExecutorDpuSize()
The default number of DPUs to use for executors.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasAdditionalConfigs()
For responses, this returns true if the service returned a value for the AdditionalConfigs property.int
hashCode()
boolean
hasSparkProperties()
For responses, this returns true if the service returned a value for the SparkProperties property.Integer
maxConcurrentDpus()
The maximum number of DPUs that can run concurrently.List<SdkField<?>>
sdkFields()
static Class<? extends EngineConfiguration.Builder>
serializableBuilderClass()
Map<String,String>
sparkProperties()
Specifies custom jar files and Spark properties for use cases like cluster encryption, table formats, and general Spark tuning.EngineConfiguration.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
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 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.
-
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 namedNotebookId
toAdditionalConfigs
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 namedNotebookId
toAdditionalConfigs
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 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.
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<EngineConfiguration.Builder,EngineConfiguration>
-
builder
public static EngineConfiguration.Builder builder()
-
serializableBuilderClass
public static Class<? extends EngineConfiguration.Builder> serializableBuilderClass()
-
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.
-
-