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.Dataflow.Projects.Jobs.Snapshot

Contents

REST Resource
Creating a Request
Request Lenses

Description

Snapshot the state of a streaming job.

See: Dataflow API Reference for dataflow.projects.jobs.snapshot.

Synopsis

type ProjectsJobsSnapshotResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (CaptureMode "jobId" "snapshot" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SnapshotJobRequest :> Post '[JSON] Snapshot)))))))))))
projectsJobsSnapshot :: Text -> SnapshotJobRequest -> Text -> ProjectsJobsSnapshot
data ProjectsJobsSnapshot
pjsXgafv :: Lens' ProjectsJobsSnapshot (Maybe Xgafv)
pjsJobId :: Lens' ProjectsJobsSnapshot Text
pjsUploadProtocol :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsAccessToken :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsUploadType :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsPayload :: Lens' ProjectsJobsSnapshot SnapshotJobRequest
pjsProjectId :: Lens' ProjectsJobsSnapshot Text
pjsCallback :: Lens' ProjectsJobsSnapshot (Maybe Text)

REST Resource

type ProjectsJobsSnapshotResource = "v1b3" :> ("projects" :> (Capture "projectId" Text :> ("jobs" :> (CaptureMode "jobId" "snapshot" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] SnapshotJobRequest :> Post '[JSON] Snapshot))))))))))) Source #

A resource alias for dataflow.projects.jobs.snapshot method which the ProjectsJobsSnapshot request conforms to.

Creating a Request

projectsJobsSnapshot Source #

Arguments

:: Text	`pjsJobId`
-> SnapshotJobRequest	`pjsPayload`
-> Text	`pjsProjectId`
-> ProjectsJobsSnapshot

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

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

data ProjectsJobsSnapshot Source #

Snapshot the state of a streaming job.

See: projectsJobsSnapshot smart constructor.

Instances

Eq ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot Methods (==) :: ProjectsJobsSnapshot -> ProjectsJobsSnapshot -> Bool # (/=) :: ProjectsJobsSnapshot -> ProjectsJobsSnapshot -> Bool #
Data ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectsJobsSnapshot -> c ProjectsJobsSnapshot # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectsJobsSnapshot # toConstr :: ProjectsJobsSnapshot -> Constr # dataTypeOf :: ProjectsJobsSnapshot -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectsJobsSnapshot) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectsJobsSnapshot) # gmapT :: (forall b. Data b => b -> b) -> ProjectsJobsSnapshot -> ProjectsJobsSnapshot # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsJobsSnapshot -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectsJobsSnapshot -> r # gmapQ :: (forall d. Data d => d -> u) -> ProjectsJobsSnapshot -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectsJobsSnapshot -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectsJobsSnapshot -> m ProjectsJobsSnapshot # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsJobsSnapshot -> m ProjectsJobsSnapshot # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectsJobsSnapshot -> m ProjectsJobsSnapshot #
Show ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot Methods showsPrec :: Int -> ProjectsJobsSnapshot -> ShowS # show :: ProjectsJobsSnapshot -> String # showList :: [ProjectsJobsSnapshot] -> ShowS #
Generic ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot Associated Types type Rep ProjectsJobsSnapshot :: Type -> Type # Methods from :: ProjectsJobsSnapshot -> Rep ProjectsJobsSnapshot x # to :: Rep ProjectsJobsSnapshot x -> ProjectsJobsSnapshot #
GoogleRequest ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot Associated Types type Rs ProjectsJobsSnapshot :: Type # type Scopes ProjectsJobsSnapshot :: [Symbol] # Methods requestClient :: ProjectsJobsSnapshot -> GClient (Rs ProjectsJobsSnapshot) #
type Rep ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot type Rep ProjectsJobsSnapshot = D1 (MetaData "ProjectsJobsSnapshot" "Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot" "gogol-dataflow-0.4.0-3JQL14p7A16KlOtsdaG1RC" False) (C1 (MetaCons "ProjectsJobsSnapshot'" PrefixI True) (((S1 (MetaSel (Just "_pjsXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: S1 (MetaSel (Just "_pjsJobId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :: (S1 (MetaSel (Just "_pjsUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pjsAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_pjsUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_pjsPayload") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 SnapshotJobRequest)) :: (S1 (MetaSel (Just "_pjsProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_pjsCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot type Scopes ProjectsJobsSnapshot = "https://www.googleapis.com/auth/cloud-platform" ': ("https://www.googleapis.com/auth/compute" ': ("https://www.googleapis.com/auth/compute.readonly" ': ("https://www.googleapis.com/auth/userinfo.email" ': ([] :: [Symbol]))))
type Rs ProjectsJobsSnapshot Source #
Instance details Defined in Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot type Rs ProjectsJobsSnapshot = Snapshot

Request Lenses

pjsXgafv :: Lens' ProjectsJobsSnapshot (Maybe Xgafv) Source #

V1 error format.

pjsJobId :: Lens' ProjectsJobsSnapshot Text Source #

The job to be snapshotted.

pjsUploadProtocol :: Lens' ProjectsJobsSnapshot (Maybe Text) Source #

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

pjsAccessToken :: Lens' ProjectsJobsSnapshot (Maybe Text) Source #

OAuth access token.

pjsUploadType :: Lens' ProjectsJobsSnapshot (Maybe Text) Source #

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

pjsPayload :: Lens' ProjectsJobsSnapshot SnapshotJobRequest Source #

Multipart request metadata.

pjsProjectId :: Lens' ProjectsJobsSnapshot Text Source #

The project which owns the job to be snapshotted.

pjsCallback :: Lens' ProjectsJobsSnapshot (Maybe Text) Source #

JSONP