/** * 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 Rekognition { namespace Model { /** */ class GetContentModerationRequest : public RekognitionRequest { public: AWS_REKOGNITION_API GetContentModerationRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetContentModeration"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline const Aws::String& GetJobId() const{ return m_jobId; } /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline bool JobIdHasBeenSet() const { return m_jobIdHasBeenSet; } /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline void SetJobId(const Aws::String& value) { m_jobIdHasBeenSet = true; m_jobId = value; } /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline void SetJobId(Aws::String&& value) { m_jobIdHasBeenSet = true; m_jobId = std::move(value); } /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline void SetJobId(const char* value) { m_jobIdHasBeenSet = true; m_jobId.assign(value); } /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline GetContentModerationRequest& WithJobId(const Aws::String& value) { SetJobId(value); return *this;} /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline GetContentModerationRequest& WithJobId(Aws::String&& value) { SetJobId(std::move(value)); return *this;} /** *

The identifier for the inappropriate, unwanted, or offensive content * moderation job. Use JobId to identify the job in a subsequent call * to GetContentModeration.

*/ inline GetContentModerationRequest& WithJobId(const char* value) { SetJobId(value); return *this;} /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

Maximum number of results to return per paginated call. The largest value you * can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 * results is returned. The default value is 1000.

*/ inline GetContentModerationRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline GetContentModerationRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline GetContentModerationRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

If the previous response was incomplete (because there is more data to * retrieve), Amazon Rekognition returns a pagination token in the response. You * can use this pagination token to retrieve the next set of content moderation * labels.

*/ inline GetContentModerationRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline const ContentModerationSortBy& GetSortBy() const{ return m_sortBy; } /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline bool SortByHasBeenSet() const { return m_sortByHasBeenSet; } /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline void SetSortBy(const ContentModerationSortBy& value) { m_sortByHasBeenSet = true; m_sortBy = value; } /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline void SetSortBy(ContentModerationSortBy&& value) { m_sortByHasBeenSet = true; m_sortBy = std::move(value); } /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline GetContentModerationRequest& WithSortBy(const ContentModerationSortBy& value) { SetSortBy(value); return *this;} /** *

Sort to use for elements in the ModerationLabelDetections array. * Use TIMESTAMP to sort array elements by the time labels are * detected. Use NAME to alphabetically group elements for a label * together. Within each label group, the array element are sorted by detection * confidence. The default sort is by TIMESTAMP.

*/ inline GetContentModerationRequest& WithSortBy(ContentModerationSortBy&& value) { SetSortBy(std::move(value)); return *this;} /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline const ContentModerationAggregateBy& GetAggregateBy() const{ return m_aggregateBy; } /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline bool AggregateByHasBeenSet() const { return m_aggregateByHasBeenSet; } /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline void SetAggregateBy(const ContentModerationAggregateBy& value) { m_aggregateByHasBeenSet = true; m_aggregateBy = value; } /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline void SetAggregateBy(ContentModerationAggregateBy&& value) { m_aggregateByHasBeenSet = true; m_aggregateBy = std::move(value); } /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline GetContentModerationRequest& WithAggregateBy(const ContentModerationAggregateBy& value) { SetAggregateBy(value); return *this;} /** *

Defines how to aggregate results of the StartContentModeration request. * Default aggregation option is TIMESTAMPS. SEGMENTS mode aggregates moderation * labels over time.

*/ inline GetContentModerationRequest& WithAggregateBy(ContentModerationAggregateBy&& value) { SetAggregateBy(std::move(value)); return *this;} private: Aws::String m_jobId; bool m_jobIdHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; ContentModerationSortBy m_sortBy; bool m_sortByHasBeenSet = false; ContentModerationAggregateBy m_aggregateBy; bool m_aggregateByHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws