summaryrefslogtreecommitdiff
path: root/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs
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/Locations/Jobs
parent0631d46cd089382f5521238cbe93c6e551d2ee6e (diff)
version 0.5.0HEAD0.5.0master
Diffstat (limited to 'gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs')
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Create.hs26
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/GetConfig.hs17
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/SendCapture.hs17
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Get.hs28
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs29
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/List.hs32
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs31
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Snapshot.hs10
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Update.hs28
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/Lease.hs17
-rw-r--r--gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs17
11 files changed, 191 insertions, 61 deletions
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Create.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Create.hs
index def1b41..4aebeb6 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Create.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Create.hs
@@ -20,7 +20,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Creates a Cloud Dataflow job.
+-- Creates a Cloud Dataflow job. To create a job, we recommend using
+-- \`projects.locations.jobs.create\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.create\` is not recommended, as your job will
+-- always start in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.create@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Create
@@ -67,10 +71,15 @@ type ProjectsLocationsJobsCreateResource =
QueryParam "alt" AltJSON :>
ReqBody '[JSON] Job :> Post '[JSON] Job
--- | Creates a Cloud Dataflow job.
+-- | Creates a Cloud Dataflow job. To create a job, we recommend using
+-- \`projects.locations.jobs.create\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.create\` is not recommended, as your job will
+-- always start in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsCreate' smart constructor.
-data ProjectsLocationsJobsCreate = ProjectsLocationsJobsCreate'
+data ProjectsLocationsJobsCreate =
+ ProjectsLocationsJobsCreate'
{ _pljcXgafv :: !(Maybe Xgafv)
, _pljcUploadProtocol :: !(Maybe Text)
, _pljcLocation :: !Text
@@ -81,7 +90,9 @@ data ProjectsLocationsJobsCreate = ProjectsLocationsJobsCreate'
, _pljcProjectId :: !Text
, _pljcReplaceJobId :: !(Maybe Text)
, _pljcCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsCreate' with the minimum fields required to make a request.
--
@@ -112,7 +123,7 @@ projectsLocationsJobsCreate
-> Text -- ^ 'pljcProjectId'
-> ProjectsLocationsJobsCreate
projectsLocationsJobsCreate pPljcLocation_ pPljcPayload_ pPljcProjectId_ =
- ProjectsLocationsJobsCreate'
+ ProjectsLocationsJobsCreate'
{ _pljcXgafv = Nothing
, _pljcUploadProtocol = Nothing
, _pljcLocation = pPljcLocation_
@@ -125,6 +136,7 @@ projectsLocationsJobsCreate pPljcLocation_ pPljcPayload_ pPljcProjectId_ =
, _pljcCallback = Nothing
}
+
-- | V1 error format.
pljcXgafv :: Lens' ProjectsLocationsJobsCreate (Maybe Xgafv)
pljcXgafv
@@ -136,7 +148,9 @@ pljcUploadProtocol
= lens _pljcUploadProtocol
(\ s a -> s{_pljcUploadProtocol = a})
--- | The location that contains this job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains this job.
pljcLocation :: Lens' ProjectsLocationsJobsCreate Text
pljcLocation
= lens _pljcLocation (\ s a -> s{_pljcLocation = a})
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/GetConfig.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/GetConfig.hs
index dc417f8..93ad5fa 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/GetConfig.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/GetConfig.hs
@@ -71,7 +71,8 @@ type ProjectsLocationsJobsDebugGetConfigResource =
-- | Get encoded debug configuration for component. Not cacheable.
--
-- /See:/ 'projectsLocationsJobsDebugGetConfig' smart constructor.
-data ProjectsLocationsJobsDebugGetConfig = ProjectsLocationsJobsDebugGetConfig'
+data ProjectsLocationsJobsDebugGetConfig =
+ ProjectsLocationsJobsDebugGetConfig'
{ _pljdgcXgafv :: !(Maybe Xgafv)
, _pljdgcJobId :: !Text
, _pljdgcUploadProtocol :: !(Maybe Text)
@@ -81,7 +82,9 @@ data ProjectsLocationsJobsDebugGetConfig = ProjectsLocationsJobsDebugGetConfig'
, _pljdgcPayload :: !GetDebugConfigRequest
, _pljdgcProjectId :: !Text
, _pljdgcCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsDebugGetConfig' with the minimum fields required to make a request.
--
@@ -111,7 +114,7 @@ projectsLocationsJobsDebugGetConfig
-> Text -- ^ 'pljdgcProjectId'
-> ProjectsLocationsJobsDebugGetConfig
projectsLocationsJobsDebugGetConfig pPljdgcJobId_ pPljdgcLocation_ pPljdgcPayload_ pPljdgcProjectId_ =
- ProjectsLocationsJobsDebugGetConfig'
+ ProjectsLocationsJobsDebugGetConfig'
{ _pljdgcXgafv = Nothing
, _pljdgcJobId = pPljdgcJobId_
, _pljdgcUploadProtocol = Nothing
@@ -123,6 +126,7 @@ projectsLocationsJobsDebugGetConfig pPljdgcJobId_ pPljdgcLocation_ pPljdgcPayloa
, _pljdgcCallback = Nothing
}
+
-- | V1 error format.
pljdgcXgafv :: Lens' ProjectsLocationsJobsDebugGetConfig (Maybe Xgafv)
pljdgcXgafv
@@ -139,7 +143,9 @@ pljdgcUploadProtocol
= lens _pljdgcUploadProtocol
(\ s a -> s{_pljdgcUploadProtocol = a})
--- | The location which contains the job specified by job_id.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the job specified by job_id.
pljdgcLocation :: Lens' ProjectsLocationsJobsDebugGetConfig Text
pljdgcLocation
= lens _pljdgcLocation
@@ -176,7 +182,8 @@ pljdgcCallback
(\ s a -> s{_pljdgcCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsDebugGetConfig where
+ ProjectsLocationsJobsDebugGetConfig
+ where
type Rs ProjectsLocationsJobsDebugGetConfig =
GetDebugConfigResponse
type Scopes ProjectsLocationsJobsDebugGetConfig =
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/SendCapture.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/SendCapture.hs
index 87cace3..2f5ff7c 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/SendCapture.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Debug/SendCapture.hs
@@ -71,7 +71,8 @@ type ProjectsLocationsJobsDebugSendCaptureResource =
-- | Send encoded debug capture data for component.
--
-- /See:/ 'projectsLocationsJobsDebugSendCapture' smart constructor.
-data ProjectsLocationsJobsDebugSendCapture = ProjectsLocationsJobsDebugSendCapture'
+data ProjectsLocationsJobsDebugSendCapture =
+ ProjectsLocationsJobsDebugSendCapture'
{ _pljdscXgafv :: !(Maybe Xgafv)
, _pljdscJobId :: !Text
, _pljdscUploadProtocol :: !(Maybe Text)
@@ -81,7 +82,9 @@ data ProjectsLocationsJobsDebugSendCapture = ProjectsLocationsJobsDebugSendCaptu
, _pljdscPayload :: !SendDebugCaptureRequest
, _pljdscProjectId :: !Text
, _pljdscCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsDebugSendCapture' with the minimum fields required to make a request.
--
@@ -111,7 +114,7 @@ projectsLocationsJobsDebugSendCapture
-> Text -- ^ 'pljdscProjectId'
-> ProjectsLocationsJobsDebugSendCapture
projectsLocationsJobsDebugSendCapture pPljdscJobId_ pPljdscLocation_ pPljdscPayload_ pPljdscProjectId_ =
- ProjectsLocationsJobsDebugSendCapture'
+ ProjectsLocationsJobsDebugSendCapture'
{ _pljdscXgafv = Nothing
, _pljdscJobId = pPljdscJobId_
, _pljdscUploadProtocol = Nothing
@@ -123,6 +126,7 @@ projectsLocationsJobsDebugSendCapture pPljdscJobId_ pPljdscLocation_ pPljdscPayl
, _pljdscCallback = Nothing
}
+
-- | V1 error format.
pljdscXgafv :: Lens' ProjectsLocationsJobsDebugSendCapture (Maybe Xgafv)
pljdscXgafv
@@ -139,7 +143,9 @@ pljdscUploadProtocol
= lens _pljdscUploadProtocol
(\ s a -> s{_pljdscUploadProtocol = a})
--- | The location which contains the job specified by job_id.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the job specified by job_id.
pljdscLocation :: Lens' ProjectsLocationsJobsDebugSendCapture Text
pljdscLocation
= lens _pljdscLocation
@@ -176,7 +182,8 @@ pljdscCallback
(\ s a -> s{_pljdscCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsDebugSendCapture where
+ ProjectsLocationsJobsDebugSendCapture
+ where
type Rs ProjectsLocationsJobsDebugSendCapture =
SendDebugCaptureResponse
type Scopes ProjectsLocationsJobsDebugSendCapture =
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Get.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Get.hs
index d7b8a1f..899ead1 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Get.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/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.locations.jobs.get@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Get
@@ -65,10 +70,16 @@ type ProjectsLocationsJobsGetResource =
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:/ 'projectsLocationsJobsGet' smart constructor.
-data ProjectsLocationsJobsGet = ProjectsLocationsJobsGet'
+data ProjectsLocationsJobsGet =
+ ProjectsLocationsJobsGet'
{ _pljgXgafv :: !(Maybe Xgafv)
, _pljgJobId :: !Text
, _pljgUploadProtocol :: !(Maybe Text)
@@ -78,7 +89,9 @@ data ProjectsLocationsJobsGet = ProjectsLocationsJobsGet'
, _pljgView :: !(Maybe Text)
, _pljgProjectId :: !Text
, _pljgCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsGet' with the minimum fields required to make a request.
--
@@ -107,7 +120,7 @@ projectsLocationsJobsGet
-> Text -- ^ 'pljgProjectId'
-> ProjectsLocationsJobsGet
projectsLocationsJobsGet pPljgJobId_ pPljgLocation_ pPljgProjectId_ =
- ProjectsLocationsJobsGet'
+ ProjectsLocationsJobsGet'
{ _pljgXgafv = Nothing
, _pljgJobId = pPljgJobId_
, _pljgUploadProtocol = Nothing
@@ -119,6 +132,7 @@ projectsLocationsJobsGet pPljgJobId_ pPljgLocation_ pPljgProjectId_ =
, _pljgCallback = Nothing
}
+
-- | V1 error format.
pljgXgafv :: Lens' ProjectsLocationsJobsGet (Maybe Xgafv)
pljgXgafv
@@ -135,7 +149,9 @@ pljgUploadProtocol
= lens _pljgUploadProtocol
(\ s a -> s{_pljgUploadProtocol = a})
--- | The location that contains this job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains this job.
pljgLocation :: Lens' ProjectsLocationsJobsGet Text
pljgLocation
= lens _pljgLocation (\ s a -> s{_pljgLocation = a})
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs
index b7c91e9..04012b2 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/GetMetrics.hs
@@ -20,7 +20,11 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Request the job status.
+-- Request the job status. To request the status of a job, we recommend
+-- using \`projects.locations.jobs.getMetrics\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.getMetrics\` is not recommended, as you can only
+-- request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.getMetrics@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.GetMetrics
@@ -67,10 +71,15 @@ type ProjectsLocationsJobsGetMetricsResource =
QueryParam "alt" AltJSON :>
Get '[JSON] JobMetrics
--- | Request the job status.
+-- | Request the job status. To request the status of a job, we recommend
+-- using \`projects.locations.jobs.getMetrics\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.getMetrics\` is not recommended, as you can only
+-- request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsGetMetrics' smart constructor.
-data ProjectsLocationsJobsGetMetrics = ProjectsLocationsJobsGetMetrics'
+data ProjectsLocationsJobsGetMetrics =
+ ProjectsLocationsJobsGetMetrics'
{ _pljgmXgafv :: !(Maybe Xgafv)
, _pljgmJobId :: !Text
, _pljgmUploadProtocol :: !(Maybe Text)
@@ -80,7 +89,9 @@ data ProjectsLocationsJobsGetMetrics = ProjectsLocationsJobsGetMetrics'
, _pljgmUploadType :: !(Maybe Text)
, _pljgmProjectId :: !Text
, _pljgmCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsGetMetrics' with the minimum fields required to make a request.
--
@@ -109,7 +120,7 @@ projectsLocationsJobsGetMetrics
-> Text -- ^ 'pljgmProjectId'
-> ProjectsLocationsJobsGetMetrics
projectsLocationsJobsGetMetrics pPljgmJobId_ pPljgmLocation_ pPljgmProjectId_ =
- ProjectsLocationsJobsGetMetrics'
+ ProjectsLocationsJobsGetMetrics'
{ _pljgmXgafv = Nothing
, _pljgmJobId = pPljgmJobId_
, _pljgmUploadProtocol = Nothing
@@ -121,6 +132,7 @@ projectsLocationsJobsGetMetrics pPljgmJobId_ pPljgmLocation_ pPljgmProjectId_ =
, _pljgmCallback = Nothing
}
+
-- | V1 error format.
pljgmXgafv :: Lens' ProjectsLocationsJobsGetMetrics (Maybe Xgafv)
pljgmXgafv
@@ -137,7 +149,9 @@ pljgmUploadProtocol
= lens _pljgmUploadProtocol
(\ s a -> s{_pljgmUploadProtocol = a})
--- | The location which contains the job specified by job_id.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the job specified by job_id.
pljgmLocation :: Lens' ProjectsLocationsJobsGetMetrics Text
pljgmLocation
= lens _pljgmLocation
@@ -176,7 +190,8 @@ pljgmCallback
(\ s a -> s{_pljgmCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsGetMetrics where
+ ProjectsLocationsJobsGetMetrics
+ where
type Rs ProjectsLocationsJobsGetMetrics = JobMetrics
type Scopes ProjectsLocationsJobsGetMetrics =
'["https://www.googleapis.com/auth/cloud-platform",
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/List.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/List.hs
index 5e75988..ccdbe8f 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/List.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/List.hs
@@ -20,7 +20,14 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- List the jobs of a project in a given region.
+-- List the jobs of a project. To list the jobs of a project in a region,
+-- we recommend using \`projects.locations.jobs.get\` with a [regional
+-- endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- To list the all jobs across all regions, use
+-- \`projects.jobs.aggregated\`. Using \`projects.jobs.list\` is not
+-- recommended, as you can only get the list of jobs that are running in
+-- \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.list@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.List
@@ -70,10 +77,18 @@ type ProjectsLocationsJobsListResource =
QueryParam "alt" AltJSON :>
Get '[JSON] ListJobsResponse
--- | List the jobs of a project in a given region.
+-- | List the jobs of a project. To list the jobs of a project in a region,
+-- we recommend using \`projects.locations.jobs.get\` with a [regional
+-- endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- To list the all jobs across all regions, use
+-- \`projects.jobs.aggregated\`. Using \`projects.jobs.list\` is not
+-- recommended, as you can only get the list of jobs that are running in
+-- \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsList' smart constructor.
-data ProjectsLocationsJobsList = ProjectsLocationsJobsList'
+data ProjectsLocationsJobsList =
+ ProjectsLocationsJobsList'
{ _pljlXgafv :: !(Maybe Xgafv)
, _pljlUploadProtocol :: !(Maybe Text)
, _pljlLocation :: !Text
@@ -85,7 +100,9 @@ data ProjectsLocationsJobsList = ProjectsLocationsJobsList'
, _pljlProjectId :: !Text
, _pljlPageSize :: !(Maybe (Textual Int32))
, _pljlCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsList' with the minimum fields required to make a request.
--
@@ -117,7 +134,7 @@ projectsLocationsJobsList
-> Text -- ^ 'pljlProjectId'
-> ProjectsLocationsJobsList
projectsLocationsJobsList pPljlLocation_ pPljlProjectId_ =
- ProjectsLocationsJobsList'
+ ProjectsLocationsJobsList'
{ _pljlXgafv = Nothing
, _pljlUploadProtocol = Nothing
, _pljlLocation = pPljlLocation_
@@ -131,6 +148,7 @@ projectsLocationsJobsList pPljlLocation_ pPljlProjectId_ =
, _pljlCallback = Nothing
}
+
-- | V1 error format.
pljlXgafv :: Lens' ProjectsLocationsJobsList (Maybe Xgafv)
pljlXgafv
@@ -142,7 +160,9 @@ pljlUploadProtocol
= lens _pljlUploadProtocol
(\ s a -> s{_pljlUploadProtocol = a})
--- | The location that contains this job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains this job.
pljlLocation :: Lens' ProjectsLocationsJobsList Text
pljlLocation
= lens _pljlLocation (\ s a -> s{_pljlLocation = a})
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs
index fbb699e..fb1175f 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Messages/List.hs
@@ -20,7 +20,12 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Request the job status.
+-- Request the job status. To request the status of a job, we recommend
+-- using \`projects.locations.jobs.messages.list\` with a [regional
+-- endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.messages.list\` is not recommended, as you can
+-- only request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.messages.list@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Messages.List
@@ -75,10 +80,16 @@ type ProjectsLocationsJobsMessagesListResource =
QueryParam "alt" AltJSON :>
Get '[JSON] ListJobMessagesResponse
--- | Request the job status.
+-- | Request the job status. To request the status of a job, we recommend
+-- using \`projects.locations.jobs.messages.list\` with a [regional
+-- endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.messages.list\` is not recommended, as you can
+-- only request the status of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsMessagesList' smart constructor.
-data ProjectsLocationsJobsMessagesList = ProjectsLocationsJobsMessagesList'
+data ProjectsLocationsJobsMessagesList =
+ ProjectsLocationsJobsMessagesList'
{ _pljmlXgafv :: !(Maybe Xgafv)
, _pljmlJobId :: !Text
, _pljmlUploadProtocol :: !(Maybe Text)
@@ -92,7 +103,9 @@ data ProjectsLocationsJobsMessagesList = ProjectsLocationsJobsMessagesList'
, _pljmlProjectId :: !Text
, _pljmlPageSize :: !(Maybe (Textual Int32))
, _pljmlCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsMessagesList' with the minimum fields required to make a request.
--
@@ -129,7 +142,7 @@ projectsLocationsJobsMessagesList
-> Text -- ^ 'pljmlProjectId'
-> ProjectsLocationsJobsMessagesList
projectsLocationsJobsMessagesList pPljmlJobId_ pPljmlLocation_ pPljmlProjectId_ =
- ProjectsLocationsJobsMessagesList'
+ ProjectsLocationsJobsMessagesList'
{ _pljmlXgafv = Nothing
, _pljmlJobId = pPljmlJobId_
, _pljmlUploadProtocol = Nothing
@@ -145,6 +158,7 @@ projectsLocationsJobsMessagesList pPljmlJobId_ pPljmlLocation_ pPljmlProjectId_
, _pljmlCallback = Nothing
}
+
-- | V1 error format.
pljmlXgafv :: Lens' ProjectsLocationsJobsMessagesList (Maybe Xgafv)
pljmlXgafv
@@ -161,7 +175,9 @@ pljmlUploadProtocol
= lens _pljmlUploadProtocol
(\ s a -> s{_pljmlUploadProtocol = a})
--- | The location which contains the job specified by job_id.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the job specified by job_id.
pljmlLocation :: Lens' ProjectsLocationsJobsMessagesList Text
pljmlLocation
= lens _pljmlLocation
@@ -229,7 +245,8 @@ pljmlCallback
(\ s a -> s{_pljmlCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsMessagesList where
+ ProjectsLocationsJobsMessagesList
+ where
type Rs ProjectsLocationsJobsMessagesList =
ListJobMessagesResponse
type Scopes ProjectsLocationsJobsMessagesList =
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Snapshot.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Snapshot.hs
index 4866158..ff02413 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Snapshot.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Snapshot.hs
@@ -69,7 +69,8 @@ type ProjectsLocationsJobsSnapshotResource =
-- | Snapshot the state of a streaming job.
--
-- /See:/ 'projectsLocationsJobsSnapshot' smart constructor.
-data ProjectsLocationsJobsSnapshot = ProjectsLocationsJobsSnapshot'
+data ProjectsLocationsJobsSnapshot =
+ ProjectsLocationsJobsSnapshot'
{ _pljsXgafv :: !(Maybe Xgafv)
, _pljsJobId :: !Text
, _pljsUploadProtocol :: !(Maybe Text)
@@ -79,7 +80,9 @@ data ProjectsLocationsJobsSnapshot = ProjectsLocationsJobsSnapshot'
, _pljsPayload :: !SnapshotJobRequest
, _pljsProjectId :: !Text
, _pljsCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsSnapshot' with the minimum fields required to make a request.
--
@@ -109,7 +112,7 @@ projectsLocationsJobsSnapshot
-> Text -- ^ 'pljsProjectId'
-> ProjectsLocationsJobsSnapshot
projectsLocationsJobsSnapshot pPljsJobId_ pPljsLocation_ pPljsPayload_ pPljsProjectId_ =
- ProjectsLocationsJobsSnapshot'
+ ProjectsLocationsJobsSnapshot'
{ _pljsXgafv = Nothing
, _pljsJobId = pPljsJobId_
, _pljsUploadProtocol = Nothing
@@ -121,6 +124,7 @@ projectsLocationsJobsSnapshot pPljsJobId_ pPljsLocation_ pPljsPayload_ pPljsProj
, _pljsCallback = Nothing
}
+
-- | V1 error format.
pljsXgafv :: Lens' ProjectsLocationsJobsSnapshot (Maybe Xgafv)
pljsXgafv
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Update.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Update.hs
index f78b12a..e859138 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Update.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/Update.hs
@@ -20,7 +20,12 @@
-- Stability : auto-generated
-- Portability : non-portable (GHC extensions)
--
--- Updates the state of an existing Cloud Dataflow job.
+-- Updates the state of an existing Cloud Dataflow job. To update the state
+-- of an existing job, we recommend using
+-- \`projects.locations.jobs.update\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.update\` is not recommended, as you can only
+-- update the state of jobs that are running in \`us-central1\`.
--
-- /See:/ <https://cloud.google.com/dataflow Dataflow API Reference> for @dataflow.projects.locations.jobs.update@.
module Network.Google.Resource.Dataflow.Projects.Locations.Jobs.Update
@@ -65,10 +70,16 @@ type ProjectsLocationsJobsUpdateResource =
QueryParam "alt" AltJSON :>
ReqBody '[JSON] Job :> Put '[JSON] Job
--- | Updates the state of an existing Cloud Dataflow job.
+-- | Updates the state of an existing Cloud Dataflow job. To update the state
+-- of an existing job, we recommend using
+-- \`projects.locations.jobs.update\` with a [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints).
+-- Using \`projects.jobs.update\` is not recommended, as you can only
+-- update the state of jobs that are running in \`us-central1\`.
--
-- /See:/ 'projectsLocationsJobsUpdate' smart constructor.
-data ProjectsLocationsJobsUpdate = ProjectsLocationsJobsUpdate'
+data ProjectsLocationsJobsUpdate =
+ ProjectsLocationsJobsUpdate'
{ _pljuXgafv :: !(Maybe Xgafv)
, _pljuJobId :: !Text
, _pljuUploadProtocol :: !(Maybe Text)
@@ -78,7 +89,9 @@ data ProjectsLocationsJobsUpdate = ProjectsLocationsJobsUpdate'
, _pljuPayload :: !Job
, _pljuProjectId :: !Text
, _pljuCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsUpdate' with the minimum fields required to make a request.
--
@@ -108,7 +121,7 @@ projectsLocationsJobsUpdate
-> Text -- ^ 'pljuProjectId'
-> ProjectsLocationsJobsUpdate
projectsLocationsJobsUpdate pPljuJobId_ pPljuLocation_ pPljuPayload_ pPljuProjectId_ =
- ProjectsLocationsJobsUpdate'
+ ProjectsLocationsJobsUpdate'
{ _pljuXgafv = Nothing
, _pljuJobId = pPljuJobId_
, _pljuUploadProtocol = Nothing
@@ -120,6 +133,7 @@ projectsLocationsJobsUpdate pPljuJobId_ pPljuLocation_ pPljuPayload_ pPljuProjec
, _pljuCallback = Nothing
}
+
-- | V1 error format.
pljuXgafv :: Lens' ProjectsLocationsJobsUpdate (Maybe Xgafv)
pljuXgafv
@@ -136,7 +150,9 @@ pljuUploadProtocol
= lens _pljuUploadProtocol
(\ s a -> s{_pljuUploadProtocol = a})
--- | The location that contains this job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains this job.
pljuLocation :: Lens' ProjectsLocationsJobsUpdate Text
pljuLocation
= lens _pljuLocation (\ s a -> s{_pljuLocation = a})
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/Lease.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/Lease.hs
index 649f2f4..97c7215 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/Lease.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/Lease.hs
@@ -70,7 +70,8 @@ type ProjectsLocationsJobsWorkItemsLeaseResource =
-- | Leases a dataflow WorkItem to run.
--
-- /See:/ 'projectsLocationsJobsWorkItemsLease' smart constructor.
-data ProjectsLocationsJobsWorkItemsLease = ProjectsLocationsJobsWorkItemsLease'
+data ProjectsLocationsJobsWorkItemsLease =
+ ProjectsLocationsJobsWorkItemsLease'
{ _pljwilXgafv :: !(Maybe Xgafv)
, _pljwilJobId :: !Text
, _pljwilUploadProtocol :: !(Maybe Text)
@@ -80,7 +81,9 @@ data ProjectsLocationsJobsWorkItemsLease = ProjectsLocationsJobsWorkItemsLease'
, _pljwilPayload :: !LeaseWorkItemRequest
, _pljwilProjectId :: !Text
, _pljwilCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsWorkItemsLease' with the minimum fields required to make a request.
--
@@ -110,7 +113,7 @@ projectsLocationsJobsWorkItemsLease
-> Text -- ^ 'pljwilProjectId'
-> ProjectsLocationsJobsWorkItemsLease
projectsLocationsJobsWorkItemsLease pPljwilJobId_ pPljwilLocation_ pPljwilPayload_ pPljwilProjectId_ =
- ProjectsLocationsJobsWorkItemsLease'
+ ProjectsLocationsJobsWorkItemsLease'
{ _pljwilXgafv = Nothing
, _pljwilJobId = pPljwilJobId_
, _pljwilUploadProtocol = Nothing
@@ -122,6 +125,7 @@ projectsLocationsJobsWorkItemsLease pPljwilJobId_ pPljwilLocation_ pPljwilPayloa
, _pljwilCallback = Nothing
}
+
-- | V1 error format.
pljwilXgafv :: Lens' ProjectsLocationsJobsWorkItemsLease (Maybe Xgafv)
pljwilXgafv
@@ -138,7 +142,9 @@ pljwilUploadProtocol
= lens _pljwilUploadProtocol
(\ s a -> s{_pljwilUploadProtocol = a})
--- | The location which contains the WorkItem\'s job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the WorkItem\'s job.
pljwilLocation :: Lens' ProjectsLocationsJobsWorkItemsLease Text
pljwilLocation
= lens _pljwilLocation
@@ -175,7 +181,8 @@ pljwilCallback
(\ s a -> s{_pljwilCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsWorkItemsLease where
+ ProjectsLocationsJobsWorkItemsLease
+ where
type Rs ProjectsLocationsJobsWorkItemsLease =
LeaseWorkItemResponse
type Scopes ProjectsLocationsJobsWorkItemsLease =
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs
index f4d4e20..214c42f 100644
--- a/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs
+++ b/gen/Network/Google/Resource/Dataflow/Projects/Locations/Jobs/WorkItems/ReportStatus.hs
@@ -71,7 +71,8 @@ type ProjectsLocationsJobsWorkItemsReportStatusResource
-- | Reports the status of dataflow WorkItems leased by a worker.
--
-- /See:/ 'projectsLocationsJobsWorkItemsReportStatus' smart constructor.
-data ProjectsLocationsJobsWorkItemsReportStatus = ProjectsLocationsJobsWorkItemsReportStatus'
+data ProjectsLocationsJobsWorkItemsReportStatus =
+ ProjectsLocationsJobsWorkItemsReportStatus'
{ _pljwirsXgafv :: !(Maybe Xgafv)
, _pljwirsJobId :: !Text
, _pljwirsUploadProtocol :: !(Maybe Text)
@@ -81,7 +82,9 @@ data ProjectsLocationsJobsWorkItemsReportStatus = ProjectsLocationsJobsWorkItems
, _pljwirsPayload :: !ReportWorkItemStatusRequest
, _pljwirsProjectId :: !Text
, _pljwirsCallback :: !(Maybe Text)
- } deriving (Eq,Show,Data,Typeable,Generic)
+ }
+ deriving (Eq, Show, Data, Typeable, Generic)
+
-- | Creates a value of 'ProjectsLocationsJobsWorkItemsReportStatus' with the minimum fields required to make a request.
--
@@ -111,7 +114,7 @@ projectsLocationsJobsWorkItemsReportStatus
-> Text -- ^ 'pljwirsProjectId'
-> ProjectsLocationsJobsWorkItemsReportStatus
projectsLocationsJobsWorkItemsReportStatus pPljwirsJobId_ pPljwirsLocation_ pPljwirsPayload_ pPljwirsProjectId_ =
- ProjectsLocationsJobsWorkItemsReportStatus'
+ ProjectsLocationsJobsWorkItemsReportStatus'
{ _pljwirsXgafv = Nothing
, _pljwirsJobId = pPljwirsJobId_
, _pljwirsUploadProtocol = Nothing
@@ -123,6 +126,7 @@ projectsLocationsJobsWorkItemsReportStatus pPljwirsJobId_ pPljwirsLocation_ pPlj
, _pljwirsCallback = Nothing
}
+
-- | V1 error format.
pljwirsXgafv :: Lens' ProjectsLocationsJobsWorkItemsReportStatus (Maybe Xgafv)
pljwirsXgafv
@@ -139,7 +143,9 @@ pljwirsUploadProtocol
= lens _pljwirsUploadProtocol
(\ s a -> s{_pljwirsUploadProtocol = a})
--- | The location which contains the WorkItem\'s job.
+-- | The [regional endpoint]
+-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints)
+-- that contains the WorkItem\'s job.
pljwirsLocation :: Lens' ProjectsLocationsJobsWorkItemsReportStatus Text
pljwirsLocation
= lens _pljwirsLocation
@@ -176,7 +182,8 @@ pljwirsCallback
(\ s a -> s{_pljwirsCallback = a})
instance GoogleRequest
- ProjectsLocationsJobsWorkItemsReportStatus where
+ ProjectsLocationsJobsWorkItemsReportStatus
+ where
type Rs ProjectsLocationsJobsWorkItemsReportStatus =
ReportWorkItemStatusResponse
type Scopes