ListNotebookInstancesRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.sagemaker.model.ListNotebookInstancesRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ListNotebookInstancesRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

ListNotebookInstancesRequest()

Constructors
Constructor and Description
`ListNotebookInstancesRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ListNotebookInstancesRequest`	`clone()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals(Object obj)`
`String`	`getAdditionalCodeRepositoryEquals()` A filter that returns only notebook instances with associated with the specified git repository.
`Date`	`getCreationTimeAfter()` A filter that returns only notebook instances that were created after the specified time (timestamp).
`Date`	`getCreationTimeBefore()` A filter that returns only notebook instances that were created before the specified time (timestamp).
`String`	`getDefaultCodeRepositoryContains()` A string in the name or URL of a Git repository associated with this notebook instance.
`Date`	`getLastModifiedTimeAfter()` A filter that returns only notebook instances that were modified after the specified time (timestamp).
`Date`	`getLastModifiedTimeBefore()` A filter that returns only notebook instances that were modified before the specified time (timestamp).
`Integer`	`getMaxResults()` The maximum number of notebook instances to return.
`String`	`getNameContains()` A string in the notebook instances' name.
`String`	`getNextToken()` If the previous call to the `ListNotebookInstances` is truncated, the response includes a `NextToken`.
`String`	`getNotebookInstanceLifecycleConfigNameContains()` A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
`String`	`getSortBy()` The field to sort results by.
`String`	`getSortOrder()` The sort order for results.
`String`	`getStatusEquals()` A filter that returns only notebook instances with the specified status.
`int`	`hashCode()`
`void`	`setAdditionalCodeRepositoryEquals(String additionalCodeRepositoryEquals)` A filter that returns only notebook instances with associated with the specified git repository.
`void`	`setCreationTimeAfter(Date creationTimeAfter)` A filter that returns only notebook instances that were created after the specified time (timestamp).
`void`	`setCreationTimeBefore(Date creationTimeBefore)` A filter that returns only notebook instances that were created before the specified time (timestamp).
`void`	`setDefaultCodeRepositoryContains(String defaultCodeRepositoryContains)` A string in the name or URL of a Git repository associated with this notebook instance.
`void`	`setLastModifiedTimeAfter(Date lastModifiedTimeAfter)` A filter that returns only notebook instances that were modified after the specified time (timestamp).
`void`	`setLastModifiedTimeBefore(Date lastModifiedTimeBefore)` A filter that returns only notebook instances that were modified before the specified time (timestamp).
`void`	`setMaxResults(Integer maxResults)` The maximum number of notebook instances to return.
`void`	`setNameContains(String nameContains)` A string in the notebook instances' name.
`void`	`setNextToken(String nextToken)` If the previous call to the `ListNotebookInstances` is truncated, the response includes a `NextToken`.
`void`	`setNotebookInstanceLifecycleConfigNameContains(String notebookInstanceLifecycleConfigNameContains)` A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
`void`	`setSortBy(String sortBy)` The field to sort results by.
`void`	`setSortOrder(String sortOrder)` The sort order for results.
`void`	`setStatusEquals(String statusEquals)` A filter that returns only notebook instances with the specified status.
`String`	`toString()` Returns a string representation of this object.
`ListNotebookInstancesRequest`	`withAdditionalCodeRepositoryEquals(String additionalCodeRepositoryEquals)` A filter that returns only notebook instances with associated with the specified git repository.
`ListNotebookInstancesRequest`	`withCreationTimeAfter(Date creationTimeAfter)` A filter that returns only notebook instances that were created after the specified time (timestamp).
`ListNotebookInstancesRequest`	`withCreationTimeBefore(Date creationTimeBefore)` A filter that returns only notebook instances that were created before the specified time (timestamp).
`ListNotebookInstancesRequest`	`withDefaultCodeRepositoryContains(String defaultCodeRepositoryContains)` A string in the name or URL of a Git repository associated with this notebook instance.
`ListNotebookInstancesRequest`	`withLastModifiedTimeAfter(Date lastModifiedTimeAfter)` A filter that returns only notebook instances that were modified after the specified time (timestamp).
`ListNotebookInstancesRequest`	`withLastModifiedTimeBefore(Date lastModifiedTimeBefore)` A filter that returns only notebook instances that were modified before the specified time (timestamp).
`ListNotebookInstancesRequest`	`withMaxResults(Integer maxResults)` The maximum number of notebook instances to return.
`ListNotebookInstancesRequest`	`withNameContains(String nameContains)` A string in the notebook instances' name.
`ListNotebookInstancesRequest`	`withNextToken(String nextToken)` If the previous call to the `ListNotebookInstances` is truncated, the response includes a `NextToken`.
`ListNotebookInstancesRequest`	`withNotebookInstanceLifecycleConfigNameContains(String notebookInstanceLifecycleConfigNameContains)` A string in the name of a notebook instances lifecycle configuration associated with this notebook instance.
`ListNotebookInstancesRequest`	`withSortBy(NotebookInstanceSortKey sortBy)` The field to sort results by.
`ListNotebookInstancesRequest`	`withSortBy(String sortBy)` The field to sort results by.
`ListNotebookInstancesRequest`	`withSortOrder(NotebookInstanceSortOrder sortOrder)` The sort order for results.
`ListNotebookInstancesRequest`	`withSortOrder(String sortOrder)` The sort order for results.
`ListNotebookInstancesRequest`	`withStatusEquals(NotebookInstanceStatus statusEquals)` A filter that returns only notebook instances with the specified status.
`ListNotebookInstancesRequest`	`withStatusEquals(String statusEquals)` A filter that returns only notebook instances with the specified status.

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

- Constructor Detail
  - ListNotebookInstancesRequest
```
public ListNotebookInstancesRequest()
```
- Method Detail
  - setNextToken
```
public void setNextToken(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.
  - getNextToken
```
public String getNextToken()
```
    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.
  - withNextToken
```
public ListNotebookInstancesRequest withNextToken(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.
  - setMaxResults
```
public void setMaxResults(Integer maxResults)
```
    The maximum number of notebook instances to return.
    
    Parameters:
    
    maxResults - The maximum number of notebook instances to return.
  - getMaxResults
```
public Integer getMaxResults()
```
    The maximum number of notebook instances to return.
    
    Returns:
    
    The maximum number of notebook instances to return.
  - withMaxResults
```
public ListNotebookInstancesRequest withMaxResults(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.
  - setSortBy
```
public void setSortBy(String sortBy)
```
    The field to sort results by. The default is Name.
    
    Parameters:
    
    sortBy - The field to sort results by. The default is Name.
    
    See Also:
    
    NotebookInstanceSortKey
  - getSortBy
```
public String getSortBy()
```
    The field to sort results by. The default is Name.
    
    Returns:
    
    The field to sort results by. The default is Name.
    
    See Also:
    
    NotebookInstanceSortKey
  - withSortBy
```
public ListNotebookInstancesRequest withSortBy(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
  - withSortBy
```
public ListNotebookInstancesRequest withSortBy(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
  - setSortOrder
```
public void setSortOrder(String sortOrder)
```
    The sort order for results.
    
    Parameters:
    
    sortOrder - The sort order for results.
    
    See Also:
    
    NotebookInstanceSortOrder
  - getSortOrder
```
public String getSortOrder()
```
    The sort order for results.
    
    Returns:
    
    The sort order for results.
    
    See Also:
    
    NotebookInstanceSortOrder
  - withSortOrder
```
public ListNotebookInstancesRequest withSortOrder(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
  - withSortOrder
```
public ListNotebookInstancesRequest withSortOrder(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
  - setNameContains
```
public void setNameContains(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.
  - getNameContains
```
public String getNameContains()
```
    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.
  - withNameContains
```
public ListNotebookInstancesRequest withNameContains(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.
  - setCreationTimeBefore
```
public void setCreationTimeBefore(Date 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).
  - getCreationTimeBefore
```
public Date getCreationTimeBefore()
```
    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).
  - withCreationTimeBefore
```
public ListNotebookInstancesRequest withCreationTimeBefore(Date 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.
  - setCreationTimeAfter
```
public void setCreationTimeAfter(Date 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).
  - getCreationTimeAfter
```
public Date getCreationTimeAfter()
```
    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).
  - withCreationTimeAfter
```
public ListNotebookInstancesRequest withCreationTimeAfter(Date 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.
  - setLastModifiedTimeBefore
```
public void setLastModifiedTimeBefore(Date 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).
  - getLastModifiedTimeBefore
```
public Date getLastModifiedTimeBefore()
```
    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).
  - withLastModifiedTimeBefore
```
public ListNotebookInstancesRequest withLastModifiedTimeBefore(Date 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.
  - setLastModifiedTimeAfter
```
public void setLastModifiedTimeAfter(Date 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).
  - getLastModifiedTimeAfter
```
public Date getLastModifiedTimeAfter()
```
    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).
  - withLastModifiedTimeAfter
```
public ListNotebookInstancesRequest withLastModifiedTimeAfter(Date 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.
  - setStatusEquals
```
public void setStatusEquals(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.
    
    See Also:
    
    NotebookInstanceStatus
  - getStatusEquals
```
public String getStatusEquals()
```
    A filter that returns only notebook instances with the specified status.
    
    Returns:
    
    A filter that returns only notebook instances with the specified status.
    
    See Also:
    
    NotebookInstanceStatus
  - withStatusEquals
```
public ListNotebookInstancesRequest withStatusEquals(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
  - withStatusEquals
```
public ListNotebookInstancesRequest withStatusEquals(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
  - setNotebookInstanceLifecycleConfigNameContains
```
public void setNotebookInstanceLifecycleConfigNameContains(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.
  - getNotebookInstanceLifecycleConfigNameContains
```
public String getNotebookInstanceLifecycleConfigNameContains()
```
    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.
  - withNotebookInstanceLifecycleConfigNameContains
```
public ListNotebookInstancesRequest withNotebookInstanceLifecycleConfigNameContains(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.
  - setDefaultCodeRepositoryContains
```
public void setDefaultCodeRepositoryContains(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.
  - getDefaultCodeRepositoryContains
```
public String getDefaultCodeRepositoryContains()
```
    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.
  - withDefaultCodeRepositoryContains
```
public ListNotebookInstancesRequest withDefaultCodeRepositoryContains(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.
  - setAdditionalCodeRepositoryEquals
```
public void setAdditionalCodeRepositoryEquals(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.
  - getAdditionalCodeRepositoryEquals
```
public String getAdditionalCodeRepositoryEquals()
```
    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.
  - withAdditionalCodeRepositoryEquals
```
public ListNotebookInstancesRequest withAdditionalCodeRepositoryEquals(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ListNotebookInstancesRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class ListNotebookInstancesRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

ListNotebookInstancesRequest

Method Detail

setNextToken

getNextToken

withNextToken

setMaxResults

getMaxResults

withMaxResults

setSortBy

getSortBy

withSortBy

withSortBy

setSortOrder

getSortOrder

withSortOrder

withSortOrder

setNameContains

getNameContains

withNameContains

setCreationTimeBefore

getCreationTimeBefore

withCreationTimeBefore

setCreationTimeAfter

getCreationTimeAfter

withCreationTimeAfter

setLastModifiedTimeBefore

getLastModifiedTimeBefore

withLastModifiedTimeBefore

setLastModifiedTimeAfter

getLastModifiedTimeAfter

withLastModifiedTimeAfter

setStatusEquals

getStatusEquals

withStatusEquals

withStatusEquals

setNotebookInstanceLifecycleConfigNameContains

getNotebookInstanceLifecycleConfigNameContains

withNotebookInstanceLifecycleConfigNameContains

setDefaultCodeRepositoryContains

getDefaultCodeRepositoryContains

withDefaultCodeRepositoryContains

setAdditionalCodeRepositoryEquals

getAdditionalCodeRepositoryEquals

withAdditionalCodeRepositoryEquals

toString

equals

hashCode

clone