This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-synthetics/include/aws/synthetics/model/DescribeCanariesRequest.h

124 lines
4.6 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/synthetics/Synthetics_EXPORTS.h>
#include <aws/synthetics/SyntheticsRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Synthetics
{
namespace Model
{
/**
*/
class AWS_SYNTHETICS_API DescribeCanariesRequest : public SyntheticsRequest
{
public:
DescribeCanariesRequest();
// 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 "DescribeCanaries"; }
Aws::String SerializePayload() const override;
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline DescribeCanariesRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline DescribeCanariesRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
/**
* <p>A token that indicates that there is more data available. You can use this
* token in a subsequent operation to retrieve the next set of results.</p>
*/
inline DescribeCanariesRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
/**
* <p>Specify this parameter to limit how many canaries are returned each time you
* use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
* default of 100 is used.</p>
*/
inline int GetMaxResults() const{ return m_maxResults; }
/**
* <p>Specify this parameter to limit how many canaries are returned each time you
* use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
* default of 100 is used.</p>
*/
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
/**
* <p>Specify this parameter to limit how many canaries are returned each time you
* use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
* default of 100 is used.</p>
*/
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
/**
* <p>Specify this parameter to limit how many canaries are returned each time you
* use the <code>DescribeCanaries</code> operation. If you omit this parameter, the
* default of 100 is used.</p>
*/
inline DescribeCanariesRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
private:
Aws::String m_nextToken;
bool m_nextTokenHasBeenSet;
int m_maxResults;
bool m_maxResultsHasBeenSet;
};
} // namespace Model
} // namespace Synthetics
} // namespace Aws