pub struct CreateDeploymentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateDeployment
.
Creates a continuous deployment for a target, which is a Greengrass core device or group of core devices. When you add a new core device to a group of core devices that has a deployment, IoT Greengrass deploys that group's deployment to the new device.
You can define one deployment for each target. When you create a new deployment for a target that has an existing deployment, you replace the previous deployment. IoT Greengrass applies the new deployment to the target devices.
Every deployment has a revision number that indicates how many deployment revisions you define for a target. Use this operation to create a new revision of an existing deployment.
For more information, see the Create deployments in the IoT Greengrass V2 Developer Guide.
Implementations§
Source§impl CreateDeploymentFluentBuilder
impl CreateDeploymentFluentBuilder
Sourcepub fn as_input(&self) -> &CreateDeploymentInputBuilder
pub fn as_input(&self) -> &CreateDeploymentInputBuilder
Access the CreateDeployment as a reference.
Sourcepub async fn send(
self,
) -> Result<CreateDeploymentOutput, SdkError<CreateDeploymentError, HttpResponse>>
pub async fn send( self, ) -> Result<CreateDeploymentOutput, SdkError<CreateDeploymentError, 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<CreateDeploymentOutput, CreateDeploymentError, Self>
pub fn customize( self, ) -> CustomizableOperation<CreateDeploymentOutput, CreateDeploymentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
Sourcepub fn target_arn(self, input: impl Into<String>) -> Self
pub fn target_arn(self, input: impl Into<String>) -> Self
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
Sourcepub fn set_target_arn(self, input: Option<String>) -> Self
pub fn set_target_arn(self, input: Option<String>) -> Self
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
Sourcepub fn get_target_arn(&self) -> &Option<String>
pub fn get_target_arn(&self) -> &Option<String>
The ARN of the target IoT thing or thing group. When creating a subdeployment, the targetARN can only be a thing group.
Sourcepub fn deployment_name(self, input: impl Into<String>) -> Self
pub fn deployment_name(self, input: impl Into<String>) -> Self
The name of the deployment.
Sourcepub fn set_deployment_name(self, input: Option<String>) -> Self
pub fn set_deployment_name(self, input: Option<String>) -> Self
The name of the deployment.
Sourcepub fn get_deployment_name(&self) -> &Option<String>
pub fn get_deployment_name(&self) -> &Option<String>
The name of the deployment.
Sourcepub fn components(
self,
k: impl Into<String>,
v: ComponentDeploymentSpecification,
) -> Self
pub fn components( self, k: impl Into<String>, v: ComponentDeploymentSpecification, ) -> Self
Adds a key-value pair to components
.
To override the contents of this collection use set_components
.
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
Sourcepub fn set_components(
self,
input: Option<HashMap<String, ComponentDeploymentSpecification>>,
) -> Self
pub fn set_components( self, input: Option<HashMap<String, ComponentDeploymentSpecification>>, ) -> Self
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
Sourcepub fn get_components(
&self,
) -> &Option<HashMap<String, ComponentDeploymentSpecification>>
pub fn get_components( &self, ) -> &Option<HashMap<String, ComponentDeploymentSpecification>>
The components to deploy. This is a dictionary, where each key is the name of a component, and each key's value is the version and configuration to deploy for that component.
Sourcepub fn iot_job_configuration(self, input: DeploymentIoTJobConfiguration) -> Self
pub fn iot_job_configuration(self, input: DeploymentIoTJobConfiguration) -> Self
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
Sourcepub fn set_iot_job_configuration(
self,
input: Option<DeploymentIoTJobConfiguration>,
) -> Self
pub fn set_iot_job_configuration( self, input: Option<DeploymentIoTJobConfiguration>, ) -> Self
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
Sourcepub fn get_iot_job_configuration(
&self,
) -> &Option<DeploymentIoTJobConfiguration>
pub fn get_iot_job_configuration( &self, ) -> &Option<DeploymentIoTJobConfiguration>
The job configuration for the deployment configuration. The job configuration specifies the rollout, timeout, and stop configurations for the deployment configuration.
Sourcepub fn deployment_policies(self, input: DeploymentPolicies) -> Self
pub fn deployment_policies(self, input: DeploymentPolicies) -> Self
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
Sourcepub fn set_deployment_policies(self, input: Option<DeploymentPolicies>) -> Self
pub fn set_deployment_policies(self, input: Option<DeploymentPolicies>) -> Self
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
Sourcepub fn get_deployment_policies(&self) -> &Option<DeploymentPolicies>
pub fn get_deployment_policies(&self) -> &Option<DeploymentPolicies>
The deployment policies for the deployment. These policies define how the deployment updates components and handles failure.
Sourcepub fn parent_target_arn(self, input: impl Into<String>) -> Self
pub fn parent_target_arn(self, input: impl Into<String>) -> Self
The parent deployment's target ARN within a subdeployment.
Sourcepub fn set_parent_target_arn(self, input: Option<String>) -> Self
pub fn set_parent_target_arn(self, input: Option<String>) -> Self
The parent deployment's target ARN within a subdeployment.
Sourcepub fn get_parent_target_arn(&self) -> &Option<String>
pub fn get_parent_target_arn(&self) -> &Option<String>
The parent deployment's target ARN within a subdeployment.
Adds a key-value pair to tags
.
To override the contents of this collection use set_tags
.
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
A list of key-value pairs that contain metadata for the resource. For more information, see Tag your resources in the IoT Greengrass V2 Developer Guide.
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 can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
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 can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
Sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
A unique, case-sensitive identifier that you can provide to ensure that the request is idempotent. Idempotency means that the request is successfully processed only once, even if you send the request multiple times. When a request succeeds, and you specify the same client token for subsequent successful requests, the IoT Greengrass V2 service returns the successful response that it caches from the previous request. IoT Greengrass V2 caches successful responses for idempotent requests for up to 8 hours.
Trait Implementations§
Source§impl Clone for CreateDeploymentFluentBuilder
impl Clone for CreateDeploymentFluentBuilder
Source§fn clone(&self) -> CreateDeploymentFluentBuilder
fn clone(&self) -> CreateDeploymentFluentBuilder
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 CreateDeploymentFluentBuilder
impl !RefUnwindSafe for CreateDeploymentFluentBuilder
impl Send for CreateDeploymentFluentBuilder
impl Sync for CreateDeploymentFluentBuilder
impl Unpin for CreateDeploymentFluentBuilder
impl !UnwindSafe for CreateDeploymentFluentBuilder
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);