411 lines
13 KiB
C++
411 lines
13 KiB
C++
/**
|
|
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
|
|
* SPDX-License-Identifier: Apache-2.0.
|
|
*/
|
|
|
|
#pragma once
|
|
#include <aws/kinesisvideo/KinesisVideo_EXPORTS.h>
|
|
#include <aws/core/utils/memory/stl/AWSString.h>
|
|
#include <aws/kinesisvideo/model/Status.h>
|
|
#include <aws/core/utils/DateTime.h>
|
|
#include <utility>
|
|
|
|
namespace Aws
|
|
{
|
|
namespace Utils
|
|
{
|
|
namespace Json
|
|
{
|
|
class JsonValue;
|
|
class JsonView;
|
|
} // namespace Json
|
|
} // namespace Utils
|
|
namespace KinesisVideo
|
|
{
|
|
namespace Model
|
|
{
|
|
|
|
/**
|
|
* <p>An object describing a Kinesis video stream.</p><p><h3>See Also:</h3> <a
|
|
* href="http://docs.aws.amazon.com/goto/WebAPI/kinesisvideo-2017-09-30/StreamInfo">AWS
|
|
* API Reference</a></p>
|
|
*/
|
|
class AWS_KINESISVIDEO_API StreamInfo
|
|
{
|
|
public:
|
|
StreamInfo();
|
|
StreamInfo(Aws::Utils::Json::JsonView jsonValue);
|
|
StreamInfo& operator=(Aws::Utils::Json::JsonView jsonValue);
|
|
Aws::Utils::Json::JsonValue Jsonize() const;
|
|
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline const Aws::String& GetDeviceName() const{ return m_deviceName; }
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline bool DeviceNameHasBeenSet() const { return m_deviceNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline void SetDeviceName(const Aws::String& value) { m_deviceNameHasBeenSet = true; m_deviceName = value; }
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline void SetDeviceName(Aws::String&& value) { m_deviceNameHasBeenSet = true; m_deviceName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline void SetDeviceName(const char* value) { m_deviceNameHasBeenSet = true; m_deviceName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithDeviceName(const Aws::String& value) { SetDeviceName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithDeviceName(Aws::String&& value) { SetDeviceName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the device that is associated with the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithDeviceName(const char* value) { SetDeviceName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline const Aws::String& GetStreamName() const{ return m_streamName; }
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; }
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); }
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); }
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The name of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamName(const char* value) { SetStreamName(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline const Aws::String& GetStreamARN() const{ return m_streamARN; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline bool StreamARNHasBeenSet() const { return m_streamARNHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline void SetStreamARN(const Aws::String& value) { m_streamARNHasBeenSet = true; m_streamARN = value; }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline void SetStreamARN(Aws::String&& value) { m_streamARNHasBeenSet = true; m_streamARN = std::move(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline void SetStreamARN(const char* value) { m_streamARNHasBeenSet = true; m_streamARN.assign(value); }
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamARN(const Aws::String& value) { SetStreamARN(value); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamARN(Aws::String&& value) { SetStreamARN(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The Amazon Resource Name (ARN) of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStreamARN(const char* value) { SetStreamARN(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline const Aws::String& GetMediaType() const{ return m_mediaType; }
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline bool MediaTypeHasBeenSet() const { return m_mediaTypeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline void SetMediaType(const Aws::String& value) { m_mediaTypeHasBeenSet = true; m_mediaType = value; }
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline void SetMediaType(Aws::String&& value) { m_mediaTypeHasBeenSet = true; m_mediaType = std::move(value); }
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline void SetMediaType(const char* value) { m_mediaTypeHasBeenSet = true; m_mediaType.assign(value); }
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline StreamInfo& WithMediaType(const Aws::String& value) { SetMediaType(value); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline StreamInfo& WithMediaType(Aws::String&& value) { SetMediaType(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The <code>MediaType</code> of the stream. </p>
|
|
*/
|
|
inline StreamInfo& WithMediaType(const char* value) { SetMediaType(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline const Aws::String& GetKmsKeyId() const{ return m_kmsKeyId; }
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline bool KmsKeyIdHasBeenSet() const { return m_kmsKeyIdHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline void SetKmsKeyId(const Aws::String& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = value; }
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline void SetKmsKeyId(Aws::String&& value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId = std::move(value); }
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline void SetKmsKeyId(const char* value) { m_kmsKeyIdHasBeenSet = true; m_kmsKeyId.assign(value); }
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithKmsKeyId(const Aws::String& value) { SetKmsKeyId(value); return *this;}
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithKmsKeyId(Aws::String&& value) { SetKmsKeyId(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The ID of the AWS Key Management Service (AWS KMS) key that Kinesis Video
|
|
* Streams uses to encrypt data on the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithKmsKeyId(const char* value) { SetKmsKeyId(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline const Aws::String& GetVersion() const{ return m_version; }
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline bool VersionHasBeenSet() const { return m_versionHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline void SetVersion(const Aws::String& value) { m_versionHasBeenSet = true; m_version = value; }
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline void SetVersion(Aws::String&& value) { m_versionHasBeenSet = true; m_version = std::move(value); }
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline void SetVersion(const char* value) { m_versionHasBeenSet = true; m_version.assign(value); }
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithVersion(const Aws::String& value) { SetVersion(value); return *this;}
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithVersion(Aws::String&& value) { SetVersion(std::move(value)); return *this;}
|
|
|
|
/**
|
|
* <p>The version of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithVersion(const char* value) { SetVersion(value); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline const Status& GetStatus() const{ return m_status; }
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; }
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline void SetStatus(const Status& value) { m_statusHasBeenSet = true; m_status = value; }
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline void SetStatus(Status&& value) { m_statusHasBeenSet = true; m_status = std::move(value); }
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStatus(const Status& value) { SetStatus(value); return *this;}
|
|
|
|
/**
|
|
* <p>The status of the stream.</p>
|
|
*/
|
|
inline StreamInfo& WithStatus(Status&& value) { SetStatus(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; }
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; }
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; }
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); }
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline StreamInfo& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;}
|
|
|
|
/**
|
|
* <p>A time stamp that indicates when the stream was created.</p>
|
|
*/
|
|
inline StreamInfo& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;}
|
|
|
|
|
|
/**
|
|
* <p>How long the stream retains data, in hours.</p>
|
|
*/
|
|
inline int GetDataRetentionInHours() const{ return m_dataRetentionInHours; }
|
|
|
|
/**
|
|
* <p>How long the stream retains data, in hours.</p>
|
|
*/
|
|
inline bool DataRetentionInHoursHasBeenSet() const { return m_dataRetentionInHoursHasBeenSet; }
|
|
|
|
/**
|
|
* <p>How long the stream retains data, in hours.</p>
|
|
*/
|
|
inline void SetDataRetentionInHours(int value) { m_dataRetentionInHoursHasBeenSet = true; m_dataRetentionInHours = value; }
|
|
|
|
/**
|
|
* <p>How long the stream retains data, in hours.</p>
|
|
*/
|
|
inline StreamInfo& WithDataRetentionInHours(int value) { SetDataRetentionInHours(value); return *this;}
|
|
|
|
private:
|
|
|
|
Aws::String m_deviceName;
|
|
bool m_deviceNameHasBeenSet;
|
|
|
|
Aws::String m_streamName;
|
|
bool m_streamNameHasBeenSet;
|
|
|
|
Aws::String m_streamARN;
|
|
bool m_streamARNHasBeenSet;
|
|
|
|
Aws::String m_mediaType;
|
|
bool m_mediaTypeHasBeenSet;
|
|
|
|
Aws::String m_kmsKeyId;
|
|
bool m_kmsKeyIdHasBeenSet;
|
|
|
|
Aws::String m_version;
|
|
bool m_versionHasBeenSet;
|
|
|
|
Status m_status;
|
|
bool m_statusHasBeenSet;
|
|
|
|
Aws::Utils::DateTime m_creationTime;
|
|
bool m_creationTimeHasBeenSet;
|
|
|
|
int m_dataRetentionInHours;
|
|
bool m_dataRetentionInHoursHasBeenSet;
|
|
};
|
|
|
|
} // namespace Model
|
|
} // namespace KinesisVideo
|
|
} // namespace Aws
|