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)
Safe Haskell	None
Language	Haskell2010

Network.Google.Resource.YouTube.LiveStreams.Update

Contents

REST Resource
Creating a Request
Request Lenses

Description

Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.

See: YouTube Data API Reference for youtube.liveStreams.update.

Synopsis

type LiveStreamsUpdateResource = "youtube" :> ("v3" :> ("liveStreams" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LiveStream :> Put '[JSON] LiveStream)))))))
liveStreamsUpdate :: Text -> LiveStream -> LiveStreamsUpdate
data LiveStreamsUpdate
lsuPart :: Lens' LiveStreamsUpdate Text
lsuPayload :: Lens' LiveStreamsUpdate LiveStream
lsuOnBehalfOfContentOwner :: Lens' LiveStreamsUpdate (Maybe Text)
lsuOnBehalfOfContentOwnerChannel :: Lens' LiveStreamsUpdate (Maybe Text)

REST Resource

type LiveStreamsUpdateResource = "youtube" :> ("v3" :> ("liveStreams" :> (QueryParam "part" Text :> (QueryParam "onBehalfOfContentOwner" Text :> (QueryParam "onBehalfOfContentOwnerChannel" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] LiveStream :> Put '[JSON] LiveStream))))))) Source #

A resource alias for youtube.liveStreams.update method which the LiveStreamsUpdate request conforms to.

Creating a Request

liveStreamsUpdate Source #

Arguments

:: Text	`lsuPart`
-> LiveStream	`lsuPayload`
-> LiveStreamsUpdate

Creates a value of LiveStreamsUpdate with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data LiveStreamsUpdate Source #

Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings.

See: liveStreamsUpdate smart constructor.

Instances

Eq LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update Methods (==) :: LiveStreamsUpdate -> LiveStreamsUpdate -> Bool # (/=) :: LiveStreamsUpdate -> LiveStreamsUpdate -> Bool #
Data LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> LiveStreamsUpdate -> c LiveStreamsUpdate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c LiveStreamsUpdate # toConstr :: LiveStreamsUpdate -> Constr # dataTypeOf :: LiveStreamsUpdate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c LiveStreamsUpdate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c LiveStreamsUpdate) # gmapT :: (forall b. Data b => b -> b) -> LiveStreamsUpdate -> LiveStreamsUpdate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> LiveStreamsUpdate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> LiveStreamsUpdate -> r # gmapQ :: (forall d. Data d => d -> u) -> LiveStreamsUpdate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> LiveStreamsUpdate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> LiveStreamsUpdate -> m LiveStreamsUpdate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> LiveStreamsUpdate -> m LiveStreamsUpdate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> LiveStreamsUpdate -> m LiveStreamsUpdate #
Show LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update Methods showsPrec :: Int -> LiveStreamsUpdate -> ShowS # show :: LiveStreamsUpdate -> String # showList :: [LiveStreamsUpdate] -> ShowS #
Generic LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update Associated Types type Rep LiveStreamsUpdate :: Type -> Type # Methods from :: LiveStreamsUpdate -> Rep LiveStreamsUpdate x # to :: Rep LiveStreamsUpdate x -> LiveStreamsUpdate #
GoogleRequest LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update Associated Types type Rs LiveStreamsUpdate :: Type # type Scopes LiveStreamsUpdate :: [Symbol] # Methods requestClient :: LiveStreamsUpdate -> GClient (Rs LiveStreamsUpdate) #
type Rep LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update type Rep LiveStreamsUpdate = D1 (MetaData "LiveStreamsUpdate" "Network.Google.Resource.YouTube.LiveStreams.Update" "gogol-youtube-0.4.0-ICfv3TXlvc9ZGnb0rCY6m" False) (C1 (MetaCons "LiveStreamsUpdate'" PrefixI True) ((S1 (MetaSel (Just "_lsuPart") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_lsuPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 LiveStream)) :: (S1 (MetaSel (Just "_lsuOnBehalfOfContentOwner") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_lsuOnBehalfOfContentOwnerChannel") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))
type Scopes LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update type Scopes LiveStreamsUpdate = "https://www.googleapis.com/auth/youtube" ': ("https://www.googleapis.com/auth/youtube.force-ssl" ': ([] :: [Symbol]))
type Rs LiveStreamsUpdate Source #
Instance details Defined in Network.Google.Resource.YouTube.LiveStreams.Update type Rs LiveStreamsUpdate = LiveStream

Request Lenses

lsuPart :: Lens' LiveStreamsUpdate Text Source #

The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. The part properties that you can include in the parameter value are id, snippet, cdn, and status. Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. If the request body does not specify a value for a mutable property, the existing value for that property will be removed.

lsuPayload :: Lens' LiveStreamsUpdate LiveStream Source #

Multipart request metadata.

lsuOnBehalfOfContentOwner :: Lens' LiveStreamsUpdate (Maybe Text) Source #

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.

lsuOnBehalfOfContentOwnerChannel :: Lens' LiveStreamsUpdate (Maybe Text) Source #

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.