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

Specifies information about the specified endpoint. For information about * endpoints, see Managing * endpoints.

See Also:

AWS * API Reference

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

The Amazon Resource Number (ARN) of the endpoint.

*/ inline const Aws::String& GetEndpointArn() const{ return m_endpointArn; } /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline bool EndpointArnHasBeenSet() const { return m_endpointArnHasBeenSet; } /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline void SetEndpointArn(const Aws::String& value) { m_endpointArnHasBeenSet = true; m_endpointArn = value; } /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline void SetEndpointArn(Aws::String&& value) { m_endpointArnHasBeenSet = true; m_endpointArn = std::move(value); } /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline void SetEndpointArn(const char* value) { m_endpointArnHasBeenSet = true; m_endpointArn.assign(value); } /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline EndpointProperties& WithEndpointArn(const Aws::String& value) { SetEndpointArn(value); return *this;} /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline EndpointProperties& WithEndpointArn(Aws::String&& value) { SetEndpointArn(std::move(value)); return *this;} /** *

The Amazon Resource Number (ARN) of the endpoint.

*/ inline EndpointProperties& WithEndpointArn(const char* value) { SetEndpointArn(value); return *this;} /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline const EndpointStatus& GetStatus() const{ return m_status; } /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline void SetStatus(const EndpointStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline void SetStatus(EndpointStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline EndpointProperties& WithStatus(const EndpointStatus& value) { SetStatus(value); return *this;} /** *

Specifies the status of the endpoint. Because the endpoint updates and * creation are asynchronous, so customers will need to wait for the endpoint to be * Ready status before making inference requests.

*/ inline EndpointProperties& WithStatus(EndpointStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

Specifies a reason for failure in cases of Failed status.

*/ inline const Aws::String& GetMessage() const{ return m_message; } /** *

Specifies a reason for failure in cases of Failed status.

*/ inline bool MessageHasBeenSet() const { return m_messageHasBeenSet; } /** *

Specifies a reason for failure in cases of Failed status.

*/ inline void SetMessage(const Aws::String& value) { m_messageHasBeenSet = true; m_message = value; } /** *

Specifies a reason for failure in cases of Failed status.

*/ inline void SetMessage(Aws::String&& value) { m_messageHasBeenSet = true; m_message = std::move(value); } /** *

Specifies a reason for failure in cases of Failed status.

*/ inline void SetMessage(const char* value) { m_messageHasBeenSet = true; m_message.assign(value); } /** *

Specifies a reason for failure in cases of Failed status.

*/ inline EndpointProperties& WithMessage(const Aws::String& value) { SetMessage(value); return *this;} /** *

Specifies a reason for failure in cases of Failed status.

*/ inline EndpointProperties& WithMessage(Aws::String&& value) { SetMessage(std::move(value)); return *this;} /** *

Specifies a reason for failure in cases of Failed status.

*/ inline EndpointProperties& WithMessage(const char* value) { SetMessage(value); return *this;} /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline const Aws::String& GetModelArn() const{ return m_modelArn; } /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline bool ModelArnHasBeenSet() const { return m_modelArnHasBeenSet; } /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline void SetModelArn(const Aws::String& value) { m_modelArnHasBeenSet = true; m_modelArn = value; } /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline void SetModelArn(Aws::String&& value) { m_modelArnHasBeenSet = true; m_modelArn = std::move(value); } /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline void SetModelArn(const char* value) { m_modelArnHasBeenSet = true; m_modelArn.assign(value); } /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline EndpointProperties& WithModelArn(const Aws::String& value) { SetModelArn(value); return *this;} /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline EndpointProperties& WithModelArn(Aws::String&& value) { SetModelArn(std::move(value)); return *this;} /** *

The Amazon Resource Number (ARN) of the model to which the endpoint is * attached.

*/ inline EndpointProperties& WithModelArn(const char* value) { SetModelArn(value); return *this;} /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline const Aws::String& GetDesiredModelArn() const{ return m_desiredModelArn; } /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline bool DesiredModelArnHasBeenSet() const { return m_desiredModelArnHasBeenSet; } /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline void SetDesiredModelArn(const Aws::String& value) { m_desiredModelArnHasBeenSet = true; m_desiredModelArn = value; } /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline void SetDesiredModelArn(Aws::String&& value) { m_desiredModelArnHasBeenSet = true; m_desiredModelArn = std::move(value); } /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline void SetDesiredModelArn(const char* value) { m_desiredModelArnHasBeenSet = true; m_desiredModelArn.assign(value); } /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline EndpointProperties& WithDesiredModelArn(const Aws::String& value) { SetDesiredModelArn(value); return *this;} /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline EndpointProperties& WithDesiredModelArn(Aws::String&& value) { SetDesiredModelArn(std::move(value)); return *this;} /** *

ARN of the new model to use for updating an existing endpoint. This ARN is * going to be different from the model ARN when the update is in progress

*/ inline EndpointProperties& WithDesiredModelArn(const char* value) { SetDesiredModelArn(value); return *this;} /** *

The desired number of inference units to be used by the model using this * endpoint. Each inference unit represents of a throughput of 100 characters per * second.

*/ inline int GetDesiredInferenceUnits() const{ return m_desiredInferenceUnits; } /** *

The desired number of inference units to be used by the model using this * endpoint. Each inference unit represents of a throughput of 100 characters per * second.

*/ inline bool DesiredInferenceUnitsHasBeenSet() const { return m_desiredInferenceUnitsHasBeenSet; } /** *

The desired number of inference units to be used by the model using this * endpoint. Each inference unit represents of a throughput of 100 characters per * second.

*/ inline void SetDesiredInferenceUnits(int value) { m_desiredInferenceUnitsHasBeenSet = true; m_desiredInferenceUnits = value; } /** *

The desired number of inference units to be used by the model using this * endpoint. Each inference unit represents of a throughput of 100 characters per * second.

*/ inline EndpointProperties& WithDesiredInferenceUnits(int value) { SetDesiredInferenceUnits(value); return *this;} /** *

The number of inference units currently used by the model using this * endpoint.

*/ inline int GetCurrentInferenceUnits() const{ return m_currentInferenceUnits; } /** *

The number of inference units currently used by the model using this * endpoint.

*/ inline bool CurrentInferenceUnitsHasBeenSet() const { return m_currentInferenceUnitsHasBeenSet; } /** *

The number of inference units currently used by the model using this * endpoint.

*/ inline void SetCurrentInferenceUnits(int value) { m_currentInferenceUnitsHasBeenSet = true; m_currentInferenceUnits = value; } /** *

The number of inference units currently used by the model using this * endpoint.

*/ inline EndpointProperties& WithCurrentInferenceUnits(int value) { SetCurrentInferenceUnits(value); return *this;} /** *

The creation date and time of the endpoint.

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The creation date and time of the endpoint.

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The creation date and time of the endpoint.

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

The creation date and time of the endpoint.

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

The creation date and time of the endpoint.

*/ inline EndpointProperties& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The creation date and time of the endpoint.

*/ inline EndpointProperties& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The date and time that the endpoint was last modified.

*/ inline const Aws::Utils::DateTime& GetLastModifiedTime() const{ return m_lastModifiedTime; } /** *

The date and time that the endpoint was last modified.

*/ inline bool LastModifiedTimeHasBeenSet() const { return m_lastModifiedTimeHasBeenSet; } /** *

The date and time that the endpoint was last modified.

*/ inline void SetLastModifiedTime(const Aws::Utils::DateTime& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = value; } /** *

The date and time that the endpoint was last modified.

*/ inline void SetLastModifiedTime(Aws::Utils::DateTime&& value) { m_lastModifiedTimeHasBeenSet = true; m_lastModifiedTime = std::move(value); } /** *

The date and time that the endpoint was last modified.

*/ inline EndpointProperties& WithLastModifiedTime(const Aws::Utils::DateTime& value) { SetLastModifiedTime(value); return *this;} /** *

The date and time that the endpoint was last modified.

*/ inline EndpointProperties& WithLastModifiedTime(Aws::Utils::DateTime&& value) { SetLastModifiedTime(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline const Aws::String& GetDataAccessRoleArn() const{ return m_dataAccessRoleArn; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline bool DataAccessRoleArnHasBeenSet() const { return m_dataAccessRoleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline void SetDataAccessRoleArn(const Aws::String& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = value; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline void SetDataAccessRoleArn(Aws::String&& value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline void SetDataAccessRoleArn(const char* value) { m_dataAccessRoleArnHasBeenSet = true; m_dataAccessRoleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline EndpointProperties& WithDataAccessRoleArn(const Aws::String& value) { SetDataAccessRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline EndpointProperties& WithDataAccessRoleArn(Aws::String&& value) { SetDataAccessRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants Amazon Comprehend * read access to trained custom models encrypted with a customer managed key * (ModelKmsKeyId).

*/ inline EndpointProperties& WithDataAccessRoleArn(const char* value) { SetDataAccessRoleArn(value); return *this;} /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline const Aws::String& GetDesiredDataAccessRoleArn() const{ return m_desiredDataAccessRoleArn; } /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline bool DesiredDataAccessRoleArnHasBeenSet() const { return m_desiredDataAccessRoleArnHasBeenSet; } /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline void SetDesiredDataAccessRoleArn(const Aws::String& value) { m_desiredDataAccessRoleArnHasBeenSet = true; m_desiredDataAccessRoleArn = value; } /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline void SetDesiredDataAccessRoleArn(Aws::String&& value) { m_desiredDataAccessRoleArnHasBeenSet = true; m_desiredDataAccessRoleArn = std::move(value); } /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline void SetDesiredDataAccessRoleArn(const char* value) { m_desiredDataAccessRoleArnHasBeenSet = true; m_desiredDataAccessRoleArn.assign(value); } /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline EndpointProperties& WithDesiredDataAccessRoleArn(const Aws::String& value) { SetDesiredDataAccessRoleArn(value); return *this;} /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline EndpointProperties& WithDesiredDataAccessRoleArn(Aws::String&& value) { SetDesiredDataAccessRoleArn(std::move(value)); return *this;} /** *

Data access role ARN to use in case the new model is encrypted with a * customer KMS key.

*/ inline EndpointProperties& WithDesiredDataAccessRoleArn(const char* value) { SetDesiredDataAccessRoleArn(value); return *this;} /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline const Aws::String& GetFlywheelArn() const{ return m_flywheelArn; } /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline bool FlywheelArnHasBeenSet() const { return m_flywheelArnHasBeenSet; } /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline void SetFlywheelArn(const Aws::String& value) { m_flywheelArnHasBeenSet = true; m_flywheelArn = value; } /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline void SetFlywheelArn(Aws::String&& value) { m_flywheelArnHasBeenSet = true; m_flywheelArn = std::move(value); } /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline void SetFlywheelArn(const char* value) { m_flywheelArnHasBeenSet = true; m_flywheelArn.assign(value); } /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline EndpointProperties& WithFlywheelArn(const Aws::String& value) { SetFlywheelArn(value); return *this;} /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline EndpointProperties& WithFlywheelArn(Aws::String&& value) { SetFlywheelArn(std::move(value)); return *this;} /** *

The Amazon Resource Number (ARN) of the flywheel

*/ inline EndpointProperties& WithFlywheelArn(const char* value) { SetFlywheelArn(value); return *this;} private: Aws::String m_endpointArn; bool m_endpointArnHasBeenSet = false; EndpointStatus m_status; bool m_statusHasBeenSet = false; Aws::String m_message; bool m_messageHasBeenSet = false; Aws::String m_modelArn; bool m_modelArnHasBeenSet = false; Aws::String m_desiredModelArn; bool m_desiredModelArnHasBeenSet = false; int m_desiredInferenceUnits; bool m_desiredInferenceUnitsHasBeenSet = false; int m_currentInferenceUnits; bool m_currentInferenceUnitsHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_lastModifiedTime; bool m_lastModifiedTimeHasBeenSet = false; Aws::String m_dataAccessRoleArn; bool m_dataAccessRoleArnHasBeenSet = false; Aws::String m_desiredDataAccessRoleArn; bool m_desiredDataAccessRoleArnHasBeenSet = false; Aws::String m_flywheelArn; bool m_flywheelArnHasBeenSet = false; }; } // namespace Model } // namespace Comprehend } // namespace Aws