Class ListNotebookExecutionsRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListNotebookExecutionsRequest.Builder,
ListNotebookExecutionsRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
editorId()
The unique ID of the editor 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 String
The unique ID of the execution engine.final Instant
from()
The beginning of time range filter for listing notebook executions.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final String
marker()
The pagination token, returned by a previousListNotebookExecutions
call, that indicates the start of the list for thisListNotebookExecutions
call.static Class
<? extends ListNotebookExecutionsRequest.Builder> final NotebookExecutionStatus
status()
The status filter for listing notebook executions.final String
The status filter for listing notebook executions.final Instant
to()
The end of time range filter for listing notebook executions.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 ID of the editor associated with the notebook execution.
- Returns:
- The unique ID of the editor associated with the notebook execution.
-
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
If the service returns an enum value that is not available in the current SDK version,
status
will returnNotebookExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
-
- See Also:
-
-
statusAsString
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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
If the service returns an enum value that is not available in the current SDK version,
status
will returnNotebookExecutionStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- 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 aStopNotebookExecution
request and the stop is pending. -
STOPPING
indicates that the cluster is in the process of stopping the execution as a result of aStopNotebookExecution
request. -
STOPPED
indicates that the execution stopped because of aStopNotebookExecution
request.
-
- See Also:
-
-
from
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.
-
to
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.
-
marker
The pagination token, returned by a previous
ListNotebookExecutions
call, that indicates the start of the list for thisListNotebookExecutions
call.- Returns:
- The pagination token, returned by a previous
ListNotebookExecutions
call, that indicates the start of the list for thisListNotebookExecutions
call.
-
executionEngineId
The unique ID of the execution engine.
- Returns:
- The unique ID of the execution engine.
-
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<ListNotebookExecutionsRequest.Builder,
ListNotebookExecutionsRequest> - 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
-