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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-athena-federation-sdk Show documentation
The Athena Query Federation SDK defines a set of interfaces and wire protocols that you can implement to enable Athena to delegate portions of it's query execution plan to code that you deploy/write.
There is a newer version: 2024.46.1
Show newest version
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.Split;
import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Objects;

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

import static java.util.Objects.requireNonNull;

/**
 * Represents the output of a GetSplits operation.
 */
public class GetSplitsResponse
        extends MetadataResponse
{
    private final Set splits;
    private final String continuationToken;

    /**
     * Constructs a new GetSplitsResponse object.
     *
     * @param catalogName The catalog that splits were generated for.
     * @param splits The splits that were generated.
     * @param continuationToken A continuation token that, if present, can be used to request the next batch of splits.
     *          This token is opaque and only needs to be understood by the same MetadataHandler that produces it.
     */
    @JsonCreator
    public GetSplitsResponse(@JsonProperty("catalogName") String catalogName,
            @JsonProperty("splits") Set splits,
            @JsonProperty("continuationToken") String continuationToken)
    {
        super(MetadataRequestType.GET_SPLITS, catalogName);
        requireNonNull(splits, "splits is null");
        this.splits = Collections.unmodifiableSet(splits);
        this.continuationToken = continuationToken;
    }

    /**
     * Constructs a new GetSplitsResponse object. Convenience constructor for when there is no continuation token.
     *
     * @param catalogName The catalog that splits were generated for.
     * @param splits The splits that were generated.
     */
    public GetSplitsResponse(String catalogName,
            Set splits)
    {
        super(MetadataRequestType.GET_SPLITS, catalogName);
        requireNonNull(splits, "splits is null");
        this.splits = Collections.unmodifiableSet(splits);
        this.continuationToken = null;
    }

    /**
     * Constructs a new GetSplitsResponse object. Convenience constructor for when there is no continuation token
     * and only a single split.
     *
     * @param catalogName The catalog that splits were generated for.
     * @param split The splits that were generated.
     */
    public GetSplitsResponse(String catalogName,
            Split split)
    {
        super(MetadataRequestType.GET_SPLITS, catalogName);
        requireNonNull(split, "split is null");
        Set splits = new HashSet<>();
        splits.add(split);
        this.splits = Collections.unmodifiableSet(splits);
        this.continuationToken = null;
    }

    /**
     * Returns the generated splits.
     *
     * @return The splits that were generated.
     */
    @JsonProperty
    public Set getSplits()
    {
        return splits;
    }

    /**
     * Returns the continuation token that, if present, can be used to request the next batch of splits.
     *
     * @return The continuation token that, if present, can be used to request the next batch of splits.
     */
    @JsonProperty
    public String getContinuationToken()
    {
        return continuationToken;
    }

    @Override
    public void close()
            throws Exception
    {
        //NoOp
    }

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

        GetSplitsResponse that = (GetSplitsResponse) o;

        return Objects.equal(this.splits, that.splits) &&
                Objects.equal(this.continuationToken, that.continuationToken) &&
                Objects.equal(this.getRequestType(), that.getRequestType()) &&
                Objects.equal(this.getCatalogName(), that.getCatalogName());
    }

    @Override
    public int hashCode()
    {
        return Objects.hashCode(splits, continuationToken, getRequestType(), getCatalogName());
    }

    @Override
    public String toString()
    {
        return "GetSplitsResponse{" +
                "splitSize=" + splits.size() +
                ", continuationToken='" + continuationToken + '\'' +
                '}';
    }
}