Struct aws_sdk_codecommit::client::fluent_builders::DeleteFile
source · [−]pub struct DeleteFile { /* 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
sourceimpl DeleteFile
impl DeleteFile
sourcepub async fn send(self) -> Result<DeleteFileOutput, SdkError<DeleteFileError>>
pub async fn send(self) -> Result<DeleteFileOutput, SdkError<DeleteFileError>>
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.
sourcepub fn repository_name(self, input: impl Into<String>) -> Self
pub fn repository_name(self, input: impl Into<String>) -> Self
The name of the repository that contains the file to delete.
sourcepub fn set_repository_name(self, input: Option<String>) -> Self
pub fn set_repository_name(self, input: Option<String>) -> Self
The name of the repository that contains the file to delete.
sourcepub fn branch_name(self, input: impl Into<String>) -> Self
pub fn branch_name(self, input: impl Into<String>) -> Self
The name of the branch where the commit that deletes the file is made.
sourcepub fn set_branch_name(self, input: Option<String>) -> Self
pub fn set_branch_name(self, input: Option<String>) -> Self
The name of the branch where the commit that deletes the file is made.
sourcepub fn file_path(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_file_path(self, input: Option<String>) -> Self
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.
sourcepub fn parent_commit_id(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_parent_commit_id(self, input: Option<String>) -> Self
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.
sourcepub fn keep_empty_folders(self, input: bool) -> Self
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.
sourcepub fn set_keep_empty_folders(self, input: Option<bool>) -> Self
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.
sourcepub fn commit_message(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_commit_message(self, input: Option<String>) -> Self
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.
sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name of the author of the commit that deletes the file. If no name is specified, the user's ARN is used as the author name and committer name.
sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name of the author of the commit that deletes the file. If no name is specified, the user's ARN is used as the author name and committer name.
Trait Implementations
sourceimpl Clone for DeleteFile
impl Clone for DeleteFile
sourcefn clone(&self) -> DeleteFile
fn clone(&self) -> DeleteFile
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for DeleteFile
impl Send for DeleteFile
impl Sync for DeleteFile
impl Unpin for DeleteFile
impl !UnwindSafe for DeleteFile
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more