Class AthenaDatasetDefinition

java.lang.Object
software.amazon.awssdk.services.sagemaker.model.AthenaDatasetDefinition
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AthenaDatasetDefinition.Builder,AthenaDatasetDefinition>
@Generated("software.amazon.awssdk:codegen") public final class AthenaDatasetDefinition extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AthenaDatasetDefinition.Builder,AthenaDatasetDefinition>

Configuration for Athena Dataset Definition input.

See Also:

  • Method Details

    • catalog

      public final String catalog()
      Returns the value of the Catalog property for this object.
      Returns:
      The value of the Catalog property for this object.

    • database

      public final String database()
      Returns the value of the Database property for this object.
      Returns:
      The value of the Database property for this object.

    • queryString

      public final String queryString()
      Returns the value of the QueryString property for this object.
      Returns:
      The value of the QueryString property for this object.

    • workGroup

      public final String workGroup()
      Returns the value of the WorkGroup property for this object.
      Returns:
      The value of the WorkGroup property for this object.

    • outputS3Uri

      public final String outputS3Uri()

      The location in Amazon S3 where Athena query results are stored.

      Returns:
      The location in Amazon S3 where Athena query results are stored.

    • kmsKeyId

      public final String kmsKeyId()

      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

      Returns:
      The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data generated from an Athena query execution.

    • outputFormat

      public final AthenaResultFormat outputFormat()
      Returns the value of the OutputFormat property for this object.

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

      Returns:
      The value of the OutputFormat property for this object.
      See Also:

    • outputFormatAsString

      public final String outputFormatAsString()
      Returns the value of the OutputFormat property for this object.

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

      Returns:
      The value of the OutputFormat property for this object.
      See Also:

    • outputCompression

      public final AthenaResultCompressionType outputCompression()
      Returns the value of the OutputCompression property for this object.

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

      Returns:
      The value of the OutputCompression property for this object.
      See Also:

    • outputCompressionAsString

      public final String outputCompressionAsString()
      Returns the value of the OutputCompression property for this object.

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

      Returns:
      The value of the OutputCompression property for this object.
      See Also:

    • toBuilder

      public AthenaDatasetDefinition.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<AthenaDatasetDefinition.Builder,AthenaDatasetDefinition>
      Returns:
      a builder for type T

    • builder

      public static AthenaDatasetDefinition.Builder builder()

    • serializableBuilderClass

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.