Struct aws_sdk_codecommit::input::DeleteFileInput
source · [−]#[non_exhaustive]pub struct DeleteFileInput {
pub repository_name: Option<String>,
pub branch_name: Option<String>,
pub file_path: Option<String>,
pub parent_commit_id: Option<String>,
pub keep_empty_folders: bool,
pub commit_message: Option<String>,
pub name: Option<String>,
pub email: Option<String>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.repository_name: Option<String>
The name of the repository that contains the file to delete.
branch_name: Option<String>
The name of the branch where the commit that deletes the file is made.
file_path: 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.
parent_commit_id: 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.
keep_empty_folders: 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.
commit_message: 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.
name: 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.
email: Option<String>
The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.
Implementations
sourceimpl DeleteFileInput
impl DeleteFileInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<DeleteFile, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<DeleteFile, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<DeleteFile
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture DeleteFileInput
sourceimpl DeleteFileInput
impl DeleteFileInput
sourcepub fn repository_name(&self) -> Option<&str>
pub fn repository_name(&self) -> Option<&str>
The name of the repository that contains the file to delete.
sourcepub fn branch_name(&self) -> Option<&str>
pub fn branch_name(&self) -> Option<&str>
The name of the branch where the commit that deletes the file is made.
sourcepub fn file_path(&self) -> Option<&str>
pub fn file_path(&self) -> Option<&str>
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) -> Option<&str>
pub fn parent_commit_id(&self) -> Option<&str>
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) -> bool
pub fn keep_empty_folders(&self) -> 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) -> Option<&str>
pub fn commit_message(&self) -> Option<&str>
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.
Trait Implementations
sourceimpl Clone for DeleteFileInput
impl Clone for DeleteFileInput
sourcefn clone(&self) -> DeleteFileInput
fn clone(&self) -> DeleteFileInput
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
sourceimpl Debug for DeleteFileInput
impl Debug for DeleteFileInput
sourceimpl PartialEq<DeleteFileInput> for DeleteFileInput
impl PartialEq<DeleteFileInput> for DeleteFileInput
sourcefn eq(&self, other: &DeleteFileInput) -> bool
fn eq(&self, other: &DeleteFileInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &DeleteFileInput) -> bool
fn ne(&self, other: &DeleteFileInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for DeleteFileInput
Auto Trait Implementations
impl RefUnwindSafe for DeleteFileInput
impl Send for DeleteFileInput
impl Sync for DeleteFileInput
impl Unpin for DeleteFileInput
impl UnwindSafe for DeleteFileInput
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub 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.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub 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