pub struct CreateUserFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateUser
.
Creates a new user in FinSpace.
Implementations§
Source§impl CreateUserFluentBuilder
impl CreateUserFluentBuilder
Sourcepub fn as_input(&self) -> &CreateUserInputBuilder
pub fn as_input(&self) -> &CreateUserInputBuilder
Access the CreateUser as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateUserOutput, SdkError<CreateUserError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateUserOutput, SdkError<CreateUserError, 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<CreateUserOutput, CreateUserError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateUserOutput, CreateUserError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn email_address(self, input: impl Into<String>) -> Self
pub fn email_address(self, input: impl Into<String>) -> Self
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
Sourcepub fn set_email_address(self, input: Option<String>) -> Self
pub fn set_email_address(self, input: Option<String>) -> Self
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
Sourcepub fn get_email_address(&self) -> &Option<String>
pub fn get_email_address(&self) -> &Option<String>
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
Sourcepub fn type(self, input: UserType) -> Self
pub fn type(self, input: UserType) -> Self
The option to indicate the type of user. Use one of the following options to specify this parameter:
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Sourcepub fn set_type(self, input: Option<UserType>) -> Self
pub fn set_type(self, input: Option<UserType>) -> Self
The option to indicate the type of user. Use one of the following options to specify this parameter:
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Sourcepub fn get_type(&self) -> &Option<UserType>
pub fn get_type(&self) -> &Option<UserType>
The option to indicate the type of user. Use one of the following options to specify this parameter:
-
SUPER_USER
– A user with permission to all the functionality and data in FinSpace. -
APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
Sourcepub fn first_name(self, input: impl Into<String>) -> Self
pub fn first_name(self, input: impl Into<String>) -> Self
The first name of the user that you want to register.
Sourcepub fn set_first_name(self, input: Option<String>) -> Self
pub fn set_first_name(self, input: Option<String>) -> Self
The first name of the user that you want to register.
Sourcepub fn get_first_name(&self) -> &Option<String>
pub fn get_first_name(&self) -> &Option<String>
The first name of the user that you want to register.
Sourcepub fn last_name(self, input: impl Into<String>) -> Self
pub fn last_name(self, input: impl Into<String>) -> Self
The last name of the user that you want to register.
Sourcepub fn set_last_name(self, input: Option<String>) -> Self
pub fn set_last_name(self, input: Option<String>) -> Self
The last name of the user that you want to register.
Sourcepub fn get_last_name(&self) -> &Option<String>
pub fn get_last_name(&self) -> &Option<String>
The last name of the user that you want to register.
Sourcepub fn api_access(self, input: ApiAccess) -> Self
pub fn api_access(self, input: ApiAccess) -> Self
The option to indicate whether the user can use the GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.
-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
Sourcepub fn set_api_access(self, input: Option<ApiAccess>) -> Self
pub fn set_api_access(self, input: Option<ApiAccess>) -> Self
The option to indicate whether the user can use the GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.
-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
Sourcepub fn get_api_access(&self) -> &Option<ApiAccess>
pub fn get_api_access(&self) -> &Option<ApiAccess>
The option to indicate whether the user can use the GetProgrammaticAccessCredentials
API to obtain credentials that can then be used to access other FinSpace Data API operations.
-
ENABLED
– The user has permissions to use the APIs. -
DISABLED
– The user does not have permissions to use any APIs.
Sourcepub fn api_access_principal_arn(self, input: impl Into<String>) -> Self
pub fn api_access_principal_arn(self, input: impl Into<String>) -> Self
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
Sourcepub fn set_api_access_principal_arn(self, input: Option<String>) -> Self
pub fn set_api_access_principal_arn(self, input: Option<String>) -> Self
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
Sourcepub fn get_api_access_principal_arn(&self) -> &Option<String>
pub fn get_api_access_principal_arn(&self) -> &Option<String>
The ARN identifier of an AWS user or role that is allowed to call the GetProgrammaticAccessCredentials
API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A token that ensures idempotency. This token expires in 10 minutes.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A token that ensures idempotency. This token expires in 10 minutes.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A token that ensures idempotency. This token expires in 10 minutes.
Trait Implementations§
Source§impl Clone for CreateUserFluentBuilder
impl Clone for CreateUserFluentBuilder
Source§fn clone(&self) -> CreateUserFluentBuilder
fn clone(&self) -> CreateUserFluentBuilder
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 CreateUserFluentBuilder
impl !RefUnwindSafe for CreateUserFluentBuilder
impl Send for CreateUserFluentBuilder
impl Sync for CreateUserFluentBuilder
impl Unpin for CreateUserFluentBuilder
impl !UnwindSafe for CreateUserFluentBuilder
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);