/* * 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.protocol.StructuredPojo; import com.amazonaws.protocol.ProtocolMarshaller; /** *
* A notebook execution. An execution is a specific instance that an Amazon EMR Notebook is run using the
* StartNotebookExecution
action.
*
* The unique identifier of a notebook execution. *
*/ private String notebookExecutionId; /** ** The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. *
*/ private String editorId; /** ** The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook * execution. *
*/ private ExecutionEngineConfig executionEngine; /** ** A 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; /** ** The status of the notebook execution. *
*
* START_PENDING
indicates that the cluster has received the execution request but execution has not
* begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
* and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* The timestamp when notebook execution started. *
*/ private java.util.Date startTime; /** ** The timestamp when notebook execution ended. *
*/ private java.util.Date endTime; /** ** The Amazon Resource Name (ARN) of the notebook execution. *
*/ private String arn; /** ** The location of the notebook execution's output file in Amazon S3. *
*/ private String outputNotebookURI; /** ** The reason for the latest status change of the notebook execution. *
*/ private String lastStateChangeReason; /** ** The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more * information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide. *
*/ 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 that stores the notebook execution input. *
*/ private NotebookS3LocationForOutput notebookS3Location; /** ** The Amazon S3 location for the notebook execution output. *
*/ private OutputNotebookS3LocationForOutput 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 a notebook execution. *
* * @param notebookExecutionId * The unique identifier of a notebook execution. */ public void setNotebookExecutionId(String notebookExecutionId) { this.notebookExecutionId = notebookExecutionId; } /** ** The unique identifier of a notebook execution. *
* * @return The unique identifier of a notebook execution. */ public String getNotebookExecutionId() { return this.notebookExecutionId; } /** ** The unique identifier of a notebook execution. *
* * @param notebookExecutionId * The unique identifier of a notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withNotebookExecutionId(String notebookExecutionId) { setNotebookExecutionId(notebookExecutionId); return this; } /** ** The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. *
* * @param editorId * The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. */ public void setEditorId(String editorId) { this.editorId = editorId; } /** ** The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. *
* * @return The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. */ public String getEditorId() { return this.editorId; } /** ** The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. *
* * @param editorId * The unique identifier of the Amazon EMR Notebook that is used for the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withEditorId(String editorId) { setEditorId(editorId); return this; } /** ** The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook * execution. *
* * @param executionEngine * The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the * notebook execution. */ public void setExecutionEngine(ExecutionEngineConfig executionEngine) { this.executionEngine = executionEngine; } /** ** The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook * execution. *
* * @return The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the * notebook execution. */ public ExecutionEngineConfig getExecutionEngine() { return this.executionEngine; } /** ** The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the notebook * execution. *
* * @param executionEngine * The execution engine, such as an Amazon EMR cluster, used to run the Amazon EMR notebook and perform the * notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withExecutionEngine(ExecutionEngineConfig executionEngine) { setExecutionEngine(executionEngine); return this; } /** ** A name for the notebook execution. *
* * @param notebookExecutionName * A name for the notebook execution. */ public void setNotebookExecutionName(String notebookExecutionName) { this.notebookExecutionName = notebookExecutionName; } /** ** A name for the notebook execution. *
* * @return A name for the notebook execution. */ public String getNotebookExecutionName() { return this.notebookExecutionName; } /** ** A name for the notebook execution. *
* * @param notebookExecutionName * A name for the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution 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 NotebookExecution withNotebookParams(String notebookParams) { setNotebookParams(notebookParams); return this; } /** ** The status of the notebook execution. *
*
* START_PENDING
indicates that the cluster has received the execution request but execution has not
* begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
* and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* START_PENDING
indicates that the cluster has received the execution request but execution has
* not begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* The status of the notebook execution. *
*
* START_PENDING
indicates that the cluster has received the execution request but execution has not
* begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
* and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* START_PENDING
indicates that the cluster has received the execution request but execution
* has not begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* The status of the notebook execution. *
*
* START_PENDING
indicates that the cluster has received the execution request but execution has not
* begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
* and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* START_PENDING
indicates that the cluster has received the execution request but execution has
* not begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* The status of the notebook execution. *
*
* START_PENDING
indicates that the cluster has received the execution request but execution has not
* begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
request
* and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result of a
* StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* START_PENDING
indicates that the cluster has received the execution request but execution has
* not begun.
*
* STARTING
indicates that the execution is starting on the cluster.
*
* RUNNING
indicates that the execution is being processed by the cluster.
*
* FINISHING
indicates that execution processing is in the final stages.
*
* FINISHED
indicates that the execution has completed without error.
*
* FAILING
indicates that the execution is failing and will not finish successfully.
*
* FAILED
indicates that the execution failed.
*
* STOP_PENDING
indicates that the cluster has received a StopNotebookExecution
* request and the stop is pending.
*
* STOPPING
indicates that the cluster is in the process of stopping the execution as a result
* of a StopNotebookExecution
request.
*
* STOPPED
indicates that the execution stopped because of a StopNotebookExecution
* request.
*
* The timestamp when notebook execution started. *
* * @param startTime * The timestamp when notebook execution started. */ public void setStartTime(java.util.Date startTime) { this.startTime = startTime; } /** ** The timestamp when notebook execution started. *
* * @return The timestamp when notebook execution started. */ public java.util.Date getStartTime() { return this.startTime; } /** ** The timestamp when notebook execution started. *
* * @param startTime * The timestamp when notebook execution started. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withStartTime(java.util.Date startTime) { setStartTime(startTime); return this; } /** ** The timestamp when notebook execution ended. *
* * @param endTime * The timestamp when notebook execution ended. */ public void setEndTime(java.util.Date endTime) { this.endTime = endTime; } /** ** The timestamp when notebook execution ended. *
* * @return The timestamp when notebook execution ended. */ public java.util.Date getEndTime() { return this.endTime; } /** ** The timestamp when notebook execution ended. *
* * @param endTime * The timestamp when notebook execution ended. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withEndTime(java.util.Date endTime) { setEndTime(endTime); return this; } /** ** The Amazon Resource Name (ARN) of the notebook execution. *
* * @param arn * The Amazon Resource Name (ARN) of the notebook execution. */ public void setArn(String arn) { this.arn = arn; } /** ** The Amazon Resource Name (ARN) of the notebook execution. *
* * @return The Amazon Resource Name (ARN) of the notebook execution. */ public String getArn() { return this.arn; } /** ** The Amazon Resource Name (ARN) of the notebook execution. *
* * @param arn * The Amazon Resource Name (ARN) of the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withArn(String arn) { setArn(arn); return this; } /** ** The location of the notebook execution's output file in Amazon S3. *
* * @param outputNotebookURI * The location of the notebook execution's output file in Amazon S3. */ public void setOutputNotebookURI(String outputNotebookURI) { this.outputNotebookURI = outputNotebookURI; } /** ** The location of the notebook execution's output file in Amazon S3. *
* * @return The location of the notebook execution's output file in Amazon S3. */ public String getOutputNotebookURI() { return this.outputNotebookURI; } /** ** The location of the notebook execution's output file in Amazon S3. *
* * @param outputNotebookURI * The location of the notebook execution's output file in Amazon S3. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withOutputNotebookURI(String outputNotebookURI) { setOutputNotebookURI(outputNotebookURI); return this; } /** ** The reason for the latest status change of the notebook execution. *
* * @param lastStateChangeReason * The reason for the latest status change of the notebook execution. */ public void setLastStateChangeReason(String lastStateChangeReason) { this.lastStateChangeReason = lastStateChangeReason; } /** ** The reason for the latest status change of the notebook execution. *
* * @return The reason for the latest status change of the notebook execution. */ public String getLastStateChangeReason() { return this.lastStateChangeReason; } /** ** The reason for the latest status change of the notebook execution. *
* * @param lastStateChangeReason * The reason for the latest status change of the notebook execution. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withLastStateChangeReason(String lastStateChangeReason) { setLastStateChangeReason(lastStateChangeReason); return this; } /** ** The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more * information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide. *
* * @param notebookInstanceSecurityGroupId * The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. * For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management * Guide. */ public void setNotebookInstanceSecurityGroupId(String notebookInstanceSecurityGroupId) { this.notebookInstanceSecurityGroupId = notebookInstanceSecurityGroupId; } /** ** The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more * information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide. *
* * @return The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. * For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management * Guide. */ public String getNotebookInstanceSecurityGroupId() { return this.notebookInstanceSecurityGroupId; } /** ** The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. For more * information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management Guide. *
* * @param notebookInstanceSecurityGroupId * The unique identifier of the Amazon EC2 security group associated with the Amazon EMR Notebook instance. * For more information see Specifying Amazon EC2 Security Groups for Amazon EMR Notebooks in the Amazon EMR Management * Guide. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution 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 NotebookExecution 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 NotebookExecution withTags(java.util.Collection* The Amazon S3 location that stores the notebook execution input. *
* * @param notebookS3Location * The Amazon S3 location that stores the notebook execution input. */ public void setNotebookS3Location(NotebookS3LocationForOutput notebookS3Location) { this.notebookS3Location = notebookS3Location; } /** ** The Amazon S3 location that stores the notebook execution input. *
* * @return The Amazon S3 location that stores the notebook execution input. */ public NotebookS3LocationForOutput getNotebookS3Location() { return this.notebookS3Location; } /** ** The Amazon S3 location that stores the notebook execution input. *
* * @param notebookS3Location * The Amazon S3 location that stores the notebook execution input. * @return Returns a reference to this object so that method calls can be chained together. */ public NotebookExecution withNotebookS3Location(NotebookS3LocationForOutput 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(OutputNotebookS3LocationForOutput outputNotebookS3Location) { this.outputNotebookS3Location = outputNotebookS3Location; } /** ** The Amazon S3 location for the notebook execution output. *
* * @return The Amazon S3 location for the notebook execution output. */ public OutputNotebookS3LocationForOutput 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 NotebookExecution withOutputNotebookS3Location(OutputNotebookS3LocationForOutput 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 NotebookExecution 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 NotebookExecution 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 NotebookExecution withEnvironmentVariables(java.util.Map