software.amazon.awssdk.services.athena.model.DataCatalog Maven / Gradle / Ivy
Show all versions of athena Show documentation
/*
* 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.athena.model;
import java.beans.Transient;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Map;
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.core.traits.MapTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructMap;
import software.amazon.awssdk.core.util.SdkAutoConstructMap;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Contains information about a data catalog in an Amazon Web Services account.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class DataCatalog implements SdkPojo, Serializable, ToCopyableBuilder {
private static final SdkField NAME_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Name")
.getter(getter(DataCatalog::name)).setter(setter(Builder::name))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Name").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("Description").getter(getter(DataCatalog::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField TYPE_FIELD = SdkField. builder(MarshallingType.STRING).memberName("Type")
.getter(getter(DataCatalog::typeAsString)).setter(setter(Builder::type))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Type").build()).build();
private static final SdkField> PARAMETERS_FIELD = SdkField
.> builder(MarshallingType.MAP)
.memberName("Parameters")
.getter(getter(DataCatalog::parameters))
.setter(setter(Builder::parameters))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Parameters").build(),
MapTrait.builder()
.keyLocationName("key")
.valueLocationName("value")
.valueFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("value").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(NAME_FIELD, DESCRIPTION_FIELD,
TYPE_FIELD, PARAMETERS_FIELD));
private static final long serialVersionUID = 1L;
private final String name;
private final String description;
private final String type;
private final Map parameters;
private DataCatalog(BuilderImpl builder) {
this.name = builder.name;
this.description = builder.description;
this.type = builder.type;
this.parameters = builder.parameters;
}
/**
*
* The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use a
* maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length constraint of
* 256 is reserved for use by Athena.
*
*
* @return The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can
* use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length
* constraint of 256 is reserved for use by Athena.
*/
public final String name() {
return name;
}
/**
*
* An optional description of the data catalog.
*
*
* @return An optional description of the data catalog.
*/
public final String description() {
return description;
}
/**
*
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link DataCatalogType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
* @see DataCatalogType
*/
public final DataCatalogType type() {
return DataCatalogType.fromValue(type);
}
/**
*
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #type} will return
* {@link DataCatalogType#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #typeAsString}.
*
*
* @return The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
* @see DataCatalogType
*/
public final String typeAsString() {
return type;
}
/**
* For responses, this returns true if the service returned a value for the Parameters property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is
* useful because the SDK will never return a null collection or map, but you may need to differentiate between the
* service returning nothing (or null) and the service returning an empty collection or map. For requests, this
* returns true if a value for the property was specified in the request builder, and false if a value was not
* specified.
*/
public final boolean hasParameters() {
return parameters != null && !(parameters instanceof SdkAutoConstructMap);
}
/**
*
* Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend on
* the catalog type.
*
*
* -
*
* For the HIVE data catalog type, use the following syntax. The metadata-function
* parameter is required. The sdk-version parameter is optional and defaults to the currently supported
* version.
*
*
* metadata-function=lambda_arn, sdk-version=version_number
*
*
* -
*
* For the LAMBDA data catalog type, use one of the following sets of required parameters, but not
* both.
*
*
* -
*
* If you have one Lambda function that processes metadata and another for reading the actual data, use the
* following syntax. Both parameters are required.
*
*
* metadata-function=lambda_arn, record-function=lambda_arn
*
*
* -
*
* If you have a composite Lambda function that processes both metadata and data, use the following syntax to
* specify your Lambda function.
*
*
* function=lambda_arn
*
*
*
*
* -
*
* The GLUE type takes a catalog ID parameter and is required. The catalog_id is
* the account ID of the Amazon Web Services account to which the Glue catalog belongs.
*
*
* catalog-id=catalog_id
*
*
* -
*
* The GLUE data catalog type also applies to the default AwsDataCatalog that already
* exists in your account, of which you can have only one and cannot modify.
*
*
* -
*
* Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on Athena
* engine version 2.
*
*
*
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasParameters} method.
*
*
* @return Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values
* depend on the catalog type.
*
* -
*
* For the HIVE data catalog type, use the following syntax. The metadata-function
* parameter is required. The sdk-version parameter is optional and defaults to the currently
* supported version.
*
*
* metadata-function=lambda_arn, sdk-version=version_number
*
*
* -
*
* For the LAMBDA data catalog type, use one of the following sets of required parameters, but
* not both.
*
*
* -
*
* If you have one Lambda function that processes metadata and another for reading the actual data, use the
* following syntax. Both parameters are required.
*
*
* metadata-function=lambda_arn, record-function=lambda_arn
*
*
* -
*
* If you have a composite Lambda function that processes both metadata and data, use the following syntax
* to specify your Lambda function.
*
*
* function=lambda_arn
*
*
*
*
* -
*
* The GLUE type takes a catalog ID parameter and is required. The
* catalog_id is the account ID of the Amazon Web Services account to which the Glue
* catalog belongs.
*
*
* catalog-id=catalog_id
*
*
* -
*
* The GLUE data catalog type also applies to the default AwsDataCatalog that
* already exists in your account, of which you can have only one and cannot modify.
*
*
* -
*
* Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run
* on Athena engine version 2.
*
*
*
*
*/
public final Map parameters() {
return parameters;
}
@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(name());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(typeAsString());
hashCode = 31 * hashCode + Objects.hashCode(hasParameters() ? parameters() : null);
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 DataCatalog)) {
return false;
}
DataCatalog other = (DataCatalog) obj;
return Objects.equals(name(), other.name()) && Objects.equals(description(), other.description())
&& Objects.equals(typeAsString(), other.typeAsString()) && hasParameters() == other.hasParameters()
&& Objects.equals(parameters(), other.parameters());
}
/**
* 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("DataCatalog").add("Name", name()).add("Description", description()).add("Type", typeAsString())
.add("Parameters", hasParameters() ? parameters() : null).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "Name":
return Optional.ofNullable(clazz.cast(name()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
case "Type":
return Optional.ofNullable(clazz.cast(typeAsString()));
case "Parameters":
return Optional.ofNullable(clazz.cast(parameters()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((DataCatalog) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends SdkPojo, CopyableBuilder {
/**
*
* The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and can use
* a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the length
* constraint of 256 is reserved for use by Athena.
*
*
* @param name
* The name of the data catalog. The catalog name must be unique for the Amazon Web Services account and
* can use a maximum of 127 alphanumeric, underscore, at sign, or hyphen characters. The remainder of the
* length constraint of 256 is reserved for use by Athena.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder name(String name);
/**
*
* An optional description of the data catalog.
*
*
* @param description
* An optional description of the data catalog.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
/**
*
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
*
*
* @param type
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for
* an external hive metastore, or GLUE for an Glue Data Catalog.
* @see DataCatalogType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataCatalogType
*/
Builder type(String type);
/**
*
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for an
* external hive metastore, or GLUE for an Glue Data Catalog.
*
*
* @param type
* The type of data catalog to create: LAMBDA for a federated catalog, HIVE for
* an external hive metastore, or GLUE for an Glue Data Catalog.
* @see DataCatalogType
* @return Returns a reference to this object so that method calls can be chained together.
* @see DataCatalogType
*/
Builder type(DataCatalogType type);
/**
*
* Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values depend
* on the catalog type.
*
*
* -
*
* For the HIVE data catalog type, use the following syntax. The metadata-function
* parameter is required. The sdk-version parameter is optional and defaults to the currently
* supported version.
*
*
* metadata-function=lambda_arn, sdk-version=version_number
*
*
* -
*
* For the LAMBDA data catalog type, use one of the following sets of required parameters, but not
* both.
*
*
* -
*
* If you have one Lambda function that processes metadata and another for reading the actual data, use the
* following syntax. Both parameters are required.
*
*
* metadata-function=lambda_arn, record-function=lambda_arn
*
*
* -
*
* If you have a composite Lambda function that processes both metadata and data, use the following syntax to
* specify your Lambda function.
*
*
* function=lambda_arn
*
*
*
*
* -
*
* The GLUE type takes a catalog ID parameter and is required. The catalog_id
* is the account ID of the Amazon Web Services account to which the Glue catalog belongs.
*
*
* catalog-id=catalog_id
*
*
* -
*
* The GLUE data catalog type also applies to the default AwsDataCatalog that already
* exists in your account, of which you can have only one and cannot modify.
*
*
* -
*
* Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be run on
* Athena engine version 2.
*
*
*
*
*
*
* @param parameters
* Specifies the Lambda function or functions to use for the data catalog. This is a mapping whose values
* depend on the catalog type.
*
* -
*
* For the HIVE data catalog type, use the following syntax. The
* metadata-function parameter is required. The sdk-version parameter is
* optional and defaults to the currently supported version.
*
*
* metadata-function=lambda_arn, sdk-version=version_number
*
*
* -
*
* For the LAMBDA data catalog type, use one of the following sets of required parameters,
* but not both.
*
*
* -
*
* If you have one Lambda function that processes metadata and another for reading the actual data, use
* the following syntax. Both parameters are required.
*
*
* metadata-function=lambda_arn, record-function=lambda_arn
*
*
* -
*
* If you have a composite Lambda function that processes both metadata and data, use the following
* syntax to specify your Lambda function.
*
*
* function=lambda_arn
*
*
*
*
* -
*
* The GLUE type takes a catalog ID parameter and is required. The
* catalog_id is the account ID of the Amazon Web Services account to which the
* Glue catalog belongs.
*
*
* catalog-id=catalog_id
*
*
* -
*
* The GLUE data catalog type also applies to the default AwsDataCatalog that
* already exists in your account, of which you can have only one and cannot modify.
*
*
* -
*
* Queries that specify a Glue Data Catalog other than the default AwsDataCatalog must be
* run on Athena engine version 2.
*
*
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder parameters(Map parameters);
}
static final class BuilderImpl implements Builder {
private String name;
private String description;
private String type;
private Map parameters = DefaultSdkAutoConstructMap.getInstance();
private BuilderImpl() {
}
private BuilderImpl(DataCatalog model) {
name(model.name);
description(model.description);
type(model.type);
parameters(model.parameters);
}
public final String getName() {
return name;
}
public final void setName(String name) {
this.name = name;
}
@Override
@Transient
public final Builder name(String name) {
this.name = name;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
@Transient
public final Builder description(String description) {
this.description = description;
return this;
}
public final String getType() {
return type;
}
public final void setType(String type) {
this.type = type;
}
@Override
@Transient
public final Builder type(String type) {
this.type = type;
return this;
}
@Override
@Transient
public final Builder type(DataCatalogType type) {
this.type(type == null ? null : type.toString());
return this;
}
public final Map getParameters() {
if (parameters instanceof SdkAutoConstructMap) {
return null;
}
return parameters;
}
public final void setParameters(Map parameters) {
this.parameters = ParametersMapCopier.copy(parameters);
}
@Override
@Transient
public final Builder parameters(Map parameters) {
this.parameters = ParametersMapCopier.copy(parameters);
return this;
}
@Override
public DataCatalog build() {
return new DataCatalog(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}