Interface StartNotebookSyncRequest.Builder

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

  • Method Details

    • domainIdentifier

      StartNotebookSyncRequest.Builder domainIdentifier(String domainIdentifier)

      The identifier of the Amazon SageMaker Unified Studio domain in which to sync the notebook.

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

    • owningProjectIdentifier

      StartNotebookSyncRequest.Builder owningProjectIdentifier(String owningProjectIdentifier)

      The identifier of the project that will own the synced notebook.

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

    • sourceLocation

      StartNotebookSyncRequest.Builder sourceLocation(SourceLocation sourceLocation)

      The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.

      Parameters:
      sourceLocation - The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sourceLocation

      default StartNotebookSyncRequest.Builder sourceLocation(Consumer<SourceLocation.Builder> sourceLocation)

      The source location of the notebook to sync. This specifies the Amazon Simple Storage Service URI of the notebook file.

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

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

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

    • gitMetadata

      StartNotebookSyncRequest.Builder gitMetadata(GitMetadata gitMetadata)

      The Git metadata for the notebook sync, including repository, branch, and commit information.

      Parameters:
      gitMetadata - The Git metadata for the notebook sync, including repository, branch, and commit information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • gitMetadata

      default StartNotebookSyncRequest.Builder gitMetadata(Consumer<GitMetadata.Builder> gitMetadata)

      The Git metadata for the notebook sync, including repository, branch, and commit information.

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

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

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

    • notebookId

      StartNotebookSyncRequest.Builder notebookId(String notebookId)

      The identifier of an existing notebook to sync. If not specified, a new notebook is created.

      Parameters:
      notebookId - The identifier of an existing notebook to sync. If not specified, a new notebook is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      StartNotebookSyncRequest.Builder name(String name)

      The name of the notebook. The name must be between 1 and 256 characters.

      Parameters:
      name - The name of the notebook. The name must be between 1 and 256 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

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

    • clientToken

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

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

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