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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>

@Generated("software.amazon.awssdk:codegen")
public final class StartNotebookExecutionRequest
extends EmrRequest
implements ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface StartNotebookExecutionRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static StartNotebookExecutionRequest.Builder`	`builder()`
`String`	`editorId()`	The unique identifier of the Amazon EMR Notebook to use for notebook execution.
`Map<String,String>`	`environmentVariables()`	The environment variables associated with the notebook execution.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`ExecutionEngineConfig`	`executionEngine()`	Specifies the execution engine (cluster) that runs the notebook execution.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasEnvironmentVariables()`	For responses, this returns true if the service returned a value for the EnvironmentVariables property.
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`String`	`notebookExecutionName()`	An optional name for the notebook execution.
`String`	`notebookInstanceSecurityGroupId()`	The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
`String`	`notebookParams()`	Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
`NotebookS3LocationFromInput`	`notebookS3Location()`	The Amazon S3 location for the notebook execution input.
`OutputNotebookFormat`	`outputNotebookFormat()`	The output format for the notebook execution.
`String`	`outputNotebookFormatAsString()`	The output format for the notebook execution.
`OutputNotebookS3LocationFromInput`	`outputNotebookS3Location()`	The Amazon S3 location for the notebook execution output.
`String`	`relativePath()`	The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StartNotebookExecutionRequest.Builder>`	`serializableBuilderClass()`
`String`	`serviceRole()`	The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
`List<Tag>`	`tags()`	A list of tags associated with a notebook execution.
`StartNotebookExecutionRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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
  - editorId
```
public final String editorId()
```
    The unique identifier of the Amazon EMR Notebook to use for notebook execution.
    
    Returns:
    
    The unique identifier of the Amazon EMR Notebook to use for notebook execution.
  - relativePath
```
public final String relativePath()
```
    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .
    
    Returns:
    
    The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook. For example, if you specify a path of s3://MyBucket/MyNotebooks when you create an Amazon EMR Notebook for a notebook with an ID of e-ABCDEFGHIJK1234567890ABCD (the EditorID of this request), and you specify a RelativePath of my_notebook_executions/notebook_execution.ipynb, the location of the file for the notebook execution is s3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb .
  - notebookExecutionName
```
public final String notebookExecutionName()
```
    An optional name for the notebook execution.
    
    Returns:
    
    An optional name for the notebook execution.
  - notebookParams
```
public final String notebookParams()
```
    Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
    
    Returns:
    
    Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.
  - executionEngine
```
public final ExecutionEngineConfig executionEngine()
```
    Specifies the execution engine (cluster) that runs the notebook execution.
    
    Returns:
    
    Specifies the execution engine (cluster) that runs the notebook execution.
  - serviceRole
```
public final String serviceRole()
```
    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
    
    Returns:
    
    The name or ARN of the IAM role that is used as the service role for Amazon EMR (the Amazon EMR role) for the notebook execution.
  - notebookInstanceSecurityGroupId
```
public final String notebookInstanceSecurityGroupId()
```
    The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
    
    Returns:
    
    The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.
  - 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()
```
    A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
    
    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:
    
    A list of tags associated with a notebook execution. Tags are user-defined key-value pairs that consist of a required key string with a maximum of 128 characters and an optional value string with a maximum of 256 characters.
  - notebookS3Location
```
public final NotebookS3LocationFromInput notebookS3Location()
```
    The Amazon S3 location for the notebook execution input.
    
    Returns:
    
    The Amazon S3 location for the notebook execution input.
  - outputNotebookS3Location
```
public final OutputNotebookS3LocationFromInput outputNotebookS3Location()
```
    The Amazon S3 location for the notebook execution output.
    
    Returns:
    
    The Amazon S3 location for the notebook execution output.
  - outputNotebookFormat
```
public final OutputNotebookFormat outputNotebookFormat()
```
    The output format for the notebook execution.
    
    If the service returns an enum value that is not available in the current SDK version, outputNotebookFormat will return OutputNotebookFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputNotebookFormatAsString().
    
    Returns:
    
    The output format for the notebook execution.
    
    See Also:
    
    OutputNotebookFormat
  - outputNotebookFormatAsString
```
public final String outputNotebookFormatAsString()
```
    The output format for the notebook execution.
    
    If the service returns an enum value that is not available in the current SDK version, outputNotebookFormat will return OutputNotebookFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from outputNotebookFormatAsString().
    
    Returns:
    
    The output format for the notebook execution.
    
    See Also:
    
    OutputNotebookFormat
  - hasEnvironmentVariables
```
public final boolean hasEnvironmentVariables()
```
    For responses, this returns true if the service returned a value for the EnvironmentVariables 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.
  - environmentVariables
```
public final Map<String,String> environmentVariables()
```
    The environment variables associated with the notebook execution.
    
    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 hasEnvironmentVariables() method.
    
    Returns:
    
    The environment variables associated with the notebook execution.
  - toBuilder
```
public StartNotebookExecutionRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StartNotebookExecutionRequest.Builder,StartNotebookExecutionRequest>
    
    Specified by:
    
    toBuilder in class EmrRequest
  - builder
```
public static StartNotebookExecutionRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StartNotebookExecutionRequest.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class StartNotebookExecutionRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

editorId

relativePath

notebookExecutionName

notebookParams

executionEngine

serviceRole

notebookInstanceSecurityGroupId

hasTags

tags

notebookS3Location

outputNotebookS3Location

outputNotebookFormat

outputNotebookFormatAsString

hasEnvironmentVariables

environmentVariables

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields