pub struct ImportDocumentFluentBuilder { /* private fields */ }Expand description
Fluent builder constructing a request to ImportDocument.
Uploads a file that can then be used either as a default in a FileUploadCard from Q App definition or as a file that is used inside a single Q App run. The purpose of the document is determined by a scope parameter that indicates whether it is at the app definition level or at the app session level.
Implementations§
Source§impl ImportDocumentFluentBuilder
impl ImportDocumentFluentBuilder
Sourcepub fn as_input(&self) -> &ImportDocumentInputBuilder
pub fn as_input(&self) -> &ImportDocumentInputBuilder
Access the ImportDocument as a reference.
Sourcepub async fn send(
self,
) -> Result<ImportDocumentOutput, SdkError<ImportDocumentError, HttpResponse>>
pub async fn send( self, ) -> Result<ImportDocumentOutput, SdkError<ImportDocumentError, 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<ImportDocumentOutput, ImportDocumentError, Self>
pub fn customize( self, ) -> CustomizableOperation<ImportDocumentOutput, ImportDocumentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The unique identifier of the Amazon Q Business application environment instance.
Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The unique identifier of the Amazon Q Business application environment instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The unique identifier of the Amazon Q Business application environment instance.
Sourcepub fn card_id(self, input: impl Into<String>) -> Self
pub fn card_id(self, input: impl Into<String>) -> Self
The unique identifier of the card the file is associated with.
Sourcepub fn set_card_id(self, input: Option<String>) -> Self
pub fn set_card_id(self, input: Option<String>) -> Self
The unique identifier of the card the file is associated with.
Sourcepub fn get_card_id(&self) -> &Option<String>
pub fn get_card_id(&self) -> &Option<String>
The unique identifier of the card the file is associated with.
Sourcepub fn app_id(self, input: impl Into<String>) -> Self
pub fn app_id(self, input: impl Into<String>) -> Self
The unique identifier of the Q App the file is associated with.
Sourcepub fn set_app_id(self, input: Option<String>) -> Self
pub fn set_app_id(self, input: Option<String>) -> Self
The unique identifier of the Q App the file is associated with.
Sourcepub fn get_app_id(&self) -> &Option<String>
pub fn get_app_id(&self) -> &Option<String>
The unique identifier of the Q App the file is associated with.
Sourcepub fn file_contents_base64(self, input: impl Into<String>) -> Self
pub fn file_contents_base64(self, input: impl Into<String>) -> Self
The base64-encoded contents of the file to upload.
Sourcepub fn set_file_contents_base64(self, input: Option<String>) -> Self
pub fn set_file_contents_base64(self, input: Option<String>) -> Self
The base64-encoded contents of the file to upload.
Sourcepub fn get_file_contents_base64(&self) -> &Option<String>
pub fn get_file_contents_base64(&self) -> &Option<String>
The base64-encoded contents of the file to upload.
Sourcepub fn set_file_name(self, input: Option<String>) -> Self
pub fn set_file_name(self, input: Option<String>) -> Self
The name of the file being uploaded.
Sourcepub fn get_file_name(&self) -> &Option<String>
pub fn get_file_name(&self) -> &Option<String>
The name of the file being uploaded.
Sourcepub fn scope(self, input: DocumentScope) -> Self
pub fn scope(self, input: DocumentScope) -> Self
Whether the file is associated with a Q App definition or a specific Q App session.
Sourcepub fn set_scope(self, input: Option<DocumentScope>) -> Self
pub fn set_scope(self, input: Option<DocumentScope>) -> Self
Whether the file is associated with a Q App definition or a specific Q App session.
Sourcepub fn get_scope(&self) -> &Option<DocumentScope>
pub fn get_scope(&self) -> &Option<DocumentScope>
Whether the file is associated with a Q App definition or a specific Q App session.
Sourcepub fn session_id(self, input: impl Into<String>) -> Self
pub fn session_id(self, input: impl Into<String>) -> Self
The unique identifier of the Q App session the file is associated with, if applicable.
Sourcepub fn set_session_id(self, input: Option<String>) -> Self
pub fn set_session_id(self, input: Option<String>) -> Self
The unique identifier of the Q App session the file is associated with, if applicable.
Sourcepub fn get_session_id(&self) -> &Option<String>
pub fn get_session_id(&self) -> &Option<String>
The unique identifier of the Q App session the file is associated with, if applicable.
Trait Implementations§
Source§impl Clone for ImportDocumentFluentBuilder
impl Clone for ImportDocumentFluentBuilder
Source§fn clone(&self) -> ImportDocumentFluentBuilder
fn clone(&self) -> ImportDocumentFluentBuilder
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 ImportDocumentFluentBuilder
impl !RefUnwindSafe for ImportDocumentFluentBuilder
impl Send for ImportDocumentFluentBuilder
impl Sync for ImportDocumentFluentBuilder
impl Unpin for ImportDocumentFluentBuilder
impl !UnwindSafe for ImportDocumentFluentBuilder
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);