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

Object specifying a participant token configuration in a stage.

See * Also:

AWS * API Reference

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

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline const Aws::Map& GetAttributes() const{ return m_attributes; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline bool AttributesHasBeenSet() const { return m_attributesHasBeenSet; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline void SetAttributes(const Aws::Map& value) { m_attributesHasBeenSet = true; m_attributes = value; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline void SetAttributes(Aws::Map&& value) { m_attributesHasBeenSet = true; m_attributes = std::move(value); } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& WithAttributes(const Aws::Map& value) { SetAttributes(value); return *this;} /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& WithAttributes(Aws::Map&& value) { SetAttributes(std::move(value)); return *this;} /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(const Aws::String& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(Aws::String&& key, const Aws::String& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(const Aws::String& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(Aws::String&& key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), std::move(value)); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(const char* key, Aws::String&& value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, std::move(value)); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(Aws::String&& key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(std::move(key), value); return *this; } /** *

Application-provided attributes to encode into the corresponding participant * token and attach to a stage. Map keys and values can contain UTF-8 encoded text. * The maximum length of this field is 1 KB total. This field is exposed to all * stage participants and should not be used for personally identifying, * confidential, or sensitive information.

*/ inline ParticipantTokenConfiguration& AddAttributes(const char* key, const char* value) { m_attributesHasBeenSet = true; m_attributes.emplace(key, value); return *this; } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline const Aws::Vector& GetCapabilities() const{ return m_capabilities; } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline bool CapabilitiesHasBeenSet() const { return m_capabilitiesHasBeenSet; } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline void SetCapabilities(const Aws::Vector& value) { m_capabilitiesHasBeenSet = true; m_capabilities = value; } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline void SetCapabilities(Aws::Vector&& value) { m_capabilitiesHasBeenSet = true; m_capabilities = std::move(value); } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline ParticipantTokenConfiguration& WithCapabilities(const Aws::Vector& value) { SetCapabilities(value); return *this;} /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline ParticipantTokenConfiguration& WithCapabilities(Aws::Vector&& value) { SetCapabilities(std::move(value)); return *this;} /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline ParticipantTokenConfiguration& AddCapabilities(const ParticipantTokenCapability& value) { m_capabilitiesHasBeenSet = true; m_capabilities.push_back(value); return *this; } /** *

Set of capabilities that the user is allowed to perform in the stage.

*/ inline ParticipantTokenConfiguration& AddCapabilities(ParticipantTokenCapability&& value) { m_capabilitiesHasBeenSet = true; m_capabilities.push_back(std::move(value)); return *this; } /** *

Duration (in minutes), after which the corresponding participant token * expires. Default: 720 (12 hours).

*/ inline int GetDuration() const{ return m_duration; } /** *

Duration (in minutes), after which the corresponding participant token * expires. Default: 720 (12 hours).

*/ inline bool DurationHasBeenSet() const { return m_durationHasBeenSet; } /** *

Duration (in minutes), after which the corresponding participant token * expires. Default: 720 (12 hours).

*/ inline void SetDuration(int value) { m_durationHasBeenSet = true; m_duration = value; } /** *

Duration (in minutes), after which the corresponding participant token * expires. Default: 720 (12 hours).

*/ inline ParticipantTokenConfiguration& WithDuration(int value) { SetDuration(value); return *this;} /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline const Aws::String& GetUserId() const{ return m_userId; } /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline bool UserIdHasBeenSet() const { return m_userIdHasBeenSet; } /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline void SetUserId(const Aws::String& value) { m_userIdHasBeenSet = true; m_userId = value; } /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline void SetUserId(Aws::String&& value) { m_userIdHasBeenSet = true; m_userId = std::move(value); } /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline void SetUserId(const char* value) { m_userIdHasBeenSet = true; m_userId.assign(value); } /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline ParticipantTokenConfiguration& WithUserId(const Aws::String& value) { SetUserId(value); return *this;} /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline ParticipantTokenConfiguration& WithUserId(Aws::String&& value) { SetUserId(std::move(value)); return *this;} /** *

Customer-assigned name to help identify the token; this can be used to link a * participant to a user in the customer’s own systems. This can be any UTF-8 * encoded text. This field is exposed to all stage participants and should not * be used for personally identifying, confidential, or sensitive information. *

*/ inline ParticipantTokenConfiguration& WithUserId(const char* value) { SetUserId(value); return *this;} private: Aws::Map m_attributes; bool m_attributesHasBeenSet = false; Aws::Vector m_capabilities; bool m_capabilitiesHasBeenSet = false; int m_duration; bool m_durationHasBeenSet = false; Aws::String m_userId; bool m_userIdHasBeenSet = false; }; } // namespace Model } // namespace ivsrealtime } // namespace Aws