Interface ListNotebooksRequest.Builder

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

  • Method Details

    • domainIdentifier

      ListNotebooksRequest.Builder domainIdentifier(String domainIdentifier)

      The identifier of the Amazon SageMaker Unified Studio domain in which to list notebooks.

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

    • owningProjectIdentifier

      ListNotebooksRequest.Builder owningProjectIdentifier(String owningProjectIdentifier)

      The identifier of the project that owns the notebooks.

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

    • maxResults

      ListNotebooksRequest.Builder maxResults(Integer maxResults)

      The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of MaxResults, the response contains a NextToken value.

      Parameters:
      maxResults - The maximum number of notebooks to return in a single call. When the number of notebooks exceeds the value of MaxResults, the response contains a NextToken value.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortOrder

      ListNotebooksRequest.Builder sortOrder(String sortOrder)

      The sort order for the results.

      Parameters:
      sortOrder - The sort order for the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortOrder

      ListNotebooksRequest.Builder sortOrder(SortOrder sortOrder)

      The sort order for the results.

      Parameters:
      sortOrder - The sort order for the results.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListNotebooksRequest.Builder sortBy(String sortBy)

      The field to sort the results by.

      Parameters:
      sortBy - The field to sort the results by.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sortBy

      ListNotebooksRequest.Builder sortBy(SortKey sortBy)

      The field to sort the results by.

      Parameters:
      sortBy - The field to sort the results by.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ListNotebooksRequest.Builder status(String status)

      The status to filter notebooks by.

      Parameters:
      status - The status to filter notebooks by.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      ListNotebooksRequest.Builder status(NotebookStatus status)

      The status to filter notebooks by.

      Parameters:
      status - The status to filter notebooks by.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • nextToken

      ListNotebooksRequest.Builder nextToken(String nextToken)

      When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.

      Parameters:
      nextToken - When the number of notebooks is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of notebooks, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListNotebooks to list the next set of notebooks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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