pub struct UpdateComponentFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to UpdateComponent
.
Update a component.
There are a few modes for updating a component. The deploymentType
field defines the mode.
You can't update a component while its deployment status, or the deployment status of a service instance attached to it, is IN_PROGRESS
.
For more information about components, see Proton components in the Proton User Guide.
Implementations§
source§impl UpdateComponentFluentBuilder
impl UpdateComponentFluentBuilder
sourcepub fn as_input(&self) -> &UpdateComponentInputBuilder
pub fn as_input(&self) -> &UpdateComponentInputBuilder
Access the UpdateComponent as a reference.
sourcepub async fn send(
self
) -> Result<UpdateComponentOutput, SdkError<UpdateComponentError, HttpResponse>>
pub async fn send( self ) -> Result<UpdateComponentOutput, SdkError<UpdateComponentError, 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<UpdateComponentOutput, UpdateComponentError, Self>
pub fn customize( self ) -> CustomizableOperation<UpdateComponentOutput, UpdateComponentError, Self>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn deployment_type(self, input: ComponentDeploymentUpdateType) -> Self
pub fn deployment_type(self, input: ComponentDeploymentUpdateType) -> Self
The deployment type. It defines the mode for updating a component, as follows:
-
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify
description
in this mode. -
CURRENT_VERSION
In this mode, the component is deployed and updated with the new
serviceSpec
,templateSource
, and/ortype
that you provide. Only requested parameters are updated.
sourcepub fn set_deployment_type(
self,
input: Option<ComponentDeploymentUpdateType>
) -> Self
pub fn set_deployment_type( self, input: Option<ComponentDeploymentUpdateType> ) -> Self
The deployment type. It defines the mode for updating a component, as follows:
-
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify
description
in this mode. -
CURRENT_VERSION
In this mode, the component is deployed and updated with the new
serviceSpec
,templateSource
, and/ortype
that you provide. Only requested parameters are updated.
sourcepub fn get_deployment_type(&self) -> &Option<ComponentDeploymentUpdateType>
pub fn get_deployment_type(&self) -> &Option<ComponentDeploymentUpdateType>
The deployment type. It defines the mode for updating a component, as follows:
-
NONE
In this mode, a deployment doesn't occur. Only the requested metadata parameters are updated. You can only specify
description
in this mode. -
CURRENT_VERSION
In this mode, the component is deployed and updated with the new
serviceSpec
,templateSource
, and/ortype
that you provide. Only requested parameters are updated.
sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
An optional customer-provided description of the component.
sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
An optional customer-provided description of the component.
sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
An optional customer-provided description of the component.
sourcepub fn service_name(self, input: impl Into<String>) -> Self
pub fn service_name(self, input: impl Into<String>) -> Self
The name of the service that serviceInstanceName
is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn set_service_name(self, input: Option<String>) -> Self
pub fn set_service_name(self, input: Option<String>) -> Self
The name of the service that serviceInstanceName
is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn get_service_name(&self) -> &Option<String>
pub fn get_service_name(&self) -> &Option<String>
The name of the service that serviceInstanceName
is associated with. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn service_instance_name(self, input: impl Into<String>) -> Self
pub fn service_instance_name(self, input: impl Into<String>) -> Self
The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn set_service_instance_name(self, input: Option<String>) -> Self
pub fn set_service_instance_name(self, input: Option<String>) -> Self
The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn get_service_instance_name(&self) -> &Option<String>
pub fn get_service_instance_name(&self) -> &Option<String>
The name of the service instance that you want to attach this component to. Don't specify to keep the component's current service instance attachment. Specify an empty string to detach the component from the service instance it's attached to. Specify non-empty values for both serviceInstanceName
and serviceName
or for neither of them.
sourcepub fn service_spec(self, input: impl Into<String>) -> Self
pub fn service_spec(self, input: impl Into<String>) -> Self
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
sourcepub fn set_service_spec(self, input: Option<String>) -> Self
pub fn set_service_spec(self, input: Option<String>) -> Self
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
sourcepub fn get_service_spec(&self) -> &Option<String>
pub fn get_service_spec(&self) -> &Option<String>
The service spec that you want the component to use to access service inputs. Set this only when the component is attached to a service instance.
sourcepub fn template_file(self, input: impl Into<String>) -> Self
pub fn template_file(self, input: impl Into<String>) -> Self
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Components support a single IaC file, even if you use Terraform as your template language.
sourcepub fn set_template_file(self, input: Option<String>) -> Self
pub fn set_template_file(self, input: Option<String>) -> Self
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Components support a single IaC file, even if you use Terraform as your template language.
sourcepub fn get_template_file(&self) -> &Option<String>
pub fn get_template_file(&self) -> &Option<String>
A path to the Infrastructure as Code (IaC) file describing infrastructure that a custom component provisions.
Components support a single IaC file, even if you use Terraform as your template language.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The client token for the updated component.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The client token for the updated component.
sourcepub fn get_client_token(&self) -> &Option<String>
pub fn get_client_token(&self) -> &Option<String>
The client token for the updated component.
Trait Implementations§
source§impl Clone for UpdateComponentFluentBuilder
impl Clone for UpdateComponentFluentBuilder
source§fn clone(&self) -> UpdateComponentFluentBuilder
fn clone(&self) -> UpdateComponentFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more