#[non_exhaustive]pub struct GetDocumentationPartsInputBuilder { /* private fields */ }Expand description
A builder for GetDocumentationPartsInput.
Implementations§
Source§impl GetDocumentationPartsInputBuilder
impl GetDocumentationPartsInputBuilder
Sourcepub fn rest_api_id(self, input: impl Into<String>) -> Self
pub fn rest_api_id(self, input: impl Into<String>) -> Self
The string identifier of the associated RestApi.
This field is required.Sourcepub fn set_rest_api_id(self, input: Option<String>) -> Self
pub fn set_rest_api_id(self, input: Option<String>) -> Self
The string identifier of the associated RestApi.
Sourcepub fn get_rest_api_id(&self) -> &Option<String>
pub fn get_rest_api_id(&self) -> &Option<String>
The string identifier of the associated RestApi.
Sourcepub fn type(self, input: DocumentationPartType) -> Self
pub fn type(self, input: DocumentationPartType) -> Self
The type of API entities of the to-be-retrieved documentation parts.
Sourcepub fn set_type(self, input: Option<DocumentationPartType>) -> Self
pub fn set_type(self, input: Option<DocumentationPartType>) -> Self
The type of API entities of the to-be-retrieved documentation parts.
Sourcepub fn get_type(&self) -> &Option<DocumentationPartType>
pub fn get_type(&self) -> &Option<DocumentationPartType>
The type of API entities of the to-be-retrieved documentation parts.
Sourcepub fn name_query(self, input: impl Into<String>) -> Self
pub fn name_query(self, input: impl Into<String>) -> Self
The name of API entities of the to-be-retrieved documentation parts.
Sourcepub fn set_name_query(self, input: Option<String>) -> Self
pub fn set_name_query(self, input: Option<String>) -> Self
The name of API entities of the to-be-retrieved documentation parts.
Sourcepub fn get_name_query(&self) -> &Option<String>
pub fn get_name_query(&self) -> &Option<String>
The name of API entities of the to-be-retrieved documentation parts.
Sourcepub fn path(self, input: impl Into<String>) -> Self
pub fn path(self, input: impl Into<String>) -> Self
The path of API entities of the to-be-retrieved documentation parts.
Sourcepub fn set_path(self, input: Option<String>) -> Self
pub fn set_path(self, input: Option<String>) -> Self
The path of API entities of the to-be-retrieved documentation parts.
Sourcepub fn get_path(&self) -> &Option<String>
pub fn get_path(&self) -> &Option<String>
The path of API entities of the to-be-retrieved documentation parts.
Sourcepub fn position(self, input: impl Into<String>) -> Self
pub fn position(self, input: impl Into<String>) -> Self
The current pagination position in the paged result set.
Sourcepub fn set_position(self, input: Option<String>) -> Self
pub fn set_position(self, input: Option<String>) -> Self
The current pagination position in the paged result set.
Sourcepub fn get_position(&self) -> &Option<String>
pub fn get_position(&self) -> &Option<String>
The current pagination position in the paged result set.
Sourcepub fn limit(self, input: i32) -> Self
pub fn limit(self, input: i32) -> Self
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Sourcepub fn set_limit(self, input: Option<i32>) -> Self
pub fn set_limit(self, input: Option<i32>) -> Self
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Sourcepub fn get_limit(&self) -> &Option<i32>
pub fn get_limit(&self) -> &Option<i32>
The maximum number of returned results per page. The default value is 25 and the maximum value is 500.
Sourcepub fn location_status(self, input: LocationStatusType) -> Self
pub fn location_status(self, input: LocationStatusType) -> Self
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
Sourcepub fn set_location_status(self, input: Option<LocationStatusType>) -> Self
pub fn set_location_status(self, input: Option<LocationStatusType>) -> Self
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
Sourcepub fn get_location_status(&self) -> &Option<LocationStatusType>
pub fn get_location_status(&self) -> &Option<LocationStatusType>
The status of the API documentation parts to retrieve. Valid values are DOCUMENTED for retrieving DocumentationPart resources with content and UNDOCUMENTED for DocumentationPart resources without content.
Sourcepub fn build(self) -> Result<GetDocumentationPartsInput, BuildError>
pub fn build(self) -> Result<GetDocumentationPartsInput, BuildError>
Consumes the builder and constructs a GetDocumentationPartsInput.
Source§impl GetDocumentationPartsInputBuilder
impl GetDocumentationPartsInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<GetDocumentationPartsOutput, SdkError<GetDocumentationPartsError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<GetDocumentationPartsOutput, SdkError<GetDocumentationPartsError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for GetDocumentationPartsInputBuilder
impl Clone for GetDocumentationPartsInputBuilder
Source§fn clone(&self) -> GetDocumentationPartsInputBuilder
fn clone(&self) -> GetDocumentationPartsInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Default for GetDocumentationPartsInputBuilder
impl Default for GetDocumentationPartsInputBuilder
Source§fn default() -> GetDocumentationPartsInputBuilder
fn default() -> GetDocumentationPartsInputBuilder
Source§impl PartialEq for GetDocumentationPartsInputBuilder
impl PartialEq for GetDocumentationPartsInputBuilder
Source§fn eq(&self, other: &GetDocumentationPartsInputBuilder) -> bool
fn eq(&self, other: &GetDocumentationPartsInputBuilder) -> bool
self and other values to be equal, and is used by ==.impl StructuralPartialEq for GetDocumentationPartsInputBuilder
Auto Trait Implementations§
impl Freeze for GetDocumentationPartsInputBuilder
impl RefUnwindSafe for GetDocumentationPartsInputBuilder
impl Send for GetDocumentationPartsInputBuilder
impl Sync for GetDocumentationPartsInputBuilder
impl Unpin for GetDocumentationPartsInputBuilder
impl UnwindSafe for GetDocumentationPartsInputBuilder
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);