aws_sdk_codecommit/operation/delete_file/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::delete_file::_delete_file_output::DeleteFileOutputBuilder;
3
4pub use crate::operation::delete_file::_delete_file_input::DeleteFileInputBuilder;
5
6impl crate::operation::delete_file::builders::DeleteFileInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::delete_file::DeleteFileOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::delete_file::DeleteFileError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.delete_file();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `DeleteFile`.
24///
25/// <p>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.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct DeleteFileFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::delete_file::builders::DeleteFileInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::delete_file::DeleteFileOutput,
35        crate::operation::delete_file::DeleteFileError,
36    > for DeleteFileFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::delete_file::DeleteFileOutput,
44            crate::operation::delete_file::DeleteFileError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl DeleteFileFluentBuilder {
51    /// Creates a new `DeleteFileFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the DeleteFile as a reference.
60    pub fn as_input(&self) -> &crate::operation::delete_file::builders::DeleteFileInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::delete_file::DeleteFileOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::delete_file::DeleteFileError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::delete_file::DeleteFile::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::delete_file::DeleteFile::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::delete_file::DeleteFileOutput,
97        crate::operation::delete_file::DeleteFileError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The name of the repository that contains the file to delete.</p>
112    pub fn repository_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.repository_name(input.into());
114        self
115    }
116    /// <p>The name of the repository that contains the file to delete.</p>
117    pub fn set_repository_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_repository_name(input);
119        self
120    }
121    /// <p>The name of the repository that contains the file to delete.</p>
122    pub fn get_repository_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_repository_name()
124    }
125    /// <p>The name of the branch where the commit that deletes the file is made.</p>
126    pub fn branch_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.branch_name(input.into());
128        self
129    }
130    /// <p>The name of the branch where the commit that deletes the file is made.</p>
131    pub fn set_branch_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_branch_name(input);
133        self
134    }
135    /// <p>The name of the branch where the commit that deletes the file is made.</p>
136    pub fn get_branch_name(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_branch_name()
138    }
139    /// <p>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.</p>
140    pub fn file_path(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
141        self.inner = self.inner.file_path(input.into());
142        self
143    }
144    /// <p>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.</p>
145    pub fn set_file_path(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
146        self.inner = self.inner.set_file_path(input);
147        self
148    }
149    /// <p>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.</p>
150    pub fn get_file_path(&self) -> &::std::option::Option<::std::string::String> {
151        self.inner.get_file_path()
152    }
153    /// <p>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.</p>
154    pub fn parent_commit_id(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
155        self.inner = self.inner.parent_commit_id(input.into());
156        self
157    }
158    /// <p>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.</p>
159    pub fn set_parent_commit_id(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
160        self.inner = self.inner.set_parent_commit_id(input);
161        self
162    }
163    /// <p>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.</p>
164    pub fn get_parent_commit_id(&self) -> &::std::option::Option<::std::string::String> {
165        self.inner.get_parent_commit_id()
166    }
167    /// <p>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.</p>
168    pub fn keep_empty_folders(mut self, input: bool) -> Self {
169        self.inner = self.inner.keep_empty_folders(input);
170        self
171    }
172    /// <p>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.</p>
173    pub fn set_keep_empty_folders(mut self, input: ::std::option::Option<bool>) -> Self {
174        self.inner = self.inner.set_keep_empty_folders(input);
175        self
176    }
177    /// <p>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.</p>
178    pub fn get_keep_empty_folders(&self) -> &::std::option::Option<bool> {
179        self.inner.get_keep_empty_folders()
180    }
181    /// <p>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.</p>
182    pub fn commit_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
183        self.inner = self.inner.commit_message(input.into());
184        self
185    }
186    /// <p>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.</p>
187    pub fn set_commit_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
188        self.inner = self.inner.set_commit_message(input);
189        self
190    }
191    /// <p>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.</p>
192    pub fn get_commit_message(&self) -> &::std::option::Option<::std::string::String> {
193        self.inner.get_commit_message()
194    }
195    /// <p>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.</p>
196    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
197        self.inner = self.inner.name(input.into());
198        self
199    }
200    /// <p>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.</p>
201    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
202        self.inner = self.inner.set_name(input);
203        self
204    }
205    /// <p>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.</p>
206    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
207        self.inner.get_name()
208    }
209    /// <p>The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.</p>
210    pub fn email(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
211        self.inner = self.inner.email(input.into());
212        self
213    }
214    /// <p>The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.</p>
215    pub fn set_email(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
216        self.inner = self.inner.set_email(input);
217        self
218    }
219    /// <p>The email address for the commit that deletes the file. If no email address is specified, the email address is left blank.</p>
220    pub fn get_email(&self) -> &::std::option::Option<::std::string::String> {
221        self.inner.get_email()
222    }
223}
aws_sdk_codecommit/operation/delete_file/builders.rs

aws_sdk_codecommit/operation/delete_file/
builders.rs
