/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the kinesisvideo-2017-09-30.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.KinesisVideo.Model
{
///
/// Container for the parameters to the GetSignalingChannelEndpoint operation.
/// Provides an endpoint for the specified signaling channel to send and receive messages.
/// This API uses the SingleMasterChannelEndpointConfiguration
input parameter,
/// which consists of the Protocols
and Role
properties.
///
///
///
/// Protocols
is used to determine the communication mechanism. For example,
/// if you specify WSS
as the protocol, this API produces a secure websocket
/// endpoint. If you specify HTTPS
as the protocol, this API generates an
/// HTTPS endpoint.
///
///
///
/// Role
determines the messaging permissions. A MASTER
role
/// results in this API generating an endpoint that a client can use to communicate with
/// any of the viewers on the channel. A VIEWER
role results in this API
/// generating an endpoint that a client can use to communicate only with a MASTER
.
///
///
///
public partial class GetSignalingChannelEndpointRequest : AmazonKinesisVideoRequest
{
private string _channelARN;
private SingleMasterChannelEndpointConfiguration _singleMasterChannelEndpointConfiguration;
///
/// Gets and sets the property ChannelARN.
///
/// The Amazon Resource Name (ARN) of the signalling channel for which you want to get
/// an endpoint.
///
///
[AWSProperty(Required=true, Min=1, Max=1024)]
public string ChannelARN
{
get { return this._channelARN; }
set { this._channelARN = value; }
}
// Check to see if ChannelARN property is set
internal bool IsSetChannelARN()
{
return this._channelARN != null;
}
///
/// Gets and sets the property SingleMasterChannelEndpointConfiguration.
///
/// A structure containing the endpoint configuration for the SINGLE_MASTER
/// channel type.
///
///
public SingleMasterChannelEndpointConfiguration SingleMasterChannelEndpointConfiguration
{
get { return this._singleMasterChannelEndpointConfiguration; }
set { this._singleMasterChannelEndpointConfiguration = value; }
}
// Check to see if SingleMasterChannelEndpointConfiguration property is set
internal bool IsSetSingleMasterChannelEndpointConfiguration()
{
return this._singleMasterChannelEndpointConfiguration != null;
}
}
}