Interface StartNotebookRunRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>, DataZoneRequest.Builder, SdkBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartNotebookRunRequest
@Mutable @NotThreadSafe public static interface StartNotebookRunRequest.Builder extends DataZoneRequest.Builder, SdkPojo, CopyableBuilder<StartNotebookRunRequest.Builder,StartNotebookRunRequest>

  • Method Details

    • domainIdentifier

      StartNotebookRunRequest.Builder domainIdentifier(String domainIdentifier)

      The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.

      Parameters:
      domainIdentifier - The identifier of the Amazon SageMaker Unified Studio domain in which the notebook run is started.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • owningProjectIdentifier

      StartNotebookRunRequest.Builder owningProjectIdentifier(String owningProjectIdentifier)

      The identifier of the project that owns the notebook run.

      Parameters:
      owningProjectIdentifier - 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.

    • notebookIdentifier

      StartNotebookRunRequest.Builder notebookIdentifier(String notebookIdentifier)

      The identifier of the notebook to run.

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

    • scheduleIdentifier

      StartNotebookRunRequest.Builder scheduleIdentifier(String scheduleIdentifier)

      The identifier of the schedule associated with the notebook run.

      Parameters:
      scheduleIdentifier - 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.

    • computeConfiguration

      StartNotebookRunRequest.Builder computeConfiguration(ComputeConfig computeConfiguration)

      The compute configuration for the notebook run, including instance type and environment version.

      Parameters:
      computeConfiguration - The compute configuration for the notebook run, including instance type and environment version.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • computeConfiguration

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

      The compute configuration for the notebook run, including instance type and environment version.

      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:

    • networkConfiguration

      StartNotebookRunRequest.Builder networkConfiguration(NetworkConfig networkConfiguration)

      The network configuration for the notebook run, including network access type and optional VPC settings.

      Parameters:
      networkConfiguration - The network configuration for the notebook run, including network access type and optional VPC settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • networkConfiguration

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

      The network configuration for the notebook run, including network access type and optional VPC settings.

      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:

    • timeoutConfiguration

      StartNotebookRunRequest.Builder timeoutConfiguration(TimeoutConfig timeoutConfiguration)

      The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

      Parameters:
      timeoutConfiguration - The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeoutConfiguration

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

      The timeout configuration for the notebook run. The default timeout is 720 minutes (12 hours) and the maximum is 1440 minutes (24 hours).

      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:

    • triggerSource

      StartNotebookRunRequest.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 StartNotebookRunRequest.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:

    • metadata

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

      The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

      Parameters:
      metadata - The metadata for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parameters

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

      The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.

      Parameters:
      parameters - The sensitive parameters for the notebook run, specified as key-value pairs. You can specify up to 50 entries, with keys up to 128 characters and values up to 1024 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartNotebookRunRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure idempotency of the request. This field is automatically populated if not provided.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartNotebookRunRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartNotebookRunRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.