#[non_exhaustive]pub struct CreateCommentInputBuilder { /* private fields */ }
Expand description
A builder for CreateCommentInput
.
Implementations§
Source§impl CreateCommentInputBuilder
impl CreateCommentInputBuilder
Sourcepub fn authentication_token(self, input: impl Into<String>) -> Self
pub fn authentication_token(self, input: impl Into<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn set_authentication_token(self, input: Option<String>) -> Self
pub fn set_authentication_token(self, input: Option<String>) -> Self
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn get_authentication_token(&self) -> &Option<String>
pub fn get_authentication_token(&self) -> &Option<String>
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Sourcepub fn document_id(self, input: impl Into<String>) -> Self
pub fn document_id(self, input: impl Into<String>) -> Self
The ID of the document.
This field is required.Sourcepub fn set_document_id(self, input: Option<String>) -> Self
pub fn set_document_id(self, input: Option<String>) -> Self
The ID of the document.
Sourcepub fn get_document_id(&self) -> &Option<String>
pub fn get_document_id(&self) -> &Option<String>
The ID of the document.
Sourcepub fn version_id(self, input: impl Into<String>) -> Self
pub fn version_id(self, input: impl Into<String>) -> Self
The ID of the document version.
This field is required.Sourcepub fn set_version_id(self, input: Option<String>) -> Self
pub fn set_version_id(self, input: Option<String>) -> Self
The ID of the document version.
Sourcepub fn get_version_id(&self) -> &Option<String>
pub fn get_version_id(&self) -> &Option<String>
The ID of the document version.
Sourcepub fn set_parent_id(self, input: Option<String>) -> Self
pub fn set_parent_id(self, input: Option<String>) -> Self
The ID of the parent comment.
Sourcepub fn get_parent_id(&self) -> &Option<String>
pub fn get_parent_id(&self) -> &Option<String>
The ID of the parent comment.
Sourcepub fn thread_id(self, input: impl Into<String>) -> Self
pub fn thread_id(self, input: impl Into<String>) -> Self
The ID of the root comment in the thread.
Sourcepub fn set_thread_id(self, input: Option<String>) -> Self
pub fn set_thread_id(self, input: Option<String>) -> Self
The ID of the root comment in the thread.
Sourcepub fn get_thread_id(&self) -> &Option<String>
pub fn get_thread_id(&self) -> &Option<String>
The ID of the root comment in the thread.
Sourcepub fn text(self, input: impl Into<String>) -> Self
pub fn text(self, input: impl Into<String>) -> Self
The text of the comment.
This field is required.Sourcepub fn visibility(self, input: CommentVisibilityType) -> Self
pub fn visibility(self, input: CommentVisibilityType) -> Self
The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
Sourcepub fn set_visibility(self, input: Option<CommentVisibilityType>) -> Self
pub fn set_visibility(self, input: Option<CommentVisibilityType>) -> Self
The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
Sourcepub fn get_visibility(&self) -> &Option<CommentVisibilityType>
pub fn get_visibility(&self) -> &Option<CommentVisibilityType>
The visibility of the comment. Options are either PRIVATE, where the comment is visible only to the comment author and document owner and co-owners, or PUBLIC, where the comment is visible to document owners, co-owners, and contributors.
Sourcepub fn notify_collaborators(self, input: bool) -> Self
pub fn notify_collaborators(self, input: bool) -> Self
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
Sourcepub fn set_notify_collaborators(self, input: Option<bool>) -> Self
pub fn set_notify_collaborators(self, input: Option<bool>) -> Self
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
Sourcepub fn get_notify_collaborators(&self) -> &Option<bool>
pub fn get_notify_collaborators(&self) -> &Option<bool>
Set this parameter to TRUE to send an email out to the document collaborators after the comment is created.
Sourcepub fn build(self) -> Result<CreateCommentInput, BuildError>
pub fn build(self) -> Result<CreateCommentInput, BuildError>
Consumes the builder and constructs a CreateCommentInput
.
Source§impl CreateCommentInputBuilder
impl CreateCommentInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreateCommentOutput, SdkError<CreateCommentError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreateCommentOutput, SdkError<CreateCommentError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreateCommentInputBuilder
impl Clone for CreateCommentInputBuilder
Source§fn clone(&self) -> CreateCommentInputBuilder
fn clone(&self) -> CreateCommentInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateCommentInputBuilder
impl Debug for CreateCommentInputBuilder
Source§impl Default for CreateCommentInputBuilder
impl Default for CreateCommentInputBuilder
Source§fn default() -> CreateCommentInputBuilder
fn default() -> CreateCommentInputBuilder
impl StructuralPartialEq for CreateCommentInputBuilder
Auto Trait Implementations§
impl Freeze for CreateCommentInputBuilder
impl RefUnwindSafe for CreateCommentInputBuilder
impl Send for CreateCommentInputBuilder
impl Sync for CreateCommentInputBuilder
impl Unpin for CreateCommentInputBuilder
impl UnwindSafe for CreateCommentInputBuilder
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§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)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>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
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>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
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>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
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>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
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>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
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>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
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 underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
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);