/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SQS { namespace Model { /** *

See Also:

AWS * API Reference

*/ class ListQueuesRequest : public SQSRequest { public: AWS_SQS_API ListQueuesRequest(); // 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 "ListQueues"; } AWS_SQS_API Aws::String SerializePayload() const override; protected: AWS_SQS_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline const Aws::String& GetQueueNamePrefix() const{ return m_queueNamePrefix; } /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline bool QueueNamePrefixHasBeenSet() const { return m_queueNamePrefixHasBeenSet; } /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline void SetQueueNamePrefix(const Aws::String& value) { m_queueNamePrefixHasBeenSet = true; m_queueNamePrefix = value; } /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline void SetQueueNamePrefix(Aws::String&& value) { m_queueNamePrefixHasBeenSet = true; m_queueNamePrefix = std::move(value); } /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline void SetQueueNamePrefix(const char* value) { m_queueNamePrefixHasBeenSet = true; m_queueNamePrefix.assign(value); } /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline ListQueuesRequest& WithQueueNamePrefix(const Aws::String& value) { SetQueueNamePrefix(value); return *this;} /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline ListQueuesRequest& WithQueueNamePrefix(Aws::String&& value) { SetQueueNamePrefix(std::move(value)); return *this;} /** *

A string to use for filtering the list results. Only those queues whose name * begins with the specified string are returned.

Queue URLs and names are * case-sensitive.

*/ inline ListQueuesRequest& WithQueueNamePrefix(const char* value) { SetQueueNamePrefix(value); return *this;} /** *

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Pagination token to request the next set of results.

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

Maximum number of results to include in the response. Value range is 1 to * 1000. You must set MaxResults to receive a value for * NextToken in the response.

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

Maximum number of results to include in the response. Value range is 1 to * 1000. You must set MaxResults to receive a value for * NextToken in the response.

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

Maximum number of results to include in the response. Value range is 1 to * 1000. You must set MaxResults to receive a value for * NextToken in the response.

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

Maximum number of results to include in the response. Value range is 1 to * 1000. You must set MaxResults to receive a value for * NextToken in the response.

*/ inline ListQueuesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} private: Aws::String m_queueNamePrefix; bool m_queueNamePrefixHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; }; } // namespace Model } // namespace SQS } // namespace Aws