#[non_exhaustive]pub struct KinesisSettingsBuilder { /* private fields */ }
Expand description
A builder for KinesisSettings
.
Implementations§
Source§impl KinesisSettingsBuilder
impl KinesisSettingsBuilder
Sourcepub fn stream_arn(self, input: impl Into<String>) -> Self
pub fn stream_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
Sourcepub fn set_stream_arn(self, input: Option<String>) -> Self
pub fn set_stream_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
Sourcepub fn get_stream_arn(&self) -> &Option<String>
pub fn get_stream_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the Amazon Kinesis Data Streams endpoint.
Sourcepub fn message_format(self, input: MessageFormatValue) -> Self
pub fn message_format(self, input: MessageFormatValue) -> Self
The output format for the records created on the endpoint. The message format is JSON
(default) or JSON_UNFORMATTED
(a single line with no tab).
Sourcepub fn set_message_format(self, input: Option<MessageFormatValue>) -> Self
pub fn set_message_format(self, input: Option<MessageFormatValue>) -> Self
The output format for the records created on the endpoint. The message format is JSON
(default) or JSON_UNFORMATTED
(a single line with no tab).
Sourcepub fn get_message_format(&self) -> &Option<MessageFormatValue>
pub fn get_message_format(&self) -> &Option<MessageFormatValue>
The output format for the records created on the endpoint. The message format is JSON
(default) or JSON_UNFORMATTED
(a single line with no tab).
Sourcepub fn service_access_role_arn(self, input: impl Into<String>) -> Self
pub fn service_access_role_arn(self, input: impl Into<String>) -> Self
The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole
action.
Sourcepub fn set_service_access_role_arn(self, input: Option<String>) -> Self
pub fn set_service_access_role_arn(self, input: Option<String>) -> Self
The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole
action.
Sourcepub fn get_service_access_role_arn(&self) -> &Option<String>
pub fn get_service_access_role_arn(&self) -> &Option<String>
The Amazon Resource Name (ARN) for the IAM role that DMS uses to write to the Kinesis data stream. The role must allow the iam:PassRole
action.
Sourcepub fn include_transaction_details(self, input: bool) -> Self
pub fn include_transaction_details(self, input: bool) -> Self
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id
, previous transaction_id
, and transaction_record_id
(the record offset within a transaction). The default is false
.
Sourcepub fn set_include_transaction_details(self, input: Option<bool>) -> Self
pub fn set_include_transaction_details(self, input: Option<bool>) -> Self
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id
, previous transaction_id
, and transaction_record_id
(the record offset within a transaction). The default is false
.
Sourcepub fn get_include_transaction_details(&self) -> &Option<bool>
pub fn get_include_transaction_details(&self) -> &Option<bool>
Provides detailed transaction information from the source database. This information includes a commit timestamp, a log position, and values for transaction_id
, previous transaction_id
, and transaction_record_id
(the record offset within a transaction). The default is false
.
Sourcepub fn include_partition_value(self, input: bool) -> Self
pub fn include_partition_value(self, input: bool) -> Self
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type
. The default is false
.
Sourcepub fn set_include_partition_value(self, input: Option<bool>) -> Self
pub fn set_include_partition_value(self, input: Option<bool>) -> Self
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type
. The default is false
.
Sourcepub fn get_include_partition_value(&self) -> &Option<bool>
pub fn get_include_partition_value(&self) -> &Option<bool>
Shows the partition value within the Kinesis message output, unless the partition type is schema-table-type
. The default is false
.
Sourcepub fn partition_include_schema_table(self, input: bool) -> Self
pub fn partition_include_schema_table(self, input: bool) -> Self
Prefixes schema and table names to partition values, when the partition type is primary-key-type
. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false
.
Sourcepub fn set_partition_include_schema_table(self, input: Option<bool>) -> Self
pub fn set_partition_include_schema_table(self, input: Option<bool>) -> Self
Prefixes schema and table names to partition values, when the partition type is primary-key-type
. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false
.
Sourcepub fn get_partition_include_schema_table(&self) -> &Option<bool>
pub fn get_partition_include_schema_table(&self) -> &Option<bool>
Prefixes schema and table names to partition values, when the partition type is primary-key-type
. Doing this increases data distribution among Kinesis shards. For example, suppose that a SysBench schema has thousands of tables and each table has only limited range for a primary key. In this case, the same primary key is sent from thousands of tables to the same shard, which causes throttling. The default is false
.
Sourcepub fn include_table_alter_operations(self, input: bool) -> Self
pub fn include_table_alter_operations(self, input: bool) -> Self
Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table
, drop-table
, add-column
, drop-column
, and rename-column
. The default is false
.
Sourcepub fn set_include_table_alter_operations(self, input: Option<bool>) -> Self
pub fn set_include_table_alter_operations(self, input: Option<bool>) -> Self
Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table
, drop-table
, add-column
, drop-column
, and rename-column
. The default is false
.
Sourcepub fn get_include_table_alter_operations(&self) -> &Option<bool>
pub fn get_include_table_alter_operations(&self) -> &Option<bool>
Includes any data definition language (DDL) operations that change the table in the control data, such as rename-table
, drop-table
, add-column
, drop-column
, and rename-column
. The default is false
.
Sourcepub fn include_control_details(self, input: bool) -> Self
pub fn include_control_details(self, input: bool) -> Self
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false
.
Sourcepub fn set_include_control_details(self, input: Option<bool>) -> Self
pub fn set_include_control_details(self, input: Option<bool>) -> Self
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false
.
Sourcepub fn get_include_control_details(&self) -> &Option<bool>
pub fn get_include_control_details(&self) -> &Option<bool>
Shows detailed control information for table definition, column definition, and table and column changes in the Kinesis message output. The default is false
.
Sourcepub fn include_null_and_empty(self, input: bool) -> Self
pub fn include_null_and_empty(self, input: bool) -> Self
Include NULL and empty columns for records migrated to the endpoint. The default is false
.
Sourcepub fn set_include_null_and_empty(self, input: Option<bool>) -> Self
pub fn set_include_null_and_empty(self, input: Option<bool>) -> Self
Include NULL and empty columns for records migrated to the endpoint. The default is false
.
Sourcepub fn get_include_null_and_empty(&self) -> &Option<bool>
pub fn get_include_null_and_empty(&self) -> &Option<bool>
Include NULL and empty columns for records migrated to the endpoint. The default is false
.
Sourcepub fn no_hex_prefix(self, input: bool) -> Self
pub fn no_hex_prefix(self, input: bool) -> Self
Set this optional parameter to true
to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix
endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
Sourcepub fn set_no_hex_prefix(self, input: Option<bool>) -> Self
pub fn set_no_hex_prefix(self, input: Option<bool>) -> Self
Set this optional parameter to true
to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix
endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
Sourcepub fn get_no_hex_prefix(&self) -> &Option<bool>
pub fn get_no_hex_prefix(&self) -> &Option<bool>
Set this optional parameter to true
to avoid adding a '0x' prefix to raw data in hexadecimal format. For example, by default, DMS adds a '0x' prefix to the LOB column type in hexadecimal format moving from an Oracle source to an Amazon Kinesis target. Use the NoHexPrefix
endpoint setting to enable migration of RAW data type columns without adding the '0x' prefix.
Sourcepub fn use_large_integer_value(self, input: bool) -> Self
pub fn use_large_integer_value(self, input: bool) -> Self
Specifies using the large integer value with Kinesis.
Sourcepub fn set_use_large_integer_value(self, input: Option<bool>) -> Self
pub fn set_use_large_integer_value(self, input: Option<bool>) -> Self
Specifies using the large integer value with Kinesis.
Sourcepub fn get_use_large_integer_value(&self) -> &Option<bool>
pub fn get_use_large_integer_value(&self) -> &Option<bool>
Specifies using the large integer value with Kinesis.
Sourcepub fn build(self) -> KinesisSettings
pub fn build(self) -> KinesisSettings
Consumes the builder and constructs a KinesisSettings
.
Trait Implementations§
Source§impl Clone for KinesisSettingsBuilder
impl Clone for KinesisSettingsBuilder
Source§fn clone(&self) -> KinesisSettingsBuilder
fn clone(&self) -> KinesisSettingsBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for KinesisSettingsBuilder
impl Debug for KinesisSettingsBuilder
Source§impl Default for KinesisSettingsBuilder
impl Default for KinesisSettingsBuilder
Source§fn default() -> KinesisSettingsBuilder
fn default() -> KinesisSettingsBuilder
Source§impl PartialEq for KinesisSettingsBuilder
impl PartialEq for KinesisSettingsBuilder
impl StructuralPartialEq for KinesisSettingsBuilder
Auto Trait Implementations§
impl Freeze for KinesisSettingsBuilder
impl RefUnwindSafe for KinesisSettingsBuilder
impl Send for KinesisSettingsBuilder
impl Sync for KinesisSettingsBuilder
impl Unpin for KinesisSettingsBuilder
impl UnwindSafe for KinesisSettingsBuilder
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);