{-# LANGUAGE DataKinds #-} {-# LANGUAGE DeriveDataTypeable #-} {-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE FlexibleInstances #-} {-# LANGUAGE NoImplicitPrelude #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE TypeOperators #-} {-# OPTIONS_GHC -fno-warn-duplicate-exports #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} -- | -- Module : Network.Google.Resource.YouTube.LiveBroadcasts.Bind -- Copyright : (c) 2015-2016 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay <brendan.g.hay@gmail.com> -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Binds a YouTube broadcast to a stream or removes an existing binding -- between a broadcast and a stream. A broadcast can only be bound to one -- video stream, though a video stream may be bound to more than one -- broadcast. -- -- /See:/ <https://developers.google.com/youtube/v3 YouTube Data API Reference> for @youtube.liveBroadcasts.bind@. module Network.Google.Resource.YouTube.LiveBroadcasts.Bind ( -- * REST Resource LiveBroadcastsBindResource -- * Creating a Request , liveBroadcastsBind , LiveBroadcastsBind -- * Request Lenses , lbbPart , lbbOnBehalfOfContentOwner , lbbOnBehalfOfContentOwnerChannel , lbbId , lbbStreamId ) where import Network.Google.Prelude import Network.Google.YouTube.Types -- | A resource alias for @youtube.liveBroadcasts.bind@ method which the -- 'LiveBroadcastsBind' request conforms to. type LiveBroadcastsBindResource = "youtube" :> "v3" :> "liveBroadcasts" :> "bind" :> QueryParam "id" Text :> QueryParam "part" Text :> QueryParam "onBehalfOfContentOwner" Text :> QueryParam "onBehalfOfContentOwnerChannel" Text :> QueryParam "streamId" Text :> QueryParam "alt" AltJSON :> Post '[JSON] LiveBroadcast -- | Binds a YouTube broadcast to a stream or removes an existing binding -- between a broadcast and a stream. A broadcast can only be bound to one -- video stream, though a video stream may be bound to more than one -- broadcast. -- -- /See:/ 'liveBroadcastsBind' smart constructor. data LiveBroadcastsBind = LiveBroadcastsBind' { _lbbPart :: !Text , _lbbOnBehalfOfContentOwner :: !(Maybe Text) , _lbbOnBehalfOfContentOwnerChannel :: !(Maybe Text) , _lbbId :: !Text , _lbbStreamId :: !(Maybe Text) } deriving (Eq,Show,Data,Typeable,Generic) -- | Creates a value of 'LiveBroadcastsBind' with the minimum fields required to make a request. -- -- Use one of the following lenses to modify other fields as desired: -- -- * 'lbbPart' -- -- * 'lbbOnBehalfOfContentOwner' -- -- * 'lbbOnBehalfOfContentOwnerChannel' -- -- * 'lbbId' -- -- * 'lbbStreamId' liveBroadcastsBind :: Text -- ^ 'lbbPart' -> Text -- ^ 'lbbId' -> LiveBroadcastsBind liveBroadcastsBind pLbbPart_ pLbbId_ = LiveBroadcastsBind' { _lbbPart = pLbbPart_ , _lbbOnBehalfOfContentOwner = Nothing , _lbbOnBehalfOfContentOwnerChannel = Nothing , _lbbId = pLbbId_ , _lbbStreamId = Nothing } -- | The part parameter specifies a comma-separated list of one or more -- liveBroadcast resource properties that the API response will include. -- The part names that you can include in the parameter value are id, -- snippet, contentDetails, and status. lbbPart :: Lens' LiveBroadcastsBind Text lbbPart = lens _lbbPart (\ s a -> s{_lbbPart = a}) -- | Note: This parameter is intended exclusively for YouTube content -- partners. The onBehalfOfContentOwner parameter indicates that the -- request\'s authorization credentials identify a YouTube CMS user who is -- acting on behalf of the content owner specified in the parameter value. -- This parameter is intended for YouTube content partners that own and -- manage many different YouTube channels. It allows content owners to -- authenticate once and get access to all their video and channel data, -- without having to provide authentication credentials for each individual -- channel. The CMS account that the user authenticates with must be linked -- to the specified YouTube content owner. lbbOnBehalfOfContentOwner :: Lens' LiveBroadcastsBind (Maybe Text) lbbOnBehalfOfContentOwner = lens _lbbOnBehalfOfContentOwner (\ s a -> s{_lbbOnBehalfOfContentOwner = a}) -- | This parameter can only be used in a properly authorized request. Note: -- This parameter is intended exclusively for YouTube content partners. The -- onBehalfOfContentOwnerChannel parameter specifies the YouTube channel ID -- of the channel to which a video is being added. This parameter is -- required when a request specifies a value for the onBehalfOfContentOwner -- parameter, and it can only be used in conjunction with that parameter. -- In addition, the request must be authorized using a CMS account that is -- linked to the content owner that the onBehalfOfContentOwner parameter -- specifies. Finally, the channel that the onBehalfOfContentOwnerChannel -- parameter value specifies must be linked to the content owner that the -- onBehalfOfContentOwner parameter specifies. This parameter is intended -- for YouTube content partners that own and manage many different YouTube -- channels. It allows content owners to authenticate once and perform -- actions on behalf of the channel specified in the parameter value, -- without having to provide authentication credentials for each separate -- channel. lbbOnBehalfOfContentOwnerChannel :: Lens' LiveBroadcastsBind (Maybe Text) lbbOnBehalfOfContentOwnerChannel = lens _lbbOnBehalfOfContentOwnerChannel (\ s a -> s{_lbbOnBehalfOfContentOwnerChannel = a}) -- | The id parameter specifies the unique ID of the broadcast that is being -- bound to a video stream. lbbId :: Lens' LiveBroadcastsBind Text lbbId = lens _lbbId (\ s a -> s{_lbbId = a}) -- | The streamId parameter specifies the unique ID of the video stream that -- is being bound to a broadcast. If this parameter is omitted, the API -- will remove any existing binding between the broadcast and a video -- stream. lbbStreamId :: Lens' LiveBroadcastsBind (Maybe Text) lbbStreamId = lens _lbbStreamId (\ s a -> s{_lbbStreamId = a}) instance GoogleRequest LiveBroadcastsBind where type Rs LiveBroadcastsBind = LiveBroadcast type Scopes LiveBroadcastsBind = '["https://www.googleapis.com/auth/youtube", "https://www.googleapis.com/auth/youtube.force-ssl"] requestClient LiveBroadcastsBind'{..} = go (Just _lbbId) (Just _lbbPart) _lbbOnBehalfOfContentOwner _lbbOnBehalfOfContentOwnerChannel _lbbStreamId (Just AltJSON) youTubeService where go = buildClient (Proxy :: Proxy LiveBroadcastsBindResource) mempty