Interface PullRequestTarget.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<PullRequestTarget.Builder,
,PullRequestTarget> SdkBuilder<PullRequestTarget.Builder,
,PullRequestTarget> SdkPojo
- Enclosing class:
PullRequestTarget
-
Method Summary
Modifier and TypeMethodDescriptiondestinationCommit
(String destinationCommit) The full commit ID that is the tip of the destination branch.destinationReference
(String destinationReference) The branch of the repository where the pull request changes are merged.The commit ID of the most recent commit that the source branch and the destination branch have in common.default PullRequestTarget.Builder
mergeMetadata
(Consumer<MergeMetadata.Builder> mergeMetadata) Returns metadata about the state of the merge, including whether the merge has been made.mergeMetadata
(MergeMetadata mergeMetadata) Returns metadata about the state of the merge, including whether the merge has been made.repositoryName
(String repositoryName) The name of the repository that contains the pull request source and destination branches.sourceCommit
(String sourceCommit) The full commit ID of the tip of the source branch used to create the pull request.sourceReference
(String sourceReference) The branch of the repository that contains the changes for the pull request.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
repositoryName
The name of the repository that contains the pull request source and destination branches.
- Parameters:
repositoryName
- The name of the repository that contains the pull request source and destination branches.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceReference
The branch of the repository that contains the changes for the pull request. Also known as the source branch.
- Parameters:
sourceReference
- The branch of the repository that contains the changes for the pull request. Also known as the source branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationReference
The branch of the repository where the pull request changes are merged. Also known as the destination branch.
- Parameters:
destinationReference
- The branch of the repository where the pull request changes are merged. Also known as the destination branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
destinationCommit
The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.
- Parameters:
destinationCommit
- The full commit ID that is the tip of the destination branch. This is the commit where the pull request was or will be merged.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceCommit
The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.
- Parameters:
sourceCommit
- The full commit ID of the tip of the source branch used to create the pull request. If the pull request branch is updated by a push while the pull request is open, the commit ID changes to reflect the new tip of the branch.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mergeBase
The commit ID of the most recent commit that the source branch and the destination branch have in common.
- Parameters:
mergeBase
- The commit ID of the most recent commit that the source branch and the destination branch have in common.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mergeMetadata
Returns metadata about the state of the merge, including whether the merge has been made.
- Parameters:
mergeMetadata
- Returns metadata about the state of the merge, including whether the merge has been made.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
mergeMetadata
Returns metadata about the state of the merge, including whether the merge has been made.
This is a convenience method that creates an instance of theMergeMetadata.Builder
avoiding the need to create one manually viaMergeMetadata.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomergeMetadata(MergeMetadata)
.- Parameters:
mergeMetadata
- a consumer that will call methods onMergeMetadata.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-