software.amazon.awssdk.services.sagemaker.model.AthenaDatasetDefinition Maven / Gradle / Ivy
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.sagemaker.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Configuration for Athena Dataset Definition input.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class AthenaDatasetDefinition implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField CATALOG_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Catalog")
.getter(getter(AthenaDatasetDefinition::catalog)).setter(setter(Builder::catalog))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Catalog").build()).build();
private static final SdkField DATABASE_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Database").getter(getter(AthenaDatasetDefinition::database)).setter(setter(Builder::database))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Database").build()).build();
private static final SdkField QUERY_STRING_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("QueryString").getter(getter(AthenaDatasetDefinition::queryString)).setter(setter(Builder::queryString))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("QueryString").build()).build();
private static final SdkField WORK_GROUP_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("WorkGroup").getter(getter(AthenaDatasetDefinition::workGroup)).setter(setter(Builder::workGroup))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("WorkGroup").build()).build();
private static final SdkField OUTPUT_S3_URI_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputS3Uri").getter(getter(AthenaDatasetDefinition::outputS3Uri)).setter(setter(Builder::outputS3Uri))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputS3Uri").build()).build();
private static final SdkField KMS_KEY_ID_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("KmsKeyId").getter(getter(AthenaDatasetDefinition::kmsKeyId)).setter(setter(Builder::kmsKeyId))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("KmsKeyId").build()).build();
private static final SdkField OUTPUT_FORMAT_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputFormat").getter(getter(AthenaDatasetDefinition::outputFormatAsString))
.setter(setter(Builder::outputFormat))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputFormat").build()).build();
private static final SdkField OUTPUT_COMPRESSION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("OutputCompression").getter(getter(AthenaDatasetDefinition::outputCompressionAsString))
.setter(setter(Builder::outputCompression))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("OutputCompression").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CATALOG_FIELD, DATABASE_FIELD,
QUERY_STRING_FIELD, WORK_GROUP_FIELD, OUTPUT_S3_URI_FIELD, KMS_KEY_ID_FIELD, OUTPUT_FORMAT_FIELD,
OUTPUT_COMPRESSION_FIELD));
private static final long serialVersionUID = 1L;
private final String catalog;
private final String database;
private final String queryString;
private final String workGroup;
private final String outputS3Uri;
private final String kmsKeyId;
private final String outputFormat;
private final String outputCompression;
private AthenaDatasetDefinition(BuilderImpl builder) {
this.catalog = builder.catalog;
this.database = builder.database;
this.queryString = builder.queryString;
this.workGroup = builder.workGroup;
this.outputS3Uri = builder.outputS3Uri;
this.kmsKeyId = builder.kmsKeyId;
this.outputFormat = builder.outputFormat;
this.outputCompression = builder.outputCompression;
}
/**
* Returns the value of the Catalog property for this object.
*
* @return The value of the Catalog property for this object.
*/
public final String catalog() {
return catalog;
}
/**
* Returns the value of the Database property for this object.
*
* @return The value of the Database property for this object.
*/
public final String database() {
return database;
}
/**
* Returns the value of the QueryString property for this object.
*
* @return The value of the QueryString property for this object.
*/
public final String queryString() {
return queryString;
}
/**
* Returns the value of the WorkGroup property for this object.
*
* @return The value of the WorkGroup property for this object.
*/
public final String workGroup() {
return workGroup;
}
/**
*
* The location in Amazon S3 where Athena query results are stored.
*
*
* @return The location in Amazon S3 where Athena query results are stored.
*/
public final String outputS3Uri() {
return outputS3Uri;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String kmsKeyId() {
return kmsKeyId;
}
/**
* 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, {@link #outputFormat} will
* return {@link AthenaResultFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #outputFormatAsString}.
*
*
* @return The value of the OutputFormat property for this object.
* @see AthenaResultFormat
*/
public final AthenaResultFormat outputFormat() {
return AthenaResultFormat.fromValue(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, {@link #outputFormat} will
* return {@link AthenaResultFormat#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #outputFormatAsString}.
*
*
* @return The value of the OutputFormat property for this object.
* @see AthenaResultFormat
*/
public final String outputFormatAsString() {
return outputFormat;
}
/**
* 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, {@link #outputCompression}
* will return {@link AthenaResultCompressionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #outputCompressionAsString}.
*
*
* @return The value of the OutputCompression property for this object.
* @see AthenaResultCompressionType
*/
public final AthenaResultCompressionType outputCompression() {
return AthenaResultCompressionType.fromValue(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, {@link #outputCompression}
* will return {@link AthenaResultCompressionType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is
* available from {@link #outputCompressionAsString}.
*
*
* @return The value of the OutputCompression property for this object.
* @see AthenaResultCompressionType
*/
public final String outputCompressionAsString() {
return outputCompression;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(catalog());
hashCode = 31 * hashCode + Objects.hashCode(database());
hashCode = 31 * hashCode + Objects.hashCode(queryString());
hashCode = 31 * hashCode + Objects.hashCode(workGroup());
hashCode = 31 * hashCode + Objects.hashCode(outputS3Uri());
hashCode = 31 * hashCode + Objects.hashCode(kmsKeyId());
hashCode = 31 * hashCode + Objects.hashCode(outputFormatAsString());
hashCode = 31 * hashCode + Objects.hashCode(outputCompressionAsString());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof AthenaDatasetDefinition)) {
return false;
}
AthenaDatasetDefinition other = (AthenaDatasetDefinition) obj;
return Objects.equals(catalog(), other.catalog()) && Objects.equals(database(), other.database())
&& Objects.equals(queryString(), other.queryString()) && Objects.equals(workGroup(), other.workGroup())
&& Objects.equals(outputS3Uri(), other.outputS3Uri()) && Objects.equals(kmsKeyId(), other.kmsKeyId())
&& Objects.equals(outputFormatAsString(), other.outputFormatAsString())
&& Objects.equals(outputCompressionAsString(), other.outputCompressionAsString());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("AthenaDatasetDefinition").add("Catalog", catalog()).add("Database", database())
.add("QueryString", queryString()).add("WorkGroup", workGroup()).add("OutputS3Uri", outputS3Uri())
.add("KmsKeyId", kmsKeyId()).add("OutputFormat", outputFormatAsString())
.add("OutputCompression", outputCompressionAsString()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Catalog":
return Optional.ofNullable(clazz.cast(catalog()));
case "Database":
return Optional.ofNullable(clazz.cast(database()));
case "QueryString":
return Optional.ofNullable(clazz.cast(queryString()));
case "WorkGroup":
return Optional.ofNullable(clazz.cast(workGroup()));
case "OutputS3Uri":
return Optional.ofNullable(clazz.cast(outputS3Uri()));
case "KmsKeyId":
return Optional.ofNullable(clazz.cast(kmsKeyId()));
case "OutputFormat":
return Optional.ofNullable(clazz.cast(outputFormatAsString()));
case "OutputCompression":
return Optional.ofNullable(clazz.cast(outputCompressionAsString()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((AthenaDatasetDefinition) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
* Sets the value of the Catalog property for this object.
*
* @param catalog
* The new value for the Catalog property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder catalog(String catalog);
/**
* Sets the value of the Database property for this object.
*
* @param database
* The new value for the Database property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder database(String database);
/**
* Sets the value of the QueryString property for this object.
*
* @param queryString
* The new value for the QueryString property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder queryString(String queryString);
/**
* Sets the value of the WorkGroup property for this object.
*
* @param workGroup
* The new value for the WorkGroup property for this object.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder workGroup(String workGroup);
/**
*
* The location in Amazon S3 where Athena query results are stored.
*
*
* @param outputS3Uri
* The location in Amazon S3 where Athena query results are stored.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder outputS3Uri(String outputS3Uri);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder kmsKeyId(String kmsKeyId);
/**
* Sets the value of the OutputFormat property for this object.
*
* @param outputFormat
* The new value for the OutputFormat property for this object.
* @see AthenaResultFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see AthenaResultFormat
*/
Builder outputFormat(String outputFormat);
/**
* Sets the value of the OutputFormat property for this object.
*
* @param outputFormat
* The new value for the OutputFormat property for this object.
* @see AthenaResultFormat
* @return Returns a reference to this object so that method calls can be chained together.
* @see AthenaResultFormat
*/
Builder outputFormat(AthenaResultFormat outputFormat);
/**
* Sets the value of the OutputCompression property for this object.
*
* @param outputCompression
* The new value for the OutputCompression property for this object.
* @see AthenaResultCompressionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AthenaResultCompressionType
*/
Builder outputCompression(String outputCompression);
/**
* Sets the value of the OutputCompression property for this object.
*
* @param outputCompression
* The new value for the OutputCompression property for this object.
* @see AthenaResultCompressionType
* @return Returns a reference to this object so that method calls can be chained together.
* @see AthenaResultCompressionType
*/
Builder outputCompression(AthenaResultCompressionType outputCompression);
}
static final class BuilderImpl implements Builder {
private String catalog;
private String database;
private String queryString;
private String workGroup;
private String outputS3Uri;
private String kmsKeyId;
private String outputFormat;
private String outputCompression;
private BuilderImpl() {
}
private BuilderImpl(AthenaDatasetDefinition model) {
catalog(model.catalog);
database(model.database);
queryString(model.queryString);
workGroup(model.workGroup);
outputS3Uri(model.outputS3Uri);
kmsKeyId(model.kmsKeyId);
outputFormat(model.outputFormat);
outputCompression(model.outputCompression);
}
public final String getCatalog() {
return catalog;
}
public final void setCatalog(String catalog) {
this.catalog = catalog;
}
@Override
public final Builder catalog(String catalog) {
this.catalog = catalog;
return this;
}
public final String getDatabase() {
return database;
}
public final void setDatabase(String database) {
this.database = database;
}
@Override
public final Builder database(String database) {
this.database = database;
return this;
}
public final String getQueryString() {
return queryString;
}
public final void setQueryString(String queryString) {
this.queryString = queryString;
}
@Override
public final Builder queryString(String queryString) {
this.queryString = queryString;
return this;
}
public final String getWorkGroup() {
return workGroup;
}
public final void setWorkGroup(String workGroup) {
this.workGroup = workGroup;
}
@Override
public final Builder workGroup(String workGroup) {
this.workGroup = workGroup;
return this;
}
public final String getOutputS3Uri() {
return outputS3Uri;
}
public final void setOutputS3Uri(String outputS3Uri) {
this.outputS3Uri = outputS3Uri;
}
@Override
public final Builder outputS3Uri(String outputS3Uri) {
this.outputS3Uri = outputS3Uri;
return this;
}
public final String getKmsKeyId() {
return kmsKeyId;
}
public final void setKmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
}
@Override
public final Builder kmsKeyId(String kmsKeyId) {
this.kmsKeyId = kmsKeyId;
return this;
}
public final String getOutputFormat() {
return outputFormat;
}
public final void setOutputFormat(String outputFormat) {
this.outputFormat = outputFormat;
}
@Override
public final Builder outputFormat(String outputFormat) {
this.outputFormat = outputFormat;
return this;
}
@Override
public final Builder outputFormat(AthenaResultFormat outputFormat) {
this.outputFormat(outputFormat == null ? null : outputFormat.toString());
return this;
}
public final String getOutputCompression() {
return outputCompression;
}
public final void setOutputCompression(String outputCompression) {
this.outputCompression = outputCompression;
}
@Override
public final Builder outputCompression(String outputCompression) {
this.outputCompression = outputCompression;
return this;
}
@Override
public final Builder outputCompression(AthenaResultCompressionType outputCompression) {
this.outputCompression(outputCompression == null ? null : outputCompression.toString());
return this;
}
@Override
public AthenaDatasetDefinition build() {
return new AthenaDatasetDefinition(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy