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.VideoIntelligence.Videos.Annotate

Contents

REST Resource
Creating a Request
Request Lenses

Description

Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results).

See: Cloud Video Intelligence API Reference for videointelligence.videos.annotate.

Synopsis

type VideosAnnotateResource = "v1p1beta1" :> ("videos:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest :> Post '[JSON] GoogleLongrunning_Operation))))))))
videosAnnotate :: GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest -> VideosAnnotate
data VideosAnnotate
vaXgafv :: Lens' VideosAnnotate (Maybe Xgafv)
vaUploadProtocol :: Lens' VideosAnnotate (Maybe Text)
vaAccessToken :: Lens' VideosAnnotate (Maybe Text)
vaUploadType :: Lens' VideosAnnotate (Maybe Text)
vaPayload :: Lens' VideosAnnotate GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest
vaCallback :: Lens' VideosAnnotate (Maybe Text)

REST Resource

type VideosAnnotateResource = "v1p1beta1" :> ("videos:annotate" :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest :> Post '[JSON] GoogleLongrunning_Operation)))))))) Source #

A resource alias for videointelligence.videos.annotate method which the VideosAnnotate request conforms to.

Creating a Request

videosAnnotate Source #

Arguments

:: GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest	`vaPayload`
-> VideosAnnotate

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

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

data VideosAnnotate Source #

Performs asynchronous video annotation. Progress and results can be retrieved through the `google.longrunning.Operations` interface. `Operation.metadata` contains `AnnotateVideoProgress` (progress). `Operation.response` contains `AnnotateVideoResponse` (results).

See: videosAnnotate smart constructor.

Instances

Eq VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate Methods (==) :: VideosAnnotate -> VideosAnnotate -> Bool # (/=) :: VideosAnnotate -> VideosAnnotate -> Bool #
Data VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> VideosAnnotate -> c VideosAnnotate # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c VideosAnnotate # toConstr :: VideosAnnotate -> Constr # dataTypeOf :: VideosAnnotate -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c VideosAnnotate) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c VideosAnnotate) # gmapT :: (forall b. Data b => b -> b) -> VideosAnnotate -> VideosAnnotate # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> VideosAnnotate -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> VideosAnnotate -> r # gmapQ :: (forall d. Data d => d -> u) -> VideosAnnotate -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> VideosAnnotate -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> VideosAnnotate -> m VideosAnnotate # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> VideosAnnotate -> m VideosAnnotate # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> VideosAnnotate -> m VideosAnnotate #
Show VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate Methods showsPrec :: Int -> VideosAnnotate -> ShowS # show :: VideosAnnotate -> String # showList :: [VideosAnnotate] -> ShowS #
Generic VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate Associated Types type Rep VideosAnnotate :: Type -> Type # Methods from :: VideosAnnotate -> Rep VideosAnnotate x # to :: Rep VideosAnnotate x -> VideosAnnotate #
GoogleRequest VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate Associated Types type Rs VideosAnnotate :: Type # type Scopes VideosAnnotate :: [Symbol] # Methods requestClient :: VideosAnnotate -> GClient (Rs VideosAnnotate) #
type Rep VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate type Rep VideosAnnotate = D1 (MetaData "VideosAnnotate" "Network.Google.Resource.VideoIntelligence.Videos.Annotate" "gogol-videointelligence-0.4.0-33YwUF2oXgzGsYmP62p2e3" False) (C1 (MetaCons "VideosAnnotate'" PrefixI True) ((S1 (MetaSel (Just "_vaXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_vaUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_vaAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 (MetaSel (Just "_vaUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: (S1 (MetaSel (Just "_vaPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest) :*: S1 (MetaSel (Just "_vaCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate type Scopes VideosAnnotate = "https://www.googleapis.com/auth/cloud-platform" ': ([] :: [Symbol])
type Rs VideosAnnotate Source #
Instance details Defined in Network.Google.Resource.VideoIntelligence.Videos.Annotate type Rs VideosAnnotate = GoogleLongrunning_Operation

Request Lenses

vaXgafv :: Lens' VideosAnnotate (Maybe Xgafv) Source #

V1 error format.

vaUploadProtocol :: Lens' VideosAnnotate (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

vaAccessToken :: Lens' VideosAnnotate (Maybe Text) Source #

OAuth access token.

vaUploadType :: Lens' VideosAnnotate (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

vaPayload :: Lens' VideosAnnotate GoogleCloudVideointelligenceV1p1beta1_AnnotateVideoRequest Source #

Multipart request metadata.

vaCallback :: Lens' VideosAnnotate (Maybe Text) Source #

JSONP