#[non_exhaustive]pub struct CreatePersistentContactAssociationInputBuilder { /* private fields */ }
Expand description
A builder for CreatePersistentContactAssociationInput
.
Implementations§
Source§impl CreatePersistentContactAssociationInputBuilder
impl CreatePersistentContactAssociationInputBuilder
Sourcepub fn instance_id(self, input: impl Into<String>) -> Self
pub fn instance_id(self, input: impl Into<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
This field is required.Sourcepub fn set_instance_id(self, input: Option<String>) -> Self
pub fn set_instance_id(self, input: Option<String>) -> Self
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn get_instance_id(&self) -> &Option<String>
pub fn get_instance_id(&self) -> &Option<String>
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Sourcepub fn initial_contact_id(self, input: impl Into<String>) -> Self
pub fn initial_contact_id(self, input: impl Into<String>) -> Self
This is the contactId of the current contact that the CreatePersistentContactAssociation
API is being called from.
Sourcepub fn set_initial_contact_id(self, input: Option<String>) -> Self
pub fn set_initial_contact_id(self, input: Option<String>) -> Self
This is the contactId of the current contact that the CreatePersistentContactAssociation
API is being called from.
Sourcepub fn get_initial_contact_id(&self) -> &Option<String>
pub fn get_initial_contact_id(&self) -> &Option<String>
This is the contactId of the current contact that the CreatePersistentContactAssociation
API is being called from.
Sourcepub fn rehydration_type(self, input: RehydrationType) -> Self
pub fn rehydration_type(self, input: RehydrationType) -> Self
The contactId chosen for rehydration depends on the type chosen.
-
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide theinitialContactId
of the past ended chat session in thesourceContactId
field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. -
FROM_SEGMENT
: Rehydrates a chat from the specified past chat contact provided in thesourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
-
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C2"
-
RehydrationType = "FROM_SEGMENT"
-
-
Expected behavior
-
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
-
-
-
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C1"
-
RehydrationType = "ENTIRE_PAST_SESSION"
-
-
Expected behavior
-
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
-
-
Sourcepub fn set_rehydration_type(self, input: Option<RehydrationType>) -> Self
pub fn set_rehydration_type(self, input: Option<RehydrationType>) -> Self
The contactId chosen for rehydration depends on the type chosen.
-
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide theinitialContactId
of the past ended chat session in thesourceContactId
field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. -
FROM_SEGMENT
: Rehydrates a chat from the specified past chat contact provided in thesourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
-
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C2"
-
RehydrationType = "FROM_SEGMENT"
-
-
Expected behavior
-
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
-
-
-
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C1"
-
RehydrationType = "ENTIRE_PAST_SESSION"
-
-
Expected behavior
-
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
-
-
Sourcepub fn get_rehydration_type(&self) -> &Option<RehydrationType>
pub fn get_rehydration_type(&self) -> &Option<RehydrationType>
The contactId chosen for rehydration depends on the type chosen.
-
ENTIRE_PAST_SESSION
: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide theinitialContactId
of the past ended chat session in thesourceContactId
field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. -
FROM_SEGMENT
: Rehydrates a chat from the specified past chat contact provided in thesourceContactId
field.
The actual contactId used for rehydration is provided in the response of this API.
To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID C1. Agent a1 then transfers the chat to Agent a2. This creates another contact ID C2. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID C3. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases:
-
Use Case 1: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C2"
-
RehydrationType = "FROM_SEGMENT"
-
-
Expected behavior
-
This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.
-
-
-
Use Case 2: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:
-
Configuration
-
SourceContactId = "C1"
-
RehydrationType = "ENTIRE_PAST_SESSION"
-
-
Expected behavior
-
This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.
-
-
Sourcepub fn source_contact_id(self, input: impl Into<String>) -> Self
pub fn source_contact_id(self, input: impl Into<String>) -> Self
The contactId from which a persistent chat session must be started.
This field is required.Sourcepub fn set_source_contact_id(self, input: Option<String>) -> Self
pub fn set_source_contact_id(self, input: Option<String>) -> Self
The contactId from which a persistent chat session must be started.
Sourcepub fn get_source_contact_id(&self) -> &Option<String>
pub fn get_source_contact_id(&self) -> &Option<String>
The contactId from which a persistent chat session must be started.
Sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
Sourcepub fn build(
self,
) -> Result<CreatePersistentContactAssociationInput, BuildError>
pub fn build( self, ) -> Result<CreatePersistentContactAssociationInput, BuildError>
Consumes the builder and constructs a CreatePersistentContactAssociationInput
.
Source§impl CreatePersistentContactAssociationInputBuilder
impl CreatePersistentContactAssociationInputBuilder
Sourcepub async fn send_with(
self,
client: &Client,
) -> Result<CreatePersistentContactAssociationOutput, SdkError<CreatePersistentContactAssociationError, HttpResponse>>
pub async fn send_with( self, client: &Client, ) -> Result<CreatePersistentContactAssociationOutput, SdkError<CreatePersistentContactAssociationError, HttpResponse>>
Sends a request with this input using the given client.
Trait Implementations§
Source§impl Clone for CreatePersistentContactAssociationInputBuilder
impl Clone for CreatePersistentContactAssociationInputBuilder
Source§fn clone(&self) -> CreatePersistentContactAssociationInputBuilder
fn clone(&self) -> CreatePersistentContactAssociationInputBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Default for CreatePersistentContactAssociationInputBuilder
impl Default for CreatePersistentContactAssociationInputBuilder
Source§fn default() -> CreatePersistentContactAssociationInputBuilder
fn default() -> CreatePersistentContactAssociationInputBuilder
Source§impl PartialEq for CreatePersistentContactAssociationInputBuilder
impl PartialEq for CreatePersistentContactAssociationInputBuilder
Source§fn eq(&self, other: &CreatePersistentContactAssociationInputBuilder) -> bool
fn eq(&self, other: &CreatePersistentContactAssociationInputBuilder) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for CreatePersistentContactAssociationInputBuilder
Auto Trait Implementations§
impl Freeze for CreatePersistentContactAssociationInputBuilder
impl RefUnwindSafe for CreatePersistentContactAssociationInputBuilder
impl Send for CreatePersistentContactAssociationInputBuilder
impl Sync for CreatePersistentContactAssociationInputBuilder
impl Unpin for CreatePersistentContactAssociationInputBuilder
impl UnwindSafe for CreatePersistentContactAssociationInputBuilder
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>
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);