Class StartNotebookExecutionRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<StartNotebookExecutionRequest.Builder,
StartNotebookExecutionRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
editorId()
The unique identifier of the Amazon EMR Notebook to use for notebook execution.The environment variables associated with the notebook execution.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExecutionEngineConfig
Specifies the execution engine (cluster) that runs the notebook execution.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
For responses, this returns true if the service returned a value for the EnvironmentVariables property.final int
hashCode()
final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final String
An optional name for the notebook execution.final String
The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this notebook execution.final String
Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution.The Amazon S3 location for the notebook execution input.final OutputNotebookFormat
The output format for the notebook execution.final String
The output format for the notebook execution.The Amazon S3 location for the notebook execution output.final String
The path and file name of the notebook file for this execution, relative to the path specified for the Amazon EMR Notebook.static Class
<? extends StartNotebookExecutionRequest.Builder> final String
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.tags()
A list of tags associated with a notebook execution.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 ofe-ABCDEFGHIJK1234567890ABCD
(theEditorID
of this request), and you specify aRelativePath
ofmy_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution iss3://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 ofe-ABCDEFGHIJK1234567890ABCD
(theEditorID
of this request), and you specify aRelativePath
ofmy_notebook_executions/notebook_execution.ipynb
, the location of the file for the notebook execution iss3://MyBucket/MyNotebooks/e-ABCDEFGHIJK1234567890ABCD/my_notebook_executions/notebook_execution.ipynb
.
-
notebookExecutionName
An optional name for the notebook execution.
- Returns:
- An optional name for the notebook execution.
-
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
Specifies the execution engine (cluster) that runs the notebook execution.
- Returns:
- Specifies the execution engine (cluster) that runs the notebook execution.
-
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
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 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. -
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
The Amazon S3 location for the notebook execution input.
- Returns:
- The Amazon S3 location for the notebook execution input.
-
outputNotebookS3Location
The Amazon S3 location for the notebook execution output.
- Returns:
- The Amazon S3 location for the notebook execution output.
-
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 returnOutputNotebookFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputNotebookFormatAsString()
.- Returns:
- The output format for the notebook execution.
- See Also:
-
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 returnOutputNotebookFormat.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoutputNotebookFormatAsString()
.- Returns:
- The output format for the notebook execution.
- See Also:
-
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 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. -
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
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 interfaceToCopyableBuilder<StartNotebookExecutionRequest.Builder,
StartNotebookExecutionRequest> - Specified by:
toBuilder
in classEmrRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-