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

Class ImportNotebookRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ImportNotebookRequest.Builder,ImportNotebookRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ImportNotebookRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ImportNotebookRequest.Builder	builder()
String	clientRequestToken()	A unique case-sensitive string used to ensure the request to import 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	name()	The name of the notebook to import.
String	notebookS3LocationUri()	A URI that specifies the Amazon S3 location of a notebook file in ipynb format.
String	payload()	The notebook content to be imported.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ImportNotebookRequest.Builder>	serializableBuilderClass()
ImportNotebookRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
NotebookType	type()	The notebook content type.
String	typeAsString()	The notebook content type.
String	workGroup()	The name of the Spark enabled workgroup to import the notebook to.

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

workGroup

public final String workGroup()

The name of the Spark enabled workgroup to import the notebook to.

Returns:

The name of the Spark enabled workgroup to import the notebook to.

name

public final String name()

The name of the notebook to import.

Returns:

The name of the notebook to import.

payload

public final String payload()

The notebook content to be imported. The payload must be in ipynb format.

Returns:

The notebook content to be imported. The payload must be in ipynb format.

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

notebookS3LocationUri

public final String notebookS3LocationUri()

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

Returns:

A URI that specifies the Amazon S3 location of a notebook file in ipynb format.

clientRequestToken

public final String clientRequestToken()

A unique case-sensitive string used to ensure the request to import 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 import 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 ImportNotebookRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportNotebookRequest.Builder,ImportNotebookRequest>

Specified by:

toBuilder in class AthenaRequest

builder

public static ImportNotebookRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo