ListNotebookInstancesRequest (AWS SDK for Java

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(value="software.amazon.awssdk:codegen")
public final class ListNotebookInstancesRequest
extends SageMakerRequest
implements ToCopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface ListNotebookInstancesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ListNotebookInstancesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`additionalCodeRepositoryEquals()` A filter that returns only notebook instances with associated with the specified git respository.
`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)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)` Used to retrieve the value of a field from any class that extends `SdkRequest`.
`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.
`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()` Take this object and create a builder that contains all of the current property values of this object.
`String`	`toString()`

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

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - nextToken
```
public 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 Integer maxResults()
```
    The maximum number of notebook instances to return.
    
    Returns:
    
    The maximum number of notebook instances to return.
  - sortBy
```
public 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 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 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 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 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 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 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 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 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 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 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 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 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 String additionalCodeRepositoryEquals()
```
    A filter that returns only notebook instances with associated with the specified git respository.
    
    Returns:
    
    A filter that returns only notebook instances with associated with the specified git respository.
  - toBuilder
```
public ListNotebookInstancesRequest.Builder toBuilder()
```
    Description copied from interface: ToCopyableBuilder
    
    Take this object and create a builder that contains all of the current property values of this object.
    
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListNotebookInstancesRequest.Builder,ListNotebookInstancesRequest>
    
    Specified by:
    
    toBuilder in class SageMakerRequest
    
    Returns:
    
    a builder for type T
  - builder
```
public static ListNotebookInstancesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListNotebookInstancesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Description copied from class: SdkRequest
    
    Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
    
    Overrides:
    
    getValueForField in class SdkRequest
    
    Parameters:
    
    fieldName - The name of the member to be retrieved.
    
    clazz - The class to cast the returned object to.
    
    Returns:
    
    Optional containing the casted return value
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo
    
    Returns:
    
    List of SdkField in this POJO. May be empty list but should never be null.

Class ListNotebookInstancesRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

nextToken

maxResults

sortBy

sortByAsString

sortOrder

sortOrderAsString

nameContains

creationTimeBefore

creationTimeAfter

lastModifiedTimeBefore

lastModifiedTimeAfter

statusEquals

statusEqualsAsString

notebookInstanceLifecycleConfigNameContains

defaultCodeRepositoryContains

additionalCodeRepositoryEquals

toBuilder

builder

serializableBuilderClass

hashCode

equals

toString

getValueForField

sdkFields