pub struct RegisterClientFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to RegisterClient
.
Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
Implementations§
source§impl RegisterClientFluentBuilder
impl RegisterClientFluentBuilder
sourcepub fn as_input(&self) -> &RegisterClientInputBuilder
pub fn as_input(&self) -> &RegisterClientInputBuilder
Access the RegisterClient as a reference.
sourcepub async fn send(
self,
) -> Result<RegisterClientOutput, SdkError<RegisterClientError, HttpResponse>>
pub async fn send( self, ) -> Result<RegisterClientOutput, SdkError<RegisterClientError, 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<RegisterClientOutput, RegisterClientError, Self>
pub fn customize( self, ) -> CustomizableOperation<RegisterClientOutput, RegisterClientError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn client_name(self, input: impl Into<String>) -> Self
pub fn client_name(self, input: impl Into<String>) -> Self
The friendly name of the client.
sourcepub fn set_client_name(self, input: Option<String>) -> Self
pub fn set_client_name(self, input: Option<String>) -> Self
The friendly name of the client.
sourcepub fn get_client_name(&self) -> &Option<String>
pub fn get_client_name(&self) -> &Option<String>
The friendly name of the client.
sourcepub fn client_type(self, input: impl Into<String>) -> Self
pub fn client_type(self, input: impl Into<String>) -> Self
The type of client. The service supports only public
as a client type. Anything other than public will be rejected by the service.
sourcepub fn set_client_type(self, input: Option<String>) -> Self
pub fn set_client_type(self, input: Option<String>) -> Self
The type of client. The service supports only public
as a client type. Anything other than public will be rejected by the service.
sourcepub fn get_client_type(&self) -> &Option<String>
pub fn get_client_type(&self) -> &Option<String>
The type of client. The service supports only public
as a client type. Anything other than public will be rejected by the service.
sourcepub fn scopes(self, input: impl Into<String>) -> Self
pub fn scopes(self, input: impl Into<String>) -> Self
Appends an item to scopes
.
To override the contents of this collection use set_scopes
.
The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
sourcepub fn set_scopes(self, input: Option<Vec<String>>) -> Self
pub fn set_scopes(self, input: Option<Vec<String>>) -> Self
The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
sourcepub fn get_scopes(&self) -> &Option<Vec<String>>
pub fn get_scopes(&self) -> &Option<Vec<String>>
The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
sourcepub fn redirect_uris(self, input: impl Into<String>) -> Self
pub fn redirect_uris(self, input: impl Into<String>) -> Self
Appends an item to redirectUris
.
To override the contents of this collection use set_redirect_uris
.
The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
sourcepub fn set_redirect_uris(self, input: Option<Vec<String>>) -> Self
pub fn set_redirect_uris(self, input: Option<Vec<String>>) -> Self
The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
sourcepub fn get_redirect_uris(&self) -> &Option<Vec<String>>
pub fn get_redirect_uris(&self) -> &Option<Vec<String>>
The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
sourcepub fn grant_types(self, input: impl Into<String>) -> Self
pub fn grant_types(self, input: impl Into<String>) -> Self
Appends an item to grantTypes
.
To override the contents of this collection use set_grant_types
.
The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.
sourcepub fn set_grant_types(self, input: Option<Vec<String>>) -> Self
pub fn set_grant_types(self, input: Option<Vec<String>>) -> Self
The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.
sourcepub fn get_grant_types(&self) -> &Option<Vec<String>>
pub fn get_grant_types(&self) -> &Option<Vec<String>>
The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.
sourcepub fn issuer_url(self, input: impl Into<String>) -> Self
pub fn issuer_url(self, input: impl Into<String>) -> Self
The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.
sourcepub fn set_issuer_url(self, input: Option<String>) -> Self
pub fn set_issuer_url(self, input: Option<String>) -> Self
The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.
sourcepub fn get_issuer_url(&self) -> &Option<String>
pub fn get_issuer_url(&self) -> &Option<String>
The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.
sourcepub fn entitled_application_arn(self, input: impl Into<String>) -> Self
pub fn entitled_application_arn(self, input: impl Into<String>) -> Self
This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.
sourcepub fn set_entitled_application_arn(self, input: Option<String>) -> Self
pub fn set_entitled_application_arn(self, input: Option<String>) -> Self
This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.
sourcepub fn get_entitled_application_arn(&self) -> &Option<String>
pub fn get_entitled_application_arn(&self) -> &Option<String>
This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.
Trait Implementations§
source§impl Clone for RegisterClientFluentBuilder
impl Clone for RegisterClientFluentBuilder
source§fn clone(&self) -> RegisterClientFluentBuilder
fn clone(&self) -> RegisterClientFluentBuilder
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 RegisterClientFluentBuilder
impl !RefUnwindSafe for RegisterClientFluentBuilder
impl Send for RegisterClientFluentBuilder
impl Sync for RegisterClientFluentBuilder
impl Unpin for RegisterClientFluentBuilder
impl !UnwindSafe for RegisterClientFluentBuilder
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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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 more§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
§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();
§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
§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();
§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
§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();
§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
§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();
§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.§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);