com.amazonaws.athena.connector.lambda.metadata.GetTableLayoutRequest Maven / Gradle / Ivy

Go to download
package com.amazonaws.athena.connector.lambda.metadata;

/*-
 * #%L
 * Amazon Athena Query Federation SDK
 * %%
 * Copyright (C) 2019 Amazon Web Services
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License 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.
 * #L%
 */

import com.amazonaws.athena.connector.lambda.domain.TableName;
import com.amazonaws.athena.connector.lambda.domain.predicate.Constraints;
import com.amazonaws.athena.connector.lambda.domain.predicate.ValueSet;
import com.amazonaws.athena.connector.lambda.security.FederatedIdentity;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Objects;
import org.apache.arrow.vector.types.pojo.Schema;

import java.util.Collections;
import java.util.HashSet;
import java.util.Set;

import static java.util.Objects.requireNonNull;

/**
 * Represents the input of a GetTableLayout operation.
 */
public class GetTableLayoutRequest
        extends MetadataRequest
{
    private final TableName tableName;
    private final Constraints constraints;
    private final Schema schema;
    private final Set partitionCols;

    /**
     * Constructs a new GetTableLayoutRequest object.
     *
     * @param identity The identity of the caller.
     * @param queryId The ID of the query requesting metadata.
     * @param catalogName The catalog name that the table layout should be generated for.
     * @param tableName The table name that the table layout should be generated for.
     * @param constraints The constraints that can be applied to table layout generation.
     * @param schema The table's schema.
     * @param partitionCols The partition columns that can be used for table layout generation.
     */
    @JsonCreator
    public GetTableLayoutRequest(@JsonProperty("identity") FederatedIdentity identity,
            @JsonProperty("queryId") String queryId,
            @JsonProperty("catalogName") String catalogName,
            @JsonProperty("tableName") TableName tableName,
            @JsonProperty("constraints") Constraints constraints,
            @JsonProperty("schema") Schema schema,
            @JsonProperty("partitionCols") Set partitionCols)
    {
        super(identity, MetadataRequestType.GET_TABLE_LAYOUT, queryId, catalogName);
        requireNonNull(partitionCols, "partitionCols is null");
        this.tableName = requireNonNull(tableName, "tableName is null");
        this.constraints = requireNonNull(constraints, "constraints is null");
        this.schema = requireNonNull(schema, "schema is null");
        this.partitionCols = Collections.unmodifiableSet(new HashSet<>(partitionCols));
    }

    /**
     * Returns the table name to generate a table layout for.
     *
     * @return The table name to generate a table layout for.
     */
    public TableName getTableName()
    {
        return tableName;
    }

    /**
     * Returns the constraints that can be applied to table layout generation.
     *
     * @return The constraints that can be applied to table layout generation.
     */
    public Constraints getConstraints()
    {
        return constraints;
    }

    /**
     * Returns the table's schema.
     *
     * @return The table's schema.
     */
    public Schema getSchema()
    {
        return schema;
    }

    /**
     * Returns the partition columns that can be used for table layout generation.
     *
     * @return The partition columns that can be used for table layout generation.
     */
    public Set getPartitionCols()
    {
        return partitionCols;
    }

    /**
     * Frees up resources associated with the constraints Block.
     */
    @Override
    public void close()
            throws Exception
    {
        for (ValueSet next : constraints.getSummary().values()) {
            next.close();
        }
        constraints.close();
    }

    @Override
    public String toString()
    {
        return "GetTableLayoutRequest{" +
                "queryId=" + getQueryId() +
                ", tableName=" + tableName +
                ", constraints=" + constraints +
                ", schema=" + schema +
                ", partitionCols=" + partitionCols +
                '}';
    }

    @Override
    public boolean equals(Object o)
    {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        GetTableLayoutRequest that = (GetTableLayoutRequest) o;

        return Objects.equal(this.tableName, that.tableName) &&
                Objects.equal(this.constraints, that.constraints) &&
                Objects.equal(this.schema, that.schema) &&
                Objects.equal(this.partitionCols, that.partitionCols) &&
                Objects.equal(this.getRequestType(), that.getRequestType()) &&
                Objects.equal(this.getCatalogName(), that.getCatalogName());
    }

    @Override
    public int hashCode()
    {
        return Objects.hashCode(tableName, constraints, schema, partitionCols, getRequestType(), getCatalogName());
    }
}