/* * Copyright 2018-2023 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 com.amazonaws.services.codestarconnections; import javax.annotation.Generated; import com.amazonaws.services.codestarconnections.model.*; /** * Interface for accessing AWS CodeStar connections asynchronously. Each asynchronous method will return a Java Future * object representing the asynchronous operation; overloads which accept an {@code AsyncHandler} can be used to receive * notification when an asynchronous operation completes. *

* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from * {@link com.amazonaws.services.codestarconnections.AbstractAWSCodeStarconnectionsAsync} instead. *

*

* AWS CodeStar Connections *

* This AWS CodeStar Connections API Reference provides descriptions and usage examples of the operations and data types * for the AWS CodeStar Connections API. You can use the connections API to work with connections and installations. *

*

* Connections are configurations that you use to connect AWS resources to external code repositories. Each * connection is a resource that can be given to services such as CodePipeline to connect to a third-party repository * such as Bitbucket. For example, you can add the connection in CodePipeline so that it triggers your pipeline when a * code change is made to your third-party code repository. Each connection is named and associated with a unique ARN * that is used to reference the connection. *

*

* When you create a connection, the console initiates a third-party connection handshake. Installations are the * apps that are used to conduct this handshake. For example, the installation for the Bitbucket provider type is the * Bitbucket app. When you create a connection, you can choose an existing installation or create one. *

*

* When you want to create a connection to an installed provider type such as GitHub Enterprise Server, you create a * host for your connections. *

*

* You can work with connections by calling: *

* *

* You can work with hosts by calling: *

* *

* You can work with tags in AWS CodeStar Connections by calling the following: *

* *

* For information about how to use AWS CodeStar Connections, see the Developer Tools User * Guide. *

*/ @Generated("com.amazonaws:aws-java-sdk-code-generator") public interface AWSCodeStarconnectionsAsync extends AWSCodeStarconnections { /** *

* Creates a connection that can then be given to other AWS services like CodePipeline so that it can access * third-party code repositories. The connection is in pending status until the third-party connection handshake is * completed from the console. *

* * @param createConnectionRequest * @return A Java Future containing the result of the CreateConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsync.CreateConnection * @see AWS API Documentation */ java.util.concurrent.Future createConnectionAsync(CreateConnectionRequest createConnectionRequest); /** *

* Creates a connection that can then be given to other AWS services like CodePipeline so that it can access * third-party code repositories. The connection is in pending status until the third-party connection handshake is * completed from the console. *

* * @param createConnectionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.CreateConnection * @see AWS API Documentation */ java.util.concurrent.Future createConnectionAsync(CreateConnectionRequest createConnectionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used * when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You * create one host for all connections to that provider. *

* *

* A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` * by setting up the host in the console. *

* * * @param createHostRequest * @return A Java Future containing the result of the CreateHost operation returned by the service. * @sample AWSCodeStarconnectionsAsync.CreateHost * @see AWS API Documentation */ java.util.concurrent.Future createHostAsync(CreateHostRequest createHostRequest); /** *

* Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used * when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You * create one host for all connections to that provider. *

* *

* A host created through the CLI or the SDK is in `PENDING` status by default. You can make its status `AVAILABLE` * by setting up the host in the console. *

* * * @param createHostRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the CreateHost operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.CreateHost * @see AWS API Documentation */ java.util.concurrent.Future createHostAsync(CreateHostRequest createHostRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* The connection to be deleted. *

* * @param deleteConnectionRequest * @return A Java Future containing the result of the DeleteConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsync.DeleteConnection * @see AWS API Documentation */ java.util.concurrent.Future deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest); /** *

* The connection to be deleted. *

* * @param deleteConnectionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.DeleteConnection * @see AWS API Documentation */ java.util.concurrent.Future deleteConnectionAsync(DeleteConnectionRequest deleteConnectionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* The host to be deleted. Before you delete a host, all connections associated to the host must be deleted. *

* *

* A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. *

* * * @param deleteHostRequest * @return A Java Future containing the result of the DeleteHost operation returned by the service. * @sample AWSCodeStarconnectionsAsync.DeleteHost * @see AWS API Documentation */ java.util.concurrent.Future deleteHostAsync(DeleteHostRequest deleteHostRequest); /** *

* The host to be deleted. Before you delete a host, all connections associated to the host must be deleted. *

* *

* A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state. *

* * * @param deleteHostRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the DeleteHost operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.DeleteHost * @see AWS API Documentation */ java.util.concurrent.Future deleteHostAsync(DeleteHostRequest deleteHostRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the connection ARN and details such as status, owner, and provider type. *

* * @param getConnectionRequest * @return A Java Future containing the result of the GetConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsync.GetConnection * @see AWS API Documentation */ java.util.concurrent.Future getConnectionAsync(GetConnectionRequest getConnectionRequest); /** *

* Returns the connection ARN and details such as status, owner, and provider type. *

* * @param getConnectionRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetConnection operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.GetConnection * @see AWS API Documentation */ java.util.concurrent.Future getConnectionAsync(GetConnectionRequest getConnectionRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC * configuration. *

* * @param getHostRequest * @return A Java Future containing the result of the GetHost operation returned by the service. * @sample AWSCodeStarconnectionsAsync.GetHost * @see AWS * API Documentation */ java.util.concurrent.Future getHostAsync(GetHostRequest getHostRequest); /** *

* Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC * configuration. *

* * @param getHostRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the GetHost operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.GetHost * @see AWS * API Documentation */ java.util.concurrent.Future getHostAsync(GetHostRequest getHostRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the connections associated with your account. *

* * @param listConnectionsRequest * @return A Java Future containing the result of the ListConnections operation returned by the service. * @sample AWSCodeStarconnectionsAsync.ListConnections * @see AWS API Documentation */ java.util.concurrent.Future listConnectionsAsync(ListConnectionsRequest listConnectionsRequest); /** *

* Lists the connections associated with your account. *

* * @param listConnectionsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListConnections operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.ListConnections * @see AWS API Documentation */ java.util.concurrent.Future listConnectionsAsync(ListConnectionsRequest listConnectionsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Lists the hosts associated with your account. *

* * @param listHostsRequest * @return A Java Future containing the result of the ListHosts operation returned by the service. * @sample AWSCodeStarconnectionsAsync.ListHosts * @see AWS * API Documentation */ java.util.concurrent.Future listHostsAsync(ListHostsRequest listHostsRequest); /** *

* Lists the hosts associated with your account. *

* * @param listHostsRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListHosts operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.ListHosts * @see AWS * API Documentation */ java.util.concurrent.Future listHostsAsync(ListHostsRequest listHostsRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Gets the set of key-value pairs (metadata) that are used to manage the resource. *

* * @param listTagsForResourceRequest * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSCodeStarconnectionsAsync.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest); /** *

* Gets the set of key-value pairs (metadata) that are used to manage the resource. *

* * @param listTagsForResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the ListTagsForResource operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.ListTagsForResource * @see AWS API Documentation */ java.util.concurrent.Future listTagsForResourceAsync(ListTagsForResourceRequest listTagsForResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. *

* * @param tagResourceRequest * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSCodeStarconnectionsAsync.TagResource * @see AWS API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest); /** *

* Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. *

* * @param tagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the TagResource operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.TagResource * @see AWS API Documentation */ java.util.concurrent.Future tagResourceAsync(TagResourceRequest tagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Removes tags from an AWS resource. *

* * @param untagResourceRequest * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSCodeStarconnectionsAsync.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest); /** *

* Removes tags from an AWS resource. *

* * @param untagResourceRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UntagResource operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.UntagResource * @see AWS API Documentation */ java.util.concurrent.Future untagResourceAsync(UntagResourceRequest untagResourceRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); /** *

* Updates a specified host with the provided configurations. *

* * @param updateHostRequest * @return A Java Future containing the result of the UpdateHost operation returned by the service. * @sample AWSCodeStarconnectionsAsync.UpdateHost * @see AWS API Documentation */ java.util.concurrent.Future updateHostAsync(UpdateHostRequest updateHostRequest); /** *

* Updates a specified host with the provided configurations. *

* * @param updateHostRequest * @param asyncHandler * Asynchronous callback handler for events in the lifecycle of the request. Users can provide an * implementation of the callback methods in this interface to receive notification of successful or * unsuccessful completion of the operation. * @return A Java Future containing the result of the UpdateHost operation returned by the service. * @sample AWSCodeStarconnectionsAsyncHandler.UpdateHost * @see AWS API Documentation */ java.util.concurrent.Future updateHostAsync(UpdateHostRequest updateHostRequest, com.amazonaws.handlers.AsyncHandler asyncHandler); }