/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace CloudControlApi { namespace Model { /** *

Represents the current status of a resource operation request. For more * information, see Managing * resource operation requests in the Amazon Web Services Cloud Control API * User Guide.

See Also:

AWS * API Reference

*/ class ProgressEvent { public: AWS_CLOUDCONTROLAPI_API ProgressEvent(); AWS_CLOUDCONTROLAPI_API ProgressEvent(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDCONTROLAPI_API ProgressEvent& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_CLOUDCONTROLAPI_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the resource type used in the operation.

*/ inline const Aws::String& GetTypeName() const{ return m_typeName; } /** *

The name of the resource type used in the operation.

*/ inline bool TypeNameHasBeenSet() const { return m_typeNameHasBeenSet; } /** *

The name of the resource type used in the operation.

*/ inline void SetTypeName(const Aws::String& value) { m_typeNameHasBeenSet = true; m_typeName = value; } /** *

The name of the resource type used in the operation.

*/ inline void SetTypeName(Aws::String&& value) { m_typeNameHasBeenSet = true; m_typeName = std::move(value); } /** *

The name of the resource type used in the operation.

*/ inline void SetTypeName(const char* value) { m_typeNameHasBeenSet = true; m_typeName.assign(value); } /** *

The name of the resource type used in the operation.

*/ inline ProgressEvent& WithTypeName(const Aws::String& value) { SetTypeName(value); return *this;} /** *

The name of the resource type used in the operation.

*/ inline ProgressEvent& WithTypeName(Aws::String&& value) { SetTypeName(std::move(value)); return *this;} /** *

The name of the resource type used in the operation.

*/ inline ProgressEvent& WithTypeName(const char* value) { SetTypeName(value); return *this;} /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline const Aws::String& GetIdentifier() const{ return m_identifier; } /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline bool IdentifierHasBeenSet() const { return m_identifierHasBeenSet; } /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline void SetIdentifier(const Aws::String& value) { m_identifierHasBeenSet = true; m_identifier = value; } /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline void SetIdentifier(Aws::String&& value) { m_identifierHasBeenSet = true; m_identifier = std::move(value); } /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline void SetIdentifier(const char* value) { m_identifierHasBeenSet = true; m_identifier.assign(value); } /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline ProgressEvent& WithIdentifier(const Aws::String& value) { SetIdentifier(value); return *this;} /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline ProgressEvent& WithIdentifier(Aws::String&& value) { SetIdentifier(std::move(value)); return *this;} /** *

The primary identifier for the resource.

In some cases, the * resource identifier may be available before the resource operation has reached a * status of SUCCESS.

*/ inline ProgressEvent& WithIdentifier(const char* value) { SetIdentifier(value); return *this;} /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline const Aws::String& GetRequestToken() const{ return m_requestToken; } /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline bool RequestTokenHasBeenSet() const { return m_requestTokenHasBeenSet; } /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline void SetRequestToken(const Aws::String& value) { m_requestTokenHasBeenSet = true; m_requestToken = value; } /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline void SetRequestToken(Aws::String&& value) { m_requestTokenHasBeenSet = true; m_requestToken = std::move(value); } /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline void SetRequestToken(const char* value) { m_requestTokenHasBeenSet = true; m_requestToken.assign(value); } /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline ProgressEvent& WithRequestToken(const Aws::String& value) { SetRequestToken(value); return *this;} /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline ProgressEvent& WithRequestToken(Aws::String&& value) { SetRequestToken(std::move(value)); return *this;} /** *

The unique token representing this resource operation request.

Use the * RequestToken with GetResourceRequestStatus * to return the current status of a resource operation request.

*/ inline ProgressEvent& WithRequestToken(const char* value) { SetRequestToken(value); return *this;} /** *

The resource operation type.

*/ inline const Operation& GetOperation() const{ return m_operation; } /** *

The resource operation type.

*/ inline bool OperationHasBeenSet() const { return m_operationHasBeenSet; } /** *

The resource operation type.

*/ inline void SetOperation(const Operation& value) { m_operationHasBeenSet = true; m_operation = value; } /** *

The resource operation type.

*/ inline void SetOperation(Operation&& value) { m_operationHasBeenSet = true; m_operation = std::move(value); } /** *

The resource operation type.

*/ inline ProgressEvent& WithOperation(const Operation& value) { SetOperation(value); return *this;} /** *

The resource operation type.

*/ inline ProgressEvent& WithOperation(Operation&& value) { SetOperation(std::move(value)); return *this;} /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline const OperationStatus& GetOperationStatus() const{ return m_operationStatus; } /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline bool OperationStatusHasBeenSet() const { return m_operationStatusHasBeenSet; } /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline void SetOperationStatus(const OperationStatus& value) { m_operationStatusHasBeenSet = true; m_operationStatus = value; } /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline void SetOperationStatus(OperationStatus&& value) { m_operationStatusHasBeenSet = true; m_operationStatus = std::move(value); } /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline ProgressEvent& WithOperationStatus(const OperationStatus& value) { SetOperationStatus(value); return *this;} /** *

The current status of the resource operation request.

  • * PENDING: The resource operation hasn't yet started.

  • *

    IN_PROGRESS: The resource operation is currently in * progress.

  • SUCCESS: The resource operation has * successfully completed.

  • FAILED: The resource * operation has failed. Refer to the error code and status message for more * information.

  • CANCEL_IN_PROGRESS: The resource * operation is in the process of being canceled.

  • * CANCEL_COMPLETE: The resource operation has been canceled.

    *
*/ inline ProgressEvent& WithOperationStatus(OperationStatus&& value) { SetOperationStatus(std::move(value)); return *this;} /** *

When the resource operation request was initiated.

*/ inline const Aws::Utils::DateTime& GetEventTime() const{ return m_eventTime; } /** *

When the resource operation request was initiated.

*/ inline bool EventTimeHasBeenSet() const { return m_eventTimeHasBeenSet; } /** *

When the resource operation request was initiated.

*/ inline void SetEventTime(const Aws::Utils::DateTime& value) { m_eventTimeHasBeenSet = true; m_eventTime = value; } /** *

When the resource operation request was initiated.

*/ inline void SetEventTime(Aws::Utils::DateTime&& value) { m_eventTimeHasBeenSet = true; m_eventTime = std::move(value); } /** *

When the resource operation request was initiated.

*/ inline ProgressEvent& WithEventTime(const Aws::Utils::DateTime& value) { SetEventTime(value); return *this;} /** *

When the resource operation request was initiated.

*/ inline ProgressEvent& WithEventTime(Aws::Utils::DateTime&& value) { SetEventTime(std::move(value)); return *this;} /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline const Aws::String& GetResourceModel() const{ return m_resourceModel; } /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline bool ResourceModelHasBeenSet() const { return m_resourceModelHasBeenSet; } /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline void SetResourceModel(const Aws::String& value) { m_resourceModelHasBeenSet = true; m_resourceModel = value; } /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline void SetResourceModel(Aws::String&& value) { m_resourceModelHasBeenSet = true; m_resourceModel = std::move(value); } /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline void SetResourceModel(const char* value) { m_resourceModelHasBeenSet = true; m_resourceModel.assign(value); } /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline ProgressEvent& WithResourceModel(const Aws::String& value) { SetResourceModel(value); return *this;} /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline ProgressEvent& WithResourceModel(Aws::String&& value) { SetResourceModel(std::move(value)); return *this;} /** *

A JSON string containing the resource model, consisting of each resource * property and its current value.

*/ inline ProgressEvent& WithResourceModel(const char* value) { SetResourceModel(value); return *this;} /** *

Any message explaining the current status.

*/ inline const Aws::String& GetStatusMessage() const{ return m_statusMessage; } /** *

Any message explaining the current status.

*/ inline bool StatusMessageHasBeenSet() const { return m_statusMessageHasBeenSet; } /** *

Any message explaining the current status.

*/ inline void SetStatusMessage(const Aws::String& value) { m_statusMessageHasBeenSet = true; m_statusMessage = value; } /** *

Any message explaining the current status.

*/ inline void SetStatusMessage(Aws::String&& value) { m_statusMessageHasBeenSet = true; m_statusMessage = std::move(value); } /** *

Any message explaining the current status.

*/ inline void SetStatusMessage(const char* value) { m_statusMessageHasBeenSet = true; m_statusMessage.assign(value); } /** *

Any message explaining the current status.

*/ inline ProgressEvent& WithStatusMessage(const Aws::String& value) { SetStatusMessage(value); return *this;} /** *

Any message explaining the current status.

*/ inline ProgressEvent& WithStatusMessage(Aws::String&& value) { SetStatusMessage(std::move(value)); return *this;} /** *

Any message explaining the current status.

*/ inline ProgressEvent& WithStatusMessage(const char* value) { SetStatusMessage(value); return *this;} /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline const HandlerErrorCode& GetErrorCode() const{ return m_errorCode; } /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline bool ErrorCodeHasBeenSet() const { return m_errorCodeHasBeenSet; } /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline void SetErrorCode(const HandlerErrorCode& value) { m_errorCodeHasBeenSet = true; m_errorCode = value; } /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline void SetErrorCode(HandlerErrorCode&& value) { m_errorCodeHasBeenSet = true; m_errorCode = std::move(value); } /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline ProgressEvent& WithErrorCode(const HandlerErrorCode& value) { SetErrorCode(value); return *this;} /** *

For requests with a status of FAILED, the associated error * code.

For error code definitions, see Handler * error codes in the CloudFormation Command Line Interface User Guide for * Extension Development.

*/ inline ProgressEvent& WithErrorCode(HandlerErrorCode&& value) { SetErrorCode(std::move(value)); return *this;} /** *

When to next request the status of this resource operation request.

*/ inline const Aws::Utils::DateTime& GetRetryAfter() const{ return m_retryAfter; } /** *

When to next request the status of this resource operation request.

*/ inline bool RetryAfterHasBeenSet() const { return m_retryAfterHasBeenSet; } /** *

When to next request the status of this resource operation request.

*/ inline void SetRetryAfter(const Aws::Utils::DateTime& value) { m_retryAfterHasBeenSet = true; m_retryAfter = value; } /** *

When to next request the status of this resource operation request.

*/ inline void SetRetryAfter(Aws::Utils::DateTime&& value) { m_retryAfterHasBeenSet = true; m_retryAfter = std::move(value); } /** *

When to next request the status of this resource operation request.

*/ inline ProgressEvent& WithRetryAfter(const Aws::Utils::DateTime& value) { SetRetryAfter(value); return *this;} /** *

When to next request the status of this resource operation request.

*/ inline ProgressEvent& WithRetryAfter(Aws::Utils::DateTime&& value) { SetRetryAfter(std::move(value)); return *this;} private: Aws::String m_typeName; bool m_typeNameHasBeenSet = false; Aws::String m_identifier; bool m_identifierHasBeenSet = false; Aws::String m_requestToken; bool m_requestTokenHasBeenSet = false; Operation m_operation; bool m_operationHasBeenSet = false; OperationStatus m_operationStatus; bool m_operationStatusHasBeenSet = false; Aws::Utils::DateTime m_eventTime; bool m_eventTimeHasBeenSet = false; Aws::String m_resourceModel; bool m_resourceModelHasBeenSet = false; Aws::String m_statusMessage; bool m_statusMessageHasBeenSet = false; HandlerErrorCode m_errorCode; bool m_errorCodeHasBeenSet = false; Aws::Utils::DateTime m_retryAfter; bool m_retryAfterHasBeenSet = false; }; } // namespace Model } // namespace CloudControlApi } // namespace Aws