pub struct TestInvokeMethodFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to TestInvokeMethod
.
Simulate the invocation of a Method in your RestApi with headers, parameters, and an incoming request body.
Implementations§
Source§impl TestInvokeMethodFluentBuilder
impl TestInvokeMethodFluentBuilder
Sourcepub fn as_input(&self) -> &TestInvokeMethodInputBuilder
pub fn as_input(&self) -> &TestInvokeMethodInputBuilder
Access the TestInvokeMethod as a reference.
Sourcepub async fn send(
self,
) -> Result<TestInvokeMethodOutput, SdkError<TestInvokeMethodError, HttpResponse>>
pub async fn send( self, ) -> Result<TestInvokeMethodOutput, SdkError<TestInvokeMethodError, 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<TestInvokeMethodOutput, TestInvokeMethodError, Self>
pub fn customize( self, ) -> CustomizableOperation<TestInvokeMethodOutput, TestInvokeMethodError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
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.
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 resource_id(self, input: impl Into<String>) -> Self
pub fn resource_id(self, input: impl Into<String>) -> Self
Specifies a test invoke method request's resource ID.
Sourcepub fn set_resource_id(self, input: Option<String>) -> Self
pub fn set_resource_id(self, input: Option<String>) -> Self
Specifies a test invoke method request's resource ID.
Sourcepub fn get_resource_id(&self) -> &Option<String>
pub fn get_resource_id(&self) -> &Option<String>
Specifies a test invoke method request's resource ID.
Sourcepub fn http_method(self, input: impl Into<String>) -> Self
pub fn http_method(self, input: impl Into<String>) -> Self
Specifies a test invoke method request's HTTP method.
Sourcepub fn set_http_method(self, input: Option<String>) -> Self
pub fn set_http_method(self, input: Option<String>) -> Self
Specifies a test invoke method request's HTTP method.
Sourcepub fn get_http_method(&self) -> &Option<String>
pub fn get_http_method(&self) -> &Option<String>
Specifies a test invoke method request's HTTP method.
Sourcepub fn path_with_query_string(self, input: impl Into<String>) -> Self
pub fn path_with_query_string(self, input: impl Into<String>) -> Self
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
Sourcepub fn set_path_with_query_string(self, input: Option<String>) -> Self
pub fn set_path_with_query_string(self, input: Option<String>) -> Self
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
Sourcepub fn get_path_with_query_string(&self) -> &Option<String>
pub fn get_path_with_query_string(&self) -> &Option<String>
The URI path, including query string, of the simulated invocation request. Use this to specify path parameters and query string parameters.
Sourcepub fn body(self, input: impl Into<String>) -> Self
pub fn body(self, input: impl Into<String>) -> Self
The simulated request body of an incoming invocation request.
Sourcepub fn set_body(self, input: Option<String>) -> Self
pub fn set_body(self, input: Option<String>) -> Self
The simulated request body of an incoming invocation request.
Sourcepub fn get_body(&self) -> &Option<String>
pub fn get_body(&self) -> &Option<String>
The simulated request body of an incoming invocation request.
Sourcepub fn headers(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn headers(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to headers
.
To override the contents of this collection use set_headers
.
A key-value map of headers to simulate an incoming invocation request.
Sourcepub fn set_headers(self, input: Option<HashMap<String, String>>) -> Self
pub fn set_headers(self, input: Option<HashMap<String, String>>) -> Self
A key-value map of headers to simulate an incoming invocation request.
Sourcepub fn get_headers(&self) -> &Option<HashMap<String, String>>
pub fn get_headers(&self) -> &Option<HashMap<String, String>>
A key-value map of headers to simulate an incoming invocation request.
Sourcepub fn multi_value_headers(self, k: impl Into<String>, v: Vec<String>) -> Self
pub fn multi_value_headers(self, k: impl Into<String>, v: Vec<String>) -> Self
Adds a key-value pair to multiValueHeaders
.
To override the contents of this collection use set_multi_value_headers
.
The headers as a map from string to list of values to simulate an incoming invocation request.
Sourcepub fn set_multi_value_headers(
self,
input: Option<HashMap<String, Vec<String>>>,
) -> Self
pub fn set_multi_value_headers( self, input: Option<HashMap<String, Vec<String>>>, ) -> Self
The headers as a map from string to list of values to simulate an incoming invocation request.
Sourcepub fn get_multi_value_headers(&self) -> &Option<HashMap<String, Vec<String>>>
pub fn get_multi_value_headers(&self) -> &Option<HashMap<String, Vec<String>>>
The headers as a map from string to list of values to simulate an incoming invocation request.
Sourcepub fn client_certificate_id(self, input: impl Into<String>) -> Self
pub fn client_certificate_id(self, input: impl Into<String>) -> Self
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
Sourcepub fn set_client_certificate_id(self, input: Option<String>) -> Self
pub fn set_client_certificate_id(self, input: Option<String>) -> Self
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
Sourcepub fn get_client_certificate_id(&self) -> &Option<String>
pub fn get_client_certificate_id(&self) -> &Option<String>
A ClientCertificate identifier to use in the test invocation. API Gateway will use the certificate when making the HTTPS request to the defined back-end endpoint.
Sourcepub fn stage_variables(self, k: impl Into<String>, v: impl Into<String>) -> Self
pub fn stage_variables(self, k: impl Into<String>, v: impl Into<String>) -> Self
Adds a key-value pair to stageVariables
.
To override the contents of this collection use set_stage_variables
.
A key-value map of stage variables to simulate an invocation on a deployed Stage.
Trait Implementations§
Source§impl Clone for TestInvokeMethodFluentBuilder
impl Clone for TestInvokeMethodFluentBuilder
Source§fn clone(&self) -> TestInvokeMethodFluentBuilder
fn clone(&self) -> TestInvokeMethodFluentBuilder
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreAuto Trait Implementations§
impl Freeze for TestInvokeMethodFluentBuilder
impl !RefUnwindSafe for TestInvokeMethodFluentBuilder
impl Send for TestInvokeMethodFluentBuilder
impl Sync for TestInvokeMethodFluentBuilder
impl Unpin for TestInvokeMethodFluentBuilder
impl !UnwindSafe for TestInvokeMethodFluentBuilder
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);