You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.jobs.html
+28
Original file line number
Diff line number
Diff line change
@@ -433,6 +433,10 @@ <h3>Method Details</h3>
433
433
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
434
434
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
435
435
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
436
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
437
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
438
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
439
+
},
436
440
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
437
441
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
438
442
{ # A message describing the state of a particular execution stage.
@@ -769,6 +773,10 @@ <h3>Method Details</h3>
769
773
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
770
774
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
771
775
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
776
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
777
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
778
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
779
+
},
772
780
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
773
781
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
774
782
{ # A message describing the state of a particular execution stage.
@@ -1089,6 +1097,10 @@ <h3>Method Details</h3>
1089
1097
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1090
1098
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1091
1099
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1100
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1101
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1102
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1103
+
},
1092
1104
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1093
1105
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1094
1106
{ # A message describing the state of a particular execution stage.
@@ -1416,6 +1428,10 @@ <h3>Method Details</h3>
1416
1428
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1417
1429
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1418
1430
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1431
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1432
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1433
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1434
+
},
1419
1435
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1420
1436
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1421
1437
{ # A message describing the state of a particular execution stage.
@@ -1801,6 +1817,10 @@ <h3>Method Details</h3>
1801
1817
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1802
1818
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1803
1819
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1820
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1821
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1822
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1823
+
},
1804
1824
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1805
1825
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1806
1826
{ # A message describing the state of a particular execution stage.
@@ -2178,6 +2198,10 @@ <h3>Method Details</h3>
2178
2198
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
2179
2199
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
2180
2200
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
2201
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
2202
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
2203
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
2204
+
},
2181
2205
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
2182
2206
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
2183
2207
{ # A message describing the state of a particular execution stage.
@@ -2492,6 +2516,10 @@ <h3>Method Details</h3>
2492
2516
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
2493
2517
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
2494
2518
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
2519
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
2520
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
2521
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
2522
+
},
2495
2523
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
2496
2524
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
2497
2525
{ # A message describing the state of a particular execution stage.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
+2
Original file line number
Diff line number
Diff line change
@@ -609,6 +609,7 @@ <h3>Method Details</h3>
609
609
},
610
610
"pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
611
611
"dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
612
+
"dynamicDestinations": True or False, # If true, then this location represents dynamic topics.
612
613
"idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
613
614
"subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
614
615
"timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
@@ -641,6 +642,7 @@ <h3>Method Details</h3>
641
642
},
642
643
"pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
643
644
"dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
645
+
"dynamicDestinations": True or False, # If true, then this location represents dynamic topics.
644
646
"idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
645
647
"subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
646
648
"timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
+4
Original file line number
Diff line number
Diff line change
@@ -493,6 +493,10 @@ <h3>Method Details</h3>
493
493
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
494
494
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
495
495
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
496
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
497
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
498
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
499
+
},
496
500
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
497
501
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
498
502
{ # A message describing the state of a particular execution stage.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.locations.jobs.html
+24
Original file line number
Diff line number
Diff line change
@@ -421,6 +421,10 @@ <h3>Method Details</h3>
421
421
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
422
422
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
423
423
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
424
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
425
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
426
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
427
+
},
424
428
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
425
429
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
426
430
{ # A message describing the state of a particular execution stage.
@@ -740,6 +744,10 @@ <h3>Method Details</h3>
740
744
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
741
745
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
742
746
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
747
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
748
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
749
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
750
+
},
743
751
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
744
752
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
745
753
{ # A message describing the state of a particular execution stage.
@@ -1067,6 +1075,10 @@ <h3>Method Details</h3>
1067
1075
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1068
1076
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1069
1077
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1078
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1079
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1080
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1081
+
},
1070
1082
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1071
1083
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1072
1084
{ # A message describing the state of a particular execution stage.
@@ -1560,6 +1572,10 @@ <h3>Method Details</h3>
1560
1572
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1561
1573
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1562
1574
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1575
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1576
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1577
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1578
+
},
1563
1579
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1564
1580
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1565
1581
{ # A message describing the state of a particular execution stage.
@@ -1939,6 +1955,10 @@ <h3>Method Details</h3>
1939
1955
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
1940
1956
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
1941
1957
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
1958
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
1959
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
1960
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
1961
+
},
1942
1962
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
1943
1963
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
1944
1964
{ # A message describing the state of a particular execution stage.
@@ -2252,6 +2272,10 @@ <h3>Method Details</h3>
2252
2272
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
2253
2273
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
2254
2274
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
2275
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
2276
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
2277
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
2278
+
},
2255
2279
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
2256
2280
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
2257
2281
{ # A message describing the state of a particular execution stage.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.locations.jobs.workItems.html
+2
Original file line number
Diff line number
Diff line change
@@ -610,6 +610,7 @@ <h3>Method Details</h3>
610
610
},
611
611
"pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
612
612
"dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
613
+
"dynamicDestinations": True or False, # If true, then this location represents dynamic topics.
613
614
"idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
614
615
"subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
615
616
"timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
@@ -642,6 +643,7 @@ <h3>Method Details</h3>
642
643
},
643
644
"pubsubLocation": { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
644
645
"dropLateData": True or False, # Indicates whether the pipeline allows late-arriving data.
646
+
"dynamicDestinations": True or False, # If true, then this location represents dynamic topics.
645
647
"idLabel": "A String", # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
646
648
"subscription": "A String", # A pubsub subscription, in the form of "pubsub.googleapis.com/subscriptions//"
647
649
"timestampLabel": "A String", # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.locations.templates.html
+8
Original file line number
Diff line number
Diff line change
@@ -417,6 +417,10 @@ <h3>Method Details</h3>
417
417
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
418
418
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
419
419
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
420
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
421
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
422
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
423
+
},
420
424
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
421
425
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
422
426
{ # A message describing the state of a particular execution stage.
@@ -861,6 +865,10 @@ <h3>Method Details</h3>
861
865
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
862
866
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
863
867
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
868
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
869
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
870
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
871
+
},
864
872
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
865
873
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
866
874
{ # A message describing the state of a particular execution stage.
Copy file name to clipboardexpand all lines: docs/dyn/dataflow_v1b3.projects.templates.html
+8
Original file line number
Diff line number
Diff line change
@@ -416,6 +416,10 @@ <h3>Method Details</h3>
416
416
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
417
417
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
418
418
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
419
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
420
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
421
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
422
+
},
419
423
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
420
424
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
421
425
{ # A message describing the state of a particular execution stage.
@@ -860,6 +864,10 @@ <h3>Method Details</h3>
860
864
"replaceJobId": "A String", # If this job is an update of an existing job, this field is the job ID of the job it replaced. When sending a `CreateJobRequest`, you can update a job by specifying it here. The job named here is stopped, and its intermediate state is transferred to this job.
861
865
"replacedByJobId": "A String", # If another job is an update of this job (and thus, this job is in `JOB_STATE_UPDATED`), this field contains the ID of that job.
862
866
"requestedState": "A String", # The job's requested state. `UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may also be used to directly set a job's requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
867
+
"runtimeUpdatableParams": { # Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation. # This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation.
868
+
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
869
+
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
870
+
},
863
871
"satisfiesPzs": True or False, # Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
864
872
"stageStates": [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
865
873
{ # A message describing the state of a particular execution stage.
Copy file name to clipboardexpand all lines: googleapiclient/discovery_cache/documents/dataflow.v1b3.json
+38-3
Original file line number
Diff line number
Diff line change
@@ -2211,7 +2211,7 @@
2211
2211
}
2212
2212
}
2213
2213
},
2214
-
"revision": "20230331",
2214
+
"revision": "20230514",
2215
2215
"rootUrl": "https://dataflow.googleapis.com/",
2216
2216
"schemas": {
2217
2217
"ApproximateProgress": {
@@ -3838,6 +3838,10 @@
3838
3838
],
3839
3839
"type": "string"
3840
3840
},
3841
+
"runtimeUpdatableParams": {
3842
+
"$ref": "RuntimeUpdatableParams",
3843
+
"description": "This field may ONLY be modified at runtime using the projects.jobs.update method to adjust job behavior. This field has no effect when specified at job creation."
3844
+
},
3841
3845
"satisfiesPzs": {
3842
3846
"description": "Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.",
3843
3847
"type": "boolean"
@@ -4727,7 +4731,12 @@
4727
4731
"PUBSUB_TOPIC",
4728
4732
"PUBSUB_SUBSCRIPTION",
4729
4733
"BIGQUERY_TABLE",
4730
-
"JAVASCRIPT_UDF_FILE"
4734
+
"JAVASCRIPT_UDF_FILE",
4735
+
"SERVICE_ACCOUNT",
4736
+
"MACHINE_TYPE",
4737
+
"KMS_KEY_NAME",
4738
+
"WORKER_REGION",
4739
+
"WORKER_ZONE"
4731
4740
],
4732
4741
"enumDescriptions": [
4733
4742
"Default input type.",
@@ -4741,7 +4750,12 @@
4741
4750
"The parameter specifies a Pub/Sub Topic.",
4742
4751
"The parameter specifies a Pub/Sub Subscription.",
4743
4752
"The parameter specifies a BigQuery table.",
4744
-
"The parameter specifies a JavaScript UDF in Cloud Storage."
4753
+
"The parameter specifies a JavaScript UDF in Cloud Storage.",
4754
+
"The parameter specifies a Service Account email.",
4755
+
"The parameter specifies a Machine Type.",
4756
+
"The parameter specifies a KMS Key name.",
4757
+
"The parameter specifies a Worker Region.",
4758
+
"The parameter specifies a Worker Zone."
4745
4759
],
4746
4760
"type": "string"
4747
4761
},
@@ -4932,6 +4946,10 @@
4932
4946
"description": "Indicates whether the pipeline allows late-arriving data.",
4933
4947
"type": "boolean"
4934
4948
},
4949
+
"dynamicDestinations": {
4950
+
"description": "If true, then this location represents dynamic topics.",
4951
+
"type": "boolean"
4952
+
},
4935
4953
"idLabel": {
4936
4954
"description": "If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.",
4937
4955
"type": "string"
@@ -5204,6 +5222,23 @@
5204
5222
},
5205
5223
"type": "object"
5206
5224
},
5225
+
"RuntimeUpdatableParams": {
5226
+
"description": "Additional job parameters that can only be updated during runtime using the projects.jobs.update method. These fields have no effect when specified during job creation.",
5227
+
"id": "RuntimeUpdatableParams",
5228
+
"properties": {
5229
+
"maxNumWorkers": {
5230
+
"description": "The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.",
5231
+
"format": "int32",
5232
+
"type": "integer"
5233
+
},
5234
+
"minNumWorkers": {
5235
+
"description": "The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.",
0 commit comments