1 /** 2 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 3 * SPDX-License-Identifier: Apache-2.0. 4 */ 5 6 #pragma once 7 #include <aws/comprehend/Comprehend_EXPORTS.h> 8 #include <aws/comprehend/ComprehendRequest.h> 9 #include <aws/comprehend/model/EntityRecognizerFilter.h> 10 #include <aws/core/utils/memory/stl/AWSString.h> 11 #include <utility> 12 13 namespace Aws 14 { 15 namespace Comprehend 16 { 17 namespace Model 18 { 19 20 /** 21 */ 22 class AWS_COMPREHEND_API ListEntityRecognizersRequest : public ComprehendRequest 23 { 24 public: 25 ListEntityRecognizersRequest(); 26 27 // Service request name is the Operation name which will send this request out, 28 // each operation should has unique request name, so that we can get operation's name from this request. 29 // Note: this is not true for response, multiple operations may have the same response name, 30 // so we can not get operation's name from response. GetServiceRequestName()31 inline virtual const char* GetServiceRequestName() const override { return "ListEntityRecognizers"; } 32 33 Aws::String SerializePayload() const override; 34 35 Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; 36 37 38 /** 39 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 40 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 41 * one filter at a time.</p> 42 */ GetFilter()43 inline const EntityRecognizerFilter& GetFilter() const{ return m_filter; } 44 45 /** 46 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 47 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 48 * one filter at a time.</p> 49 */ FilterHasBeenSet()50 inline bool FilterHasBeenSet() const { return m_filterHasBeenSet; } 51 52 /** 53 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 54 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 55 * one filter at a time.</p> 56 */ SetFilter(const EntityRecognizerFilter & value)57 inline void SetFilter(const EntityRecognizerFilter& value) { m_filterHasBeenSet = true; m_filter = value; } 58 59 /** 60 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 61 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 62 * one filter at a time.</p> 63 */ SetFilter(EntityRecognizerFilter && value)64 inline void SetFilter(EntityRecognizerFilter&& value) { m_filterHasBeenSet = true; m_filter = std::move(value); } 65 66 /** 67 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 68 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 69 * one filter at a time.</p> 70 */ WithFilter(const EntityRecognizerFilter & value)71 inline ListEntityRecognizersRequest& WithFilter(const EntityRecognizerFilter& value) { SetFilter(value); return *this;} 72 73 /** 74 * <p>Filters the list of entities returned. You can filter on <code>Status</code>, 75 * <code>SubmitTimeBefore</code>, or <code>SubmitTimeAfter</code>. You can only set 76 * one filter at a time.</p> 77 */ WithFilter(EntityRecognizerFilter && value)78 inline ListEntityRecognizersRequest& WithFilter(EntityRecognizerFilter&& value) { SetFilter(std::move(value)); return *this;} 79 80 81 /** 82 * <p>Identifies the next page of results to return.</p> 83 */ GetNextToken()84 inline const Aws::String& GetNextToken() const{ return m_nextToken; } 85 86 /** 87 * <p>Identifies the next page of results to return.</p> 88 */ NextTokenHasBeenSet()89 inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } 90 91 /** 92 * <p>Identifies the next page of results to return.</p> 93 */ SetNextToken(const Aws::String & value)94 inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } 95 96 /** 97 * <p>Identifies the next page of results to return.</p> 98 */ SetNextToken(Aws::String && value)99 inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } 100 101 /** 102 * <p>Identifies the next page of results to return.</p> 103 */ SetNextToken(const char * value)104 inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } 105 106 /** 107 * <p>Identifies the next page of results to return.</p> 108 */ WithNextToken(const Aws::String & value)109 inline ListEntityRecognizersRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} 110 111 /** 112 * <p>Identifies the next page of results to return.</p> 113 */ WithNextToken(Aws::String && value)114 inline ListEntityRecognizersRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} 115 116 /** 117 * <p>Identifies the next page of results to return.</p> 118 */ WithNextToken(const char * value)119 inline ListEntityRecognizersRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} 120 121 122 /** 123 * <p> The maximum number of results to return on each page. The default is 124 * 100.</p> 125 */ GetMaxResults()126 inline int GetMaxResults() const{ return m_maxResults; } 127 128 /** 129 * <p> The maximum number of results to return on each page. The default is 130 * 100.</p> 131 */ MaxResultsHasBeenSet()132 inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } 133 134 /** 135 * <p> The maximum number of results to return on each page. The default is 136 * 100.</p> 137 */ SetMaxResults(int value)138 inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } 139 140 /** 141 * <p> The maximum number of results to return on each page. The default is 142 * 100.</p> 143 */ WithMaxResults(int value)144 inline ListEntityRecognizersRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} 145 146 private: 147 148 EntityRecognizerFilter m_filter; 149 bool m_filterHasBeenSet; 150 151 Aws::String m_nextToken; 152 bool m_nextTokenHasBeenSet; 153 154 int m_maxResults; 155 bool m_maxResultsHasBeenSet; 156 }; 157 158 } // namespace Model 159 } // namespace Comprehend 160 } // namespace Aws 161