NotebookExecutionSummary (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.795

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.elasticmapreduce.model

Class NotebookExecutionSummary

java.lang.Object
- com.amazonaws.services.elasticmapreduce.model.NotebookExecutionSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NotebookExecutionSummary
extends Object
implements Serializable, Cloneable, StructuredPojo 
```
Details for a notebook execution. The details include information such as the unique ID and status of the notebook execution.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NotebookExecutionSummary ()

Constructors
Constructor and Description
`NotebookExecutionSummary ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`NotebookExecutionSummary`	`clone ()`
`boolean`	`equals (Object obj)`
`String`	`getEditorId ()` The unique identifier of the editor associated with the notebook execution.
`Date`	`getEndTime ()` The timestamp when notebook execution started.
`String`	`getExecutionEngineId ()` The unique ID of the execution engine for the notebook execution.
`String`	`getNotebookExecutionId ()` The unique identifier of the notebook execution.
`String`	`getNotebookExecutionName ()` The name of the notebook execution.
`NotebookS3LocationForOutput`	`getNotebookS3Location ()` The Amazon S3 location that stores the notebook execution input.
`Date`	`getStartTime ()` The timestamp when notebook execution started.
`String`	`getStatus ()` The status of the notebook execution.
`int`	`hashCode ()`
`void`	`marshall (ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEditorId (String editorId)` The unique identifier of the editor associated with the notebook execution.
`void`	`setEndTime (Date endTime)` The timestamp when notebook execution started.
`void`	`setExecutionEngineId (String executionEngineId)` The unique ID of the execution engine for the notebook execution.
`void`	`setNotebookExecutionId (String notebookExecutionId)` The unique identifier of the notebook execution.
`void`	`setNotebookExecutionName (String notebookExecutionName)` The name of the notebook execution.
`void`	`setNotebookS3Location (NotebookS3LocationForOutput notebookS3Location)` The Amazon S3 location that stores the notebook execution input.
`void`	`setStartTime (Date startTime)` The timestamp when notebook execution started.
`void`	`setStatus (String status)` The status of the notebook execution.
`String`	`toString ()` Returns a string representation of this object.
`NotebookExecutionSummary`	`withEditorId (String editorId)` The unique identifier of the editor associated with the notebook execution.
`NotebookExecutionSummary`	`withEndTime (Date endTime)` The timestamp when notebook execution started.
`NotebookExecutionSummary`	`withExecutionEngineId (String executionEngineId)` The unique ID of the execution engine for the notebook execution.
`NotebookExecutionSummary`	`withNotebookExecutionId (String notebookExecutionId)` The unique identifier of the notebook execution.
`NotebookExecutionSummary`	`withNotebookExecutionName (String notebookExecutionName)` The name of the notebook execution.
`NotebookExecutionSummary`	`withNotebookS3Location (NotebookS3LocationForOutput notebookS3Location)` The Amazon S3 location that stores the notebook execution input.
`NotebookExecutionSummary`	`withStartTime (Date startTime)` The timestamp when notebook execution started.
`NotebookExecutionSummary`	`withStatus (NotebookExecutionStatus status)` The status of the notebook execution.
`NotebookExecutionSummary`	`withStatus (String status)` The status of the notebook execution.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NotebookExecutionSummary
```
public NotebookExecutionSummary()
```
- Method Detail
  - setNotebookExecutionId
```
public void setNotebookExecutionId(String notebookExecutionId)
```
    The unique identifier of the notebook execution.
    
    Parameters:
    
    notebookExecutionId - The unique identifier of the notebook execution.
  - getNotebookExecutionId
```
public String getNotebookExecutionId()
```
    The unique identifier of the notebook execution.
    
    Returns:
    
    The unique identifier of the notebook execution.
  - withNotebookExecutionId
```
public NotebookExecutionSummary withNotebookExecutionId(String notebookExecutionId)
```
    The unique identifier of the notebook execution.
    
    Parameters:
    
    notebookExecutionId - The unique identifier of the notebook execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEditorId
```
public void setEditorId(String editorId)
```
    The unique identifier of the editor associated with the notebook execution.
    
    Parameters:
    
    editorId - The unique identifier of the editor associated with the notebook execution.
  - getEditorId
```
public String getEditorId()
```
    The unique identifier of the editor associated with the notebook execution.
    
    Returns:
    
    The unique identifier of the editor associated with the notebook execution.
  - withEditorId
```
public NotebookExecutionSummary withEditorId(String editorId)
```
    The unique identifier of the editor associated with the notebook execution.
    
    Parameters:
    
    editorId - The unique identifier of the editor associated with the notebook execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookExecutionName
```
public void setNotebookExecutionName(String notebookExecutionName)
```
    The name of the notebook execution.
    
    Parameters:
    
    notebookExecutionName - The name of the notebook execution.
  - getNotebookExecutionName
```
public String getNotebookExecutionName()
```
    The name of the notebook execution.
    
    Returns:
    
    The name of the notebook execution.
  - withNotebookExecutionName
```
public NotebookExecutionSummary withNotebookExecutionName(String notebookExecutionName)
```
    The name of the notebook execution.
    
    Parameters:
    
    notebookExecutionName - The name of the notebook execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String status)
```
    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.
    Parameters:
    status - 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.
    See Also:
    
    NotebookExecutionStatus
  - getStatus
```
public String getStatus()
```
    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.
    Returns:
    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.
    See Also:
    
    NotebookExecutionStatus
  - withStatus
```
public NotebookExecutionSummary withStatus(String status)
```
    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.
    Parameters:
    status - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookExecutionStatus
  - withStatus
```
public NotebookExecutionSummary withStatus(NotebookExecutionStatus status)
```
    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.
    Parameters:
    status - 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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookExecutionStatus
  - setStartTime
```
public void setStartTime(Date startTime)
```
    The timestamp when notebook execution started.
    
    Parameters:
    
    startTime - The timestamp when notebook execution started.
  - getStartTime
```
public Date getStartTime()
```
    The timestamp when notebook execution started.
    
    Returns:
    
    The timestamp when notebook execution started.
  - withStartTime
```
public NotebookExecutionSummary withStartTime(Date startTime)
```
    The timestamp when notebook execution started.
    
    Parameters:
    
    startTime - The timestamp when notebook execution started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEndTime
```
public void setEndTime(Date endTime)
```
    The timestamp when notebook execution started.
    
    Parameters:
    
    endTime - The timestamp when notebook execution started.
  - getEndTime
```
public Date getEndTime()
```
    The timestamp when notebook execution started.
    
    Returns:
    
    The timestamp when notebook execution started.
  - withEndTime
```
public NotebookExecutionSummary withEndTime(Date endTime)
```
    The timestamp when notebook execution started.
    
    Parameters:
    
    endTime - The timestamp when notebook execution started.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookS3Location
```
public void setNotebookS3Location(NotebookS3LocationForOutput notebookS3Location)
```
    The Amazon S3 location that stores the notebook execution input.
    
    Parameters:
    
    notebookS3Location - The Amazon S3 location that stores the notebook execution input.
  - getNotebookS3Location
```
public NotebookS3LocationForOutput getNotebookS3Location()
```
    The Amazon S3 location that stores the notebook execution input.
    
    Returns:
    
    The Amazon S3 location that stores the notebook execution input.
  - withNotebookS3Location
```
public NotebookExecutionSummary withNotebookS3Location(NotebookS3LocationForOutput notebookS3Location)
```
    The Amazon S3 location that stores the notebook execution input.
    
    Parameters:
    
    notebookS3Location - The Amazon S3 location that stores the notebook execution input.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setExecutionEngineId
```
public void setExecutionEngineId(String executionEngineId)
```
    The unique ID of the execution engine for the notebook execution.
    
    Parameters:
    
    executionEngineId - The unique ID of the execution engine for the notebook execution.
  - getExecutionEngineId
```
public String getExecutionEngineId()
```
    The unique ID of the execution engine for the notebook execution.
    
    Returns:
    
    The unique ID of the execution engine for the notebook execution.
  - withExecutionEngineId
```
public NotebookExecutionSummary withExecutionEngineId(String executionEngineId)
```
    The unique ID of the execution engine for the notebook execution.
    
    Parameters:
    
    executionEngineId - The unique ID of the execution engine for the notebook execution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public NotebookExecutionSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.795

Class NotebookExecutionSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NotebookExecutionSummary

Method Detail

setNotebookExecutionId

getNotebookExecutionId

withNotebookExecutionId

setEditorId

getEditorId

withEditorId

setNotebookExecutionName

getNotebookExecutionName

withNotebookExecutionName

setStatus

getStatus

withStatus

withStatus

setStartTime

getStartTime

withStartTime

setEndTime

getEndTime

withEndTime

setNotebookS3Location

getNotebookS3Location

withNotebookS3Location

setExecutionEngineId

getExecutionEngineId

withExecutionEngineId

toString

equals

hashCode

clone

marshall