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

Input object for the batch transform job.

See Also:

AWS * API Reference

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

The Amazon S3 location being used to capture the data.

*/ inline const Aws::String& GetDataCapturedDestinationS3Uri() const{ return m_dataCapturedDestinationS3Uri; } /** *

The Amazon S3 location being used to capture the data.

*/ inline bool DataCapturedDestinationS3UriHasBeenSet() const { return m_dataCapturedDestinationS3UriHasBeenSet; } /** *

The Amazon S3 location being used to capture the data.

*/ inline void SetDataCapturedDestinationS3Uri(const Aws::String& value) { m_dataCapturedDestinationS3UriHasBeenSet = true; m_dataCapturedDestinationS3Uri = value; } /** *

The Amazon S3 location being used to capture the data.

*/ inline void SetDataCapturedDestinationS3Uri(Aws::String&& value) { m_dataCapturedDestinationS3UriHasBeenSet = true; m_dataCapturedDestinationS3Uri = std::move(value); } /** *

The Amazon S3 location being used to capture the data.

*/ inline void SetDataCapturedDestinationS3Uri(const char* value) { m_dataCapturedDestinationS3UriHasBeenSet = true; m_dataCapturedDestinationS3Uri.assign(value); } /** *

The Amazon S3 location being used to capture the data.

*/ inline BatchTransformInput& WithDataCapturedDestinationS3Uri(const Aws::String& value) { SetDataCapturedDestinationS3Uri(value); return *this;} /** *

The Amazon S3 location being used to capture the data.

*/ inline BatchTransformInput& WithDataCapturedDestinationS3Uri(Aws::String&& value) { SetDataCapturedDestinationS3Uri(std::move(value)); return *this;} /** *

The Amazon S3 location being used to capture the data.

*/ inline BatchTransformInput& WithDataCapturedDestinationS3Uri(const char* value) { SetDataCapturedDestinationS3Uri(value); return *this;} /** *

The dataset format for your batch transform job.

*/ inline const MonitoringDatasetFormat& GetDatasetFormat() const{ return m_datasetFormat; } /** *

The dataset format for your batch transform job.

*/ inline bool DatasetFormatHasBeenSet() const { return m_datasetFormatHasBeenSet; } /** *

The dataset format for your batch transform job.

*/ inline void SetDatasetFormat(const MonitoringDatasetFormat& value) { m_datasetFormatHasBeenSet = true; m_datasetFormat = value; } /** *

The dataset format for your batch transform job.

*/ inline void SetDatasetFormat(MonitoringDatasetFormat&& value) { m_datasetFormatHasBeenSet = true; m_datasetFormat = std::move(value); } /** *

The dataset format for your batch transform job.

*/ inline BatchTransformInput& WithDatasetFormat(const MonitoringDatasetFormat& value) { SetDatasetFormat(value); return *this;} /** *

The dataset format for your batch transform job.

*/ inline BatchTransformInput& WithDatasetFormat(MonitoringDatasetFormat&& value) { SetDatasetFormat(std::move(value)); return *this;} /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline const Aws::String& GetLocalPath() const{ return m_localPath; } /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline bool LocalPathHasBeenSet() const { return m_localPathHasBeenSet; } /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline void SetLocalPath(const Aws::String& value) { m_localPathHasBeenSet = true; m_localPath = value; } /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline void SetLocalPath(Aws::String&& value) { m_localPathHasBeenSet = true; m_localPath = std::move(value); } /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline void SetLocalPath(const char* value) { m_localPathHasBeenSet = true; m_localPath.assign(value); } /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline BatchTransformInput& WithLocalPath(const Aws::String& value) { SetLocalPath(value); return *this;} /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline BatchTransformInput& WithLocalPath(Aws::String&& value) { SetLocalPath(std::move(value)); return *this;} /** *

Path to the filesystem where the batch transform data is available to the * container.

*/ inline BatchTransformInput& WithLocalPath(const char* value) { SetLocalPath(value); return *this;} /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline const ProcessingS3InputMode& GetS3InputMode() const{ return m_s3InputMode; } /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline bool S3InputModeHasBeenSet() const { return m_s3InputModeHasBeenSet; } /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline void SetS3InputMode(const ProcessingS3InputMode& value) { m_s3InputModeHasBeenSet = true; m_s3InputMode = value; } /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline void SetS3InputMode(ProcessingS3InputMode&& value) { m_s3InputModeHasBeenSet = true; m_s3InputMode = std::move(value); } /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline BatchTransformInput& WithS3InputMode(const ProcessingS3InputMode& value) { SetS3InputMode(value); return *this;} /** *

Whether the Pipe or File is used as the input mode * for transferring data for the monitoring job. Pipe mode is * recommended for large datasets. File mode is useful for small files * that fit in memory. Defaults to File.

*/ inline BatchTransformInput& WithS3InputMode(ProcessingS3InputMode&& value) { SetS3InputMode(std::move(value)); return *this;} /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline const ProcessingS3DataDistributionType& GetS3DataDistributionType() const{ return m_s3DataDistributionType; } /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline bool S3DataDistributionTypeHasBeenSet() const { return m_s3DataDistributionTypeHasBeenSet; } /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline void SetS3DataDistributionType(const ProcessingS3DataDistributionType& value) { m_s3DataDistributionTypeHasBeenSet = true; m_s3DataDistributionType = value; } /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline void SetS3DataDistributionType(ProcessingS3DataDistributionType&& value) { m_s3DataDistributionTypeHasBeenSet = true; m_s3DataDistributionType = std::move(value); } /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline BatchTransformInput& WithS3DataDistributionType(const ProcessingS3DataDistributionType& value) { SetS3DataDistributionType(value); return *this;} /** *

Whether input data distributed in Amazon S3 is fully replicated or sharded by * an S3 key. Defaults to FullyReplicated

*/ inline BatchTransformInput& WithS3DataDistributionType(ProcessingS3DataDistributionType&& value) { SetS3DataDistributionType(std::move(value)); return *this;} /** *

The attributes of the input data that are the input features.

*/ inline const Aws::String& GetFeaturesAttribute() const{ return m_featuresAttribute; } /** *

The attributes of the input data that are the input features.

*/ inline bool FeaturesAttributeHasBeenSet() const { return m_featuresAttributeHasBeenSet; } /** *

The attributes of the input data that are the input features.

*/ inline void SetFeaturesAttribute(const Aws::String& value) { m_featuresAttributeHasBeenSet = true; m_featuresAttribute = value; } /** *

The attributes of the input data that are the input features.

*/ inline void SetFeaturesAttribute(Aws::String&& value) { m_featuresAttributeHasBeenSet = true; m_featuresAttribute = std::move(value); } /** *

The attributes of the input data that are the input features.

*/ inline void SetFeaturesAttribute(const char* value) { m_featuresAttributeHasBeenSet = true; m_featuresAttribute.assign(value); } /** *

The attributes of the input data that are the input features.

*/ inline BatchTransformInput& WithFeaturesAttribute(const Aws::String& value) { SetFeaturesAttribute(value); return *this;} /** *

The attributes of the input data that are the input features.

*/ inline BatchTransformInput& WithFeaturesAttribute(Aws::String&& value) { SetFeaturesAttribute(std::move(value)); return *this;} /** *

The attributes of the input data that are the input features.

*/ inline BatchTransformInput& WithFeaturesAttribute(const char* value) { SetFeaturesAttribute(value); return *this;} /** *

The attribute of the input data that represents the ground truth label.

*/ inline const Aws::String& GetInferenceAttribute() const{ return m_inferenceAttribute; } /** *

The attribute of the input data that represents the ground truth label.

*/ inline bool InferenceAttributeHasBeenSet() const { return m_inferenceAttributeHasBeenSet; } /** *

The attribute of the input data that represents the ground truth label.

*/ inline void SetInferenceAttribute(const Aws::String& value) { m_inferenceAttributeHasBeenSet = true; m_inferenceAttribute = value; } /** *

The attribute of the input data that represents the ground truth label.

*/ inline void SetInferenceAttribute(Aws::String&& value) { m_inferenceAttributeHasBeenSet = true; m_inferenceAttribute = std::move(value); } /** *

The attribute of the input data that represents the ground truth label.

*/ inline void SetInferenceAttribute(const char* value) { m_inferenceAttributeHasBeenSet = true; m_inferenceAttribute.assign(value); } /** *

The attribute of the input data that represents the ground truth label.

*/ inline BatchTransformInput& WithInferenceAttribute(const Aws::String& value) { SetInferenceAttribute(value); return *this;} /** *

The attribute of the input data that represents the ground truth label.

*/ inline BatchTransformInput& WithInferenceAttribute(Aws::String&& value) { SetInferenceAttribute(std::move(value)); return *this;} /** *

The attribute of the input data that represents the ground truth label.

*/ inline BatchTransformInput& WithInferenceAttribute(const char* value) { SetInferenceAttribute(value); return *this;} /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline const Aws::String& GetProbabilityAttribute() const{ return m_probabilityAttribute; } /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline bool ProbabilityAttributeHasBeenSet() const { return m_probabilityAttributeHasBeenSet; } /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline void SetProbabilityAttribute(const Aws::String& value) { m_probabilityAttributeHasBeenSet = true; m_probabilityAttribute = value; } /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline void SetProbabilityAttribute(Aws::String&& value) { m_probabilityAttributeHasBeenSet = true; m_probabilityAttribute = std::move(value); } /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline void SetProbabilityAttribute(const char* value) { m_probabilityAttributeHasBeenSet = true; m_probabilityAttribute.assign(value); } /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline BatchTransformInput& WithProbabilityAttribute(const Aws::String& value) { SetProbabilityAttribute(value); return *this;} /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline BatchTransformInput& WithProbabilityAttribute(Aws::String&& value) { SetProbabilityAttribute(std::move(value)); return *this;} /** *

In a classification problem, the attribute that represents the class * probability.

*/ inline BatchTransformInput& WithProbabilityAttribute(const char* value) { SetProbabilityAttribute(value); return *this;} /** *

The threshold for the class probability to be evaluated as a positive * result.

*/ inline double GetProbabilityThresholdAttribute() const{ return m_probabilityThresholdAttribute; } /** *

The threshold for the class probability to be evaluated as a positive * result.

*/ inline bool ProbabilityThresholdAttributeHasBeenSet() const { return m_probabilityThresholdAttributeHasBeenSet; } /** *

The threshold for the class probability to be evaluated as a positive * result.

*/ inline void SetProbabilityThresholdAttribute(double value) { m_probabilityThresholdAttributeHasBeenSet = true; m_probabilityThresholdAttribute = value; } /** *

The threshold for the class probability to be evaluated as a positive * result.

*/ inline BatchTransformInput& WithProbabilityThresholdAttribute(double value) { SetProbabilityThresholdAttribute(value); return *this;} /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline const Aws::String& GetStartTimeOffset() const{ return m_startTimeOffset; } /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline bool StartTimeOffsetHasBeenSet() const { return m_startTimeOffsetHasBeenSet; } /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetStartTimeOffset(const Aws::String& value) { m_startTimeOffsetHasBeenSet = true; m_startTimeOffset = value; } /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetStartTimeOffset(Aws::String&& value) { m_startTimeOffsetHasBeenSet = true; m_startTimeOffset = std::move(value); } /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetStartTimeOffset(const char* value) { m_startTimeOffsetHasBeenSet = true; m_startTimeOffset.assign(value); } /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithStartTimeOffset(const Aws::String& value) { SetStartTimeOffset(value); return *this;} /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithStartTimeOffset(Aws::String&& value) { SetStartTimeOffset(std::move(value)); return *this;} /** *

If specified, monitoring jobs substract this time from the start time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithStartTimeOffset(const char* value) { SetStartTimeOffset(value); return *this;} /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline const Aws::String& GetEndTimeOffset() const{ return m_endTimeOffset; } /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline bool EndTimeOffsetHasBeenSet() const { return m_endTimeOffsetHasBeenSet; } /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetEndTimeOffset(const Aws::String& value) { m_endTimeOffsetHasBeenSet = true; m_endTimeOffset = value; } /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetEndTimeOffset(Aws::String&& value) { m_endTimeOffsetHasBeenSet = true; m_endTimeOffset = std::move(value); } /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline void SetEndTimeOffset(const char* value) { m_endTimeOffsetHasBeenSet = true; m_endTimeOffset.assign(value); } /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithEndTimeOffset(const Aws::String& value) { SetEndTimeOffset(value); return *this;} /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithEndTimeOffset(Aws::String&& value) { SetEndTimeOffset(std::move(value)); return *this;} /** *

If specified, monitoring jobs substract this time from the end time. For * information about using offsets for scheduling monitoring jobs, see Schedule * Model Quality Monitoring Jobs.

*/ inline BatchTransformInput& WithEndTimeOffset(const char* value) { SetEndTimeOffset(value); return *this;} private: Aws::String m_dataCapturedDestinationS3Uri; bool m_dataCapturedDestinationS3UriHasBeenSet = false; MonitoringDatasetFormat m_datasetFormat; bool m_datasetFormatHasBeenSet = false; Aws::String m_localPath; bool m_localPathHasBeenSet = false; ProcessingS3InputMode m_s3InputMode; bool m_s3InputModeHasBeenSet = false; ProcessingS3DataDistributionType m_s3DataDistributionType; bool m_s3DataDistributionTypeHasBeenSet = false; Aws::String m_featuresAttribute; bool m_featuresAttributeHasBeenSet = false; Aws::String m_inferenceAttribute; bool m_inferenceAttributeHasBeenSet = false; Aws::String m_probabilityAttribute; bool m_probabilityAttributeHasBeenSet = false; double m_probabilityThresholdAttribute; bool m_probabilityThresholdAttributeHasBeenSet = false; Aws::String m_startTimeOffset; bool m_startTimeOffsetHasBeenSet = false; Aws::String m_endTimeOffset; bool m_endTimeOffsetHasBeenSet = false; }; } // namespace Model } // namespace SageMaker } // namespace Aws