Struct aws_sdk_codecommit::client::fluent_builders::DeleteFile

source · [−]

pub struct DeleteFile<C = DynConnector, M = DefaultMiddleware, R = Standard> { /* private fields */ }

Expand description

Fluent builder constructing a request to DeleteFile.

Deletes a specified file from a specified branch. A commit is created on the branch that contains the revision. The file still exists in the commits earlier to the commit that contains the deletion.

Implementations

source

impl<C, M, R> DeleteFile<C, M, R> where
 C: SmithyConnector,
 M: SmithyMiddleware<C>,
 R: NewRequestPolicy,

source

pub async fn send(self) -> Result<DeleteFileOutput, SdkError<DeleteFileError>> where
R::Policy: SmithyRetryPolicy<DeleteFileInputOperationOutputAlias, DeleteFileOutput, DeleteFileError, DeleteFileInputOperationRetryAlias>,

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

source

pub fn repository_name(self, input: impl Into<String>) -> Self

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

source

pub fn set_repository_name(self, input: Option<String>) -> Self

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

source

pub fn branch_name(self, input: impl Into<String>) -> Self

The name of the branch where the commit that deletes the file is made.

source

pub fn set_branch_name(self, input: Option<String>) -> Self

The name of the branch where the commit that deletes the file is made.

source

pub fn file_path(self, input: impl Into<String>) -> Self

The fully qualified path to the file that to 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.

source

pub fn set_file_path(self, input: Option<String>) -> Self

The fully qualified path to the file that to 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.

source

pub fn parent_commit_id(self, input: impl Into<String>) -> Self

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

source

pub fn set_parent_commit_id(self, input: Option<String>) -> Self

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

source

pub fn keep_empty_folders(self, input: bool) -> Self

If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are 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 also deletes the empty folders dir4, dir3, and dir2.

source

pub fn set_keep_empty_folders(self, input: Option<bool>) -> Self

If a file is the only object in the folder or directory, specifies whether to delete the folder or directory that contains the file. By default, empty folders are 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 also deletes the empty folders dir4, dir3, and dir2.

source

pub fn commit_message(self, input: impl Into<String>) -> Self

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 is used.

source

pub fn set_commit_message(self, input: Option<String>) -> Self

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 is used.

source