/** * 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 ivsrealtime { namespace Model { /** *

Object specifying a participant token in a stage.

See Also:

* AWS * API Reference

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

Application-provided attributes to encode into the token and attach to a * stage. 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 token and attach to a * stage. 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 token and attach to a * stage. 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 token and attach to a * stage. 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

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

Application-provided attributes to encode into the token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

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

Application-provided attributes to encode into the token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 token and attach to a * stage. This field is exposed to all stage participants and should not be used * for personally identifying, confidential, or sensitive information.

*/ inline ParticipantToken& 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 ParticipantToken& WithCapabilities(const Aws::Vector& value) { SetCapabilities(value); return *this;} /** *

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

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

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

*/ inline ParticipantToken& 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 ParticipantToken& AddCapabilities(ParticipantTokenCapability&& value) { m_capabilitiesHasBeenSet = true; m_capabilities.push_back(std::move(value)); return *this; } /** *

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

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

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

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

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

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

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

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

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline const Aws::Utils::DateTime& GetExpirationTime() const{ return m_expirationTime; } /** *

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline bool ExpirationTimeHasBeenSet() const { return m_expirationTimeHasBeenSet; } /** *

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline void SetExpirationTime(const Aws::Utils::DateTime& value) { m_expirationTimeHasBeenSet = true; m_expirationTime = value; } /** *

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline void SetExpirationTime(Aws::Utils::DateTime&& value) { m_expirationTimeHasBeenSet = true; m_expirationTime = std::move(value); } /** *

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline ParticipantToken& WithExpirationTime(const Aws::Utils::DateTime& value) { SetExpirationTime(value); return *this;} /** *

ISO 8601 timestamp (returned as a string) for when this token expires.

*/ inline ParticipantToken& WithExpirationTime(Aws::Utils::DateTime&& value) { SetExpirationTime(std::move(value)); return *this;} /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline const Aws::String& GetParticipantId() const{ return m_participantId; } /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline bool ParticipantIdHasBeenSet() const { return m_participantIdHasBeenSet; } /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline void SetParticipantId(const Aws::String& value) { m_participantIdHasBeenSet = true; m_participantId = value; } /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline void SetParticipantId(Aws::String&& value) { m_participantIdHasBeenSet = true; m_participantId = std::move(value); } /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline void SetParticipantId(const char* value) { m_participantIdHasBeenSet = true; m_participantId.assign(value); } /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline ParticipantToken& WithParticipantId(const Aws::String& value) { SetParticipantId(value); return *this;} /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline ParticipantToken& WithParticipantId(Aws::String&& value) { SetParticipantId(std::move(value)); return *this;} /** *

Unique identifier for this participant token, assigned by IVS.

*/ inline ParticipantToken& WithParticipantId(const char* value) { SetParticipantId(value); return *this;} /** *

The issued client token, encrypted.

*/ inline const Aws::String& GetToken() const{ return m_token; } /** *

The issued client token, encrypted.

*/ inline bool TokenHasBeenSet() const { return m_tokenHasBeenSet; } /** *

The issued client token, encrypted.

*/ inline void SetToken(const Aws::String& value) { m_tokenHasBeenSet = true; m_token = value; } /** *

The issued client token, encrypted.

*/ inline void SetToken(Aws::String&& value) { m_tokenHasBeenSet = true; m_token = std::move(value); } /** *

The issued client token, encrypted.

*/ inline void SetToken(const char* value) { m_tokenHasBeenSet = true; m_token.assign(value); } /** *

The issued client token, encrypted.

*/ inline ParticipantToken& WithToken(const Aws::String& value) { SetToken(value); return *this;} /** *

The issued client token, encrypted.

*/ inline ParticipantToken& WithToken(Aws::String&& value) { SetToken(std::move(value)); return *this;} /** *

The issued client token, encrypted.

*/ inline ParticipantToken& WithToken(const char* value) { SetToken(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 ParticipantToken& 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 ParticipantToken& 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 ParticipantToken& 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::Utils::DateTime m_expirationTime; bool m_expirationTimeHasBeenSet = false; Aws::String m_participantId; bool m_participantIdHasBeenSet = false; Aws::String m_token; bool m_tokenHasBeenSet = false; Aws::String m_userId; bool m_userIdHasBeenSet = false; }; } // namespace Model } // namespace ivsrealtime } // namespace Aws