aws_sdk_cloudcontrol/types/

_progress_event.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Represents the current status of a resource operation request. For more information, see <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/userguide/resource-operations-manage-requests.html">Managing resource operation requests</a> in the <i>Amazon Web Services Cloud Control API User Guide</i>.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq)]
pub struct ProgressEvent {
    /// <p>The name of the resource type used in the operation.</p>
    pub type_name: ::std::option::Option<::std::string::String>,
    /// <p>The primary identifier for the resource.</p><note>
    /// <p>In some cases, the resource identifier may be available before the resource operation has reached a status of <code>SUCCESS</code>.</p>
    /// </note>
    pub identifier: ::std::option::Option<::std::string::String>,
    /// <p>The unique token representing this resource operation request.</p>
    /// <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>
    pub request_token: ::std::option::Option<::std::string::String>,
    /// <p>The unique token representing the Hooks operation for the request.</p>
    pub hooks_request_token: ::std::option::Option<::std::string::String>,
    /// <p>The resource operation type.</p>
    pub operation: ::std::option::Option<crate::types::Operation>,
    /// <p>The current status of the resource operation request.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code>: The resource operation hasn't yet started.</p></li>
    /// <li>
    /// <p><code>IN_PROGRESS</code>: The resource operation is currently in progress.</p></li>
    /// <li>
    /// <p><code>SUCCESS</code>: The resource operation has successfully completed.</p></li>
    /// <li>
    /// <p><code>FAILED</code>: The resource operation has failed. Refer to the error code and status message for more information.</p></li>
    /// <li>
    /// <p><code>CANCEL_IN_PROGRESS</code>: The resource operation is in the process of being canceled.</p></li>
    /// <li>
    /// <p><code>CANCEL_COMPLETE</code>: The resource operation has been canceled.</p></li>
    /// </ul>
    pub operation_status: ::std::option::Option<crate::types::OperationStatus>,
    /// <p>When the resource operation request was initiated.</p>
    pub event_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    /// <p>A JSON string containing the resource model, consisting of each resource property and its current value.</p>
    pub resource_model: ::std::option::Option<::std::string::String>,
    /// <p>Any message explaining the current status.</p>
    pub status_message: ::std::option::Option<::std::string::String>,
    /// <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
    /// <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command Line Interface User Guide for Extension Development</i>.</p>
    pub error_code: ::std::option::Option<crate::types::HandlerErrorCode>,
    /// <p>When to next request the status of this resource operation request.</p>
    pub retry_after: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl ProgressEvent {
    /// <p>The name of the resource type used in the operation.</p>
    pub fn type_name(&self) -> ::std::option::Option<&str> {
        self.type_name.as_deref()
    }
    /// <p>The primary identifier for the resource.</p><note>
    /// <p>In some cases, the resource identifier may be available before the resource operation has reached a status of <code>SUCCESS</code>.</p>
    /// </note>
    pub fn identifier(&self) -> ::std::option::Option<&str> {
        self.identifier.as_deref()
    }
    /// <p>The unique token representing this resource operation request.</p>
    /// <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>
    pub fn request_token(&self) -> ::std::option::Option<&str> {
        self.request_token.as_deref()
    }
    /// <p>The unique token representing the Hooks operation for the request.</p>
    pub fn hooks_request_token(&self) -> ::std::option::Option<&str> {
        self.hooks_request_token.as_deref()
    }
    /// <p>The resource operation type.</p>
    pub fn operation(&self) -> ::std::option::Option<&crate::types::Operation> {
        self.operation.as_ref()
    }
    /// <p>The current status of the resource operation request.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code>: The resource operation hasn't yet started.</p></li>
    /// <li>
    /// <p><code>IN_PROGRESS</code>: The resource operation is currently in progress.</p></li>
    /// <li>
    /// <p><code>SUCCESS</code>: The resource operation has successfully completed.</p></li>
    /// <li>
    /// <p><code>FAILED</code>: The resource operation has failed. Refer to the error code and status message for more information.</p></li>
    /// <li>
    /// <p><code>CANCEL_IN_PROGRESS</code>: The resource operation is in the process of being canceled.</p></li>
    /// <li>
    /// <p><code>CANCEL_COMPLETE</code>: The resource operation has been canceled.</p></li>
    /// </ul>
    pub fn operation_status(&self) -> ::std::option::Option<&crate::types::OperationStatus> {
        self.operation_status.as_ref()
    }
    /// <p>When the resource operation request was initiated.</p>
    pub fn event_time(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.event_time.as_ref()
    }
    /// <p>A JSON string containing the resource model, consisting of each resource property and its current value.</p>
    pub fn resource_model(&self) -> ::std::option::Option<&str> {
        self.resource_model.as_deref()
    }
    /// <p>Any message explaining the current status.</p>
    pub fn status_message(&self) -> ::std::option::Option<&str> {
        self.status_message.as_deref()
    }
    /// <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
    /// <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command Line Interface User Guide for Extension Development</i>.</p>
    pub fn error_code(&self) -> ::std::option::Option<&crate::types::HandlerErrorCode> {
        self.error_code.as_ref()
    }
    /// <p>When to next request the status of this resource operation request.</p>
    pub fn retry_after(&self) -> ::std::option::Option<&::aws_smithy_types::DateTime> {
        self.retry_after.as_ref()
    }
}
impl ::std::fmt::Debug for ProgressEvent {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ProgressEvent");
        formatter.field("type_name", &self.type_name);
        formatter.field("identifier", &self.identifier);
        formatter.field("request_token", &self.request_token);
        formatter.field("hooks_request_token", &self.hooks_request_token);
        formatter.field("operation", &self.operation);
        formatter.field("operation_status", &self.operation_status);
        formatter.field("event_time", &self.event_time);
        formatter.field("resource_model", &"*** Sensitive Data Redacted ***");
        formatter.field("status_message", &self.status_message);
        formatter.field("error_code", &self.error_code);
        formatter.field("retry_after", &self.retry_after);
        formatter.finish()
    }
}
impl ProgressEvent {
    /// Creates a new builder-style object to manufacture [`ProgressEvent`](crate::types::ProgressEvent).
    pub fn builder() -> crate::types::builders::ProgressEventBuilder {
        crate::types::builders::ProgressEventBuilder::default()
    }
}

/// A builder for [`ProgressEvent`](crate::types::ProgressEvent).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default)]
#[non_exhaustive]
pub struct ProgressEventBuilder {
    pub(crate) type_name: ::std::option::Option<::std::string::String>,
    pub(crate) identifier: ::std::option::Option<::std::string::String>,
    pub(crate) request_token: ::std::option::Option<::std::string::String>,
    pub(crate) hooks_request_token: ::std::option::Option<::std::string::String>,
    pub(crate) operation: ::std::option::Option<crate::types::Operation>,
    pub(crate) operation_status: ::std::option::Option<crate::types::OperationStatus>,
    pub(crate) event_time: ::std::option::Option<::aws_smithy_types::DateTime>,
    pub(crate) resource_model: ::std::option::Option<::std::string::String>,
    pub(crate) status_message: ::std::option::Option<::std::string::String>,
    pub(crate) error_code: ::std::option::Option<crate::types::HandlerErrorCode>,
    pub(crate) retry_after: ::std::option::Option<::aws_smithy_types::DateTime>,
}
impl ProgressEventBuilder {
    /// <p>The name of the resource type used in the operation.</p>
    pub fn type_name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.type_name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name of the resource type used in the operation.</p>
    pub fn set_type_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.type_name = input;
        self
    }
    /// <p>The name of the resource type used in the operation.</p>
    pub fn get_type_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.type_name
    }
    /// <p>The primary identifier for the resource.</p><note>
    /// <p>In some cases, the resource identifier may be available before the resource operation has reached a status of <code>SUCCESS</code>.</p>
    /// </note>
    pub fn identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.identifier = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The primary identifier for the resource.</p><note>
    /// <p>In some cases, the resource identifier may be available before the resource operation has reached a status of <code>SUCCESS</code>.</p>
    /// </note>
    pub fn set_identifier(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.identifier = input;
        self
    }
    /// <p>The primary identifier for the resource.</p><note>
    /// <p>In some cases, the resource identifier may be available before the resource operation has reached a status of <code>SUCCESS</code>.</p>
    /// </note>
    pub fn get_identifier(&self) -> &::std::option::Option<::std::string::String> {
        &self.identifier
    }
    /// <p>The unique token representing this resource operation request.</p>
    /// <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>
    pub fn request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.request_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique token representing this resource operation request.</p>
    /// <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>
    pub fn set_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.request_token = input;
        self
    }
    /// <p>The unique token representing this resource operation request.</p>
    /// <p>Use the <code>RequestToken</code> with <a href="https://docs.aws.amazon.com/cloudcontrolapi/latest/APIReference/API_GetResourceRequestStatus.html">GetResourceRequestStatus</a> to return the current status of a resource operation request.</p>
    pub fn get_request_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.request_token
    }
    /// <p>The unique token representing the Hooks operation for the request.</p>
    pub fn hooks_request_token(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.hooks_request_token = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The unique token representing the Hooks operation for the request.</p>
    pub fn set_hooks_request_token(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.hooks_request_token = input;
        self
    }
    /// <p>The unique token representing the Hooks operation for the request.</p>
    pub fn get_hooks_request_token(&self) -> &::std::option::Option<::std::string::String> {
        &self.hooks_request_token
    }
    /// <p>The resource operation type.</p>
    pub fn operation(mut self, input: crate::types::Operation) -> Self {
        self.operation = ::std::option::Option::Some(input);
        self
    }
    /// <p>The resource operation type.</p>
    pub fn set_operation(mut self, input: ::std::option::Option<crate::types::Operation>) -> Self {
        self.operation = input;
        self
    }
    /// <p>The resource operation type.</p>
    pub fn get_operation(&self) -> &::std::option::Option<crate::types::Operation> {
        &self.operation
    }
    /// <p>The current status of the resource operation request.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code>: The resource operation hasn't yet started.</p></li>
    /// <li>
    /// <p><code>IN_PROGRESS</code>: The resource operation is currently in progress.</p></li>
    /// <li>
    /// <p><code>SUCCESS</code>: The resource operation has successfully completed.</p></li>
    /// <li>
    /// <p><code>FAILED</code>: The resource operation has failed. Refer to the error code and status message for more information.</p></li>
    /// <li>
    /// <p><code>CANCEL_IN_PROGRESS</code>: The resource operation is in the process of being canceled.</p></li>
    /// <li>
    /// <p><code>CANCEL_COMPLETE</code>: The resource operation has been canceled.</p></li>
    /// </ul>
    pub fn operation_status(mut self, input: crate::types::OperationStatus) -> Self {
        self.operation_status = ::std::option::Option::Some(input);
        self
    }
    /// <p>The current status of the resource operation request.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code>: The resource operation hasn't yet started.</p></li>
    /// <li>
    /// <p><code>IN_PROGRESS</code>: The resource operation is currently in progress.</p></li>
    /// <li>
    /// <p><code>SUCCESS</code>: The resource operation has successfully completed.</p></li>
    /// <li>
    /// <p><code>FAILED</code>: The resource operation has failed. Refer to the error code and status message for more information.</p></li>
    /// <li>
    /// <p><code>CANCEL_IN_PROGRESS</code>: The resource operation is in the process of being canceled.</p></li>
    /// <li>
    /// <p><code>CANCEL_COMPLETE</code>: The resource operation has been canceled.</p></li>
    /// </ul>
    pub fn set_operation_status(mut self, input: ::std::option::Option<crate::types::OperationStatus>) -> Self {
        self.operation_status = input;
        self
    }
    /// <p>The current status of the resource operation request.</p>
    /// <ul>
    /// <li>
    /// <p><code>PENDING</code>: The resource operation hasn't yet started.</p></li>
    /// <li>
    /// <p><code>IN_PROGRESS</code>: The resource operation is currently in progress.</p></li>
    /// <li>
    /// <p><code>SUCCESS</code>: The resource operation has successfully completed.</p></li>
    /// <li>
    /// <p><code>FAILED</code>: The resource operation has failed. Refer to the error code and status message for more information.</p></li>
    /// <li>
    /// <p><code>CANCEL_IN_PROGRESS</code>: The resource operation is in the process of being canceled.</p></li>
    /// <li>
    /// <p><code>CANCEL_COMPLETE</code>: The resource operation has been canceled.</p></li>
    /// </ul>
    pub fn get_operation_status(&self) -> &::std::option::Option<crate::types::OperationStatus> {
        &self.operation_status
    }
    /// <p>When the resource operation request was initiated.</p>
    pub fn event_time(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.event_time = ::std::option::Option::Some(input);
        self
    }
    /// <p>When the resource operation request was initiated.</p>
    pub fn set_event_time(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.event_time = input;
        self
    }
    /// <p>When the resource operation request was initiated.</p>
    pub fn get_event_time(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.event_time
    }
    /// <p>A JSON string containing the resource model, consisting of each resource property and its current value.</p>
    pub fn resource_model(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.resource_model = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>A JSON string containing the resource model, consisting of each resource property and its current value.</p>
    pub fn set_resource_model(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.resource_model = input;
        self
    }
    /// <p>A JSON string containing the resource model, consisting of each resource property and its current value.</p>
    pub fn get_resource_model(&self) -> &::std::option::Option<::std::string::String> {
        &self.resource_model
    }
    /// <p>Any message explaining the current status.</p>
    pub fn status_message(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.status_message = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>Any message explaining the current status.</p>
    pub fn set_status_message(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.status_message = input;
        self
    }
    /// <p>Any message explaining the current status.</p>
    pub fn get_status_message(&self) -> &::std::option::Option<::std::string::String> {
        &self.status_message
    }
    /// <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
    /// <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command Line Interface User Guide for Extension Development</i>.</p>
    pub fn error_code(mut self, input: crate::types::HandlerErrorCode) -> Self {
        self.error_code = ::std::option::Option::Some(input);
        self
    }
    /// <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
    /// <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command Line Interface User Guide for Extension Development</i>.</p>
    pub fn set_error_code(mut self, input: ::std::option::Option<crate::types::HandlerErrorCode>) -> Self {
        self.error_code = input;
        self
    }
    /// <p>For requests with a status of <code>FAILED</code>, the associated error code.</p>
    /// <p>For error code definitions, see <a href="https://docs.aws.amazon.com/cloudformation-cli/latest/userguide/resource-type-test-contract-errors.html">Handler error codes</a> in the <i>CloudFormation Command Line Interface User Guide for Extension Development</i>.</p>
    pub fn get_error_code(&self) -> &::std::option::Option<crate::types::HandlerErrorCode> {
        &self.error_code
    }
    /// <p>When to next request the status of this resource operation request.</p>
    pub fn retry_after(mut self, input: ::aws_smithy_types::DateTime) -> Self {
        self.retry_after = ::std::option::Option::Some(input);
        self
    }
    /// <p>When to next request the status of this resource operation request.</p>
    pub fn set_retry_after(mut self, input: ::std::option::Option<::aws_smithy_types::DateTime>) -> Self {
        self.retry_after = input;
        self
    }
    /// <p>When to next request the status of this resource operation request.</p>
    pub fn get_retry_after(&self) -> &::std::option::Option<::aws_smithy_types::DateTime> {
        &self.retry_after
    }
    /// Consumes the builder and constructs a [`ProgressEvent`](crate::types::ProgressEvent).
    pub fn build(self) -> crate::types::ProgressEvent {
        crate::types::ProgressEvent {
            type_name: self.type_name,
            identifier: self.identifier,
            request_token: self.request_token,
            hooks_request_token: self.hooks_request_token,
            operation: self.operation,
            operation_status: self.operation_status,
            event_time: self.event_time,
            resource_model: self.resource_model,
            status_message: self.status_message,
            error_code: self.error_code,
            retry_after: self.retry_after,
        }
    }
}
impl ::std::fmt::Debug for ProgressEventBuilder {
    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
        let mut formatter = f.debug_struct("ProgressEventBuilder");
        formatter.field("type_name", &self.type_name);
        formatter.field("identifier", &self.identifier);
        formatter.field("request_token", &self.request_token);
        formatter.field("hooks_request_token", &self.hooks_request_token);
        formatter.field("operation", &self.operation);
        formatter.field("operation_status", &self.operation_status);
        formatter.field("event_time", &self.event_time);
        formatter.field("resource_model", &"*** Sensitive Data Redacted ***");
        formatter.field("status_message", &self.status_message);
        formatter.field("error_code", &self.error_code);
        formatter.field("retry_after", &self.retry_after);
        formatter.finish()
    }
}