software.amazon.awssdk.services.codecommit.model

Interface DeleteFileRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CodeCommitRequest.Builder, CopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>, SdkBuilder<DeleteFileRequest.Builder,DeleteFileRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DeleteFileRequest

public static interface DeleteFileRequest.Builder
extends CodeCommitRequest.Builder, SdkPojo, CopyableBuilder<DeleteFileRequest.Builder,DeleteFileRequest>

Method Summary

Modifier and Type	Method and Description
DeleteFileRequest.Builder	branchName(String branchName) The name of the branch where the commit will be made deleting the file.
DeleteFileRequest.Builder	commitMessage(String commitMessage) The commit message you want to include as part of deleting the file.
DeleteFileRequest.Builder	email(String email) The email address for the commit that deletes the file.
DeleteFileRequest.Builder	filePath(String filePath) The fully-qualified path to the file that will be deleted, including the full name and extension of that file.
DeleteFileRequest.Builder	keepEmptyFolders(Boolean keepEmptyFolders) Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory.
DeleteFileRequest.Builder	name(String name) The name of the author of the commit that deletes the file.
DeleteFileRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DeleteFileRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
DeleteFileRequest.Builder	parentCommitId(String parentCommitId) The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file.
DeleteFileRequest.Builder	repositoryName(String repositoryName) The name of the repository that contains the file to delete.

Methods inherited from interface software.amazon.awssdk.services.codecommit.model.CodeCommitRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

repositoryName

DeleteFileRequest.Builder repositoryName(String repositoryName)

The name of the repository that contains the file to delete.

Parameters:

repositoryName - The name of the repository that contains the file to delete.

Returns:

Returns a reference to this object so that method calls can be chained together.

branchName

DeleteFileRequest.Builder branchName(String branchName)

The name of the branch where the commit will be made deleting the file.

Parameters:

branchName - The name of the branch where the commit will be made deleting the file.

Returns:

Returns a reference to this object so that method calls can be chained together.

filePath

DeleteFileRequest.Builder filePath(String filePath)

The fully-qualified path to the file that will be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.

Parameters:

filePath - The fully-qualified path to the file that will be deleted, including the full name and extension of that file. For example, /examples/file.md is a fully qualified path to a file named file.md in a folder named examples.

Returns:

Returns a reference to this object so that method calls can be chained together.

parentCommitId

DeleteFileRequest.Builder parentCommitId(String parentCommitId)

The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file. This must be the HEAD commit for the branch. The commit that deletes the file will be created from this commit ID.

Parameters:

parentCommitId - The ID of the commit that is the tip of the branch where you want to create the commit that will delete the file. This must be the HEAD commit for the branch. The commit that deletes the file will be created from this commit ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

keepEmptyFolders

DeleteFileRequest.Builder keepEmptyFolders(Boolean keepEmptyFolders)

Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 will also delete the empty folders dir4, dir3, and dir2.

Parameters:

keepEmptyFolders - Specifies whether to delete the folder or directory that contains the file you want to delete if that file is the only object in the folder or directory. By default, empty folders will be deleted. This includes empty folders that are part of the directory structure. For example, if the path to a file is dir1/dir2/dir3/dir4, and dir2 and dir3 are empty, deleting the last file in dir4 will also delete the empty folders dir4, dir3, and dir2.

Returns:

Returns a reference to this object so that method calls can be chained together.

commitMessage

DeleteFileRequest.Builder commitMessage(String commitMessage)

The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.

Parameters:

commitMessage - The commit message you want to include as part of deleting the file. Commit messages are limited to 256 KB. If no message is specified, a default message will be used.

Returns:

Returns a reference to this object so that method calls can be chained together.

name

DeleteFileRequest.Builder name(String name)

The name of the author of the commit that deletes the file. If no name is specified, the user's ARN will be used as the author name and committer name.

Parameters:

name - The name of the author of the commit that deletes the file. If no name is specified, the user's ARN will be used as the author name and committer name.

Returns:

Returns a reference to this object so that method calls can be chained together.

email

DeleteFileRequest.Builder email(String email)

The email address for the commit that deletes the file. If no email address is specified, the email address will be left blank.

Parameters:

email - The email address for the commit that deletes the file. If no email address is specified, the email address will be left blank.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

DeleteFileRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DeleteFileRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.