software.amazon.awssdk.services.finspacedata.FinspaceDataAsyncClient Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of finspacedata Show documentation
The AWS Java SDK for Finspace Data module holds the client classes that are used for communicating with Finspace Data.
There is a newer version: 2.29.39
/*
 * 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.finspacedata;

import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.core.SdkClient;
import software.amazon.awssdk.services.finspacedata.model.CreateChangesetRequest;
import software.amazon.awssdk.services.finspacedata.model.CreateChangesetResponse;
import software.amazon.awssdk.services.finspacedata.model.GetProgrammaticAccessCredentialsRequest;
import software.amazon.awssdk.services.finspacedata.model.GetProgrammaticAccessCredentialsResponse;
import software.amazon.awssdk.services.finspacedata.model.GetWorkingLocationRequest;
import software.amazon.awssdk.services.finspacedata.model.GetWorkingLocationResponse;

/**
 * Service client for accessing FinSpace Data asynchronously. This can be created using the static {@link #builder()}
 * method.
 *
 * 
 * The FinSpace APIs let you take actions inside the FinSpace environment.
 * 
 */
@Generated("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface FinspaceDataAsyncClient extends SdkClient {
    String SERVICE_NAME = "finspace-api";

    /**
     * Value for looking up the service's metadata from the
     * {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
     */
    String SERVICE_METADATA_ID = "finspace-api";

    /**
     * Create a {@link FinspaceDataAsyncClient} with the region loaded from the
     * {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
     * {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
     */
    static FinspaceDataAsyncClient create() {
        return builder().build();
    }

    /**
     * Create a builder that can be used to configure and create a {@link FinspaceDataAsyncClient}.
     */
    static FinspaceDataAsyncClientBuilder builder() {
        return new DefaultFinspaceDataAsyncClientBuilder();
    }

    /**
     * 
     * Creates a new changeset in a FinSpace dataset.
     * 
     *
     * @param createChangesetRequest
     * @return A Java Future containing the result of the CreateChangeset operation returned by the service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         ResourceNotFoundException One or more resources can't be found.
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         ValidationException The input fails to satisfy the constraints specified by an AWS service.
     *         ThrottlingException The request was denied due to request throttling.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.CreateChangeset
     * @see AWS API
     *      Documentation
     */
    default CompletableFuture createChangeset(CreateChangesetRequest createChangesetRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * Creates a new changeset in a FinSpace dataset.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link CreateChangesetRequest.Builder} avoiding the need
     * to create one manually via {@link CreateChangesetRequest#builder()}
     * 
     *
     * @param createChangesetRequest
     *        A {@link Consumer} that will call methods on {@link CreateChangesetRequest.Builder} to create a request.
     * @return A Java Future containing the result of the CreateChangeset operation returned by the service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         ResourceNotFoundException One or more resources can't be found.
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         ValidationException The input fails to satisfy the constraints specified by an AWS service.
     *         ThrottlingException The request was denied due to request throttling.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.CreateChangeset
     * @see AWS API
     *      Documentation
     */
    default CompletableFuture createChangeset(
            Consumer createChangesetRequest) {
        return createChangeset(CreateChangesetRequest.builder().applyMutation(createChangesetRequest).build());
    }

    /**
     * 
     * Request programmatic credentials to use with Habanero SDK.
     * 
     *
     * @param getProgrammaticAccessCredentialsRequest
     * @return A Java Future containing the result of the GetProgrammaticAccessCredentials operation returned by the
     *         service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         ThrottlingException The request was denied due to request throttling.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.GetProgrammaticAccessCredentials
     * @see AWS API Documentation
     */
    default CompletableFuture getProgrammaticAccessCredentials(
            GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * Request programmatic credentials to use with Habanero SDK.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link GetProgrammaticAccessCredentialsRequest.Builder}
     * avoiding the need to create one manually via {@link GetProgrammaticAccessCredentialsRequest#builder()}
     * 
     *
     * @param getProgrammaticAccessCredentialsRequest
     *        A {@link Consumer} that will call methods on {@link GetProgrammaticAccessCredentialsRequest.Builder} to
     *        create a request.
     * @return A Java Future containing the result of the GetProgrammaticAccessCredentials operation returned by the
     *         service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         ThrottlingException The request was denied due to request throttling.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.GetProgrammaticAccessCredentials
     * @see AWS API Documentation
     */
    default CompletableFuture getProgrammaticAccessCredentials(
            Consumer getProgrammaticAccessCredentialsRequest) {
        return getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest.builder()
                .applyMutation(getProgrammaticAccessCredentialsRequest).build());
    }

    /**
     * 
     * A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in
     * Habanero notebook.
     * 
     *
     * @param getWorkingLocationRequest
     * @return A Java Future containing the result of the GetWorkingLocation operation returned by the service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         ThrottlingException The request was denied due to request throttling.
     *         ValidationException The input fails to satisfy the constraints specified by an AWS service.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.GetWorkingLocation
     * @see AWS
     *      API Documentation
     */
    default CompletableFuture getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest) {
        throw new UnsupportedOperationException();
    }

    /**
     * 
     * A temporary Amazon S3 location to copy your files from a source location to stage or use as a scratch space in
     * Habanero notebook.
     * 
     * 

     * 
     * This is a convenience which creates an instance of the {@link GetWorkingLocationRequest.Builder} avoiding the
     * need to create one manually via {@link GetWorkingLocationRequest#builder()}
     * 
     *
     * @param getWorkingLocationRequest
     *        A {@link Consumer} that will call methods on {@link GetWorkingLocationRequest.Builder} to create a
     *        request.
     * @return A Java Future containing the result of the GetWorkingLocation operation returned by the service.

     *         The CompletableFuture returned by this method can be completed exceptionally with the following
     *         exceptions.
     *         
     *         InternalServerException The request processing has failed because of an unknown error, exception or
     *         failure.
     *         AccessDeniedException You do not have sufficient access to perform this action.
     *         ThrottlingException The request was denied due to request throttling.
     *         ValidationException The input fails to satisfy the constraints specified by an AWS service.
     *         SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
     *         Can be used for catch all scenarios.
     *         SdkClientException If any client side error occurs such as an IO related failure, failure to get
     *         credentials, etc.
     *         FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an
     *         instance of this type.
     *         
     * @sample FinspaceDataAsyncClient.GetWorkingLocation
     * @see AWS
     *      API Documentation
     */
    default CompletableFuture getWorkingLocation(
            Consumer getWorkingLocationRequest) {
        return getWorkingLocation(GetWorkingLocationRequest.builder().applyMutation(getWorkingLocationRequest).build());
    }
}