com.amazonaws.services.codecommit

Interface AWSCodeCommitAsync

All Superinterfaces:

AWSCodeCommit

All Known Implementing Classes:

AbstractAWSCodeCommitAsync, AWSCodeCommitAsyncClient

public interface AWSCodeCommitAsync
extends AWSCodeCommit

Interface for accessing CodeCommit asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

AWS CodeCommit

This is the AWS CodeCommit API Reference. This reference provides descriptions of the AWS CodeCommit API.

You can use the AWS CodeCommit API to work with the following objects:

• Repositories
• Branches
• Commits

For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.

Method Summary

Methods

Modifier and Type	Method and Description
Future<BatchGetRepositoriesResult>	batchGetRepositoriesAsync(BatchGetRepositoriesRequest batchGetRepositoriesRequest) Gets information about one or more repositories.
Future<BatchGetRepositoriesResult>	batchGetRepositoriesAsync(BatchGetRepositoriesRequest batchGetRepositoriesRequest, AsyncHandler<BatchGetRepositoriesRequest,BatchGetRepositoriesResult> asyncHandler) Gets information about one or more repositories.
Future<Void>	createBranchAsync(CreateBranchRequest createBranchRequest) Creates a new branch in a repository and points the branch to a commit.
Future<Void>	createBranchAsync(CreateBranchRequest createBranchRequest, AsyncHandler<CreateBranchRequest,Void> asyncHandler) Creates a new branch in a repository and points the branch to a commit.
Future<CreateRepositoryResult>	createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest) Creates a new, empty repository.
Future<CreateRepositoryResult>	createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest, AsyncHandler<CreateRepositoryRequest,CreateRepositoryResult> asyncHandler) Creates a new, empty repository.
Future<DeleteRepositoryResult>	deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest) Deletes a repository.
Future<DeleteRepositoryResult>	deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest, AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResult> asyncHandler) Deletes a repository.
Future<GetBranchResult>	getBranchAsync(GetBranchRequest getBranchRequest) Retrieves information about a repository branch, including its name and the last commit ID.
Future<GetBranchResult>	getBranchAsync(GetBranchRequest getBranchRequest, AsyncHandler<GetBranchRequest,GetBranchResult> asyncHandler) Retrieves information about a repository branch, including its name and the last commit ID.
Future<GetRepositoryResult>	getRepositoryAsync(GetRepositoryRequest getRepositoryRequest) Gets information about a repository.
Future<GetRepositoryResult>	getRepositoryAsync(GetRepositoryRequest getRepositoryRequest, AsyncHandler<GetRepositoryRequest,GetRepositoryResult> asyncHandler) Gets information about a repository.
Future<ListBranchesResult>	listBranchesAsync(ListBranchesRequest listBranchesRequest) Gets information about one or more branches in a repository.
Future<ListBranchesResult>	listBranchesAsync(ListBranchesRequest listBranchesRequest, AsyncHandler<ListBranchesRequest,ListBranchesResult> asyncHandler) Gets information about one or more branches in a repository.
Future<ListRepositoriesResult>	listRepositoriesAsync(ListRepositoriesRequest listRepositoriesRequest) Gets information about one or more repositories.
Future<ListRepositoriesResult>	listRepositoriesAsync(ListRepositoriesRequest listRepositoriesRequest, AsyncHandler<ListRepositoriesRequest,ListRepositoriesResult> asyncHandler) Gets information about one or more repositories.
Future<Void>	updateDefaultBranchAsync(UpdateDefaultBranchRequest updateDefaultBranchRequest) Sets or changes the default branch name for the specified repository.
Future<Void>	updateDefaultBranchAsync(UpdateDefaultBranchRequest updateDefaultBranchRequest, AsyncHandler<UpdateDefaultBranchRequest,Void> asyncHandler) Sets or changes the default branch name for the specified repository.
Future<Void>	updateRepositoryDescriptionAsync(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest) Sets or changes the comment or description for a repository.
Future<Void>	updateRepositoryDescriptionAsync(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest, AsyncHandler<UpdateRepositoryDescriptionRequest,Void> asyncHandler) Sets or changes the comment or description for a repository.
Future<Void>	updateRepositoryNameAsync(UpdateRepositoryNameRequest updateRepositoryNameRequest) Renames a repository.
Future<Void>	updateRepositoryNameAsync(UpdateRepositoryNameRequest updateRepositoryNameRequest, AsyncHandler<UpdateRepositoryNameRequest,Void> asyncHandler) Renames a repository.

Methods inherited from interface com.amazonaws.services.codecommit.AWSCodeCommit

batchGetRepositories, createBranch, createRepository, deleteRepository, getBranch, getCachedResponseMetadata, getRepository, listBranches, listRepositories, setEndpoint, setRegion, shutdown, updateDefaultBranch, updateRepositoryDescription, updateRepositoryName

Method Detail

batchGetRepositoriesAsync

Future<BatchGetRepositoriesResult> batchGetRepositoriesAsync(BatchGetRepositoriesRequest batchGetRepositoriesRequest)

Gets information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

batchGetRepositoriesRequest - Represents the input of a batch get repositories operation.

Returns:

A Java Future containing the result of the BatchGetRepositories operation returned by the service.

batchGetRepositoriesAsync

Future<BatchGetRepositoriesResult> batchGetRepositoriesAsync(BatchGetRepositoriesRequest batchGetRepositoriesRequest,
                                                           AsyncHandler<BatchGetRepositoriesRequest,BatchGetRepositoriesResult> asyncHandler)

Gets information about one or more repositories.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

batchGetRepositoriesRequest - Represents the input of a batch get repositories operation.

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.

Returns:

A Java Future containing the result of the BatchGetRepositories operation returned by the service.

createBranchAsync

Future<Void> createBranchAsync(CreateBranchRequest createBranchRequest)

Creates a new branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Parameters:

createBranchRequest - Represents the input of a create branch operation.

createBranchAsync

Future<Void> createBranchAsync(CreateBranchRequest createBranchRequest,
                             AsyncHandler<CreateBranchRequest,Void> asyncHandler)

Creates a new branch in a repository and points the branch to a commit.

Calling the create branch operation does not set a repository's default branch. To do this, call the update default branch operation.

Parameters:

createBranchRequest - Represents the input of a create branch operation.

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.

createRepositoryAsync

Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest)

Creates a new, empty repository.

Parameters:

createRepositoryRequest - Represents the input of a create repository operation.

Returns:

A Java Future containing the result of the CreateRepository operation returned by the service.

createRepositoryAsync

Future<CreateRepositoryResult> createRepositoryAsync(CreateRepositoryRequest createRepositoryRequest,
                                                   AsyncHandler<CreateRepositoryRequest,CreateRepositoryResult> asyncHandler)

Creates a new, empty repository.

Parameters:

createRepositoryRequest - Represents the input of a create repository operation.

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.

Returns:

A Java Future containing the result of the CreateRepository operation returned by the service.

deleteRepositoryAsync

Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest)

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

Parameters:

deleteRepositoryRequest - Represents the input of a delete repository operation.

Returns:

A Java Future containing the result of the DeleteRepository operation returned by the service.

deleteRepositoryAsync

Future<DeleteRepositoryResult> deleteRepositoryAsync(DeleteRepositoryRequest deleteRepositoryRequest,
                                                   AsyncHandler<DeleteRepositoryRequest,DeleteRepositoryResult> asyncHandler)

Deletes a repository. If a specified repository was already deleted, a null repository ID will be returned.

Deleting a repository also deletes all associated objects and metadata. After a repository is deleted, all future push calls to the deleted repository will fail.

Parameters:

deleteRepositoryRequest - Represents the input of a delete repository operation.

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.

Returns:

A Java Future containing the result of the DeleteRepository operation returned by the service.

getBranchAsync

Future<GetBranchResult> getBranchAsync(GetBranchRequest getBranchRequest)

Retrieves information about a repository branch, including its name and the last commit ID.

Parameters:

getBranchRequest - Represents the input of a get branch operation.

Returns:

A Java Future containing the result of the GetBranch operation returned by the service.

getBranchAsync

Future<GetBranchResult> getBranchAsync(GetBranchRequest getBranchRequest,
                                     AsyncHandler<GetBranchRequest,GetBranchResult> asyncHandler)

Retrieves information about a repository branch, including its name and the last commit ID.

Parameters:

getBranchRequest - Represents the input of a get branch operation.

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.

Returns:

A Java Future containing the result of the GetBranch operation returned by the service.

getRepositoryAsync

Future<GetRepositoryResult> getRepositoryAsync(GetRepositoryRequest getRepositoryRequest)

Gets information about a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

getRepositoryRequest - Represents the input of a get repository operation.

Returns:

A Java Future containing the result of the GetRepository operation returned by the service.

getRepositoryAsync

Future<GetRepositoryResult> getRepositoryAsync(GetRepositoryRequest getRepositoryRequest,
                                             AsyncHandler<GetRepositoryRequest,GetRepositoryResult> asyncHandler)

Gets information about a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

getRepositoryRequest - Represents the input of a get repository operation.

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.

Returns:

A Java Future containing the result of the GetRepository operation returned by the service.

listBranchesAsync

Future<ListBranchesResult> listBranchesAsync(ListBranchesRequest listBranchesRequest)

Gets information about one or more branches in a repository.

Parameters:

listBranchesRequest - Represents the input of a list branches operation.

Returns:

A Java Future containing the result of the ListBranches operation returned by the service.

listBranchesAsync

Future<ListBranchesResult> listBranchesAsync(ListBranchesRequest listBranchesRequest,
                                           AsyncHandler<ListBranchesRequest,ListBranchesResult> asyncHandler)

Gets information about one or more branches in a repository.

Parameters:

listBranchesRequest - Represents the input of a list branches operation.

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.

Returns:

A Java Future containing the result of the ListBranches operation returned by the service.

listRepositoriesAsync

Future<ListRepositoriesResult> listRepositoriesAsync(ListRepositoriesRequest listRepositoriesRequest)

Gets information about one or more repositories.

Parameters:

listRepositoriesRequest - Represents the input of a list repositories operation.

Returns:

A Java Future containing the result of the ListRepositories operation returned by the service.

listRepositoriesAsync

Future<ListRepositoriesResult> listRepositoriesAsync(ListRepositoriesRequest listRepositoriesRequest,
                                                   AsyncHandler<ListRepositoriesRequest,ListRepositoriesResult> asyncHandler)

Gets information about one or more repositories.

Parameters:

listRepositoriesRequest - Represents the input of a list repositories operation.

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.

Returns:

A Java Future containing the result of the ListRepositories operation returned by the service.

updateDefaultBranchAsync

Future<Void> updateDefaultBranchAsync(UpdateDefaultBranchRequest updateDefaultBranchRequest)

Sets or changes the default branch name for the specified repository.

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Parameters:

updateDefaultBranchRequest - Represents the input of an update default branch operation.

updateDefaultBranchAsync

Future<Void> updateDefaultBranchAsync(UpdateDefaultBranchRequest updateDefaultBranchRequest,
                                    AsyncHandler<UpdateDefaultBranchRequest,Void> asyncHandler)

Sets or changes the default branch name for the specified repository.

If you use this operation to change the default branch name to the current default branch name, a success message is returned even though the default branch did not change.

Parameters:

updateDefaultBranchRequest - Represents the input of an update default branch operation.

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.

updateRepositoryDescriptionAsync

Future<Void> updateRepositoryDescriptionAsync(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest)

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

updateRepositoryDescriptionRequest - Represents the input of an update repository description operation.

updateRepositoryDescriptionAsync

Future<Void> updateRepositoryDescriptionAsync(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest,
                                            AsyncHandler<UpdateRepositoryDescriptionRequest,Void> asyncHandler)

Sets or changes the comment or description for a repository.

The description field for a repository accepts all HTML characters and all valid Unicode characters. Applications that do not HTML-encode the description and display it in a web page could expose users to potentially malicious code. Make sure that you HTML-encode the description field in any application that uses this API to display the repository description on a web page.

Parameters:

updateRepositoryDescriptionRequest - Represents the input of an update repository description operation.

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.

updateRepositoryNameAsync

Future<Void> updateRepositoryNameAsync(UpdateRepositoryNameRequest updateRepositoryNameRequest)

Renames a repository.

Parameters:

updateRepositoryNameRequest - Represents the input of an update repository description operation.

updateRepositoryNameAsync

Future<Void> updateRepositoryNameAsync(UpdateRepositoryNameRequest updateRepositoryNameRequest,
                                     AsyncHandler<UpdateRepositoryNameRequest,Void> asyncHandler)

Renames a repository.

Parameters:

updateRepositoryNameRequest - Represents the input of an update repository description operation.

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.