Package software.amazon.awssdk.services.athena.model

Class UpdateNotebookRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.athena.model.AthenaRequest

software.amazon.awssdk.services.athena.model.UpdateNotebookRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>

@Generated("software.amazon.awssdk:codegen")
public final class UpdateNotebookRequest
extends AthenaRequest
implements ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdateNotebookRequest.Builder

Method Summary

Modifier and Type	Method	Description
static UpdateNotebookRequest.Builder	builder()
String	clientRequestToken()	A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	notebookId()	The ID of the notebook to update.
String	payload()	The updated content for the notebook.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateNotebookRequest.Builder>	serializableBuilderClass()
String	sessionId()	The active notebook session ID.
UpdateNotebookRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NotebookType	type()	The notebook content type.
String	typeAsString()	The notebook content type.

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

notebookId

public final String notebookId()

The ID of the notebook to update.

Returns:

The ID of the notebook to update.

payload

public final String payload()

The updated content for the notebook.

Returns:

The updated content for the notebook.

type

public final NotebookType type()

The notebook content type. Currently, the only valid type is IPYNB.

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

Returns:

The notebook content type. Currently, the only valid type is IPYNB.

See Also:

NotebookType

typeAsString

public final String typeAsString()

The notebook content type. Currently, the only valid type is IPYNB.

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

Returns:

The notebook content type. Currently, the only valid type is IPYNB.

See Also:

NotebookType

sessionId

public final String sessionId()

The active notebook session ID. Required if the notebook has an active session.

Returns:

The active notebook session ID. Required if the notebook has an active session.

clientRequestToken

public final String clientRequestToken()

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

Returns:

A unique case-sensitive string used to ensure the request to create the notebook is idempotent (executes only once).

This token is listed as not required because Amazon Web Services SDKs (for example the Amazon Web Services SDK for Java) auto-generate the token for you. If you are not using the Amazon Web Services SDK or the Amazon Web Services CLI, you must provide this token or the action will fail.

toBuilder

public UpdateNotebookRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateNotebookRequest.Builder,UpdateNotebookRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static UpdateNotebookRequest.Builder builder()

serializableBuilderClass

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