summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
diff options
context:
space:
mode:
authorBrendanHay <>2019-08-23 07:38:00 (GMT)
committerhdiff <hdiff@hdiff.luite.com>2019-08-23 07:38:00 (GMT)
commit0af3651629f3e89aa162b41a30b0053fbed90862 (patch)
tree59ff9350963a013659ac088f4b1e824af3e35805 /gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
parent0631d46cd089382f5521238cbe93c6e551d2ee6e (diff)
version 0.5.0HEAD0.5.0master
Diffstat (limited to 'gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs')
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs28
1 files changed, 22 insertions, 6 deletions
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
index 2ed39cc..1cc5f8e 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Get.hs
@@ -20,7 +20,12 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Gets the state of the specified Cloud Dataflow job.
+-- Gets the state of the specified Cloud Dataflow job. To get the state of
+-- a job, we recommend using \`projects.locations.jobs.get\` with a
+-- [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.get\` is not recommended, as you can only get the
+-- state of jobs that are running in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.jobs.get@.
module Network.Google.Resource.Dataflow.Projects.Jobs.Get
@@ -64,10 +69,16 @@ type ProjectsJobsGetResource =
QueryParam "callback" Text :>
QueryParam "alt" AltJSON :> Get '[JSON] Job
--- | Gets the state of the specified Cloud Dataflow job.
+-- | Gets the state of the specified Cloud Dataflow job. To get the state of
+-- a job, we recommend using \`projects.locations.jobs.get\` with a
+-- [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.get\` is not recommended, as you can only get the
+-- state of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsJobsGet' smart constructor.
-data ProjectsJobsGet = ProjectsJobsGet'
+data ProjectsJobsGet =
+ ProjectsJobsGet'
{ _pjgXgafv :: !(Maybe Xgafv)
, _pjgJobId :: !Text
, _pjgUploadProtocol :: !(Maybe Text)
@@ -77,7 +88,9 @@ data ProjectsJobsGet = ProjectsJobsGet'
, _pjgView :: !(Maybe Text)
, _pjgProjectId :: !Text
, _pjgCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsJobsGet' with the minimum fields required to make a request.
--
@@ -105,7 +118,7 @@ projectsJobsGet
-> Text -- ^ 'pjgProjectId'
-> ProjectsJobsGet
projectsJobsGet pPjgJobId_ pPjgProjectId_ =
- ProjectsJobsGet'
+ ProjectsJobsGet'
{ _pjgXgafv = Nothing
, _pjgJobId = pPjgJobId_
, _pjgUploadProtocol = Nothing
@@ -117,6 +130,7 @@ projectsJobsGet pPjgJobId_ pPjgProjectId_ =
, _pjgCallback = Nothing
}
+
-- | V1 error format.
pjgXgafv :: Lens' ProjectsJobsGet (Maybe Xgafv)
pjgXgafv = lens _pjgXgafv (\ s a -> s{_pjgXgafv = a})
@@ -131,7 +145,9 @@ pjgUploadProtocol
= lens _pjgUploadProtocol
(\ s a -> s{_pjgUploadProtocol = a})
--- | The location that contains this job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains this job.
pjgLocation :: Lens' ProjectsJobsGet (Maybe Text)
pjgLocation
= lens _pjgLocation (\ s a -> s{_pjgLocation = a})