/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace QLDB { namespace Model { /** *

Information about an Amazon QLDB journal stream, including the Amazon * Resource Name (ARN), stream name, creation time, current status, and the * parameters of the original stream creation request.

See Also:

* AWS * API Reference

*/ class JournalKinesisStreamDescription { public: AWS_QLDB_API JournalKinesisStreamDescription(); AWS_QLDB_API JournalKinesisStreamDescription(Aws::Utils::Json::JsonView jsonValue); AWS_QLDB_API JournalKinesisStreamDescription& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_QLDB_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The name of the ledger.

*/ inline const Aws::String& GetLedgerName() const{ return m_ledgerName; } /** *

The name of the ledger.

*/ inline bool LedgerNameHasBeenSet() const { return m_ledgerNameHasBeenSet; } /** *

The name of the ledger.

*/ inline void SetLedgerName(const Aws::String& value) { m_ledgerNameHasBeenSet = true; m_ledgerName = value; } /** *

The name of the ledger.

*/ inline void SetLedgerName(Aws::String&& value) { m_ledgerNameHasBeenSet = true; m_ledgerName = std::move(value); } /** *

The name of the ledger.

*/ inline void SetLedgerName(const char* value) { m_ledgerNameHasBeenSet = true; m_ledgerName.assign(value); } /** *

The name of the ledger.

*/ inline JournalKinesisStreamDescription& WithLedgerName(const Aws::String& value) { SetLedgerName(value); return *this;} /** *

The name of the ledger.

*/ inline JournalKinesisStreamDescription& WithLedgerName(Aws::String&& value) { SetLedgerName(std::move(value)); return *this;} /** *

The name of the ledger.

*/ inline JournalKinesisStreamDescription& WithLedgerName(const char* value) { SetLedgerName(value); return *this;} /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline const Aws::Utils::DateTime& GetCreationTime() const{ return m_creationTime; } /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline bool CreationTimeHasBeenSet() const { return m_creationTimeHasBeenSet; } /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline void SetCreationTime(const Aws::Utils::DateTime& value) { m_creationTimeHasBeenSet = true; m_creationTime = value; } /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline void SetCreationTime(Aws::Utils::DateTime&& value) { m_creationTimeHasBeenSet = true; m_creationTime = std::move(value); } /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline JournalKinesisStreamDescription& WithCreationTime(const Aws::Utils::DateTime& value) { SetCreationTime(value); return *this;} /** *

The date and time, in epoch time format, when the QLDB journal stream was * created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM * January 1, 1970 UTC.)

*/ inline JournalKinesisStreamDescription& WithCreationTime(Aws::Utils::DateTime&& value) { SetCreationTime(std::move(value)); return *this;} /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline const Aws::Utils::DateTime& GetInclusiveStartTime() const{ return m_inclusiveStartTime; } /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline bool InclusiveStartTimeHasBeenSet() const { return m_inclusiveStartTimeHasBeenSet; } /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline void SetInclusiveStartTime(const Aws::Utils::DateTime& value) { m_inclusiveStartTimeHasBeenSet = true; m_inclusiveStartTime = value; } /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline void SetInclusiveStartTime(Aws::Utils::DateTime&& value) { m_inclusiveStartTimeHasBeenSet = true; m_inclusiveStartTime = std::move(value); } /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline JournalKinesisStreamDescription& WithInclusiveStartTime(const Aws::Utils::DateTime& value) { SetInclusiveStartTime(value); return *this;} /** *

The inclusive start date and time from which to start streaming journal * data.

*/ inline JournalKinesisStreamDescription& WithInclusiveStartTime(Aws::Utils::DateTime&& value) { SetInclusiveStartTime(std::move(value)); return *this;} /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline const Aws::Utils::DateTime& GetExclusiveEndTime() const{ return m_exclusiveEndTime; } /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline bool ExclusiveEndTimeHasBeenSet() const { return m_exclusiveEndTimeHasBeenSet; } /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline void SetExclusiveEndTime(const Aws::Utils::DateTime& value) { m_exclusiveEndTimeHasBeenSet = true; m_exclusiveEndTime = value; } /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline void SetExclusiveEndTime(Aws::Utils::DateTime&& value) { m_exclusiveEndTimeHasBeenSet = true; m_exclusiveEndTime = std::move(value); } /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline JournalKinesisStreamDescription& WithExclusiveEndTime(const Aws::Utils::DateTime& value) { SetExclusiveEndTime(value); return *this;} /** *

The exclusive date and time that specifies when the stream ends. If this * parameter is undefined, the stream runs indefinitely until you cancel it.

*/ inline JournalKinesisStreamDescription& WithExclusiveEndTime(Aws::Utils::DateTime&& value) { SetExclusiveEndTime(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline const Aws::String& GetRoleArn() const{ return m_roleArn; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline bool RoleArnHasBeenSet() const { return m_roleArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline void SetRoleArn(const Aws::String& value) { m_roleArnHasBeenSet = true; m_roleArn = value; } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline void SetRoleArn(Aws::String&& value) { m_roleArnHasBeenSet = true; m_roleArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline void SetRoleArn(const char* value) { m_roleArnHasBeenSet = true; m_roleArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline JournalKinesisStreamDescription& WithRoleArn(const Aws::String& value) { SetRoleArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline JournalKinesisStreamDescription& WithRoleArn(Aws::String&& value) { SetRoleArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role that grants QLDB permissions * for a journal stream to write data records to a Kinesis Data Streams * resource.

*/ inline JournalKinesisStreamDescription& WithRoleArn(const char* value) { SetRoleArn(value); return *this;} /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline const Aws::String& GetStreamId() const{ return m_streamId; } /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline bool StreamIdHasBeenSet() const { return m_streamIdHasBeenSet; } /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline void SetStreamId(const Aws::String& value) { m_streamIdHasBeenSet = true; m_streamId = value; } /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline void SetStreamId(Aws::String&& value) { m_streamIdHasBeenSet = true; m_streamId = std::move(value); } /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline void SetStreamId(const char* value) { m_streamIdHasBeenSet = true; m_streamId.assign(value); } /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamId(const Aws::String& value) { SetStreamId(value); return *this;} /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamId(Aws::String&& value) { SetStreamId(std::move(value)); return *this;} /** *

The UUID (represented in Base62-encoded text) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamId(const char* value) { SetStreamId(value); return *this;} /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline const Aws::String& GetArn() const{ return m_arn; } /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline bool ArnHasBeenSet() const { return m_arnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline void SetArn(const Aws::String& value) { m_arnHasBeenSet = true; m_arn = value; } /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline void SetArn(Aws::String&& value) { m_arnHasBeenSet = true; m_arn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline void SetArn(const char* value) { m_arnHasBeenSet = true; m_arn.assign(value); } /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithArn(const Aws::String& value) { SetArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithArn(Aws::String&& value) { SetArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithArn(const char* value) { SetArn(value); return *this;} /** *

The current state of the QLDB journal stream.

*/ inline const StreamStatus& GetStatus() const{ return m_status; } /** *

The current state of the QLDB journal stream.

*/ inline bool StatusHasBeenSet() const { return m_statusHasBeenSet; } /** *

The current state of the QLDB journal stream.

*/ inline void SetStatus(const StreamStatus& value) { m_statusHasBeenSet = true; m_status = value; } /** *

The current state of the QLDB journal stream.

*/ inline void SetStatus(StreamStatus&& value) { m_statusHasBeenSet = true; m_status = std::move(value); } /** *

The current state of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStatus(const StreamStatus& value) { SetStatus(value); return *this;} /** *

The current state of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStatus(StreamStatus&& value) { SetStatus(std::move(value)); return *this;} /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline const KinesisConfiguration& GetKinesisConfiguration() const{ return m_kinesisConfiguration; } /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline bool KinesisConfigurationHasBeenSet() const { return m_kinesisConfigurationHasBeenSet; } /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline void SetKinesisConfiguration(const KinesisConfiguration& value) { m_kinesisConfigurationHasBeenSet = true; m_kinesisConfiguration = value; } /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline void SetKinesisConfiguration(KinesisConfiguration&& value) { m_kinesisConfigurationHasBeenSet = true; m_kinesisConfiguration = std::move(value); } /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithKinesisConfiguration(const KinesisConfiguration& value) { SetKinesisConfiguration(value); return *this;} /** *

The configuration settings of the Amazon Kinesis Data Streams destination for * a QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithKinesisConfiguration(KinesisConfiguration&& value) { SetKinesisConfiguration(std::move(value)); return *this;} /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline const ErrorCause& GetErrorCause() const{ return m_errorCause; } /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline bool ErrorCauseHasBeenSet() const { return m_errorCauseHasBeenSet; } /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline void SetErrorCause(const ErrorCause& value) { m_errorCauseHasBeenSet = true; m_errorCause = value; } /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline void SetErrorCause(ErrorCause&& value) { m_errorCauseHasBeenSet = true; m_errorCause = std::move(value); } /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline JournalKinesisStreamDescription& WithErrorCause(const ErrorCause& value) { SetErrorCause(value); return *this;} /** *

The error message that describes the reason that a stream has a status of * IMPAIRED or FAILED. This is not applicable to streams * that have other status values.

*/ inline JournalKinesisStreamDescription& WithErrorCause(ErrorCause&& value) { SetErrorCause(std::move(value)); return *this;} /** *

The user-defined name of the QLDB journal stream.

*/ inline const Aws::String& GetStreamName() const{ return m_streamName; } /** *

The user-defined name of the QLDB journal stream.

*/ inline bool StreamNameHasBeenSet() const { return m_streamNameHasBeenSet; } /** *

The user-defined name of the QLDB journal stream.

*/ inline void SetStreamName(const Aws::String& value) { m_streamNameHasBeenSet = true; m_streamName = value; } /** *

The user-defined name of the QLDB journal stream.

*/ inline void SetStreamName(Aws::String&& value) { m_streamNameHasBeenSet = true; m_streamName = std::move(value); } /** *

The user-defined name of the QLDB journal stream.

*/ inline void SetStreamName(const char* value) { m_streamNameHasBeenSet = true; m_streamName.assign(value); } /** *

The user-defined name of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamName(const Aws::String& value) { SetStreamName(value); return *this;} /** *

The user-defined name of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamName(Aws::String&& value) { SetStreamName(std::move(value)); return *this;} /** *

The user-defined name of the QLDB journal stream.

*/ inline JournalKinesisStreamDescription& WithStreamName(const char* value) { SetStreamName(value); return *this;} private: Aws::String m_ledgerName; bool m_ledgerNameHasBeenSet = false; Aws::Utils::DateTime m_creationTime; bool m_creationTimeHasBeenSet = false; Aws::Utils::DateTime m_inclusiveStartTime; bool m_inclusiveStartTimeHasBeenSet = false; Aws::Utils::DateTime m_exclusiveEndTime; bool m_exclusiveEndTimeHasBeenSet = false; Aws::String m_roleArn; bool m_roleArnHasBeenSet = false; Aws::String m_streamId; bool m_streamIdHasBeenSet = false; Aws::String m_arn; bool m_arnHasBeenSet = false; StreamStatus m_status; bool m_statusHasBeenSet = false; KinesisConfiguration m_kinesisConfiguration; bool m_kinesisConfigurationHasBeenSet = false; ErrorCause m_errorCause; bool m_errorCauseHasBeenSet = false; Aws::String m_streamName; bool m_streamNameHasBeenSet = false; }; } // namespace Model } // namespace QLDB } // namespace Aws