software.amazon.awssdk.services.sagemaker.model

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 Summary

Modifier and Type	Method and Description
ListNotebookInstancesRequest.Builder	additionalCodeRepositoryEquals(String additionalCodeRepositoryEquals) A filter that returns only notebook instances with associated with the specified git repository.
ListNotebookInstancesRequest.Builder	creationTimeAfter(Instant creationTimeAfter) A filter that returns only notebook instances that were created after the specified time (timestamp).
ListNotebookInstancesRequest.Builder	creationTimeBefore(Instant creationTimeBefore) A filter that returns only notebook instances that were created before the specified time (timestamp).
ListNotebookInstancesRequest.Builder	defaultCodeRepositoryContains(String defaultCodeRepositoryContains) A string in the name or URL of a Git repository associated with this notebook instance.
ListNotebookInstancesRequest.Builder	lastModifiedTimeAfter(Instant lastModifiedTimeAfter) A filter that returns only notebook instances that were modified after the specified time (timestamp).
ListNotebookInstancesRequest.Builder	lastModifiedTimeBefore(Instant lastModifiedTimeBefore) A filter that returns only notebook instances that were modified before the specified time (timestamp).
ListNotebookInstancesRequest.Builder	maxResults(Integer maxResults) The maximum number of notebook instances to return.
ListNotebookInstancesRequest.Builder	nameContains(String nameContains) A string in the notebook instances' name.
ListNotebookInstancesRequest.Builder	nextToken(String nextToken) If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken.
ListNotebookInstancesRequest.Builder	notebookInstanceLifecycleConfigNameContains(String notebookInstanceLifecycleConfigNameContains) A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
ListNotebookInstancesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
ListNotebookInstancesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
ListNotebookInstancesRequest.Builder	sortBy(NotebookInstanceSortKey sortBy) The field to sort results by.
ListNotebookInstancesRequest.Builder	sortBy(String sortBy) The field to sort results by.
ListNotebookInstancesRequest.Builder	sortOrder(NotebookInstanceSortOrder sortOrder) The sort order for results.
ListNotebookInstancesRequest.Builder	sortOrder(String sortOrder) The sort order for results.
ListNotebookInstancesRequest.Builder	statusEquals(NotebookInstanceStatus statusEquals) A filter that returns only notebook instances with the specified status.
ListNotebookInstancesRequest.Builder	statusEquals(String statusEquals) A filter that returns only notebook instances with the specified status.

Methods inherited from interface software.amazon.awssdk.services.sagemaker.model.SageMakerRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

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:

NotebookInstanceSortKey, NotebookInstanceSortKey

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:

NotebookInstanceSortKey, NotebookInstanceSortKey

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:

NotebookInstanceSortOrder, NotebookInstanceSortOrder

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:

NotebookInstanceSortOrder, NotebookInstanceSortOrder

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:

NotebookInstanceStatus, NotebookInstanceStatus

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:

NotebookInstanceStatus, NotebookInstanceStatus

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)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

ListNotebookInstancesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder