Interface ListNotebookExecutionsRequest.Builder

    • Method Detail

      • editorId

        ListNotebookExecutionsRequest.Builder editorId​(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.
      • status

        ListNotebookExecutionsRequest.Builder status​(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, NotebookExecutionStatus
      • status

        ListNotebookExecutionsRequest.Builder status​(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, NotebookExecutionStatus
      • from

        ListNotebookExecutionsRequest.Builder from​(Instant 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.
      • to

        ListNotebookExecutionsRequest.Builder to​(Instant 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.
      • marker

        ListNotebookExecutionsRequest.Builder marker​(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.
      • executionEngineId

        ListNotebookExecutionsRequest.Builder executionEngineId​(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.