com.amazonaws.services.elasticmapreduce.model

Class ListNotebookExecutionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.elasticmapreduce.model.ListNotebookExecutionsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListNotebookExecutionsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ListNotebookExecutionsRequest()

Method Summary

Modifier and Type	Method and Description
ListNotebookExecutionsRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getEditorId() The unique ID of the editor associated with the notebook execution.
String	getExecutionEngineId() The unique ID of the execution engine.
Date	getFrom() The beginning of time range filter for listing notebook executions.
String	getMarker() The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.
String	getStatus() The status filter for listing notebook executions.
Date	getTo() The end of time range filter for listing notebook executions.
int	hashCode()
void	setEditorId(String editorId) The unique ID of the editor associated with the notebook execution.
void	setExecutionEngineId(String executionEngineId) The unique ID of the execution engine.
void	setFrom(Date from) The beginning of time range filter for listing notebook executions.
void	setMarker(String marker) The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.
void	setStatus(String status) The status filter for listing notebook executions.
void	setTo(Date to) The end of time range filter for listing notebook executions.
String	toString() Returns a string representation of this object.
ListNotebookExecutionsRequest	withEditorId(String editorId) The unique ID of the editor associated with the notebook execution.
ListNotebookExecutionsRequest	withExecutionEngineId(String executionEngineId) The unique ID of the execution engine.
ListNotebookExecutionsRequest	withFrom(Date from) The beginning of time range filter for listing notebook executions.
ListNotebookExecutionsRequest	withMarker(String marker) The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.
ListNotebookExecutionsRequest	withStatus(NotebookExecutionStatus status) The status filter for listing notebook executions.
ListNotebookExecutionsRequest	withStatus(String status) The status filter for listing notebook executions.
ListNotebookExecutionsRequest	withTo(Date to) The end of time range filter for listing notebook executions.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListNotebookExecutionsRequest

public ListNotebookExecutionsRequest()

Method Detail

setEditorId

public void setEditorId(String editorId)

The unique ID of the editor associated with the notebook execution.

Parameters:

editorId - The unique ID of the editor associated with the notebook execution.

getEditorId

public String getEditorId()

The unique ID of the editor associated with the notebook execution.

Returns:

The unique ID of the editor associated with the notebook execution.

withEditorId

public ListNotebookExecutionsRequest withEditorId(String editorId)

The unique ID of the editor associated with the notebook execution.

Parameters:

editorId - The unique ID of the editor associated with 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 filter for listing notebook executions.

• 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 filter for listing notebook executions.

• 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 filter for listing notebook executions.

• 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 filter for listing notebook executions.

• 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 ListNotebookExecutionsRequest withStatus(String status)

The status filter for listing notebook executions.

• 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 filter for listing notebook executions.

• 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 ListNotebookExecutionsRequest withStatus(NotebookExecutionStatus status)

The status filter for listing notebook executions.

• 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 filter for listing notebook executions.

• 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

setFrom

public void setFrom(Date from)

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

Parameters:

from - The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

getFrom

public Date getFrom()

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

Returns:

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

withFrom

public ListNotebookExecutionsRequest withFrom(Date from)

The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

Parameters:

from - The beginning of time range filter for listing notebook executions. The default is the timestamp of 30 days ago.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTo

public void setTo(Date to)

The end of time range filter for listing notebook executions. The default is the current timestamp.

Parameters:

to - The end of time range filter for listing notebook executions. The default is the current timestamp.

getTo

public Date getTo()

The end of time range filter for listing notebook executions. The default is the current timestamp.

Returns:

The end of time range filter for listing notebook executions. The default is the current timestamp.

withTo

public ListNotebookExecutionsRequest withTo(Date to)

The end of time range filter for listing notebook executions. The default is the current timestamp.

Parameters:

to - The end of time range filter for listing notebook executions. The default is the current timestamp.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMarker

public void setMarker(String marker)

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Parameters:

marker - The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

getMarker

public String getMarker()

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Returns:

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

withMarker

public ListNotebookExecutionsRequest withMarker(String marker)

The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

Parameters:

marker - The pagination token, returned by a previous ListNotebookExecutions call, that indicates the start of the list for this ListNotebookExecutions call.

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.

Parameters:

executionEngineId - The unique ID of the execution engine.

getExecutionEngineId

public String getExecutionEngineId()

The unique ID of the execution engine.

Returns:

The unique ID of the execution engine.

withExecutionEngineId

public ListNotebookExecutionsRequest withExecutionEngineId(String executionEngineId)

The unique ID of the execution engine.

Parameters:

executionEngineId - The unique ID of the execution engine.

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 ListNotebookExecutionsRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()