Interface StartNotebookRunResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<StartNotebookRunResponse.Builder,StartNotebookRunResponse>, DataZoneResponse.Builder, SdkBuilder<StartNotebookRunResponse.Builder,StartNotebookRunResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

StartNotebookRunResponse

@Mutable
@NotThreadSafe
public static interface StartNotebookRunResponse.Builder
extends DataZoneResponse.Builder, SdkPojo, CopyableBuilder<StartNotebookRunResponse.Builder,StartNotebookRunResponse>

Method Summary

Modifier and Type	Method	Description
StartNotebookRunResponse.Builder	cellOrder(Collection<CellInformation> cellOrder)	The ordered list of cells in the notebook run.
StartNotebookRunResponse.Builder	cellOrder(Consumer<CellInformation.Builder>... cellOrder)	The ordered list of cells in the notebook run.
StartNotebookRunResponse.Builder	cellOrder(CellInformation... cellOrder)	The ordered list of cells in the notebook run.
StartNotebookRunResponse.Builder	completedAt(Instant completedAt)	The timestamp of when the notebook run completed.
default StartNotebookRunResponse.Builder	computeConfiguration(Consumer<ComputeConfig.Builder> computeConfiguration)	The compute configuration of the notebook run.
StartNotebookRunResponse.Builder	computeConfiguration(ComputeConfig computeConfiguration)	The compute configuration of the notebook run.
StartNotebookRunResponse.Builder	createdAt(Instant createdAt)	The timestamp of when the notebook run was created.
StartNotebookRunResponse.Builder	createdBy(String createdBy)	The identifier of the user who created the notebook run.
StartNotebookRunResponse.Builder	domainId(String domainId)	The identifier of the Amazon SageMaker Unified Studio domain.
default StartNotebookRunResponse.Builder	environmentConfiguration(Consumer<EnvironmentConfig.Builder> environmentConfiguration)	The environment configuration of the notebook run, including image version and package settings.
StartNotebookRunResponse.Builder	environmentConfiguration(EnvironmentConfig environmentConfiguration)	The environment configuration of the notebook run, including image version and package settings.
default StartNotebookRunResponse.Builder	error(Consumer<NotebookRunError.Builder> error)	The error details if the notebook run failed.
StartNotebookRunResponse.Builder	error(NotebookRunError error)	The error details if the notebook run failed.
StartNotebookRunResponse.Builder	id(String id)	The identifier of the notebook run.
StartNotebookRunResponse.Builder	metadata(Map<String,String> metadata)	The metadata of the notebook run.
default StartNotebookRunResponse.Builder	networkConfiguration(Consumer<NetworkConfig.Builder> networkConfiguration)	The network configuration of the notebook run.
StartNotebookRunResponse.Builder	networkConfiguration(NetworkConfig networkConfiguration)	The network configuration of the notebook run.
StartNotebookRunResponse.Builder	notebookId(String notebookId)	The identifier of the notebook.
StartNotebookRunResponse.Builder	owningProjectId(String owningProjectId)	The identifier of the project that owns the notebook run.
StartNotebookRunResponse.Builder	parameters(Map<String,String> parameters)	The sensitive parameters of the notebook run.
StartNotebookRunResponse.Builder	scheduleId(String scheduleId)	The identifier of the schedule associated with the notebook run.
StartNotebookRunResponse.Builder	startedAt(Instant startedAt)	The timestamp of when the notebook run started executing.
StartNotebookRunResponse.Builder	status(String status)	The status of the notebook run.
StartNotebookRunResponse.Builder	status(NotebookRunStatus status)	The status of the notebook run.
default StartNotebookRunResponse.Builder	storageConfiguration(Consumer<StorageConfig.Builder> storageConfiguration)	The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.
StartNotebookRunResponse.Builder	storageConfiguration(StorageConfig storageConfiguration)	The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.
default StartNotebookRunResponse.Builder	timeoutConfiguration(Consumer<TimeoutConfig.Builder> timeoutConfiguration)	The timeout configuration of the notebook run.
StartNotebookRunResponse.Builder	timeoutConfiguration(TimeoutConfig timeoutConfiguration)	The timeout configuration of the notebook run.
default StartNotebookRunResponse.Builder	triggerSource(Consumer<TriggerSource.Builder> triggerSource)	The source that triggered the notebook run.
StartNotebookRunResponse.Builder	triggerSource(TriggerSource triggerSource)	The source that triggered the notebook run.
StartNotebookRunResponse.Builder	updatedAt(Instant updatedAt)	The timestamp of when the notebook run was last updated.
StartNotebookRunResponse.Builder	updatedBy(String updatedBy)	The identifier of the user who last updated the notebook run.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.datazone.model.DataZoneResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

id

StartNotebookRunResponse.Builder id(String id)

The identifier of the notebook run.

Parameters:

id - The identifier of the notebook run.

Returns:

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

domainId

StartNotebookRunResponse.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.

owningProjectId

StartNotebookRunResponse.Builder owningProjectId(String owningProjectId)

The identifier of the project that owns the notebook run.

Parameters:

owningProjectId - The identifier of the project that owns the notebook run.

Returns:

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

notebookId

StartNotebookRunResponse.Builder notebookId(String notebookId)

The identifier of the notebook.

Parameters:

notebookId - The identifier of the notebook.

Returns:

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

scheduleId

StartNotebookRunResponse.Builder scheduleId(String scheduleId)

The identifier of the schedule associated with the notebook run.

Parameters:

scheduleId - The identifier of the schedule associated with the notebook run.

Returns:

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

status

StartNotebookRunResponse.Builder status(String status)

The status of the notebook run.

Parameters:

status - The status of the notebook run.

Returns:

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

See Also:

• NotebookRunStatus
• NotebookRunStatus

status

StartNotebookRunResponse.Builder status(NotebookRunStatus status)

The status of the notebook run.

Parameters:

status - The status of the notebook run.

Returns:

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

See Also:

• NotebookRunStatus
• NotebookRunStatus

cellOrder

StartNotebookRunResponse.Builder cellOrder(Collection<CellInformation> cellOrder)

The ordered list of cells in the notebook run.

Parameters:

cellOrder - The ordered list of cells in the notebook run.

Returns:

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

cellOrder

StartNotebookRunResponse.Builder cellOrder(CellInformation... cellOrder)

The ordered list of cells in the notebook run.

Parameters:

cellOrder - The ordered list of cells in the notebook run.

Returns:

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

cellOrder

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

The ordered list of cells in the notebook run.

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:

• cellOrder(java.util.Collection<CellInformation>)

metadata

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

The metadata of the notebook run.

Parameters:

metadata - The metadata of the notebook run.

Returns:

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

parameters

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

The sensitive parameters of the notebook run.

Parameters:

parameters - The sensitive parameters of the notebook run.

Returns:

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

computeConfiguration

StartNotebookRunResponse.Builder computeConfiguration(ComputeConfig computeConfiguration)

The compute configuration of the notebook run.

Parameters:

computeConfiguration - The compute configuration of the notebook run.

Returns:

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

computeConfiguration

default StartNotebookRunResponse.Builder computeConfiguration(Consumer<ComputeConfig.Builder> computeConfiguration)

The compute configuration of the notebook run.

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

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

Parameters:

computeConfiguration - a consumer that will call methods on ComputeConfig.Builder

Returns:

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

See Also:

• computeConfiguration(ComputeConfig)

networkConfiguration

StartNotebookRunResponse.Builder networkConfiguration(NetworkConfig networkConfiguration)

The network configuration of the notebook run.

Parameters:

networkConfiguration - The network configuration of the notebook run.

Returns:

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

networkConfiguration

default StartNotebookRunResponse.Builder networkConfiguration(Consumer<NetworkConfig.Builder> networkConfiguration)

The network configuration of the notebook run.

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

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

Parameters:

networkConfiguration - a consumer that will call methods on NetworkConfig.Builder

Returns:

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

See Also:

• networkConfiguration(NetworkConfig)

timeoutConfiguration

StartNotebookRunResponse.Builder timeoutConfiguration(TimeoutConfig timeoutConfiguration)

The timeout configuration of the notebook run.

Parameters:

timeoutConfiguration - The timeout configuration of the notebook run.

Returns:

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

timeoutConfiguration

default StartNotebookRunResponse.Builder timeoutConfiguration(Consumer<TimeoutConfig.Builder> timeoutConfiguration)

The timeout configuration of the notebook run.

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

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

Parameters:

timeoutConfiguration - a consumer that will call methods on TimeoutConfig.Builder

Returns:

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

See Also:

• timeoutConfiguration(TimeoutConfig)

environmentConfiguration

StartNotebookRunResponse.Builder environmentConfiguration(EnvironmentConfig environmentConfiguration)

The environment configuration of the notebook run, including image version and package settings.

Parameters:

environmentConfiguration - The environment configuration of the notebook run, including image version and package settings.

Returns:

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

environmentConfiguration

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

The environment configuration of the notebook run, including image version and package settings.

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:

• environmentConfiguration(EnvironmentConfig)

storageConfiguration

StartNotebookRunResponse.Builder storageConfiguration(StorageConfig storageConfiguration)

The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

Parameters:

storageConfiguration - The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

Returns:

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

storageConfiguration

default StartNotebookRunResponse.Builder storageConfiguration(Consumer<StorageConfig.Builder> storageConfiguration)

The storage configuration of the notebook run, including the Amazon Simple Storage Service path and KMS key ARN.

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

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

Parameters:

storageConfiguration - a consumer that will call methods on StorageConfig.Builder

Returns:

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

See Also:

• storageConfiguration(StorageConfig)

triggerSource

StartNotebookRunResponse.Builder triggerSource(TriggerSource triggerSource)

The source that triggered the notebook run.

Parameters:

triggerSource - The source that triggered the notebook run.

Returns:

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

triggerSource

default StartNotebookRunResponse.Builder triggerSource(Consumer<TriggerSource.Builder> triggerSource)

The source that triggered the notebook run.

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

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

Parameters:

triggerSource - a consumer that will call methods on TriggerSource.Builder

Returns:

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

See Also:

• triggerSource(TriggerSource)

error

StartNotebookRunResponse.Builder error(NotebookRunError error)

The error details if the notebook run failed.

Parameters:

error - The error details if the notebook run failed.

Returns:

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

error

default StartNotebookRunResponse.Builder error(Consumer<NotebookRunError.Builder> error)

The error details if the notebook run failed.

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

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

Parameters:

error - a consumer that will call methods on NotebookRunError.Builder

Returns:

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

See Also:

• error(NotebookRunError)

createdAt

StartNotebookRunResponse.Builder createdAt(Instant createdAt)

The timestamp of when the notebook run was created.

Parameters:

createdAt - The timestamp of when the notebook run was created.

Returns:

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

createdBy

StartNotebookRunResponse.Builder createdBy(String createdBy)

The identifier of the user who created the notebook run.

Parameters:

createdBy - The identifier of the user who created the notebook run.

Returns:

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

updatedAt

StartNotebookRunResponse.Builder updatedAt(Instant updatedAt)

The timestamp of when the notebook run was last updated.

Parameters:

updatedAt - The timestamp of when the notebook run was last updated.

Returns:

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

updatedBy

StartNotebookRunResponse.Builder updatedBy(String updatedBy)

The identifier of the user who last updated the notebook run.

Parameters:

updatedBy - The identifier of the user who last updated the notebook run.

Returns:

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

startedAt

StartNotebookRunResponse.Builder startedAt(Instant startedAt)

The timestamp of when the notebook run started executing.

Parameters:

startedAt - The timestamp of when the notebook run started executing.

Returns:

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

completedAt

StartNotebookRunResponse.Builder completedAt(Instant completedAt)

The timestamp of when the notebook run completed.

Parameters:

completedAt - The timestamp of when the notebook run completed.

Returns:

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