NotebookInstanceSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.sagemaker.model.NotebookInstanceSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class NotebookInstanceSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides summary information for an SageMaker notebook instance.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

NotebookInstanceSummary()

Constructors
Constructor and Description
`NotebookInstanceSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`NotebookInstanceSummary`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalCodeRepositories()` An array of up to three Git repositories associated with the notebook instance.
`Date`	`getCreationTime()` A timestamp that shows when the notebook instance was created.
`String`	`getDefaultCodeRepository()` The Git repository associated with the notebook instance as its default code repository.
`String`	`getInstanceType()` The type of ML compute instance that the notebook instance is running on.
`Date`	`getLastModifiedTime()` A timestamp that shows when the notebook instance was last modified.
`String`	`getNotebookInstanceArn()` The Amazon Resource Name (ARN) of the notebook instance.
`String`	`getNotebookInstanceLifecycleConfigName()` The name of a notebook instance lifecycle configuration associated with this notebook instance.
`String`	`getNotebookInstanceName()` The name of the notebook instance that you want a summary for.
`String`	`getNotebookInstanceStatus()` The status of the notebook instance.
`String`	`getUrl()` The URL that you use to connect to the Jupyter notebook running in your notebook instance.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`void`	`setCreationTime(Date creationTime)` A timestamp that shows when the notebook instance was created.
`void`	`setDefaultCodeRepository(String defaultCodeRepository)` The Git repository associated with the notebook instance as its default code repository.
`void`	`setInstanceType(String instanceType)` The type of ML compute instance that the notebook instance is running on.
`void`	`setLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the notebook instance was last modified.
`void`	`setNotebookInstanceArn(String notebookInstanceArn)` The Amazon Resource Name (ARN) of the notebook instance.
`void`	`setNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)` The name of a notebook instance lifecycle configuration associated with this notebook instance.
`void`	`setNotebookInstanceName(String notebookInstanceName)` The name of the notebook instance that you want a summary for.
`void`	`setNotebookInstanceStatus(String notebookInstanceStatus)` The status of the notebook instance.
`void`	`setUrl(String url)` The URL that you use to connect to the Jupyter notebook running in your notebook instance.
`String`	`toString()` Returns a string representation of this object.
`NotebookInstanceSummary`	`withAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`NotebookInstanceSummary`	`withAdditionalCodeRepositories(String... additionalCodeRepositories)` An array of up to three Git repositories associated with the notebook instance.
`NotebookInstanceSummary`	`withCreationTime(Date creationTime)` A timestamp that shows when the notebook instance was created.
`NotebookInstanceSummary`	`withDefaultCodeRepository(String defaultCodeRepository)` The Git repository associated with the notebook instance as its default code repository.
`NotebookInstanceSummary`	`withInstanceType(InstanceType instanceType)` The type of ML compute instance that the notebook instance is running on.
`NotebookInstanceSummary`	`withInstanceType(String instanceType)` The type of ML compute instance that the notebook instance is running on.
`NotebookInstanceSummary`	`withLastModifiedTime(Date lastModifiedTime)` A timestamp that shows when the notebook instance was last modified.
`NotebookInstanceSummary`	`withNotebookInstanceArn(String notebookInstanceArn)` The Amazon Resource Name (ARN) of the notebook instance.
`NotebookInstanceSummary`	`withNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)` The name of a notebook instance lifecycle configuration associated with this notebook instance.
`NotebookInstanceSummary`	`withNotebookInstanceName(String notebookInstanceName)` The name of the notebook instance that you want a summary for.
`NotebookInstanceSummary`	`withNotebookInstanceStatus(NotebookInstanceStatus notebookInstanceStatus)` The status of the notebook instance.
`NotebookInstanceSummary`	`withNotebookInstanceStatus(String notebookInstanceStatus)` The status of the notebook instance.
`NotebookInstanceSummary`	`withUrl(String url)` The URL that you use to connect to the Jupyter notebook running in your notebook instance.

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

- Constructor Detail
  - NotebookInstanceSummary
```
public NotebookInstanceSummary()
```
- Method Detail
  - setNotebookInstanceName
```
public void setNotebookInstanceName(String notebookInstanceName)
```
    The name of the notebook instance that you want a summary for.
    
    Parameters:
    
    notebookInstanceName - The name of the notebook instance that you want a summary for.
  - getNotebookInstanceName
```
public String getNotebookInstanceName()
```
    The name of the notebook instance that you want a summary for.
    
    Returns:
    
    The name of the notebook instance that you want a summary for.
  - withNotebookInstanceName
```
public NotebookInstanceSummary withNotebookInstanceName(String notebookInstanceName)
```
    The name of the notebook instance that you want a summary for.
    
    Parameters:
    
    notebookInstanceName - The name of the notebook instance that you want a summary for.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceArn
```
public void setNotebookInstanceArn(String notebookInstanceArn)
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Parameters:
    
    notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.
  - getNotebookInstanceArn
```
public String getNotebookInstanceArn()
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the notebook instance.
  - withNotebookInstanceArn
```
public NotebookInstanceSummary withNotebookInstanceArn(String notebookInstanceArn)
```
    The Amazon Resource Name (ARN) of the notebook instance.
    
    Parameters:
    
    notebookInstanceArn - The Amazon Resource Name (ARN) of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceStatus
```
public void setNotebookInstanceStatus(String notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    See Also:
    
    NotebookInstanceStatus
  - getNotebookInstanceStatus
```
public String getNotebookInstanceStatus()
```
    The status of the notebook instance.
    
    Returns:
    
    The status of the notebook instance.
    
    See Also:
    
    NotebookInstanceStatus
  - withNotebookInstanceStatus
```
public NotebookInstanceSummary withNotebookInstanceStatus(String notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceStatus
  - withNotebookInstanceStatus
```
public NotebookInstanceSummary withNotebookInstanceStatus(NotebookInstanceStatus notebookInstanceStatus)
```
    The status of the notebook instance.
    
    Parameters:
    
    notebookInstanceStatus - The status of the notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    NotebookInstanceStatus
  - setUrl
```
public void setUrl(String url)
```
    The URL that you use to connect to the Jupyter notebook running in your notebook instance.
    
    Parameters:
    
    url - The URL that you use to connect to the Jupyter notebook running in your notebook instance.
  - getUrl
```
public String getUrl()
```
    The URL that you use to connect to the Jupyter notebook running in your notebook instance.
    
    Returns:
    
    The URL that you use to connect to the Jupyter notebook running in your notebook instance.
  - withUrl
```
public NotebookInstanceSummary withUrl(String url)
```
    The URL that you use to connect to the Jupyter notebook running in your notebook instance.
    
    Parameters:
    
    url - The URL that you use to connect to the Jupyter notebook running in your notebook instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInstanceType
```
public void setInstanceType(String instanceType)
```
    The type of ML compute instance that the notebook instance is running on.
    
    Parameters:
    
    instanceType - The type of ML compute instance that the notebook instance is running on.
    
    See Also:
    
    InstanceType
  - getInstanceType
```
public String getInstanceType()
```
    The type of ML compute instance that the notebook instance is running on.
    
    Returns:
    
    The type of ML compute instance that the notebook instance is running on.
    
    See Also:
    
    InstanceType
  - withInstanceType
```
public NotebookInstanceSummary withInstanceType(String instanceType)
```
    The type of ML compute instance that the notebook instance is running on.
    
    Parameters:
    
    instanceType - The type of ML compute instance that the notebook instance is running on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceType
  - withInstanceType
```
public NotebookInstanceSummary withInstanceType(InstanceType instanceType)
```
    The type of ML compute instance that the notebook instance is running on.
    
    Parameters:
    
    instanceType - The type of ML compute instance that the notebook instance is running on.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    InstanceType
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    A timestamp that shows when the notebook instance was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the notebook instance was created.
  - getCreationTime
```
public Date getCreationTime()
```
    A timestamp that shows when the notebook instance was created.
    
    Returns:
    
    A timestamp that shows when the notebook instance was created.
  - withCreationTime
```
public NotebookInstanceSummary withCreationTime(Date creationTime)
```
    A timestamp that shows when the notebook instance was created.
    
    Parameters:
    
    creationTime - A timestamp that shows when the notebook instance was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedTime
```
public void setLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the notebook instance was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the notebook instance was last modified.
  - getLastModifiedTime
```
public Date getLastModifiedTime()
```
    A timestamp that shows when the notebook instance was last modified.
    
    Returns:
    
    A timestamp that shows when the notebook instance was last modified.
  - withLastModifiedTime
```
public NotebookInstanceSummary withLastModifiedTime(Date lastModifiedTime)
```
    A timestamp that shows when the notebook instance was last modified.
    
    Parameters:
    
    lastModifiedTime - A timestamp that shows when the notebook instance was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotebookInstanceLifecycleConfigName
```
public void setNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)
```
    The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
    
    Parameters:
    
    notebookInstanceLifecycleConfigName - The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
  - getNotebookInstanceLifecycleConfigName
```
public String getNotebookInstanceLifecycleConfigName()
```
    The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
    
    Returns:
    
    The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
  - withNotebookInstanceLifecycleConfigName
```
public NotebookInstanceSummary withNotebookInstanceLifecycleConfigName(String notebookInstanceLifecycleConfigName)
```
    The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
    
    Parameters:
    
    notebookInstanceLifecycleConfigName - The name of a notebook instance lifecycle configuration associated with this notebook instance.
    
    For information about notebook instance lifestyle configurations, see Step 2.1: (Optional) Customize a Notebook Instance.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultCodeRepository
```
public void setDefaultCodeRepository(String defaultCodeRepository)
```
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Parameters:
    
    defaultCodeRepository - The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
  - getDefaultCodeRepository
```
public String getDefaultCodeRepository()
```
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Returns:
    
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
  - withDefaultCodeRepository
```
public NotebookInstanceSummary withDefaultCodeRepository(String defaultCodeRepository)
```
    The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Parameters:
    
    defaultCodeRepository - The Git repository associated with the notebook instance as its default code repository. This can be either the name of a Git repository stored as a resource in your account, or the URL of a Git repository in Amazon Web Services CodeCommit or in any other Git repository. When you open a notebook instance, it opens in the directory that contains this repository. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalCodeRepositories
```
public List<String> getAdditionalCodeRepositories()
```
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Returns:
    
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
  - setAdditionalCodeRepositories
```
public void setAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)
```
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Parameters:
    
    additionalCodeRepositories - An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
  - withAdditionalCodeRepositories
```
public NotebookInstanceSummary withAdditionalCodeRepositories(String... additionalCodeRepositories)
```
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalCodeRepositories(java.util.Collection) or withAdditionalCodeRepositories(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    additionalCodeRepositories - An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalCodeRepositories
```
public NotebookInstanceSummary withAdditionalCodeRepositories(Collection<String> additionalCodeRepositories)
```
    An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    Parameters:
    
    additionalCodeRepositories - An array of up to three Git repositories associated with the notebook instance. These can be either the names of Git repositories stored as resources in your account, or the URL of Git repositories in Amazon Web Services CodeCommit or in any other Git repository. These repositories are cloned at the same level as the default repository of your notebook instance. For more information, see Associating Git Repositories with SageMaker Notebook Instances.
    
    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 NotebookInstanceSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class NotebookInstanceSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NotebookInstanceSummary

Method Detail

setNotebookInstanceName

getNotebookInstanceName

withNotebookInstanceName

setNotebookInstanceArn

getNotebookInstanceArn

withNotebookInstanceArn

setNotebookInstanceStatus

getNotebookInstanceStatus

withNotebookInstanceStatus

withNotebookInstanceStatus

setUrl

getUrl

withUrl

setInstanceType

getInstanceType

withInstanceType

withInstanceType

setCreationTime

getCreationTime

withCreationTime

setLastModifiedTime

getLastModifiedTime

withLastModifiedTime

setNotebookInstanceLifecycleConfigName

getNotebookInstanceLifecycleConfigName

withNotebookInstanceLifecycleConfigName

setDefaultCodeRepository

getDefaultCodeRepository

withDefaultCodeRepository

getAdditionalCodeRepositories

setAdditionalCodeRepositories

withAdditionalCodeRepositories

withAdditionalCodeRepositories

toString

equals

hashCode

clone

marshall