Package software.amazon.awssdk.services.sagemaker.model

Class ListNotebookInstancesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.sagemaker.model.SageMakerRequest

software.amazon.awssdk.services.sagemaker.model.ListNotebookInstancesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ListNotebookInstancesRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListNotebookInstancesRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	additionalCodeRepositoryEquals()	A filter that returns only notebook instances with associated with the specified git repository.
static ListNotebookInstancesRequest.Builder	builder()
Instant	creationTimeAfter()	A filter that returns only notebook instances that were created after the specified time (timestamp).
Instant	creationTimeBefore()	A filter that returns only notebook instances that were created before the specified time (timestamp).
String	defaultCodeRepositoryContains()	A string in the name or URL of a Git repository associated with this notebook instance.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Instant	lastModifiedTimeAfter()	A filter that returns only notebook instances that were modified after the specified time (timestamp).
Instant	lastModifiedTimeBefore()	A filter that returns only notebook instances that were modified before the specified time (timestamp).
Integer	maxResults()	The maximum number of notebook instances to return.
String	nameContains()	A string in the notebook instances' name.
String	nextToken()	If the previous call to the ListNotebookInstances is truncated, the response includes a NextToken.
String	notebookInstanceLifecycleConfigNameContains()	A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListNotebookInstancesRequest.Builder>	serializableBuilderClass()
NotebookInstanceSortKey	sortBy()	The field to sort results by.
String	sortByAsString()	The field to sort results by.
NotebookInstanceSortOrder	sortOrder()	The sort order for results.
String	sortOrderAsString()	The sort order for results.
NotebookInstanceStatus	statusEquals()	A filter that returns only notebook instances with the specified status.
String	statusEqualsAsString()	A filter that returns only notebook instances with the specified status.
ListNotebookInstancesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

nextToken

public final 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.

Returns:

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.

maxResults

public final Integer maxResults()

The maximum number of notebook instances to return.

Returns:

The maximum number of notebook instances to return.

sortBy

public final NotebookInstanceSortKey sortBy()

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

If the service returns an enum value that is not available in the current SDK version, sortBy will return NotebookInstanceSortKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

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

See Also:

NotebookInstanceSortKey

sortByAsString

public final String sortByAsString()

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

If the service returns an enum value that is not available in the current SDK version, sortBy will return NotebookInstanceSortKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortByAsString().

Returns:

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

See Also:

NotebookInstanceSortKey

sortOrder

public final NotebookInstanceSortOrder sortOrder()

The sort order for results.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return NotebookInstanceSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The sort order for results.

See Also:

NotebookInstanceSortOrder

sortOrderAsString

public final String sortOrderAsString()

The sort order for results.

If the service returns an enum value that is not available in the current SDK version, sortOrder will return NotebookInstanceSortOrder.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from sortOrderAsString().

Returns:

The sort order for results.

See Also:

NotebookInstanceSortOrder

nameContains

public final String nameContains()

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

Returns:

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

creationTimeBefore

public final Instant creationTimeBefore()

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

Returns:

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

creationTimeAfter

public final Instant creationTimeAfter()

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

Returns:

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

lastModifiedTimeBefore

public final Instant lastModifiedTimeBefore()

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

Returns:

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

lastModifiedTimeAfter

public final Instant lastModifiedTimeAfter()

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

Returns:

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

statusEquals

public final NotebookInstanceStatus statusEquals()

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

If the service returns an enum value that is not available in the current SDK version, statusEquals will return NotebookInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().

Returns:

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

See Also:

NotebookInstanceStatus

statusEqualsAsString

public final String statusEqualsAsString()

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

If the service returns an enum value that is not available in the current SDK version, statusEquals will return NotebookInstanceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusEqualsAsString().

Returns:

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

See Also:

NotebookInstanceStatus

notebookInstanceLifecycleConfigNameContains

public final 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.

Returns:

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.

defaultCodeRepositoryContains

public final 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.

Returns:

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.

additionalCodeRepositoryEquals

public final String additionalCodeRepositoryEquals()

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

Returns:

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

toBuilder

public ListNotebookInstancesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static ListNotebookInstancesRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListNotebookInstancesRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo