@Generated(value="software.amazon.awssdk:codegen") public interface CodeCommitAsyncClient extends SdkClient
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.
DeleteBranch, which deletes the specified branch in a repository unless it is the default branch.
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).
Pull requests, by calling the following:
CreatePullRequest, which creates a pull request in a specified repository.
DescribePullRequestEvents, which returns information about one or more pull request events.
GetCommentsForPullRequest, which returns information about comments on a specified pull request.
GetMergeConflicts, which returns information about merge conflicts between the source and destination branch in a pull request.
GetPullRequest, which returns information about a specified pull request.
ListPullRequests, which lists all pull requests for a repository.
MergePullRequestByFastForward, which merges the source destination branch of a pull request into the specified destination branch for that pull request using the fast-forward merge option.
PostCommentForPullRequest, which posts a comment to a pull request at the specified line, file, or request.
UpdatePullRequestDescription, which updates the description of a pull request.
UpdatePullRequestStatus, which updates the status of a pull request.
UpdatePullRequestTitle, which updates the title of a pull request.
Information about comments in a repository, by calling the following:
DeleteCommentContent, which deletes the content of a comment on a commit in a repository.
GetComment, which returns information about a comment on a commit.
GetCommentsForComparedCommit, which returns information about comments on the comparison between two commit specifiers in a repository.
PostCommentForComparedCommit, which creates a comment on the comparison between two commit specifiers in a repository.
PostCommentReply, which creates a reply to a comment.
UpdateComment, which updates the content of a comment on a commit in a repository.
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 | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default CompletableFuture<BatchGetRepositoriesResponse> |
batchGetRepositories(BatchGetRepositoriesRequest batchGetRepositoriesRequest)
Returns information about one or more repositories.
|
default CompletableFuture<BatchGetRepositoriesResponse> |
batchGetRepositories(Consumer<BatchGetRepositoriesRequest.Builder> 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(Consumer<CreateBranchRequest.Builder> createBranchRequest)
Creates a new branch in a repository and points the branch to a commit.
|
default CompletableFuture<CreateBranchResponse> |
createBranch(CreateBranchRequest createBranchRequest)
Creates a new branch in a repository and points the branch to a commit.
|
default CompletableFuture<CreatePullRequestResponse> |
createPullRequest(Consumer<CreatePullRequestRequest.Builder> createPullRequestRequest)
Creates a pull request in the specified repository.
|
default CompletableFuture<CreatePullRequestResponse> |
createPullRequest(CreatePullRequestRequest createPullRequestRequest)
Creates a pull request in the specified repository.
|
default CompletableFuture<CreateRepositoryResponse> |
createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)
Creates a new, empty repository.
|
default CompletableFuture<CreateRepositoryResponse> |
createRepository(CreateRepositoryRequest createRepositoryRequest)
Creates a new, empty repository.
|
default CompletableFuture<DeleteBranchResponse> |
deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)
Deletes a branch from a repository, unless that branch is the default branch for the repository.
|
default CompletableFuture<DeleteBranchResponse> |
deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch from a repository, unless that branch is the default branch for the repository.
|
default CompletableFuture<DeleteCommentContentResponse> |
deleteCommentContent(Consumer<DeleteCommentContentRequest.Builder> deleteCommentContentRequest)
Deletes the content of a comment made on a change, file, or commit in a repository.
|
default CompletableFuture<DeleteCommentContentResponse> |
deleteCommentContent(DeleteCommentContentRequest deleteCommentContentRequest)
Deletes the content of a comment made on a change, file, or commit in a repository.
|
default CompletableFuture<DeleteRepositoryResponse> |
deleteRepository(Consumer<DeleteRepositoryRequest.Builder> deleteRepositoryRequest)
Deletes a repository.
|
default CompletableFuture<DeleteRepositoryResponse> |
deleteRepository(DeleteRepositoryRequest deleteRepositoryRequest)
Deletes a repository.
|
default CompletableFuture<DescribePullRequestEventsResponse> |
describePullRequestEvents(Consumer<DescribePullRequestEventsRequest.Builder> describePullRequestEventsRequest)
Returns information about one or more pull request events.
|
default CompletableFuture<DescribePullRequestEventsResponse> |
describePullRequestEvents(DescribePullRequestEventsRequest describePullRequestEventsRequest)
Returns information about one or more pull request events.
|
default CompletableFuture<GetBlobResponse> |
getBlob(Consumer<GetBlobRequest.Builder> getBlobRequest)
Returns the base-64 encoded content of an individual blob within 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(Consumer<GetBranchRequest.Builder> getBranchRequest)
Returns information about a repository branch, including its name and the last commit ID.
|
default CompletableFuture<GetBranchResponse> |
getBranch(GetBranchRequest getBranchRequest)
Returns information about a repository branch, including its name and the last commit ID.
|
default CompletableFuture<GetCommentResponse> |
getComment(Consumer<GetCommentRequest.Builder> getCommentRequest)
Returns the content of a comment made on a change, file, or commit in a repository.
|
default CompletableFuture<GetCommentResponse> |
getComment(GetCommentRequest getCommentRequest)
Returns the content of a comment made on a change, file, or commit in a repository.
|
default CompletableFuture<GetCommentsForComparedCommitResponse> |
getCommentsForComparedCommit(Consumer<GetCommentsForComparedCommitRequest.Builder> getCommentsForComparedCommitRequest)
Returns information about comments made on the comparison between two commits.
|
default CompletableFuture<GetCommentsForComparedCommitResponse> |
getCommentsForComparedCommit(GetCommentsForComparedCommitRequest getCommentsForComparedCommitRequest)
Returns information about comments made on the comparison between two commits.
|
default CompletableFuture<GetCommentsForPullRequestResponse> |
getCommentsForPullRequest(Consumer<GetCommentsForPullRequestRequest.Builder> getCommentsForPullRequestRequest)
Returns comments made on a pull request.
|
default CompletableFuture<GetCommentsForPullRequestResponse> |
getCommentsForPullRequest(GetCommentsForPullRequestRequest getCommentsForPullRequestRequest)
Returns comments made on a pull request.
|
default CompletableFuture<GetCommitResponse> |
getCommit(Consumer<GetCommitRequest.Builder> getCommitRequest)
Returns information about a commit, including commit message and committer information.
|
default CompletableFuture<GetCommitResponse> |
getCommit(GetCommitRequest getCommitRequest)
Returns information about a commit, including commit message and committer information.
|
default CompletableFuture<GetDifferencesResponse> |
getDifferences(Consumer<GetDifferencesRequest.Builder> 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<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 GetDifferencesPublisher |
getDifferencesPaginator(Consumer<GetDifferencesRequest.Builder> 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 GetDifferencesPublisher |
getDifferencesPaginator(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<GetMergeConflictsResponse> |
getMergeConflicts(Consumer<GetMergeConflictsRequest.Builder> getMergeConflictsRequest)
Returns information about merge conflicts between the before and after commit IDs for a pull request in a
repository.
|
default CompletableFuture<GetMergeConflictsResponse> |
getMergeConflicts(GetMergeConflictsRequest getMergeConflictsRequest)
Returns information about merge conflicts between the before and after commit IDs for a pull request in a
repository.
|
default CompletableFuture<GetPullRequestResponse> |
getPullRequest(Consumer<GetPullRequestRequest.Builder> getPullRequestRequest)
Gets information about a pull request in a specified repository.
|
default CompletableFuture<GetPullRequestResponse> |
getPullRequest(GetPullRequestRequest getPullRequestRequest)
Gets information about a pull request in a specified repository.
|
default CompletableFuture<GetRepositoryResponse> |
getRepository(Consumer<GetRepositoryRequest.Builder> getRepositoryRequest)
Returns information about a repository.
|
default CompletableFuture<GetRepositoryResponse> |
getRepository(GetRepositoryRequest getRepositoryRequest)
Returns information about a repository.
|
default CompletableFuture<GetRepositoryTriggersResponse> |
getRepositoryTriggers(Consumer<GetRepositoryTriggersRequest.Builder> getRepositoryTriggersRequest)
Gets information about triggers configured for a repository.
|
default CompletableFuture<GetRepositoryTriggersResponse> |
getRepositoryTriggers(GetRepositoryTriggersRequest getRepositoryTriggersRequest)
Gets information about triggers configured for a repository.
|
default CompletableFuture<ListBranchesResponse> |
listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Gets information about one or more branches in a repository.
|
default CompletableFuture<ListBranchesResponse> |
listBranches(ListBranchesRequest listBranchesRequest)
Gets information about one or more branches in a repository.
|
default ListBranchesPublisher |
listBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Gets information about one or more branches in a repository.
|
default ListBranchesPublisher |
listBranchesPaginator(ListBranchesRequest listBranchesRequest)
Gets information about one or more branches in a repository.
|
default CompletableFuture<ListPullRequestsResponse> |
listPullRequests(Consumer<ListPullRequestsRequest.Builder> listPullRequestsRequest)
Returns a list of pull requests for a specified repository.
|
default CompletableFuture<ListPullRequestsResponse> |
listPullRequests(ListPullRequestsRequest listPullRequestsRequest)
Returns a list of pull requests for a specified repository.
|
default CompletableFuture<ListRepositoriesResponse> |
listRepositories()
Gets information about one or more repositories.
|
default CompletableFuture<ListRepositoriesResponse> |
listRepositories(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest)
Gets information about one or more repositories.
|
default CompletableFuture<ListRepositoriesResponse> |
listRepositories(ListRepositoriesRequest listRepositoriesRequest)
Gets information about one or more repositories.
|
default ListRepositoriesPublisher |
listRepositoriesPaginator()
Gets information about one or more repositories.
|
default ListRepositoriesPublisher |
listRepositoriesPaginator(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest)
Gets information about one or more repositories.
|
default ListRepositoriesPublisher |
listRepositoriesPaginator(ListRepositoriesRequest listRepositoriesRequest)
Gets information about one or more repositories.
|
default CompletableFuture<MergePullRequestByFastForwardResponse> |
mergePullRequestByFastForward(Consumer<MergePullRequestByFastForwardRequest.Builder> mergePullRequestByFastForwardRequest)
Closes a pull request and attempts to merge the source commit of a pull request into the specified destination
branch for that pull request at the specified commit using the fast-forward merge option.
|
default CompletableFuture<MergePullRequestByFastForwardResponse> |
mergePullRequestByFastForward(MergePullRequestByFastForwardRequest mergePullRequestByFastForwardRequest)
Closes a pull request and attempts to merge the source commit of a pull request into the specified destination
branch for that pull request at the specified commit using the fast-forward merge option.
|
default CompletableFuture<PostCommentForComparedCommitResponse> |
postCommentForComparedCommit(Consumer<PostCommentForComparedCommitRequest.Builder> postCommentForComparedCommitRequest)
Posts a comment on the comparison between two commits.
|
default CompletableFuture<PostCommentForComparedCommitResponse> |
postCommentForComparedCommit(PostCommentForComparedCommitRequest postCommentForComparedCommitRequest)
Posts a comment on the comparison between two commits.
|
default CompletableFuture<PostCommentForPullRequestResponse> |
postCommentForPullRequest(Consumer<PostCommentForPullRequestRequest.Builder> postCommentForPullRequestRequest)
Posts a comment on a pull request.
|
default CompletableFuture<PostCommentForPullRequestResponse> |
postCommentForPullRequest(PostCommentForPullRequestRequest postCommentForPullRequestRequest)
Posts a comment on a pull request.
|
default CompletableFuture<PostCommentReplyResponse> |
postCommentReply(Consumer<PostCommentReplyRequest.Builder> postCommentReplyRequest)
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
|
default CompletableFuture<PostCommentReplyResponse> |
postCommentReply(PostCommentReplyRequest postCommentReplyRequest)
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
|
default CompletableFuture<PutRepositoryTriggersResponse> |
putRepositoryTriggers(Consumer<PutRepositoryTriggersRequest.Builder> putRepositoryTriggersRequest)
Replaces all triggers for a repository.
|
default CompletableFuture<PutRepositoryTriggersResponse> |
putRepositoryTriggers(PutRepositoryTriggersRequest putRepositoryTriggersRequest)
Replaces all triggers for a repository.
|
default CompletableFuture<TestRepositoryTriggersResponse> |
testRepositoryTriggers(Consumer<TestRepositoryTriggersRequest.Builder> testRepositoryTriggersRequest)
Tests the functionality of repository triggers by sending information to the trigger target.
|
default CompletableFuture<TestRepositoryTriggersResponse> |
testRepositoryTriggers(TestRepositoryTriggersRequest testRepositoryTriggersRequest)
Tests the functionality of repository triggers by sending information to the trigger target.
|
default CompletableFuture<UpdateCommentResponse> |
updateComment(Consumer<UpdateCommentRequest.Builder> updateCommentRequest)
Replaces the contents of a comment.
|
default CompletableFuture<UpdateCommentResponse> |
updateComment(UpdateCommentRequest updateCommentRequest)
Replaces the contents of a comment.
|
default CompletableFuture<UpdateDefaultBranchResponse> |
updateDefaultBranch(Consumer<UpdateDefaultBranchRequest.Builder> updateDefaultBranchRequest)
Sets or changes the default branch name for the specified repository.
|
default CompletableFuture<UpdateDefaultBranchResponse> |
updateDefaultBranch(UpdateDefaultBranchRequest updateDefaultBranchRequest)
Sets or changes the default branch name for the specified repository.
|
default CompletableFuture<UpdatePullRequestDescriptionResponse> |
updatePullRequestDescription(Consumer<UpdatePullRequestDescriptionRequest.Builder> updatePullRequestDescriptionRequest)
Replaces the contents of the description of a pull request.
|
default CompletableFuture<UpdatePullRequestDescriptionResponse> |
updatePullRequestDescription(UpdatePullRequestDescriptionRequest updatePullRequestDescriptionRequest)
Replaces the contents of the description of a pull request.
|
default CompletableFuture<UpdatePullRequestStatusResponse> |
updatePullRequestStatus(Consumer<UpdatePullRequestStatusRequest.Builder> updatePullRequestStatusRequest)
Updates the status of a pull request.
|
default CompletableFuture<UpdatePullRequestStatusResponse> |
updatePullRequestStatus(UpdatePullRequestStatusRequest updatePullRequestStatusRequest)
Updates the status of a pull request.
|
default CompletableFuture<UpdatePullRequestTitleResponse> |
updatePullRequestTitle(Consumer<UpdatePullRequestTitleRequest.Builder> updatePullRequestTitleRequest)
Replaces the title of a pull request.
|
default CompletableFuture<UpdatePullRequestTitleResponse> |
updatePullRequestTitle(UpdatePullRequestTitleRequest updatePullRequestTitleRequest)
Replaces the title of a pull request.
|
default CompletableFuture<UpdateRepositoryDescriptionResponse> |
updateRepositoryDescription(Consumer<UpdateRepositoryDescriptionRequest.Builder> updateRepositoryDescriptionRequest)
Sets or changes the comment or description for a repository.
|
default CompletableFuture<UpdateRepositoryDescriptionResponse> |
updateRepositoryDescription(UpdateRepositoryDescriptionRequest updateRepositoryDescriptionRequest)
Sets or changes the comment or description for a repository.
|
default CompletableFuture<UpdateRepositoryNameResponse> |
updateRepositoryName(Consumer<UpdateRepositoryNameRequest.Builder> updateRepositoryNameRequest)
Renames a repository.
|
default CompletableFuture<UpdateRepositoryNameResponse> |
updateRepositoryName(UpdateRepositoryNameRequest updateRepositoryNameRequest)
Renames a repository.
|
serviceName
close
static final String SERVICE_NAME
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<BatchGetRepositoriesResponse> batchGetRepositories(Consumer<BatchGetRepositoriesRequest.Builder> 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.
This is a convenience which creates an instance of the BatchGetRepositoriesRequest.Builder
avoiding the
need to create one manually via BatchGetRepositoriesRequest.builder()
batchGetRepositoriesRequest
- A Consumer
that will call methods on BatchGetRepositoriesInput.Builder
to create a
request. 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<CreateBranchResponse> createBranch(Consumer<CreateBranchRequest.Builder> 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.
This is a convenience which creates an instance of the CreateBranchRequest.Builder
avoiding the need to
create one manually via CreateBranchRequest.builder()
createBranchRequest
- A Consumer
that will call methods on CreateBranchInput.Builder
to create a request.
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<CreatePullRequestResponse> createPullRequest(CreatePullRequestRequest createPullRequestRequest)
Creates a pull request in the specified repository.
createPullRequestRequest
- 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<CreatePullRequestResponse> createPullRequest(Consumer<CreatePullRequestRequest.Builder> createPullRequestRequest)
Creates a pull request in the specified repository.
This is a convenience which creates an instance of the CreatePullRequestRequest.Builder
avoiding the need
to create one manually via CreatePullRequestRequest.builder()
createPullRequestRequest
- A Consumer
that will call methods on CreatePullRequestInput.Builder
to create a request.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<CreateRepositoryResponse> createRepository(Consumer<CreateRepositoryRequest.Builder> createRepositoryRequest)
Creates a new, empty repository.
This is a convenience which creates an instance of the CreateRepositoryRequest.Builder
avoiding the need
to create one manually via CreateRepositoryRequest.builder()
createRepositoryRequest
- A Consumer
that will call methods on CreateRepositoryInput.Builder
to create a request.
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<DeleteBranchResponse> deleteBranch(DeleteBranchRequest deleteBranchRequest)
Deletes a branch from a repository, unless that branch is the default branch for the repository.
deleteBranchRequest
- Represents the input of a delete 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<DeleteBranchResponse> deleteBranch(Consumer<DeleteBranchRequest.Builder> deleteBranchRequest)
Deletes a branch from a repository, unless that branch is the default branch for the repository.
This is a convenience which creates an instance of the DeleteBranchRequest.Builder
avoiding the need to
create one manually via DeleteBranchRequest.builder()
deleteBranchRequest
- A Consumer
that will call methods on DeleteBranchInput.Builder
to create a request.
Represents the input of a delete 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<DeleteCommentContentResponse> deleteCommentContent(DeleteCommentContentRequest deleteCommentContentRequest)
Deletes the content of a comment made on a change, file, or commit in a repository.
deleteCommentContentRequest
- default CompletableFuture<DeleteCommentContentResponse> deleteCommentContent(Consumer<DeleteCommentContentRequest.Builder> deleteCommentContentRequest)
Deletes the content of a comment made on a change, file, or commit in a repository.
This is a convenience which creates an instance of the DeleteCommentContentRequest.Builder
avoiding the
need to create one manually via DeleteCommentContentRequest.builder()
deleteCommentContentRequest
- A Consumer
that will call methods on DeleteCommentContentInput.Builder
to create a
request.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<DeleteRepositoryResponse> deleteRepository(Consumer<DeleteRepositoryRequest.Builder> 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.
This is a convenience which creates an instance of the DeleteRepositoryRequest.Builder
avoiding the need
to create one manually via DeleteRepositoryRequest.builder()
deleteRepositoryRequest
- A Consumer
that will call methods on DeleteRepositoryInput.Builder
to create a request.
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<DescribePullRequestEventsResponse> describePullRequestEvents(DescribePullRequestEventsRequest describePullRequestEventsRequest)
Returns information about one or more pull request events.
describePullRequestEventsRequest
- default CompletableFuture<DescribePullRequestEventsResponse> describePullRequestEvents(Consumer<DescribePullRequestEventsRequest.Builder> describePullRequestEventsRequest)
Returns information about one or more pull request events.
This is a convenience which creates an instance of the DescribePullRequestEventsRequest.Builder
avoiding
the need to create one manually via DescribePullRequestEventsRequest.builder()
describePullRequestEventsRequest
- A Consumer
that will call methods on DescribePullRequestEventsInput.Builder
to create a
request.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<GetBlobResponse> getBlob(Consumer<GetBlobRequest.Builder> getBlobRequest)
Returns the base-64 encoded content of an individual blob within a repository.
This is a convenience which creates an instance of the GetBlobRequest.Builder
avoiding the need to create
one manually via GetBlobRequest.builder()
getBlobRequest
- A Consumer
that will call methods on GetBlobInput.Builder
to create a request. 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<GetBranchResponse> getBranch(Consumer<GetBranchRequest.Builder> getBranchRequest)
Returns information about a repository branch, including its name and the last commit ID.
This is a convenience which creates an instance of the GetBranchRequest.Builder
avoiding the need to
create one manually via GetBranchRequest.builder()
getBranchRequest
- A Consumer
that will call methods on GetBranchInput.Builder
to create a request.
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<GetCommentResponse> getComment(GetCommentRequest getCommentRequest)
Returns the content of a comment made on a change, file, or commit in a repository.
getCommentRequest
- default CompletableFuture<GetCommentResponse> getComment(Consumer<GetCommentRequest.Builder> getCommentRequest)
Returns the content of a comment made on a change, file, or commit in a repository.
This is a convenience which creates an instance of the GetCommentRequest.Builder
avoiding the need to
create one manually via GetCommentRequest.builder()
getCommentRequest
- A Consumer
that will call methods on GetCommentInput.Builder
to create a request.default CompletableFuture<GetCommentsForComparedCommitResponse> getCommentsForComparedCommit(GetCommentsForComparedCommitRequest getCommentsForComparedCommitRequest)
Returns information about comments made on the comparison between two commits.
getCommentsForComparedCommitRequest
- 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<GetCommentsForComparedCommitResponse> getCommentsForComparedCommit(Consumer<GetCommentsForComparedCommitRequest.Builder> getCommentsForComparedCommitRequest)
Returns information about comments made on the comparison between two commits.
This is a convenience which creates an instance of the GetCommentsForComparedCommitRequest.Builder
avoiding the need to create one manually via GetCommentsForComparedCommitRequest.builder()
getCommentsForComparedCommitRequest
- A Consumer
that will call methods on GetCommentsForComparedCommitInput.Builder
to create a
request.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<GetCommentsForPullRequestResponse> getCommentsForPullRequest(GetCommentsForPullRequestRequest getCommentsForPullRequestRequest)
Returns comments made on a pull request.
getCommentsForPullRequestRequest
- 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<GetCommentsForPullRequestResponse> getCommentsForPullRequest(Consumer<GetCommentsForPullRequestRequest.Builder> getCommentsForPullRequestRequest)
Returns comments made on a pull request.
This is a convenience which creates an instance of the GetCommentsForPullRequestRequest.Builder
avoiding
the need to create one manually via GetCommentsForPullRequestRequest.builder()
getCommentsForPullRequestRequest
- A Consumer
that will call methods on GetCommentsForPullRequestInput.Builder
to create a
request.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<GetCommitResponse> getCommit(Consumer<GetCommitRequest.Builder> getCommitRequest)
Returns information about a commit, including commit message and committer information.
This is a convenience which creates an instance of the GetCommitRequest.Builder
avoiding the need to
create one manually via GetCommitRequest.builder()
getCommitRequest
- A Consumer
that will call methods on GetCommitInput.Builder
to create a request.
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<GetDifferencesResponse> getDifferences(Consumer<GetDifferencesRequest.Builder> 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.
This is a convenience which creates an instance of the GetDifferencesRequest.Builder
avoiding the need to
create one manually via GetDifferencesRequest.builder()
getDifferencesRequest
- A Consumer
that will call methods on GetDifferencesInput.Builder
to create a request.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 GetDifferencesPublisher getDifferencesPaginator(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.
This is a variant of
getDifferences(software.amazon.awssdk.services.codecommit.model.GetDifferencesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.GetDifferencesPublisher publisher = client.getDifferencesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.GetDifferencesPublisher publisher = client.getDifferencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.GetDifferencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.GetDifferencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getDifferences(software.amazon.awssdk.services.codecommit.model.GetDifferencesRequest)
operation.
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 GetDifferencesPublisher getDifferencesPaginator(Consumer<GetDifferencesRequest.Builder> 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.
This is a variant of
getDifferences(software.amazon.awssdk.services.codecommit.model.GetDifferencesRequest)
operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.GetDifferencesPublisher publisher = client.getDifferencesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.GetDifferencesPublisher publisher = client.getDifferencesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.GetDifferencesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.GetDifferencesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
getDifferences(software.amazon.awssdk.services.codecommit.model.GetDifferencesRequest)
operation.
This is a convenience which creates an instance of the GetDifferencesRequest.Builder
avoiding the need to
create one manually via GetDifferencesRequest.builder()
getDifferencesRequest
- A Consumer
that will call methods on GetDifferencesInput.Builder
to create a request.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<GetMergeConflictsResponse> getMergeConflicts(GetMergeConflictsRequest getMergeConflictsRequest)
Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.
getMergeConflictsRequest
- 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.
git diff
or a diff tool.default CompletableFuture<GetMergeConflictsResponse> getMergeConflicts(Consumer<GetMergeConflictsRequest.Builder> getMergeConflictsRequest)
Returns information about merge conflicts between the before and after commit IDs for a pull request in a repository.
This is a convenience which creates an instance of the GetMergeConflictsRequest.Builder
avoiding the need
to create one manually via GetMergeConflictsRequest.builder()
getMergeConflictsRequest
- A Consumer
that will call methods on GetMergeConflictsInput.Builder
to create a request.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.
git diff
or a diff tool.default CompletableFuture<GetPullRequestResponse> getPullRequest(GetPullRequestRequest getPullRequestRequest)
Gets information about a pull request in a specified repository.
getPullRequestRequest
- default CompletableFuture<GetPullRequestResponse> getPullRequest(Consumer<GetPullRequestRequest.Builder> getPullRequestRequest)
Gets information about a pull request in a specified repository.
This is a convenience which creates an instance of the GetPullRequestRequest.Builder
avoiding the need to
create one manually via GetPullRequestRequest.builder()
getPullRequestRequest
- A Consumer
that will call methods on GetPullRequestInput.Builder
to create a request.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<GetRepositoryResponse> getRepository(Consumer<GetRepositoryRequest.Builder> 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.
This is a convenience which creates an instance of the GetRepositoryRequest.Builder
avoiding the need to
create one manually via GetRepositoryRequest.builder()
getRepositoryRequest
- A Consumer
that will call methods on GetRepositoryInput.Builder
to create a request.
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<GetRepositoryTriggersResponse> getRepositoryTriggers(Consumer<GetRepositoryTriggersRequest.Builder> getRepositoryTriggersRequest)
Gets information about triggers configured for a repository.
This is a convenience which creates an instance of the GetRepositoryTriggersRequest.Builder
avoiding the
need to create one manually via GetRepositoryTriggersRequest.builder()
getRepositoryTriggersRequest
- A Consumer
that will call methods on GetRepositoryTriggersInput.Builder
to create a
request. 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<ListBranchesResponse> listBranches(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Gets information about one or more branches in a repository.
This is a convenience which creates an instance of the ListBranchesRequest.Builder
avoiding the need to
create one manually via ListBranchesRequest.builder()
listBranchesRequest
- A Consumer
that will call methods on ListBranchesInput.Builder
to create a request.
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 ListBranchesPublisher listBranchesPaginator(ListBranchesRequest listBranchesRequest)
Gets information about one or more branches in a repository.
This is a variant of listBranches(software.amazon.awssdk.services.codecommit.model.ListBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.ListBranchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.ListBranchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listBranches(software.amazon.awssdk.services.codecommit.model.ListBranchesRequest)
operation.
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 ListBranchesPublisher listBranchesPaginator(Consumer<ListBranchesRequest.Builder> listBranchesRequest)
Gets information about one or more branches in a repository.
This is a variant of listBranches(software.amazon.awssdk.services.codecommit.model.ListBranchesRequest)
operation. The return type is a custom publisher that can be subscribed to request a stream of response pages.
SDK will internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.ListBranchesPublisher publisher = client.listBranchesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.ListBranchesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.ListBranchesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listBranches(software.amazon.awssdk.services.codecommit.model.ListBranchesRequest)
operation.
This is a convenience which creates an instance of the ListBranchesRequest.Builder
avoiding the need to
create one manually via ListBranchesRequest.builder()
listBranchesRequest
- A Consumer
that will call methods on ListBranchesInput.Builder
to create a request.
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<ListPullRequestsResponse> listPullRequests(ListPullRequestsRequest listPullRequestsRequest)
Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.
listPullRequestsRequest
- OPEN
and CLOSED
.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<ListPullRequestsResponse> listPullRequests(Consumer<ListPullRequestsRequest.Builder> listPullRequestsRequest)
Returns a list of pull requests for a specified repository. The return list can be refined by pull request status or pull request author ARN.
This is a convenience which creates an instance of the ListPullRequestsRequest.Builder
avoiding the need
to create one manually via ListPullRequestsRequest.builder()
listPullRequestsRequest
- A Consumer
that will call methods on ListPullRequestsInput.Builder
to create a request.OPEN
and CLOSED
.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<ListRepositoriesResponse> listRepositories(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest)
Gets information about one or more repositories.
This is a convenience which creates an instance of the ListRepositoriesRequest.Builder
avoiding the need
to create one manually via ListRepositoriesRequest.builder()
listRepositoriesRequest
- A Consumer
that will call methods on ListRepositoriesInput.Builder
to create a request.
Represents the input of a list repositories operation.default CompletableFuture<ListRepositoriesResponse> listRepositories()
Gets information about one or more repositories.
default ListRepositoriesPublisher listRepositoriesPaginator()
Gets information about one or more repositories.
This is a variant of
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
default ListRepositoriesPublisher listRepositoriesPaginator(ListRepositoriesRequest listRepositoriesRequest)
Gets information about one or more repositories.
This is a variant of
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
listRepositoriesRequest
- Represents the input of a list repositories operation.default ListRepositoriesPublisher listRepositoriesPaginator(Consumer<ListRepositoriesRequest.Builder> listRepositoriesRequest)
Gets information about one or more repositories.
This is a variant of
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber)
. Each call to the subscribe
method will result in a new Subscription
i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the forEach helper method
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
CompletableFuture<Void> future = publisher.forEach(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.codecommit.paginators.ListRepositoriesPublisher publisher = client.listRepositoriesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.codecommit.model.ListRepositoriesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Note: If you prefer to have control on service calls, use the
listRepositories(software.amazon.awssdk.services.codecommit.model.ListRepositoriesRequest)
operation.
This is a convenience which creates an instance of the ListRepositoriesRequest.Builder
avoiding the need
to create one manually via ListRepositoriesRequest.builder()
listRepositoriesRequest
- A Consumer
that will call methods on ListRepositoriesInput.Builder
to create a request.
Represents the input of a list repositories operation.default CompletableFuture<MergePullRequestByFastForwardResponse> mergePullRequestByFastForward(MergePullRequestByFastForwardRequest mergePullRequestByFastForwardRequest)
Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge option.
mergePullRequestByFastForwardRequest
- 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<MergePullRequestByFastForwardResponse> mergePullRequestByFastForward(Consumer<MergePullRequestByFastForwardRequest.Builder> mergePullRequestByFastForwardRequest)
Closes a pull request and attempts to merge the source commit of a pull request into the specified destination branch for that pull request at the specified commit using the fast-forward merge option.
This is a convenience which creates an instance of the MergePullRequestByFastForwardRequest.Builder
avoiding the need to create one manually via MergePullRequestByFastForwardRequest.builder()
mergePullRequestByFastForwardRequest
- A Consumer
that will call methods on MergePullRequestByFastForwardInput.Builder
to create
a request.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<PostCommentForComparedCommitResponse> postCommentForComparedCommit(PostCommentForComparedCommitRequest postCommentForComparedCommitRequest)
Posts a comment on the comparison between two commits.
postCommentForComparedCommitRequest
- 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<PostCommentForComparedCommitResponse> postCommentForComparedCommit(Consumer<PostCommentForComparedCommitRequest.Builder> postCommentForComparedCommitRequest)
Posts a comment on the comparison between two commits.
This is a convenience which creates an instance of the PostCommentForComparedCommitRequest.Builder
avoiding the need to create one manually via PostCommentForComparedCommitRequest.builder()
postCommentForComparedCommitRequest
- A Consumer
that will call methods on PostCommentForComparedCommitInput.Builder
to create a
request.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<PostCommentForPullRequestResponse> postCommentForPullRequest(PostCommentForPullRequestRequest postCommentForPullRequestRequest)
Posts a comment on a pull request.
postCommentForPullRequestRequest
- 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<PostCommentForPullRequestResponse> postCommentForPullRequest(Consumer<PostCommentForPullRequestRequest.Builder> postCommentForPullRequestRequest)
Posts a comment on a pull request.
This is a convenience which creates an instance of the PostCommentForPullRequestRequest.Builder
avoiding
the need to create one manually via PostCommentForPullRequestRequest.builder()
postCommentForPullRequestRequest
- A Consumer
that will call methods on PostCommentForPullRequestInput.Builder
to create a
request.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<PostCommentReplyResponse> postCommentReply(PostCommentReplyRequest postCommentReplyRequest)
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
postCommentReplyRequest
- default CompletableFuture<PostCommentReplyResponse> postCommentReply(Consumer<PostCommentReplyRequest.Builder> postCommentReplyRequest)
Posts a comment in reply to an existing comment on a comparison between commits or a pull request.
This is a convenience which creates an instance of the PostCommentReplyRequest.Builder
avoiding the need
to create one manually via PostCommentReplyRequest.builder()
postCommentReplyRequest
- A Consumer
that will call methods on PostCommentReplyInput.Builder
to create a request.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<PutRepositoryTriggersResponse> putRepositoryTriggers(Consumer<PutRepositoryTriggersRequest.Builder> putRepositoryTriggersRequest)
Replaces all triggers for a repository. This can be used to create or delete triggers.
This is a convenience which creates an instance of the PutRepositoryTriggersRequest.Builder
avoiding the
need to create one manually via PutRepositoryTriggersRequest.builder()
putRepositoryTriggersRequest
- A Consumer
that will call methods on PutRepositoryTriggersInput.Builder
to create a
request. 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<TestRepositoryTriggersResponse> testRepositoryTriggers(Consumer<TestRepositoryTriggersRequest.Builder> 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.
This is a convenience which creates an instance of the TestRepositoryTriggersRequest.Builder
avoiding the
need to create one manually via TestRepositoryTriggersRequest.builder()
testRepositoryTriggersRequest
- A Consumer
that will call methods on TestRepositoryTriggersInput.Builder
to create a
request. 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<UpdateCommentResponse> updateComment(UpdateCommentRequest updateCommentRequest)
Replaces the contents of a comment.
updateCommentRequest
- default CompletableFuture<UpdateCommentResponse> updateComment(Consumer<UpdateCommentRequest.Builder> updateCommentRequest)
Replaces the contents of a comment.
This is a convenience which creates an instance of the UpdateCommentRequest.Builder
avoiding the need to
create one manually via UpdateCommentRequest.builder()
updateCommentRequest
- A Consumer
that will call methods on UpdateCommentInput.Builder
to create a request.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<UpdateDefaultBranchResponse> updateDefaultBranch(Consumer<UpdateDefaultBranchRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateDefaultBranchRequest.Builder
avoiding the
need to create one manually via UpdateDefaultBranchRequest.builder()
updateDefaultBranchRequest
- A Consumer
that will call methods on UpdateDefaultBranchInput.Builder
to create a request.
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<UpdatePullRequestDescriptionResponse> updatePullRequestDescription(UpdatePullRequestDescriptionRequest updatePullRequestDescriptionRequest)
Replaces the contents of the description of a pull request.
updatePullRequestDescriptionRequest
- default CompletableFuture<UpdatePullRequestDescriptionResponse> updatePullRequestDescription(Consumer<UpdatePullRequestDescriptionRequest.Builder> updatePullRequestDescriptionRequest)
Replaces the contents of the description of a pull request.
This is a convenience which creates an instance of the UpdatePullRequestDescriptionRequest.Builder
avoiding the need to create one manually via UpdatePullRequestDescriptionRequest.builder()
updatePullRequestDescriptionRequest
- A Consumer
that will call methods on UpdatePullRequestDescriptionInput.Builder
to create a
request.default CompletableFuture<UpdatePullRequestStatusResponse> updatePullRequestStatus(UpdatePullRequestStatusRequest updatePullRequestStatusRequest)
Updates the status of a pull request.
updatePullRequestStatusRequest
- OPEN
to CLOSED
.OPEN
and CLOSED
.default CompletableFuture<UpdatePullRequestStatusResponse> updatePullRequestStatus(Consumer<UpdatePullRequestStatusRequest.Builder> updatePullRequestStatusRequest)
Updates the status of a pull request.
This is a convenience which creates an instance of the UpdatePullRequestStatusRequest.Builder
avoiding
the need to create one manually via UpdatePullRequestStatusRequest.builder()
updatePullRequestStatusRequest
- A Consumer
that will call methods on UpdatePullRequestStatusInput.Builder
to create a
request.OPEN
to CLOSED
.OPEN
and CLOSED
.default CompletableFuture<UpdatePullRequestTitleResponse> updatePullRequestTitle(UpdatePullRequestTitleRequest updatePullRequestTitleRequest)
Replaces the title of a pull request.
updatePullRequestTitleRequest
- default CompletableFuture<UpdatePullRequestTitleResponse> updatePullRequestTitle(Consumer<UpdatePullRequestTitleRequest.Builder> updatePullRequestTitleRequest)
Replaces the title of a pull request.
This is a convenience which creates an instance of the UpdatePullRequestTitleRequest.Builder
avoiding the
need to create one manually via UpdatePullRequestTitleRequest.builder()
updatePullRequestTitleRequest
- A Consumer
that will call methods on UpdatePullRequestTitleInput.Builder
to create a
request.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<UpdateRepositoryDescriptionResponse> updateRepositoryDescription(Consumer<UpdateRepositoryDescriptionRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateRepositoryDescriptionRequest.Builder
avoiding the need to create one manually via UpdateRepositoryDescriptionRequest.builder()
updateRepositoryDescriptionRequest
- A Consumer
that will call methods on UpdateRepositoryDescriptionInput.Builder
to create a
request. 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.
default CompletableFuture<UpdateRepositoryNameResponse> updateRepositoryName(Consumer<UpdateRepositoryNameRequest.Builder> 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.
This is a convenience which creates an instance of the UpdateRepositoryNameRequest.Builder
avoiding the
need to create one manually via UpdateRepositoryNameRequest.builder()
updateRepositoryNameRequest
- A Consumer
that will call methods on UpdateRepositoryNameInput.Builder
to create a
request. 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.