pub struct DeleteFileFluentBuilder { /* 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 DeleteFileFluentBuilder
impl DeleteFileFluentBuilder
Sourcepub fn as_input(&self) -> &DeleteFileInputBuilder
pub fn as_input(&self) -> &DeleteFileInputBuilder
Access the DeleteFile as a reference.
Sourcepub async fn send(
self,
) -> Result<DeleteFileOutput, SdkError<DeleteFileError, HttpResponse>>
pub async fn send( self, ) -> Result<DeleteFileOutput, SdkError<DeleteFileError, HttpResponse>>
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 customize(
self,
) -> CustomizableOperation<DeleteFileOutput, DeleteFileError, Self>
pub fn customize( self, ) -> CustomizableOperation<DeleteFileOutput, DeleteFileError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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 get_repository_name(&self) -> &Option<String>
pub fn get_repository_name(&self) -> &Option<String>
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 get_branch_name(&self) -> &Option<String>
pub fn get_branch_name(&self) -> &Option<String>
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 get_file_path(&self) -> &Option<String>
pub fn get_file_path(&self) -> &Option<String>
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 get_parent_commit_id(&self) -> &Option<String>
pub fn get_parent_commit_id(&self) -> &Option<String>
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 get_keep_empty_folders(&self) -> &Option<bool>
pub fn get_keep_empty_folders(&self) -> &Option<bool>
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 get_commit_message(&self) -> &Option<String>
pub fn get_commit_message(&self) -> &Option<String>
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.
Sourcepub fn get_name(&self) -> &Option<String>
pub fn get_name(&self) -> &Option<String>
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 email(self, input: impl Into<String>) -> Self
pub fn email(self, input: impl Into<String>) -> Self
The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.
Trait Implementations§
Source§impl Clone for DeleteFileFluentBuilder
impl Clone for DeleteFileFluentBuilder
Source§fn clone(&self) -> DeleteFileFluentBuilder
fn clone(&self) -> DeleteFileFluentBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreAuto Trait Implementations§
impl Freeze for DeleteFileFluentBuilder
impl !RefUnwindSafe for DeleteFileFluentBuilder
impl Send for DeleteFileFluentBuilder
impl Sync for DeleteFileFluentBuilder
impl Unpin for DeleteFileFluentBuilder
impl !UnwindSafe for DeleteFileFluentBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);