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

Class CreateNamedQueryRequest

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.CreateNamedQueryRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateNamedQueryRequest.Builder,CreateNamedQueryRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateNamedQueryRequest extends AthenaRequest implements ToCopyableBuilder<CreateNamedQueryRequest.Builder,CreateNamedQueryRequest>

  • Method Details

    • name

      public final String name()

      The query name.

      Returns:
      The query name.

    • description

      public final String description()

      The query description.

      Returns:
      The query description.

    • database

      public final String database()

      The database to which the query belongs.

      Returns:
      The database to which the query belongs.

    • queryString

      public final String queryString()

      The contents of the query with all query statements.

      Returns:
      The contents of the query with all query statements.

    • clientRequestToken

      public final String clientRequestToken()

      A unique case-sensitive string used to ensure the request to create the query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

      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 users. 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 query is idempotent (executes only once). If another CreateNamedQuery request is received, the same response is returned and another query is not created. If a parameter has changed, for example, the QueryString, an error is returned.

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

    • workGroup

      public final String workGroup()

      The name of the workgroup in which the named query is being created.

      Returns:
      The name of the workgroup in which the named query is being created.

    • toBuilder

      public CreateNamedQueryRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateNamedQueryRequest.Builder,CreateNamedQueryRequest>
      Specified by:
      toBuilder in class AthenaRequest

    • builder

      public static CreateNamedQueryRequest.Builder builder()

    • serializableBuilderClass

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