Interface ListNotebookInstancesRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>, SageMakerRequest.Builder, SdkBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
ListNotebookInstancesRequest
public static interface ListNotebookInstancesRequest.Builder extends SageMakerRequest.Builder, SdkPojo, CopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>

  • Method Details

    • nextToken

      ListNotebookInstancesRequest.Builder nextToken(String nextToken)

      If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

      You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

      Parameters:
      nextToken - If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken. You can use this token in your subsequent ListNotebookInstances request to fetch the next set of notebook instances.

      You might specify a filter or a sort order in your request. When response is truncated, you must use the same values for the filer and sort order in the next request.

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

    • maxResults

      ListNotebookInstancesRequest.Builder maxResults(Integer maxResults)

      The maximum number of notebook instances to return.

      Parameters:
      maxResults - The maximum number of notebook instances to return.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sortBy

      ListNotebookInstancesRequest.Builder sortBy(String sortBy)

      The field to sort results by. The default is Name.

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

    • sortBy

      ListNotebookInstancesRequest.Builder sortBy(NotebookInstanceSortKey sortBy)

      The field to sort results by. The default is Name.

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

    • sortOrder

      ListNotebookInstancesRequest.Builder sortOrder(String sortOrder)

      The sort order for results.

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

    • sortOrder

      ListNotebookInstancesRequest.Builder sortOrder(NotebookInstanceSortOrder sortOrder)

      The sort order for results.

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

    • nameContains

      ListNotebookInstancesRequest.Builder nameContains(String nameContains)

      A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.

      Parameters:
      nameContains - A string in the notebook instances' name. This filter returns only notebook instances whose name contains the specified string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimeBefore

      ListNotebookInstancesRequest.Builder creationTimeBefore(Instant creationTimeBefore)

      A filter that returns only notebook instances that were created before the specified time (timestamp).

      Parameters:
      creationTimeBefore - A filter that returns only notebook instances that were created before the specified time (timestamp).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • creationTimeAfter

      ListNotebookInstancesRequest.Builder creationTimeAfter(Instant creationTimeAfter)

      A filter that returns only notebook instances that were created after the specified time (timestamp).

      Parameters:
      creationTimeAfter - A filter that returns only notebook instances that were created after the specified time (timestamp).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTimeBefore

      ListNotebookInstancesRequest.Builder lastModifiedTimeBefore(Instant lastModifiedTimeBefore)

      A filter that returns only notebook instances that were modified before the specified time (timestamp).

      Parameters:
      lastModifiedTimeBefore - A filter that returns only notebook instances that were modified before the specified time (timestamp).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTimeAfter

      ListNotebookInstancesRequest.Builder lastModifiedTimeAfter(Instant lastModifiedTimeAfter)

      A filter that returns only notebook instances that were modified after the specified time (timestamp).

      Parameters:
      lastModifiedTimeAfter - A filter that returns only notebook instances that were modified after the specified time (timestamp).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusEquals

      ListNotebookInstancesRequest.Builder statusEquals(String statusEquals)

      A filter that returns only notebook instances with the specified status.

      Parameters:
      statusEquals - A filter that returns only notebook instances with the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusEquals

      ListNotebookInstancesRequest.Builder statusEquals(NotebookInstanceStatus statusEquals)

      A filter that returns only notebook instances with the specified status.

      Parameters:
      statusEquals - A filter that returns only notebook instances with the specified status.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • notebookInstanceLifecycleConfigNameContains

      ListNotebookInstancesRequest.Builder notebookInstanceLifecycleConfigNameContains(String notebookInstanceLifecycleConfigNameContains)

      A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.

      Parameters:
      notebookInstanceLifecycleConfigNameContains - A string in the name of a notebook instances lifecycle configuration associated with this notebook instance. This filter returns only notebook instances associated with a lifecycle configuration with a name that contains the specified string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultCodeRepositoryContains

      ListNotebookInstancesRequest.Builder defaultCodeRepositoryContains(String defaultCodeRepositoryContains)

      A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.

      Parameters:
      defaultCodeRepositoryContains - A string in the name or URL of a Git repository associated with this notebook instance. This filter returns only notebook instances associated with a git repository with a name that contains the specified string.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalCodeRepositoryEquals

      ListNotebookInstancesRequest.Builder additionalCodeRepositoryEquals(String additionalCodeRepositoryEquals)

      A filter that returns only notebook instances with associated with the specified git repository.

      Parameters:
      additionalCodeRepositoryEquals - A filter that returns only notebook instances with associated with the specified git repository.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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