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>

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ImportNotebookRequest.Builder,ImportNotebookRequest>
      Specified by:
      toBuilder in class AthenaRequest
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.