com.amazonaws.athena.connector.lambda.request.FederationRequest 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.amazonaws.athena.connector.lambda.metadata.GetDataSourceCapabilitiesRequest;
import com.amazonaws.athena.connector.lambda.metadata.GetSplitsRequest;
import com.amazonaws.athena.connector.lambda.metadata.GetTableLayoutRequest;
import com.amazonaws.athena.connector.lambda.metadata.GetTableRequest;
import com.amazonaws.athena.connector.lambda.metadata.ListSchemasRequest;
import com.amazonaws.athena.connector.lambda.metadata.ListTablesRequest;
import com.amazonaws.athena.connector.lambda.records.ReadRecordsRequest;
import com.amazonaws.athena.connector.lambda.security.FederatedIdentity;
import com.amazonaws.athena.connector.lambda.udf.UserDefinedFunctionRequest;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

/**
 * Base class for all user facing requests.
 */
@JsonIgnoreProperties(ignoreUnknown = true)
@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY)
@JsonSubTypes({
        @JsonSubTypes.Type(value = ListSchemasRequest.class, name = "ListSchemasRequest"),
        @JsonSubTypes.Type(value = ListTablesRequest.class, name = "ListTablesRequest"),
        @JsonSubTypes.Type(value = GetTableRequest.class, name = "GetTableRequest"),
        @JsonSubTypes.Type(value = GetTableLayoutRequest.class, name = "GetTableLayoutRequest"),
        @JsonSubTypes.Type(value = GetSplitsRequest.class, name = "GetSplitsRequest"),
        @JsonSubTypes.Type(value = ReadRecordsRequest.class, name = "ReadRecordsRequest"),
        @JsonSubTypes.Type(value = UserDefinedFunctionRequest.class, name = "UserDefinedFunctionRequest"),
        @JsonSubTypes.Type(value = PingRequest.class, name = "PingRequest"),
        @JsonSubTypes.Type(value = GetDataSourceCapabilitiesRequest.class, name = "GetDataSourceCapabilitiesRequest")
})
public abstract class FederationRequest
        implements AutoCloseable
{
    private final FederatedIdentity identity;

    /**
     * Constructs a new FederationRequest object with a null identity.
     */
    public FederationRequest()
    {
        identity = null;
    }

    /**
     * Constructs a new FederationRequest object.
     *
     * @param identity The identity of the caller.
     */
    public FederationRequest(FederatedIdentity identity)
    {
        this.identity = identity;
    }

    /**
     * Returns the identity of the caller.
     *
     * @return The identity of the caller.
     */
    public FederatedIdentity getIdentity()
    {
        return identity;
    }
}