com.amazonaws.athena.connector.lambda.request.PingResponse 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.request;

/*-
 * #%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.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.google.common.base.Objects;

import static java.util.Objects.requireNonNull;

/**
 * Represents the output of a Ping operation.
 */
public class PingResponse
        extends FederationResponse
{
    private final String catalogName;
    private final String queryId;
    private final String sourceType;
    private final int capabilities;
    private final int serDeVersion;

    /**
     *
     * @param catalogName The name of the catalog that was pinged.
     * @param queryId The ID of the query that pinged.
     * @param sourceType The source type ID of the pinged endpoint.
     * @param capabilities The ID indicating the capabilities of the pinged endpoint.
     */
    @JsonCreator
    public PingResponse(@JsonProperty("catalogName") String catalogName,
            @JsonProperty("queryId") String queryId,
            @JsonProperty("sourceType") String sourceType,
            @JsonProperty("capabilities") int capabilities,
            @JsonProperty("serDeVersion") int serDeVersion)
    {
        requireNonNull(catalogName, "catalogName is null");
        requireNonNull(queryId, "queryId is null");
        this.catalogName = catalogName;
        this.queryId = queryId;
        this.sourceType = sourceType;
        this.capabilities = capabilities;
        // vanilla ObjectMapper defaults to zero on deserialization when not explicitly set for ints, but we want to default to 1
        this.serDeVersion = serDeVersion != 0 ? serDeVersion : 1;
    }

    /**
     * Returns the name of the catalog that was pinged.
     *
     * @return The name of the catalog that was pinged.
     */
    @JsonProperty("catalogName")
    public String getCatalogName()
    {
        return catalogName;
    }

    /**
     * Returns the ID of the query that pinged.
     *
     * @return The ID of the query that pinged.
     */
    @JsonProperty("queryId")
    public String getQueryId()
    {
        return queryId;
    }

    /**
     * Returns the source type ID of the pinged endpoint.
     * @return The source type ID of the pinged endpoint.
     */
    @JsonProperty("sourceType")
    public String getSourceType()
    {
        return sourceType;
    }

    /**
     * Returns the ID indicating the capabilities of the pinged endpoint.
     *
     * @return The ID indicating the capabilities of the pinged endpoint.
     */
    @JsonProperty("capabilities")
    public int getCapabilities()
    {
        return capabilities;
    }

    /**
     * Returns the version of serialization used by the pinged endpoint.
     *
     * @return The version of serialization used by the pinged endpoint.
     */
    @JsonProperty("serDeVersion")
    public int getSerDeVersion()
    {
        return serDeVersion;
    }

    @Override
    public void close()
            throws Exception
    {
        //no-op
    }

    @Override
    public String toString()
    {
        return "PingRequest{" +
                "catalogName='" + catalogName + '\'' +
                ", queryId='" + queryId + '\'' +
                ", sourceType='" + sourceType + '\'' +
                ", capabilities='" + capabilities + '\'' +
                ", serDeVersion='" + serDeVersion + '\'' +
                '}';
    }

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

        PingResponse that = (PingResponse) o;

        return Objects.equal(this.getCatalogName(), that.getCatalogName())
                && Objects.equal(this.queryId, that.queryId)
                && Objects.equal(this.sourceType, that.sourceType)
                && Objects.equal(this.capabilities, that.capabilities)
                && Objects.equal(this.serDeVersion, that.serDeVersion);
    }

    @Override
    public int hashCode()
    {
        return Objects.hashCode(catalogName, queryId, sourceType, capabilities, serDeVersion);
    }
}