Interface GetNotebookResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<GetNotebookResponse.Builder,GetNotebookResponse>, DataZoneResponse.Builder, SdkBuilder<GetNotebookResponse.Builder,GetNotebookResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetNotebookResponse
@Mutable @NotThreadSafe public static interface GetNotebookResponse.Builder extends DataZoneResponse.Builder, SdkPojo, CopyableBuilder<GetNotebookResponse.Builder,GetNotebookResponse>

  • Method Details

    • id

      GetNotebookResponse.Builder id(String id)

      The identifier of the notebook.

      Parameters:
      id - The identifier of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetNotebookResponse.Builder name(String name)

      The name of the notebook.

      Parameters:
      name - The name of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owningProjectId

      GetNotebookResponse.Builder owningProjectId(String owningProjectId)

      The identifier of the project that owns the notebook.

      Parameters:
      owningProjectId - The identifier of the project that owns the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • domainId

      GetNotebookResponse.Builder domainId(String domainId)

      The identifier of the Amazon SageMaker Unified Studio domain.

      Parameters:
      domainId - The identifier of the Amazon SageMaker Unified Studio domain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cellOrder

      GetNotebookResponse.Builder cellOrder(Collection<CellInformation> cellOrder)

      The ordered list of cells in the notebook.

      Parameters:
      cellOrder - The ordered list of cells in the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cellOrder

      GetNotebookResponse.Builder cellOrder(CellInformation... cellOrder)

      The ordered list of cells in the notebook.

      Parameters:
      cellOrder - The ordered list of cells in the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • cellOrder

      GetNotebookResponse.Builder cellOrder(Consumer<CellInformation.Builder>... cellOrder)

      The ordered list of cells in the notebook.

      This is a convenience method that creates an instance of the CellInformation.Builder avoiding the need to create one manually via CellInformation.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to cellOrder(List<CellInformation>).

      Parameters:
      cellOrder - a consumer that will call methods on CellInformation.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetNotebookResponse.Builder status(String status)

      The status of the notebook.

      Parameters:
      status - The status of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetNotebookResponse.Builder status(NotebookStatus status)

      The status of the notebook.

      Parameters:
      status - The status of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      GetNotebookResponse.Builder description(String description)

      The description of the notebook.

      Parameters:
      description - The description of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      GetNotebookResponse.Builder createdAt(Instant createdAt)

      The timestamp of when the notebook was created.

      Parameters:
      createdAt - The timestamp of when the notebook was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdBy

      GetNotebookResponse.Builder createdBy(String createdBy)

      The identifier of the user who created the notebook.

      Parameters:
      createdBy - The identifier of the user who created the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetNotebookResponse.Builder updatedAt(Instant updatedAt)

      The timestamp of when the notebook was last updated.

      Parameters:
      updatedAt - The timestamp of when the notebook was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedBy

      GetNotebookResponse.Builder updatedBy(String updatedBy)

      The identifier of the user who last updated the notebook.

      Parameters:
      updatedBy - The identifier of the user who last updated the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockedBy

      GetNotebookResponse.Builder lockedBy(String lockedBy)

      The identifier of the user who locked the notebook.

      Parameters:
      lockedBy - The identifier of the user who locked the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockedAt

      GetNotebookResponse.Builder lockedAt(Instant lockedAt)

      The timestamp of when the notebook was locked.

      Parameters:
      lockedAt - The timestamp of when the notebook was locked.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockExpiresAt

      GetNotebookResponse.Builder lockExpiresAt(Instant lockExpiresAt)

      The timestamp of when the notebook lock expires.

      Parameters:
      lockExpiresAt - The timestamp of when the notebook lock expires.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeId

      GetNotebookResponse.Builder computeId(String computeId)

      The identifier of the compute associated with the notebook.

      Parameters:
      computeId - The identifier of the compute associated with the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadata

      GetNotebookResponse.Builder metadata(Map<String,String> metadata)

      The metadata of the notebook.

      Parameters:
      metadata - The metadata of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

      GetNotebookResponse.Builder parameters(Map<String,String> parameters)

      The sensitive parameters of the notebook.

      Parameters:
      parameters - The sensitive parameters of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentConfiguration

      GetNotebookResponse.Builder environmentConfiguration(EnvironmentConfig environmentConfiguration)

      The environment configuration of the notebook.

      Parameters:
      environmentConfiguration - The environment configuration of the notebook.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • environmentConfiguration

      default GetNotebookResponse.Builder environmentConfiguration(Consumer<EnvironmentConfig.Builder> environmentConfiguration)

      The environment configuration of the notebook.

      This is a convenience method that creates an instance of the EnvironmentConfig.Builder avoiding the need to create one manually via EnvironmentConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to environmentConfiguration(EnvironmentConfig).

      Parameters:
      environmentConfiguration - a consumer that will call methods on EnvironmentConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • error

      GetNotebookResponse.Builder error(NotebookError error)

      The error details if the notebook is in a failed state.

      Parameters:
      error - The error details if the notebook is in a failed state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • error

      default GetNotebookResponse.Builder error(Consumer<NotebookError.Builder> error)

      The error details if the notebook is in a failed state.

      This is a convenience method that creates an instance of the NotebookError.Builder avoiding the need to create one manually via NotebookError.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to error(NotebookError).

      Parameters:
      error - a consumer that will call methods on NotebookError.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: