diff options
Diffstat (limited to 'gen/Network/Google/Resource/Dataflow/Projects/Jobs')
12 files changed, 179 insertions, 56 deletions
diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Aggregated.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Aggregated.hs index ea2d06e..34ba105 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Aggregated.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Aggregated.hs @@ -72,7 +72,8 @@ type ProjectsJobsAggregatedResource = -- | List the jobs of a project across all regions. -- -- /See:/ 'projectsJobsAggregated' smart constructor. -data ProjectsJobsAggregated = ProjectsJobsAggregated' +data ProjectsJobsAggregated = + ProjectsJobsAggregated' { _pjaXgafv :: !(Maybe Xgafv) , _pjaUploadProtocol :: !(Maybe Text) , _pjaLocation :: !(Maybe Text) @@ -84,7 +85,9 @@ data ProjectsJobsAggregated = ProjectsJobsAggregated' , _pjaProjectId :: !Text , _pjaPageSize :: !(Maybe (Textual Int32)) , _pjaCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsAggregated' with the minimum fields required to make a request. -- @@ -115,7 +118,7 @@ projectsJobsAggregated :: Text -- ^ 'pjaProjectId' -> ProjectsJobsAggregated projectsJobsAggregated pPjaProjectId_ = - ProjectsJobsAggregated' + ProjectsJobsAggregated' { _pjaXgafv = Nothing , _pjaUploadProtocol = Nothing , _pjaLocation = Nothing @@ -129,6 +132,7 @@ projectsJobsAggregated pPjaProjectId_ = , _pjaCallback = Nothing } + -- | V1 error format. pjaXgafv :: Lens' ProjectsJobsAggregated (Maybe Xgafv) pjaXgafv = lens _pjaXgafv (\ s a -> s{_pjaXgafv = a}) @@ -139,7 +143,9 @@ pjaUploadProtocol = lens _pjaUploadProtocol (\ s a -> s{_pjaUploadProtocol = a}) --- | The location that contains this job. +-- | The [regional endpoint] +-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints) +-- that contains this job. pjaLocation :: Lens' ProjectsJobsAggregated (Maybe Text) pjaLocation = lens _pjaLocation (\ s a -> s{_pjaLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Create.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Create.hs index 97c884d..69d8b9a 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Create.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/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.jobs.create@. module Network.Google.Resource.Dataflow.Projects.Jobs.Create @@ -66,10 +70,15 @@ type ProjectsJobsCreateResource = 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:/ 'projectsJobsCreate' smart constructor. -data ProjectsJobsCreate = ProjectsJobsCreate' +data ProjectsJobsCreate = + ProjectsJobsCreate' { _pjcXgafv :: !(Maybe Xgafv) , _pjcUploadProtocol :: !(Maybe Text) , _pjcLocation :: !(Maybe Text) @@ -80,7 +89,9 @@ data ProjectsJobsCreate = ProjectsJobsCreate' , _pjcProjectId :: !Text , _pjcReplaceJobId :: !(Maybe Text) , _pjcCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsCreate' with the minimum fields required to make a request. -- @@ -110,7 +121,7 @@ projectsJobsCreate -> Text -- ^ 'pjcProjectId' -> ProjectsJobsCreate projectsJobsCreate pPjcPayload_ pPjcProjectId_ = - ProjectsJobsCreate' + ProjectsJobsCreate' { _pjcXgafv = Nothing , _pjcUploadProtocol = Nothing , _pjcLocation = Nothing @@ -123,6 +134,7 @@ projectsJobsCreate pPjcPayload_ pPjcProjectId_ = , _pjcCallback = Nothing } + -- | V1 error format. pjcXgafv :: Lens' ProjectsJobsCreate (Maybe Xgafv) pjcXgafv = lens _pjcXgafv (\ s a -> s{_pjcXgafv = a}) @@ -133,7 +145,9 @@ pjcUploadProtocol = lens _pjcUploadProtocol (\ s a -> s{_pjcUploadProtocol = a}) --- | The location that contains this job. +-- | The [regional endpoint] +-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints) +-- that contains this job. pjcLocation :: Lens' ProjectsJobsCreate (Maybe Text) pjcLocation = lens _pjcLocation (\ s a -> s{_pjcLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/GetConfig.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/GetConfig.hs index d7eee23..74fc7a7 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/GetConfig.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/GetConfig.hs @@ -68,7 +68,8 @@ type ProjectsJobsDebugGetConfigResource = -- | Get encoded debug configuration for component. Not cacheable. -- -- /See:/ 'projectsJobsDebugGetConfig' smart constructor. -data ProjectsJobsDebugGetConfig = ProjectsJobsDebugGetConfig' +data ProjectsJobsDebugGetConfig = + ProjectsJobsDebugGetConfig' { _pjdgcXgafv :: !(Maybe Xgafv) , _pjdgcJobId :: !Text , _pjdgcUploadProtocol :: !(Maybe Text) @@ -77,7 +78,9 @@ data ProjectsJobsDebugGetConfig = ProjectsJobsDebugGetConfig' , _pjdgcPayload :: !GetDebugConfigRequest , _pjdgcProjectId :: !Text , _pjdgcCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsDebugGetConfig' with the minimum fields required to make a request. -- @@ -104,7 +107,7 @@ projectsJobsDebugGetConfig -> Text -- ^ 'pjdgcProjectId' -> ProjectsJobsDebugGetConfig projectsJobsDebugGetConfig pPjdgcJobId_ pPjdgcPayload_ pPjdgcProjectId_ = - ProjectsJobsDebugGetConfig' + ProjectsJobsDebugGetConfig' { _pjdgcXgafv = Nothing , _pjdgcJobId = pPjdgcJobId_ , _pjdgcUploadProtocol = Nothing @@ -115,6 +118,7 @@ projectsJobsDebugGetConfig pPjdgcJobId_ pPjdgcPayload_ pPjdgcProjectId_ = , _pjdgcCallback = Nothing } + -- | V1 error format. pjdgcXgafv :: Lens' ProjectsJobsDebugGetConfig (Maybe Xgafv) pjdgcXgafv diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/SendCapture.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/SendCapture.hs index f7d2405..45e9afa 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/SendCapture.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Debug/SendCapture.hs @@ -68,7 +68,8 @@ type ProjectsJobsDebugSendCaptureResource = -- | Send encoded debug capture data for component. -- -- /See:/ 'projectsJobsDebugSendCapture' smart constructor. -data ProjectsJobsDebugSendCapture = ProjectsJobsDebugSendCapture' +data ProjectsJobsDebugSendCapture = + ProjectsJobsDebugSendCapture' { _pjdscXgafv :: !(Maybe Xgafv) , _pjdscJobId :: !Text , _pjdscUploadProtocol :: !(Maybe Text) @@ -77,7 +78,9 @@ data ProjectsJobsDebugSendCapture = ProjectsJobsDebugSendCapture' , _pjdscPayload :: !SendDebugCaptureRequest , _pjdscProjectId :: !Text , _pjdscCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsDebugSendCapture' with the minimum fields required to make a request. -- @@ -104,7 +107,7 @@ projectsJobsDebugSendCapture -> Text -- ^ 'pjdscProjectId' -> ProjectsJobsDebugSendCapture projectsJobsDebugSendCapture pPjdscJobId_ pPjdscPayload_ pPjdscProjectId_ = - ProjectsJobsDebugSendCapture' + ProjectsJobsDebugSendCapture' { _pjdscXgafv = Nothing , _pjdscJobId = pPjdscJobId_ , _pjdscUploadProtocol = Nothing @@ -115,6 +118,7 @@ projectsJobsDebugSendCapture pPjdscJobId_ pPjdscPayload_ pPjdscProjectId_ = , _pjdscCallback = Nothing } + -- | V1 error format. pjdscXgafv :: Lens' ProjectsJobsDebugSendCapture (Maybe Xgafv) pjdscXgafv 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}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/GetMetrics.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/GetMetrics.hs index 54d7e9a..b3ae133 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/GetMetrics.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/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.jobs.getMetrics@. module Network.Google.Resource.Dataflow.Projects.Jobs.GetMetrics @@ -66,10 +70,15 @@ type ProjectsJobsGetMetricsResource = 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:/ 'projectsJobsGetMetrics' smart constructor. -data ProjectsJobsGetMetrics = ProjectsJobsGetMetrics' +data ProjectsJobsGetMetrics = + ProjectsJobsGetMetrics' { _pjgmXgafv :: !(Maybe Xgafv) , _pjgmJobId :: !Text , _pjgmUploadProtocol :: !(Maybe Text) @@ -79,7 +88,9 @@ data ProjectsJobsGetMetrics = ProjectsJobsGetMetrics' , _pjgmUploadType :: !(Maybe Text) , _pjgmProjectId :: !Text , _pjgmCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsGetMetrics' with the minimum fields required to make a request. -- @@ -107,7 +118,7 @@ projectsJobsGetMetrics -> Text -- ^ 'pjgmProjectId' -> ProjectsJobsGetMetrics projectsJobsGetMetrics pPjgmJobId_ pPjgmProjectId_ = - ProjectsJobsGetMetrics' + ProjectsJobsGetMetrics' { _pjgmXgafv = Nothing , _pjgmJobId = pPjgmJobId_ , _pjgmUploadProtocol = Nothing @@ -119,6 +130,7 @@ projectsJobsGetMetrics pPjgmJobId_ pPjgmProjectId_ = , _pjgmCallback = Nothing } + -- | V1 error format. pjgmXgafv :: Lens' ProjectsJobsGetMetrics (Maybe Xgafv) pjgmXgafv @@ -135,7 +147,9 @@ pjgmUploadProtocol = lens _pjgmUploadProtocol (\ s a -> s{_pjgmUploadProtocol = 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. pjgmLocation :: Lens' ProjectsJobsGetMetrics (Maybe Text) pjgmLocation = lens _pjgmLocation (\ s a -> s{_pjgmLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/List.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/List.hs index 9f07fb8..f5293c6 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/List.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/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.jobs.list@. module Network.Google.Resource.Dataflow.Projects.Jobs.List @@ -69,10 +76,18 @@ type ProjectsJobsListResource = 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:/ 'projectsJobsList' smart constructor. -data ProjectsJobsList = ProjectsJobsList' +data ProjectsJobsList = + ProjectsJobsList' { _pjlXgafv :: !(Maybe Xgafv) , _pjlUploadProtocol :: !(Maybe Text) , _pjlLocation :: !(Maybe Text) @@ -84,7 +99,9 @@ data ProjectsJobsList = ProjectsJobsList' , _pjlProjectId :: !Text , _pjlPageSize :: !(Maybe (Textual Int32)) , _pjlCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsList' with the minimum fields required to make a request. -- @@ -115,7 +132,7 @@ projectsJobsList :: Text -- ^ 'pjlProjectId' -> ProjectsJobsList projectsJobsList pPjlProjectId_ = - ProjectsJobsList' + ProjectsJobsList' { _pjlXgafv = Nothing , _pjlUploadProtocol = Nothing , _pjlLocation = Nothing @@ -129,6 +146,7 @@ projectsJobsList pPjlProjectId_ = , _pjlCallback = Nothing } + -- | V1 error format. pjlXgafv :: Lens' ProjectsJobsList (Maybe Xgafv) pjlXgafv = lens _pjlXgafv (\ s a -> s{_pjlXgafv = a}) @@ -139,7 +157,9 @@ pjlUploadProtocol = lens _pjlUploadProtocol (\ s a -> s{_pjlUploadProtocol = a}) --- | The location that contains this job. +-- | The [regional endpoint] +-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints) +-- that contains this job. pjlLocation :: Lens' ProjectsJobsList (Maybe Text) pjlLocation = lens _pjlLocation (\ s a -> s{_pjlLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Messages/List.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Messages/List.hs index af5d54a..28e4f94 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Messages/List.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/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.jobs.messages.list@. module Network.Google.Resource.Dataflow.Projects.Jobs.Messages.List @@ -74,10 +79,16 @@ type ProjectsJobsMessagesListResource = 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:/ 'projectsJobsMessagesList' smart constructor. -data ProjectsJobsMessagesList = ProjectsJobsMessagesList' +data ProjectsJobsMessagesList = + ProjectsJobsMessagesList' { _pjmlXgafv :: !(Maybe Xgafv) , _pjmlJobId :: !Text , _pjmlUploadProtocol :: !(Maybe Text) @@ -91,7 +102,9 @@ data ProjectsJobsMessagesList = ProjectsJobsMessagesList' , _pjmlProjectId :: !Text , _pjmlPageSize :: !(Maybe (Textual Int32)) , _pjmlCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsMessagesList' with the minimum fields required to make a request. -- @@ -127,7 +140,7 @@ projectsJobsMessagesList -> Text -- ^ 'pjmlProjectId' -> ProjectsJobsMessagesList projectsJobsMessagesList pPjmlJobId_ pPjmlProjectId_ = - ProjectsJobsMessagesList' + ProjectsJobsMessagesList' { _pjmlXgafv = Nothing , _pjmlJobId = pPjmlJobId_ , _pjmlUploadProtocol = Nothing @@ -143,6 +156,7 @@ projectsJobsMessagesList pPjmlJobId_ pPjmlProjectId_ = , _pjmlCallback = Nothing } + -- | V1 error format. pjmlXgafv :: Lens' ProjectsJobsMessagesList (Maybe Xgafv) pjmlXgafv @@ -159,7 +173,9 @@ pjmlUploadProtocol = lens _pjmlUploadProtocol (\ s a -> s{_pjmlUploadProtocol = 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. pjmlLocation :: Lens' ProjectsJobsMessagesList (Maybe Text) pjmlLocation = lens _pjmlLocation (\ s a -> s{_pjmlLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Snapshot.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Snapshot.hs index f24cdea..2ece42c 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Snapshot.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Snapshot.hs @@ -66,7 +66,8 @@ type ProjectsJobsSnapshotResource = -- | Snapshot the state of a streaming job. -- -- /See:/ 'projectsJobsSnapshot' smart constructor. -data ProjectsJobsSnapshot = ProjectsJobsSnapshot' +data ProjectsJobsSnapshot = + ProjectsJobsSnapshot' { _pjsXgafv :: !(Maybe Xgafv) , _pjsJobId :: !Text , _pjsUploadProtocol :: !(Maybe Text) @@ -75,7 +76,9 @@ data ProjectsJobsSnapshot = ProjectsJobsSnapshot' , _pjsPayload :: !SnapshotJobRequest , _pjsProjectId :: !Text , _pjsCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsSnapshot' with the minimum fields required to make a request. -- @@ -102,7 +105,7 @@ projectsJobsSnapshot -> Text -- ^ 'pjsProjectId' -> ProjectsJobsSnapshot projectsJobsSnapshot pPjsJobId_ pPjsPayload_ pPjsProjectId_ = - ProjectsJobsSnapshot' + ProjectsJobsSnapshot' { _pjsXgafv = Nothing , _pjsJobId = pPjsJobId_ , _pjsUploadProtocol = Nothing @@ -113,6 +116,7 @@ projectsJobsSnapshot pPjsJobId_ pPjsPayload_ pPjsProjectId_ = , _pjsCallback = Nothing } + -- | V1 error format. pjsXgafv :: Lens' ProjectsJobsSnapshot (Maybe Xgafv) pjsXgafv = lens _pjsXgafv (\ s a -> s{_pjsXgafv = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Update.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Update.hs index a9efd4a..9569217 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/Update.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/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.jobs.update@. module Network.Google.Resource.Dataflow.Projects.Jobs.Update @@ -64,10 +69,16 @@ type ProjectsJobsUpdateResource = 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:/ 'projectsJobsUpdate' smart constructor. -data ProjectsJobsUpdate = ProjectsJobsUpdate' +data ProjectsJobsUpdate = + ProjectsJobsUpdate' { _pjuXgafv :: !(Maybe Xgafv) , _pjuJobId :: !Text , _pjuUploadProtocol :: !(Maybe Text) @@ -77,7 +88,9 @@ data ProjectsJobsUpdate = ProjectsJobsUpdate' , _pjuPayload :: !Job , _pjuProjectId :: !Text , _pjuCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsUpdate' with the minimum fields required to make a request. -- @@ -106,7 +119,7 @@ projectsJobsUpdate -> Text -- ^ 'pjuProjectId' -> ProjectsJobsUpdate projectsJobsUpdate pPjuJobId_ pPjuPayload_ pPjuProjectId_ = - ProjectsJobsUpdate' + ProjectsJobsUpdate' { _pjuXgafv = Nothing , _pjuJobId = pPjuJobId_ , _pjuUploadProtocol = Nothing @@ -118,6 +131,7 @@ projectsJobsUpdate pPjuJobId_ pPjuPayload_ pPjuProjectId_ = , _pjuCallback = Nothing } + -- | V1 error format. pjuXgafv :: Lens' ProjectsJobsUpdate (Maybe Xgafv) pjuXgafv = lens _pjuXgafv (\ s a -> s{_pjuXgafv = a}) @@ -132,7 +146,9 @@ pjuUploadProtocol = lens _pjuUploadProtocol (\ s a -> s{_pjuUploadProtocol = a}) --- | The location that contains this job. +-- | The [regional endpoint] +-- (https:\/\/cloud.google.com\/dataflow\/docs\/concepts\/regional-endpoints) +-- that contains this job. pjuLocation :: Lens' ProjectsJobsUpdate (Maybe Text) pjuLocation = lens _pjuLocation (\ s a -> s{_pjuLocation = a}) diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/Lease.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/Lease.hs index a7912b8..eca6faa 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/Lease.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/Lease.hs @@ -67,7 +67,8 @@ type ProjectsJobsWorkItemsLeaseResource = -- | Leases a dataflow WorkItem to run. -- -- /See:/ 'projectsJobsWorkItemsLease' smart constructor. -data ProjectsJobsWorkItemsLease = ProjectsJobsWorkItemsLease' +data ProjectsJobsWorkItemsLease = + ProjectsJobsWorkItemsLease' { _pjwilXgafv :: !(Maybe Xgafv) , _pjwilJobId :: !Text , _pjwilUploadProtocol :: !(Maybe Text) @@ -76,7 +77,9 @@ data ProjectsJobsWorkItemsLease = ProjectsJobsWorkItemsLease' , _pjwilPayload :: !LeaseWorkItemRequest , _pjwilProjectId :: !Text , _pjwilCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsWorkItemsLease' with the minimum fields required to make a request. -- @@ -103,7 +106,7 @@ projectsJobsWorkItemsLease -> Text -- ^ 'pjwilProjectId' -> ProjectsJobsWorkItemsLease projectsJobsWorkItemsLease pPjwilJobId_ pPjwilPayload_ pPjwilProjectId_ = - ProjectsJobsWorkItemsLease' + ProjectsJobsWorkItemsLease' { _pjwilXgafv = Nothing , _pjwilJobId = pPjwilJobId_ , _pjwilUploadProtocol = Nothing @@ -114,6 +117,7 @@ projectsJobsWorkItemsLease pPjwilJobId_ pPjwilPayload_ pPjwilProjectId_ = , _pjwilCallback = Nothing } + -- | V1 error format. pjwilXgafv :: Lens' ProjectsJobsWorkItemsLease (Maybe Xgafv) pjwilXgafv diff --git a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/ReportStatus.hs b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/ReportStatus.hs index b642873..ab04f43 100644 --- a/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/ReportStatus.hs +++ b/gen/Network/Google/Resource/Dataflow/Projects/Jobs/WorkItems/ReportStatus.hs @@ -67,7 +67,8 @@ type ProjectsJobsWorkItemsReportStatusResource = -- | Reports the status of dataflow WorkItems leased by a worker. -- -- /See:/ 'projectsJobsWorkItemsReportStatus' smart constructor. -data ProjectsJobsWorkItemsReportStatus = ProjectsJobsWorkItemsReportStatus' +data ProjectsJobsWorkItemsReportStatus = + ProjectsJobsWorkItemsReportStatus' { _pjwirsXgafv :: !(Maybe Xgafv) , _pjwirsJobId :: !Text , _pjwirsUploadProtocol :: !(Maybe Text) @@ -76,7 +77,9 @@ data ProjectsJobsWorkItemsReportStatus = ProjectsJobsWorkItemsReportStatus' , _pjwirsPayload :: !ReportWorkItemStatusRequest , _pjwirsProjectId :: !Text , _pjwirsCallback :: !(Maybe Text) - } deriving (Eq,Show,Data,Typeable,Generic) + } + deriving (Eq, Show, Data, Typeable, Generic) + -- | Creates a value of 'ProjectsJobsWorkItemsReportStatus' with the minimum fields required to make a request. -- @@ -103,7 +106,7 @@ projectsJobsWorkItemsReportStatus -> Text -- ^ 'pjwirsProjectId' -> ProjectsJobsWorkItemsReportStatus projectsJobsWorkItemsReportStatus pPjwirsJobId_ pPjwirsPayload_ pPjwirsProjectId_ = - ProjectsJobsWorkItemsReportStatus' + ProjectsJobsWorkItemsReportStatus' { _pjwirsXgafv = Nothing , _pjwirsJobId = pPjwirsJobId_ , _pjwirsUploadProtocol = Nothing @@ -114,6 +117,7 @@ projectsJobsWorkItemsReportStatus pPjwirsJobId_ pPjwirsPayload_ pPjwirsProjectId , _pjwirsCallback = Nothing } + -- | V1 error format. pjwirsXgafv :: Lens' ProjectsJobsWorkItemsReportStatus (Maybe Xgafv) pjwirsXgafv @@ -161,7 +165,8 @@ pjwirsCallback (\ s a -> s{_pjwirsCallback = a}) instance GoogleRequest - ProjectsJobsWorkItemsReportStatus where + ProjectsJobsWorkItemsReportStatus + where type Rs ProjectsJobsWorkItemsReportStatus = ReportWorkItemStatusResponse type Scopes ProjectsJobsWorkItemsReportStatus = |