software.amazon.awssdk.services.sagemaker.model

Class CreateNotebookInstanceLifecycleConfigRequest

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.CreateNotebookInstanceLifecycleConfigRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateNotebookInstanceLifecycleConfigRequest.Builder,CreateNotebookInstanceLifecycleConfigRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateNotebookInstanceLifecycleConfigRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateNotebookInstanceLifecycleConfigRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasOnCreate() For responses, this returns true if the service returned a value for the OnCreate property.
boolean	hasOnStart() For responses, this returns true if the service returned a value for the OnStart property.
String	notebookInstanceLifecycleConfigName() The name of the lifecycle configuration.
List<NotebookInstanceLifecycleHook>	onCreate() A shell script that runs only once, when you create a notebook instance.
List<NotebookInstanceLifecycleHook>	onStart() A shell script that runs every time you start a notebook instance, including when you create the notebook instance.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateNotebookInstanceLifecycleConfigRequest.Builder>	serializableBuilderClass()
CreateNotebookInstanceLifecycleConfigRequest.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

notebookInstanceLifecycleConfigName

public final String notebookInstanceLifecycleConfigName()

The name of the lifecycle configuration.

Returns:

The name of the lifecycle configuration.

hasOnCreate

public final boolean hasOnCreate()

For responses, this returns true if the service returned a value for the OnCreate 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.

onCreate

public final List<NotebookInstanceLifecycleHook> onCreate()

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

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 hasOnCreate() method.

Returns:

A shell script that runs only once, when you create a notebook instance. The shell script must be a base64-encoded string.

hasOnStart

public final boolean hasOnStart()

For responses, this returns true if the service returned a value for the OnStart 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.

onStart

public final List<NotebookInstanceLifecycleHook> onStart()

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

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 hasOnStart() method.

Returns:

A shell script that runs every time you start a notebook instance, including when you create the notebook instance. The shell script must be a base64-encoded string.

toBuilder

public CreateNotebookInstanceLifecycleConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateNotebookInstanceLifecycleConfigRequest.Builder,CreateNotebookInstanceLifecycleConfigRequest>

Specified by:

toBuilder in class SageMakerRequest

builder

public static CreateNotebookInstanceLifecycleConfigRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateNotebookInstanceLifecycleConfigRequest.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