software.amazon.awssdk.services.sagemaker.model

Class NotebookInstanceSummary

java.lang.Object

software.amazon.awssdk.services.sagemaker.model.NotebookInstanceSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<NotebookInstanceSummary.Builder,NotebookInstanceSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class NotebookInstanceSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<NotebookInstanceSummary.Builder,NotebookInstanceSummary>

Provides summary information for an SageMaker notebook instance.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NotebookInstanceSummary.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	additionalCodeRepositories() An array of up to three Git repositories associated with the notebook instance.
static NotebookInstanceSummary.Builder	builder()
Instant	creationTime() A timestamp that shows when the notebook instance was created.
String	defaultCodeRepository() The Git repository associated with the notebook instance as its default code repository.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasAdditionalCodeRepositories() For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property.
int	hashCode()
InstanceType	instanceType() The type of ML compute instance that the notebook instance is running on.
String	instanceTypeAsString() The type of ML compute instance that the notebook instance is running on.
Instant	lastModifiedTime() A timestamp that shows when the notebook instance was last modified.
String	notebookInstanceArn() The Amazon Resource Name (ARN) of the notebook instance.
String	notebookInstanceLifecycleConfigName() The name of a notebook instance lifecycle configuration associated with this notebook instance.
String	notebookInstanceName() The name of the notebook instance that you want a summary for.
NotebookInstanceStatus	notebookInstanceStatus() The status of the notebook instance.
String	notebookInstanceStatusAsString() The status of the notebook instance.
List<SdkField<?>>	sdkFields()
static Class<? extends NotebookInstanceSummary.Builder>	serializableBuilderClass()
NotebookInstanceSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.
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

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

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

copy

Method Detail

notebookInstanceName

public final String notebookInstanceName()

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.

notebookInstanceArn

public final String notebookInstanceArn()

The Amazon Resource Name (ARN) of the notebook instance.

Returns:

The Amazon Resource Name (ARN) of the notebook instance.

notebookInstanceStatus

public final NotebookInstanceStatus notebookInstanceStatus()

The status of the notebook instance.

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

Returns:

The status of the notebook instance.

See Also:

NotebookInstanceStatus

notebookInstanceStatusAsString

public final String notebookInstanceStatusAsString()

The status of the notebook instance.

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

Returns:

The status of the notebook instance.

See Also:

NotebookInstanceStatus

url

public final String url()

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.

instanceType

public final InstanceType instanceType()

The type of ML compute instance that the notebook instance is running on.

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

Returns:

The type of ML compute instance that the notebook instance is running on.

See Also:

InstanceType

instanceTypeAsString

public final String instanceTypeAsString()

The type of ML compute instance that the notebook instance is running on.

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

Returns:

The type of ML compute instance that the notebook instance is running on.

See Also:

InstanceType

creationTime

public final Instant creationTime()

A timestamp that shows when the notebook instance was created.

Returns:

A timestamp that shows when the notebook instance was created.

lastModifiedTime

public final Instant lastModifiedTime()

A timestamp that shows when the notebook instance was last modified.

Returns:

A timestamp that shows when the notebook instance was last modified.

notebookInstanceLifecycleConfigName

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

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.

defaultCodeRepository

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

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.

hasAdditionalCodeRepositories

public final boolean hasAdditionalCodeRepositories()

For responses, this returns true if the service returned a value for the AdditionalCodeRepositories property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

additionalCodeRepositories

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalCodeRepositories() method.

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.

toBuilder

public NotebookInstanceSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<NotebookInstanceSummary.Builder,NotebookInstanceSummary>

builder

public static NotebookInstanceSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo