/** * 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 Rekognition { namespace Model { /** */ class ListDatasetEntriesRequest : public RekognitionRequest { public: AWS_REKOGNITION_API ListDatasetEntriesRequest(); // 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 "ListDatasetEntries"; } AWS_REKOGNITION_API Aws::String SerializePayload() const override; AWS_REKOGNITION_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline const Aws::String& GetDatasetArn() const{ return m_datasetArn; } /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline bool DatasetArnHasBeenSet() const { return m_datasetArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline void SetDatasetArn(const Aws::String& value) { m_datasetArnHasBeenSet = true; m_datasetArn = value; } /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline void SetDatasetArn(Aws::String&& value) { m_datasetArnHasBeenSet = true; m_datasetArn = std::move(value); } /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline void SetDatasetArn(const char* value) { m_datasetArnHasBeenSet = true; m_datasetArn.assign(value); } /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline ListDatasetEntriesRequest& WithDatasetArn(const Aws::String& value) { SetDatasetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline ListDatasetEntriesRequest& WithDatasetArn(Aws::String&& value) { SetDatasetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) for the dataset that you want to use.

*/ inline ListDatasetEntriesRequest& WithDatasetArn(const char* value) { SetDatasetArn(value); return *this;} /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline const Aws::Vector& GetContainsLabels() const{ return m_containsLabels; } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline bool ContainsLabelsHasBeenSet() const { return m_containsLabelsHasBeenSet; } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline void SetContainsLabels(const Aws::Vector& value) { m_containsLabelsHasBeenSet = true; m_containsLabels = value; } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline void SetContainsLabels(Aws::Vector&& value) { m_containsLabelsHasBeenSet = true; m_containsLabels = std::move(value); } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline ListDatasetEntriesRequest& WithContainsLabels(const Aws::Vector& value) { SetContainsLabels(value); return *this;} /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline ListDatasetEntriesRequest& WithContainsLabels(Aws::Vector&& value) { SetContainsLabels(std::move(value)); return *this;} /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline ListDatasetEntriesRequest& AddContainsLabels(const Aws::String& value) { m_containsLabelsHasBeenSet = true; m_containsLabels.push_back(value); return *this; } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline ListDatasetEntriesRequest& AddContainsLabels(Aws::String&& value) { m_containsLabelsHasBeenSet = true; m_containsLabels.push_back(std::move(value)); return *this; } /** *

Specifies a label filter for the response. The response includes an entry * only if one or more of the labels in ContainsLabels exist in the * entry.

*/ inline ListDatasetEntriesRequest& AddContainsLabels(const char* value) { m_containsLabelsHasBeenSet = true; m_containsLabels.push_back(value); return *this; } /** *

Specify true to get only the JSON Lines where the image is * labeled. Specify false to get only the JSON Lines where the image * isn't labeled. If you don't specify Labeled, * ListDatasetEntries returns JSON Lines for labeled and unlabeled * images.

*/ inline bool GetLabeled() const{ return m_labeled; } /** *

Specify true to get only the JSON Lines where the image is * labeled. Specify false to get only the JSON Lines where the image * isn't labeled. If you don't specify Labeled, * ListDatasetEntries returns JSON Lines for labeled and unlabeled * images.

*/ inline bool LabeledHasBeenSet() const { return m_labeledHasBeenSet; } /** *

Specify true to get only the JSON Lines where the image is * labeled. Specify false to get only the JSON Lines where the image * isn't labeled. If you don't specify Labeled, * ListDatasetEntries returns JSON Lines for labeled and unlabeled * images.

*/ inline void SetLabeled(bool value) { m_labeledHasBeenSet = true; m_labeled = value; } /** *

Specify true to get only the JSON Lines where the image is * labeled. Specify false to get only the JSON Lines where the image * isn't labeled. If you don't specify Labeled, * ListDatasetEntries returns JSON Lines for labeled and unlabeled * images.

*/ inline ListDatasetEntriesRequest& WithLabeled(bool value) { SetLabeled(value); return *this;} /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline const Aws::String& GetSourceRefContains() const{ return m_sourceRefContains; } /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline bool SourceRefContainsHasBeenSet() const { return m_sourceRefContainsHasBeenSet; } /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline void SetSourceRefContains(const Aws::String& value) { m_sourceRefContainsHasBeenSet = true; m_sourceRefContains = value; } /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline void SetSourceRefContains(Aws::String&& value) { m_sourceRefContainsHasBeenSet = true; m_sourceRefContains = std::move(value); } /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline void SetSourceRefContains(const char* value) { m_sourceRefContainsHasBeenSet = true; m_sourceRefContains.assign(value); } /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline ListDatasetEntriesRequest& WithSourceRefContains(const Aws::String& value) { SetSourceRefContains(value); return *this;} /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline ListDatasetEntriesRequest& WithSourceRefContains(Aws::String&& value) { SetSourceRefContains(std::move(value)); return *this;} /** *

If specified, ListDatasetEntries only returns JSON Lines where * the value of SourceRefContains is part of the * source-ref field. The source-ref field contains the * Amazon S3 location of the image. You can use SouceRefContains for * tasks such as getting the JSON Line for a single image, or gettting JSON Lines * for all images within a specific folder.

*/ inline ListDatasetEntriesRequest& WithSourceRefContains(const char* value) { SetSourceRefContains(value); return *this;} /** *

Specifies an error filter for the response. Specify True to only * include entries that have errors.

*/ inline bool GetHasErrors() const{ return m_hasErrors; } /** *

Specifies an error filter for the response. Specify True to only * include entries that have errors.

*/ inline bool HasErrorsHasBeenSet() const { return m_hasErrorsHasBeenSet; } /** *

Specifies an error filter for the response. Specify True to only * include entries that have errors.

*/ inline void SetHasErrors(bool value) { m_hasErrorsHasBeenSet = true; m_hasErrors = value; } /** *

Specifies an error filter for the response. Specify True to only * include entries that have errors.

*/ inline ListDatasetEntriesRequest& WithHasErrors(bool value) { SetHasErrors(value); return *this;} /** *

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

The maximum number of results to return per paginated call. The largest value * you can specify is 100. If you specify a value greater than 100, a * ValidationException error occurs. The default value is 100.

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

The maximum number of results to return per paginated call. The largest value * you can specify is 100. If you specify a value greater than 100, a * ValidationException error occurs. The default value is 100.

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

The maximum number of results to return per paginated call. The largest value * you can specify is 100. If you specify a value greater than 100, a * ValidationException error occurs. The default value is 100.

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

The maximum number of results to return per paginated call. The largest value * you can specify is 100. If you specify a value greater than 100, a * ValidationException error occurs. The default value is 100.

*/ inline ListDatasetEntriesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} private: Aws::String m_datasetArn; bool m_datasetArnHasBeenSet = false; Aws::Vector m_containsLabels; bool m_containsLabelsHasBeenSet = false; bool m_labeled; bool m_labeledHasBeenSet = false; Aws::String m_sourceRefContains; bool m_sourceRefContainsHasBeenSet = false; bool m_hasErrors; bool m_hasErrorsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; }; } // namespace Model } // namespace Rekognition } // namespace Aws