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-kinesis/include/aws/kinesis/model/DescribeStreamConsumerRequest.h

206 lines
7.9 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/kinesis/Kinesis_EXPORTS.h>
#include <aws/kinesis/KinesisRequest.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <utility>
namespace Aws
{
namespace Kinesis
{
namespace Model
{
/**
*/
class AWS_KINESIS_API DescribeStreamConsumerRequest : public KinesisRequest
{
public:
DescribeStreamConsumerRequest();
// 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 "DescribeStreamConsumer"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline DescribeStreamConsumerRequest& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline DescribeStreamConsumerRequest& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
/**
* <p>The ARN of the Kinesis data stream that the consumer is registered with. For
* more information, see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html#arn-syntax-kinesis-streams">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline DescribeStreamConsumerRequest& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
/**
* <p>The name that you gave to the consumer.</p>
*/
inline const Aws::String& GetConsumerName() const{ return m_consumerName; }
/**
* <p>The name that you gave to the consumer.</p>
*/
inline bool ConsumerNameHasBeenSet() const { return m_consumerNameHasBeenSet; }
/**
* <p>The name that you gave to the consumer.</p>
*/
inline void SetConsumerName(const Aws::String& value) { m_consumerNameHasBeenSet = true; m_consumerName = value; }
/**
* <p>The name that you gave to the consumer.</p>
*/
inline void SetConsumerName(Aws::String&& value) { m_consumerNameHasBeenSet = true; m_consumerName = std::move(value); }
/**
* <p>The name that you gave to the consumer.</p>
*/
inline void SetConsumerName(const char* value) { m_consumerNameHasBeenSet = true; m_consumerName.assign(value); }
/**
* <p>The name that you gave to the consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerName(const Aws::String& value) { SetConsumerName(value); return *this;}
/**
* <p>The name that you gave to the consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerName(Aws::String&& value) { SetConsumerName(std::move(value)); return *this;}
/**
* <p>The name that you gave to the consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerName(const char* value) { SetConsumerName(value); return *this;}
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline const Aws::String& GetConsumerARN() const{ return m_consumerARN; }
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline bool ConsumerARNHasBeenSet() const { return m_consumerARNHasBeenSet; }
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline void SetConsumerARN(const Aws::String& value) { m_consumerARNHasBeenSet = true; m_consumerARN = value; }
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline void SetConsumerARN(Aws::String&& value) { m_consumerARNHasBeenSet = true; m_consumerARN = std::move(value); }
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline void SetConsumerARN(const char* value) { m_consumerARNHasBeenSet = true; m_consumerARN.assign(value); }
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerARN(const Aws::String& value) { SetConsumerARN(value); return *this;}
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerARN(Aws::String&& value) { SetConsumerARN(std::move(value)); return *this;}
/**
* <p>The ARN returned by Kinesis Data Streams when you registered the
* consumer.</p>
*/
inline DescribeStreamConsumerRequest& WithConsumerARN(const char* value) { SetConsumerARN(value); return *this;}
private:
Aws::String m_streamARN;
bool m_streamARNHasBeenSet;
Aws::String m_consumerName;
bool m_consumerNameHasBeenSet;
Aws::String m_consumerARN;
bool m_consumerARNHasBeenSet;
};
} // namespace Model
} // namespace Kinesis
} // namespace Aws