summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Snapshot.hs
blob: f24cdea8b9e1cf26651a9f8279044234fd0cc786 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
{-# 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.Dataflow.Projects.Jobs.Snapshot
-- 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)
--
-- Snapshot the state of a streaming job.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.jobs.snapshot@.
module Network.Google.Resource.Dataflow.Projects.Jobs.Snapshot
    (
    -- * REST Resource
      ProjectsJobsSnapshotResource

    -- * Creating a Request
    , projectsJobsSnapshot
    , ProjectsJobsSnapshot

    -- * Request Lenses
    , pjsXgafv
    , pjsJobId
    , pjsUploadProtocol
    , pjsAccessToken
    , pjsUploadType
    , pjsPayload
    , pjsProjectId
    , pjsCallback
    ) where

import           Network.Google.Dataflow.Types
import           Network.Google.Prelude

-- | A resource alias for @dataflow.projects.jobs.snapshot@ method which the
-- 'ProjectsJobsSnapshot' request conforms to.
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

-- | Snapshot the state of a streaming job.
--
-- /See:/ 'projectsJobsSnapshot' smart constructor.
data ProjectsJobsSnapshot = ProjectsJobsSnapshot'
    { _pjsXgafv          :: !(Maybe Xgafv)
    , _pjsJobId          :: !Text
    , _pjsUploadProtocol :: !(Maybe Text)
    , _pjsAccessToken    :: !(Maybe Text)
    , _pjsUploadType     :: !(Maybe Text)
    , _pjsPayload        :: !SnapshotJobRequest
    , _pjsProjectId      :: !Text
    , _pjsCallback       :: !(Maybe Text)
    } deriving (Eq,Show,Data,Typeable,Generic)

-- | 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:
--
-- * 'pjsXgafv'
--
-- * 'pjsJobId'
--
-- * 'pjsUploadProtocol'
--
-- * 'pjsAccessToken'
--
-- * 'pjsUploadType'
--
-- * 'pjsPayload'
--
-- * 'pjsProjectId'
--
-- * 'pjsCallback'
projectsJobsSnapshot
    :: Text -- ^ 'pjsJobId'
    -> SnapshotJobRequest -- ^ 'pjsPayload'
    -> Text -- ^ 'pjsProjectId'
    -> ProjectsJobsSnapshot
projectsJobsSnapshot pPjsJobId_ pPjsPayload_ pPjsProjectId_ =
    ProjectsJobsSnapshot'
    { _pjsXgafv = Nothing
    , _pjsJobId = pPjsJobId_
    , _pjsUploadProtocol = Nothing
    , _pjsAccessToken = Nothing
    , _pjsUploadType = Nothing
    , _pjsPayload = pPjsPayload_
    , _pjsProjectId = pPjsProjectId_
    , _pjsCallback = Nothing
    }

-- | V1 error format.
pjsXgafv :: Lens' ProjectsJobsSnapshot (Maybe Xgafv)
pjsXgafv = lens _pjsXgafv (\ s a -> s{_pjsXgafv = a})

-- | The job to be snapshotted.
pjsJobId :: Lens' ProjectsJobsSnapshot Text
pjsJobId = lens _pjsJobId (\ s a -> s{_pjsJobId = a})

-- | Upload protocol for media (e.g. \"raw\", \"multipart\").
pjsUploadProtocol :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsUploadProtocol
  = lens _pjsUploadProtocol
      (\ s a -> s{_pjsUploadProtocol = a})

-- | OAuth access token.
pjsAccessToken :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsAccessToken
  = lens _pjsAccessToken
      (\ s a -> s{_pjsAccessToken = a})

-- | Legacy upload protocol for media (e.g. \"media\", \"multipart\").
pjsUploadType :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsUploadType
  = lens _pjsUploadType
      (\ s a -> s{_pjsUploadType = a})

-- | Multipart request metadata.
pjsPayload :: Lens' ProjectsJobsSnapshot SnapshotJobRequest
pjsPayload
  = lens _pjsPayload (\ s a -> s{_pjsPayload = a})

-- | The project which owns the job to be snapshotted.
pjsProjectId :: Lens' ProjectsJobsSnapshot Text
pjsProjectId
  = lens _pjsProjectId (\ s a -> s{_pjsProjectId = a})

-- | JSONP
pjsCallback :: Lens' ProjectsJobsSnapshot (Maybe Text)
pjsCallback
  = lens _pjsCallback (\ s a -> s{_pjsCallback = a})

instance GoogleRequest ProjectsJobsSnapshot where
        type Rs ProjectsJobsSnapshot = 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"]
        requestClient ProjectsJobsSnapshot'{..}
          = go _pjsProjectId _pjsJobId _pjsXgafv
              _pjsUploadProtocol
              _pjsAccessToken
              _pjsUploadType
              _pjsCallback
              (Just AltJSON)
              _pjsPayload
              dataflowService
          where go
                  = buildClient
                      (Proxy :: Proxy ProjectsJobsSnapshotResource)
                      mempty