/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.elasticmapreduce.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class StartNotebookExecutionRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The unique identifier of the Amazon EMR Notebook to use for notebook execution. *
*/ private String editorId; /** *
* 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
* .
*
* An optional name for the notebook execution. *
*/ private String notebookExecutionName; /** ** Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. *
*/ private String notebookParams; /** ** Specifies the execution engine (cluster) that runs the notebook execution. *
*/ private ExecutionEngineConfig executionEngine; /** ** 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. *
*/ private String serviceRole; /** ** The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. *
*/ private String notebookInstanceSecurityGroupId; /** ** 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. *
*/ private com.amazonaws.internal.SdkInternalList* The Amazon S3 location for the notebook execution input. *
*/ private NotebookS3LocationFromInput notebookS3Location; /** ** The Amazon S3 location for the notebook execution output. *
*/ private OutputNotebookS3LocationFromInput outputNotebookS3Location; /** ** The output format for the notebook execution. *
*/ private String outputNotebookFormat; /** ** The environment variables associated with the notebook execution. *
*/ private com.amazonaws.internal.SdkInternalMap* The unique identifier of the Amazon EMR Notebook to use for notebook execution. *
* * @param editorId * The unique identifier of the Amazon EMR Notebook to use for notebook execution. */ public void setEditorId(String editorId) { this.editorId = editorId; } /** ** The unique identifier of the Amazon EMR Notebook to use for notebook execution. *
* * @return The unique identifier of the Amazon EMR Notebook to use for notebook execution. */ public String getEditorId() { return this.editorId; } /** ** The unique identifier of the Amazon EMR Notebook to use for notebook execution. *
* * @param editorId * The unique identifier of the Amazon EMR Notebook to use for notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withEditorId(String editorId) { setEditorId(editorId); return this; } /** *
* 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
* .
*
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
* .
*/
public void setRelativePath(String relativePath) {
this.relativePath = 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
* .
*
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
* .
*/
public String getRelativePath() {
return this.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
* .
*
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
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public StartNotebookExecutionRequest withRelativePath(String relativePath) {
setRelativePath(relativePath);
return this;
}
/**
* * An optional name for the notebook execution. *
* * @param notebookExecutionName * An optional name for the notebook execution. */ public void setNotebookExecutionName(String notebookExecutionName) { this.notebookExecutionName = notebookExecutionName; } /** ** An optional name for the notebook execution. *
* * @return An optional name for the notebook execution. */ public String getNotebookExecutionName() { return this.notebookExecutionName; } /** ** An optional name for the notebook execution. *
* * @param notebookExecutionName * An optional name for the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withNotebookExecutionName(String notebookExecutionName) { setNotebookExecutionName(notebookExecutionName); return this; } /** ** Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. *
* * @param notebookParams * Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. */ public void setNotebookParams(String notebookParams) { this.notebookParams = notebookParams; } /** ** Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. *
* * @return Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. */ public String getNotebookParams() { return this.notebookParams; } /** ** Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. *
* * @param notebookParams * Input parameters in JSON format passed to the Amazon EMR Notebook at runtime for execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withNotebookParams(String notebookParams) { setNotebookParams(notebookParams); return this; } /** ** Specifies the execution engine (cluster) that runs the notebook execution. *
* * @param executionEngine * Specifies the execution engine (cluster) that runs the notebook execution. */ public void setExecutionEngine(ExecutionEngineConfig executionEngine) { this.executionEngine = executionEngine; } /** ** Specifies the execution engine (cluster) that runs the notebook execution. *
* * @return Specifies the execution engine (cluster) that runs the notebook execution. */ public ExecutionEngineConfig getExecutionEngine() { return this.executionEngine; } /** ** Specifies the execution engine (cluster) that runs the notebook execution. *
* * @param executionEngine * Specifies the execution engine (cluster) that runs the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withExecutionEngine(ExecutionEngineConfig executionEngine) { setExecutionEngine(executionEngine); return this; } /** ** 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. *
* * @param 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. */ public void setServiceRole(String serviceRole) { this.serviceRole = 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. *
* * @return 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. */ public String getServiceRole() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withServiceRole(String serviceRole) { setServiceRole(serviceRole); return this; } /** ** The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. *
* * @param notebookInstanceSecurityGroupId * The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. */ public void setNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId) { this.notebookInstanceSecurityGroupId = notebookInstanceSecurityGroupId; } /** ** The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. *
* * @return The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. */ public String getNotebookInstanceSecurityGroupId() { return this.notebookInstanceSecurityGroupId; } /** ** The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. *
* * @param notebookInstanceSecurityGroupId * The unique identifier of the Amazon EC2 security group to associate with the Amazon EMR Notebook for this * notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId) { setNotebookInstanceSecurityGroupId(notebookInstanceSecurityGroupId); return this; } /** ** 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. *
* * @return 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. */ public java.util.List* 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. *
* * @param 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. */ public void setTags(java.util.Collection* 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. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the * existing values. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withTags(Tag... tags) { if (this.tags == null) { setTags(new com.amazonaws.internal.SdkInternalList* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withTags(java.util.Collection* The Amazon S3 location for the notebook execution input. *
* * @param notebookS3Location * The Amazon S3 location for the notebook execution input. */ public void setNotebookS3Location(NotebookS3LocationFromInput notebookS3Location) { this.notebookS3Location = notebookS3Location; } /** ** The Amazon S3 location for the notebook execution input. *
* * @return The Amazon S3 location for the notebook execution input. */ public NotebookS3LocationFromInput getNotebookS3Location() { return this.notebookS3Location; } /** ** The Amazon S3 location for the notebook execution input. *
* * @param notebookS3Location * The Amazon S3 location for the notebook execution input. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withNotebookS3Location(NotebookS3LocationFromInput notebookS3Location) { setNotebookS3Location(notebookS3Location); return this; } /** ** The Amazon S3 location for the notebook execution output. *
* * @param outputNotebookS3Location * The Amazon S3 location for the notebook execution output. */ public void setOutputNotebookS3Location(OutputNotebookS3LocationFromInput outputNotebookS3Location) { this.outputNotebookS3Location = outputNotebookS3Location; } /** ** The Amazon S3 location for the notebook execution output. *
* * @return The Amazon S3 location for the notebook execution output. */ public OutputNotebookS3LocationFromInput getOutputNotebookS3Location() { return this.outputNotebookS3Location; } /** ** The Amazon S3 location for the notebook execution output. *
* * @param outputNotebookS3Location * The Amazon S3 location for the notebook execution output. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withOutputNotebookS3Location(OutputNotebookS3LocationFromInput outputNotebookS3Location) { setOutputNotebookS3Location(outputNotebookS3Location); return this; } /** ** The output format for the notebook execution. *
* * @param outputNotebookFormat * The output format for the notebook execution. * @see OutputNotebookFormat */ public void setOutputNotebookFormat(String outputNotebookFormat) { this.outputNotebookFormat = outputNotebookFormat; } /** ** The output format for the notebook execution. *
* * @return The output format for the notebook execution. * @see OutputNotebookFormat */ public String getOutputNotebookFormat() { return this.outputNotebookFormat; } /** ** The output format for the notebook execution. *
* * @param outputNotebookFormat * The output format for the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. * @see OutputNotebookFormat */ public StartNotebookExecutionRequest withOutputNotebookFormat(String outputNotebookFormat) { setOutputNotebookFormat(outputNotebookFormat); return this; } /** ** The output format for the notebook execution. *
* * @param outputNotebookFormat * The output format for the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. * @see OutputNotebookFormat */ public StartNotebookExecutionRequest withOutputNotebookFormat(OutputNotebookFormat outputNotebookFormat) { this.outputNotebookFormat = outputNotebookFormat.toString(); return this; } /** ** The environment variables associated with the notebook execution. *
* * @return The environment variables associated with the notebook execution. */ public java.util.Map* The environment variables associated with the notebook execution. *
* * @param environmentVariables * The environment variables associated with the notebook execution. */ public void setEnvironmentVariables(java.util.Map* The environment variables associated with the notebook execution. *
* * @param environmentVariables * The environment variables associated with the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public StartNotebookExecutionRequest withEnvironmentVariables(java.util.Map