AutoCloseable
@Generated("software.amazon.awssdk:codegen") public interface CodeCommitAsyncClient extends AutoCloseable
builder()
method.
This is the AWS CodeCommit API Reference. This reference provides descriptions of the operations and data types for AWS CodeCommit API along with usage examples.
You can use the AWS CodeCommit API to work with the following objects:
Repositories, by calling the following:
BatchGetRepositories, which returns information about one or more repositories associated with your AWS account
CreateRepository, which creates an AWS CodeCommit repository
DeleteRepository, which deletes an AWS CodeCommit repository
GetRepository, which returns information about a specified repository
ListRepositories, which lists all AWS CodeCommit repositories associated with your AWS account
UpdateRepositoryDescription, which sets or updates the description of the repository
UpdateRepositoryName, which changes the name of the repository. If you change the name of a repository, no other users of that repository will be able to access it until you send them the new HTTPS or SSH URL to use.
Branches, by calling the following:
CreateBranch, which creates a new branch in a specified repository
GetBranch, which returns information about a specified branch
ListBranches, which lists all branches for a specified repository
UpdateDefaultBranch, which changes the default branch for a repository
Information about committed code in a repository, by calling the following:
GetBlob, which returns the base-64 encoded content of an individual Git blob object within a repository
GetCommit, which returns information about a commit, including commit messages and author and committer information
GetDifferences, which returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference)
Triggers, by calling the following:
GetRepositoryTriggers, which returns information about triggers configured for a repository
PutRepositoryTriggers, which replaces all triggers for a repository and can be used to create or delete triggers
TestRepositoryTriggers, which tests the functionality of a repository trigger by sending data to the trigger target
For information about how to use AWS CodeCommit, see the AWS CodeCommit User Guide.
Modifier and Type | Method | Description |
---|---|---|
default CompletableFuture<BatchGetRepositoriesResponse> |
batchGetRepositories(BatchGetRepositoriesRequest batchGetRepositoriesRequest) |
Returns information about one or more repositories.
|
static CodeCommitAsyncClientBuilder |
builder() |
Create a builder that can be used to configure and create a
CodeCommitAsyncClient . |
static CodeCommitAsyncClient |
create() |
Create a
CodeCommitAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
default CompletableFuture<CreateBranchResponse> |
createBranch(CreateBranchRequest createBranchRequest) |
Creates a new branch in a repository and points the branch to a commit.
|
default CompletableFuture<CreateRepositoryResponse> |
createRepository(CreateRepositoryRequest createRepositoryRequest) |
Creates a new, empty repository.
|
default CompletableFuture<DeleteRepositoryResponse> |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest) |
Deletes a repository.
|
default CompletableFuture<GetBlobResponse> |
getBlob(GetBlobRequest getBlobRequest) |
Returns the base-64 encoded content of an individual blob within a repository.
|
default CompletableFuture<GetBranchResponse> |
getBranch(GetBranchRequest getBranchRequest) |
Returns information about a repository branch, including its name and the last commit ID.
|
default CompletableFuture<GetCommitResponse> |
getCommit(GetCommitRequest getCommitRequest) |
Returns information about a commit, including commit message and committer information.
|
default CompletableFuture<GetDifferencesResponse> |
getDifferences(GetDifferencesRequest getDifferencesRequest) |
Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or
other fully qualified reference).
|
default CompletableFuture<GetRepositoryResponse> |
getRepository(GetRepositoryRequest getRepositoryRequest) |
Returns information about a repository.
|
default CompletableFuture<GetRepositoryTriggersResponse> |
getRepositoryTriggers(GetRepositoryTriggersRequest getRepositoryTriggersRequest) |
Gets information about triggers configured for a repository.
|
default CompletableFuture<ListBranchesResponse> |
listBranches(ListBranchesRequest listBranchesRequest) |
Gets information about one or more branches in a repository.
|
default CompletableFuture<ListRepositoriesResponse> |
listRepositories(ListRepositoriesRequest listRepositoriesRequest) |
Gets information about one or more repositories.
|
default CompletableFuture<PutRepositoryTriggersResponse> |
putRepositoryTriggers(PutRepositoryTriggersRequest putRepositoryTriggersRequest) |
Replaces all triggers for a repository.
|
default CompletableFuture<TestRepositoryTriggersResponse> |
testRepositoryTriggers(TestRepositoryTriggersRequest testRepositoryTriggersRequest) |
Tests the functionality of repository triggers by sending information to the trigger target.
|
default CompletableFuture<UpdateDefaultBranchResponse> |
updateDefaultBranch(UpdateDefaultBranchRequest updateDefaultBranchRequest) |
Sets or changes the default branch name for the specified repository.
|
default CompletableFuture<UpdateRepositoryDescriptionResponse> |
updateRepositoryDescription(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest) |
Sets or changes the comment or description for a repository.
|
default CompletableFuture<UpdateRepositoryNameResponse> |
updateRepositoryName(UpdateRepositoryNameRequest updateRepositoryNameRequest) |
Renames a repository.
|
close
static CodeCommitAsyncClient create()
CodeCommitAsyncClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CodeCommitAsyncClientBuilder builder()
CodeCommitAsyncClient
.default CompletableFuture<BatchGetRepositoriesResponse> batchGetRepositories(BatchGetRepositoriesRequest batchGetRepositoriesRequest)
Returns 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.
batchGetRepositoriesRequest
- Represents the input of a batch get repositories operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<CreateBranchResponse> createBranch(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.
createBranchRequest
- Represents the input of a create branch operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<CreateRepositoryResponse> createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a new, empty repository.
createRepositoryRequest
- Represents the input of a create repository operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<DeleteRepositoryResponse> deleteRepository(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.
deleteRepositoryRequest
- Represents the input of a delete repository operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetBlobResponse> getBlob(GetBlobRequest getBlobRequest)
Returns the base-64 encoded content of an individual blob within a repository.
getBlobRequest
- Represents the input of a get blob operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetBranchResponse> getBranch(GetBranchRequest getBranchRequest)
Returns information about a repository branch, including its name and the last commit ID.
getBranchRequest
- Represents the input of a get branch operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetCommitResponse> getCommit(GetCommitRequest getCommitRequest)
Returns information about a commit, including commit message and committer information.
getCommitRequest
- Represents the input of a get commit operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetDifferencesResponse> getDifferences(GetDifferencesRequest getDifferencesRequest)
Returns information about the differences in a valid commit specifier (such as a branch, tag, HEAD, commit ID or other fully qualified reference). Results can be limited to a specified path.
getDifferencesRequest
- This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetRepositoryResponse> getRepository(GetRepositoryRequest getRepositoryRequest)
Returns 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.
getRepositoryRequest
- Represents the input of a get repository operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<GetRepositoryTriggersResponse> getRepositoryTriggers(GetRepositoryTriggersRequest getRepositoryTriggersRequest)
Gets information about triggers configured for a repository.
getRepositoryTriggersRequest
- Represents the input of a get repository triggers operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<ListBranchesResponse> listBranches(ListBranchesRequest listBranchesRequest)
Gets information about one or more branches in a repository.
listBranchesRequest
- Represents the input of a list branches operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<ListRepositoriesResponse> listRepositories(ListRepositoriesRequest listRepositoriesRequest)
Gets information about one or more repositories.
listRepositoriesRequest
- Represents the input of a list repositories operation.default CompletableFuture<PutRepositoryTriggersResponse> putRepositoryTriggers(PutRepositoryTriggersRequest putRepositoryTriggersRequest)
Replaces all triggers for a repository. This can be used to create or delete triggers.
putRepositoryTriggersRequest
- Represents the input ofa put repository triggers operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<TestRepositoryTriggersResponse> testRepositoryTriggers(TestRepositoryTriggersRequest testRepositoryTriggersRequest)
Tests the functionality of repository triggers by sending information to the trigger target. If real data is available in the repository, the test will send data from the last commit. If no data is available, sample data will be generated.
testRepositoryTriggersRequest
- Represents the input of a test repository triggers operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<UpdateDefaultBranchResponse> updateDefaultBranch(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.
updateDefaultBranchRequest
- Represents the input of an update default branch operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<UpdateRepositoryDescriptionResponse> updateRepositoryDescription(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.
updateRepositoryDescriptionRequest
- Represents the input of an update repository description operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
default CompletableFuture<UpdateRepositoryNameResponse> updateRepositoryName(UpdateRepositoryNameRequest updateRepositoryNameRequest)
Renames a repository. The repository name must be unique across the calling AWS account. In addition, repository names are limited to 100 alphanumeric, dash, and underscore characters, and cannot include certain characters. The suffix ".git" is prohibited. For a full description of the limits on repository names, see Limits in the AWS CodeCommit User Guide.
updateRepositoryNameRequest
- Represents the input of an update repository description operation.This exception only occurs when a specified repository name is not valid. Other exceptions occur when a required repository parameter is missing, or when a specified repository does not exist.
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.