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.locations.flexTemplates.html
+6-5
Original file line number
Diff line number
Diff line change
@@ -229,7 +229,7 @@ <h3>Method Details</h3>
229
229
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
230
230
"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
231
231
"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.
232
-
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
232
+
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.
233
233
"currentStateTime": "A String", # The timestamp associated with the current state.
234
234
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
235
235
"clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
@@ -360,7 +360,7 @@ <h3>Method Details</h3>
360
360
},
361
361
},
362
362
},
363
-
"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
363
+
"id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
364
364
"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.
365
365
"bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job.
366
366
{ # Metadata for a Cloud Bigtable connector used by the job.
@@ -421,7 +421,7 @@ <h3>Method Details</h3>
421
421
"a_key": "A String",
422
422
},
423
423
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
424
-
"name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
424
+
"name": "A String", # The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
425
425
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -510,13 +510,14 @@ <h3>Method Details</h3>
510
510
],
511
511
"stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists.
512
512
},
513
-
"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.
513
+
"projectId": "A String", # The ID of the Google Cloud project that the job belongs to.
514
514
"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.
515
515
"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.
516
516
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
517
517
"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.
518
518
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
519
519
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
520
+
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.
520
521
},
521
522
"satisfiesPzi": True or False, # Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
522
523
"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.
@@ -544,7 +545,7 @@ <h3>Method Details</h3>
544
545
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
545
546
"a_key": "A String",
546
547
},
547
-
"type": "A String", # The type of Cloud Dataflow job.
548
+
"type": "A String", # The type of Dataflow job.
Copy file name to clipboardExpand all lines: docs/dyn/dataflow_v1b3.projects.locations.templates.html
+12-10
Original file line number
Diff line number
Diff line change
@@ -146,7 +146,7 @@ <h3>Method Details</h3>
146
146
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
147
147
"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
148
148
"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.
149
-
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
149
+
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.
150
150
"currentStateTime": "A String", # The timestamp associated with the current state.
151
151
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
152
152
"clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
@@ -277,7 +277,7 @@ <h3>Method Details</h3>
277
277
},
278
278
},
279
279
},
280
-
"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
280
+
"id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
281
281
"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.
282
282
"bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job.
283
283
{ # Metadata for a Cloud Bigtable connector used by the job.
@@ -338,7 +338,7 @@ <h3>Method Details</h3>
338
338
"a_key": "A String",
339
339
},
340
340
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
341
-
"name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
341
+
"name": "A String", # The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
342
342
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -427,13 +427,14 @@ <h3>Method Details</h3>
427
427
],
428
428
"stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists.
429
429
},
430
-
"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.
430
+
"projectId": "A String", # The ID of the Google Cloud project that the job belongs to.
431
431
"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.
432
432
"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.
433
433
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
434
434
"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.
435
435
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
436
436
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
437
+
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.
437
438
},
438
439
"satisfiesPzi": True or False, # Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
439
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.
@@ -461,7 +462,7 @@ <h3>Method Details</h3>
461
462
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
462
463
"a_key": "A String",
463
464
},
464
-
"type": "A String", # The type of Cloud Dataflow job.
465
+
"type": "A String", # The type of Dataflow job.
465
466
}</pre>
466
467
</div>
467
468
@@ -625,7 +626,7 @@ <h3>Method Details</h3>
625
626
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
626
627
"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
627
628
"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.
628
-
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
629
+
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.
629
630
"currentStateTime": "A String", # The timestamp associated with the current state.
630
631
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
631
632
"clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
@@ -756,7 +757,7 @@ <h3>Method Details</h3>
756
757
},
757
758
},
758
759
},
759
-
"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
760
+
"id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
760
761
"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.
761
762
"bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job.
762
763
{ # Metadata for a Cloud Bigtable connector used by the job.
@@ -817,7 +818,7 @@ <h3>Method Details</h3>
817
818
"a_key": "A String",
818
819
},
819
820
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
820
-
"name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
821
+
"name": "A String", # The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
821
822
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -906,13 +907,14 @@ <h3>Method Details</h3>
906
907
],
907
908
"stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists.
908
909
},
909
-
"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.
910
+
"projectId": "A String", # The ID of the Google Cloud project that the job belongs to.
910
911
"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.
911
912
"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.
912
913
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
913
914
"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.
914
915
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
915
916
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
917
+
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.
916
918
},
917
919
"satisfiesPzi": True or False, # Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
918
920
"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.
@@ -940,7 +942,7 @@ <h3>Method Details</h3>
940
942
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
941
943
"a_key": "A String",
942
944
},
943
-
"type": "A String", # The type of Cloud Dataflow job.
945
+
"type": "A String", # The type of Dataflow job.
Copy file name to clipboardExpand all lines: docs/dyn/dataflow_v1b3.projects.templates.html
+12-10
Original file line number
Diff line number
Diff line change
@@ -145,7 +145,7 @@ <h3>Method Details</h3>
145
145
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
146
146
"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
147
147
"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.
148
-
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
148
+
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.
149
149
"currentStateTime": "A String", # The timestamp associated with the current state.
150
150
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
151
151
"clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
@@ -276,7 +276,7 @@ <h3>Method Details</h3>
276
276
},
277
277
},
278
278
},
279
-
"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
279
+
"id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
280
280
"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.
281
281
"bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job.
282
282
{ # Metadata for a Cloud Bigtable connector used by the job.
@@ -337,7 +337,7 @@ <h3>Method Details</h3>
337
337
"a_key": "A String",
338
338
},
339
339
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
340
-
"name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
340
+
"name": "A String", # The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
341
341
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -426,13 +426,14 @@ <h3>Method Details</h3>
426
426
],
427
427
"stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists.
428
428
},
429
-
"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.
429
+
"projectId": "A String", # The ID of the Google Cloud project that the job belongs to.
430
430
"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.
431
431
"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.
432
432
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
433
433
"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.
434
434
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
435
435
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
436
+
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.
436
437
},
437
438
"satisfiesPzi": True or False, # Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
438
439
"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.
@@ -460,7 +461,7 @@ <h3>Method Details</h3>
460
461
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
461
462
"a_key": "A String",
462
463
},
463
-
"type": "A String", # The type of Cloud Dataflow job.
464
+
"type": "A String", # The type of Dataflow job.
464
465
}</pre>
465
466
</div>
466
467
@@ -624,7 +625,7 @@ <h3>Method Details</h3>
624
625
"clientRequestId": "A String", # The client's unique identifier of the job, re-used across retried attempts. If this field is set, the service will ensure its uniqueness. The request to create a job will fail if the service has knowledge of a previously submitted job with the same client's ID and job name. The caller may use this field to ensure idempotence of job creation across retried attempts to create a job. By default, the field is empty and, in that case, the service ignores it.
625
626
"createTime": "A String", # The timestamp when the job was initially created. Immutable and set by the Cloud Dataflow service.
626
627
"createdFromSnapshotId": "A String", # If this is specified, the job's initial state is populated from the given snapshot.
627
-
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
628
+
"currentState": "A String", # The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.
628
629
"currentStateTime": "A String", # The timestamp associated with the current state.
629
630
"environment": { # Describes the environment in which a Dataflow Job runs. # The environment for the job.
630
631
"clusterManagerApiService": "A String", # The type of cluster manager API to use. If unknown or unspecified, the service will attempt to choose a reasonable default. This should be in the form of the API service name, e.g. "compute.googleapis.com".
@@ -755,7 +756,7 @@ <h3>Method Details</h3>
755
756
},
756
757
},
757
758
},
758
-
"id": "A String", # The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.
759
+
"id": "A String", # The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.
759
760
"jobMetadata": { # Metadata available primarily for filtering jobs. Will be included in the ListJob response and Job SUMMARY view. # This field is populated by the Dataflow service to support filtering jobs by the metadata values provided here. Populated for ListJobs and all GetJob views SUMMARY and higher.
760
761
"bigTableDetails": [ # Identification of a Cloud Bigtable source used in the Dataflow job.
761
762
{ # Metadata for a Cloud Bigtable connector used by the job.
@@ -816,7 +817,7 @@ <h3>Method Details</h3>
816
817
"a_key": "A String",
817
818
},
818
819
"location": "A String", # The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.
819
-
"name": "A String", # The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
820
+
"name": "A String", # The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`
820
821
"pipelineDescription": { # A descriptive representation of submitted pipeline as well as the executed form. This data is provided by the Dataflow service for ease of visualizing the pipeline and interpreting Dataflow provided metrics. # Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL.
{ # Data provided with a pipeline or transform to provide descriptive info.
@@ -905,13 +906,14 @@ <h3>Method Details</h3>
905
906
],
906
907
"stepNamesHash": "A String", # A hash value of the submitted pipeline portable graph step names if exists.
907
908
},
908
-
"projectId": "A String", # The ID of the Cloud Platform project that the job belongs to.
909
+
"projectId": "A String", # The ID of the Google Cloud project that the job belongs to.
909
910
"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.
910
911
"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.
911
912
"requestedState": "A String", # The job's requested state. Applies to `UpdateJob` requests. Set `requested_state` with `UpdateJob` requests to switch between the states `JOB_STATE_STOPPED` and `JOB_STATE_RUNNING`. You can also use `UpdateJob` requests to change a job's state from `JOB_STATE_RUNNING` to `JOB_STATE_CANCELLED`, `JOB_STATE_DONE`, or `JOB_STATE_DRAINED`. These states irrevocably terminate the job if it hasn't already reached a terminal state. This field has no effect on `CreateJob` requests.
912
913
"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.
913
914
"maxNumWorkers": 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
914
915
"minNumWorkers": 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
916
+
"workerUtilizationHint": 3.14, # Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.
915
917
},
916
918
"satisfiesPzi": True or False, # Output only. Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests.
917
919
"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.
@@ -939,7 +941,7 @@ <h3>Method Details</h3>
939
941
"transformNameMapping": { # The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job.
940
942
"a_key": "A String",
941
943
},
942
-
"type": "A String", # The type of Cloud Dataflow job.
944
+
"type": "A String", # The type of Dataflow job.
Copy file name to clipboardExpand all lines: googleapiclient/discovery_cache/documents/dataflow.v1b3.json
+11-6
Original file line number
Diff line number
Diff line change
@@ -2221,7 +2221,7 @@
2221
2221
}
2222
2222
}
2223
2223
},
2224
-
"revision": "20231112",
2224
+
"revision": "20231130",
2225
2225
"rootUrl": "https://dataflow.googleapis.com/",
2226
2226
"schemas": {
2227
2227
"ApproximateProgress": {
@@ -3809,7 +3809,7 @@
3809
3809
"type": "string"
3810
3810
},
3811
3811
"currentState": {
3812
-
"description": "The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.",
3812
+
"description": "The current state of the job. Jobs are created in the `JOB_STATE_STOPPED` state unless otherwise specified. A job in the `JOB_STATE_RUNNING` state may asynchronously enter a terminal state. After a job has reached a terminal state, no further state updates may be made. This field might be mutated by the Dataflow service; callers cannot mutate it.",
3813
3813
"enum": [
3814
3814
"JOB_STATE_UNKNOWN",
3815
3815
"JOB_STATE_STOPPED",
@@ -3856,7 +3856,7 @@
3856
3856
"description": "Deprecated."
3857
3857
},
3858
3858
"id": {
3859
-
"description": "The unique ID of this job. This field is set by the Cloud Dataflow service when the Job is created, and is immutable for the life of the job.",
3859
+
"description": "The unique ID of this job. This field is set by the Dataflow service when the job is created, and is immutable for the life of the job.",
3860
3860
"type": "string"
3861
3861
},
3862
3862
"jobMetadata": {
@@ -3875,15 +3875,15 @@
3875
3875
"type": "string"
3876
3876
},
3877
3877
"name": {
3878
-
"description": "The user-specified Cloud Dataflow job name. Only one Job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a Job with the same name as an already-existing Job, the attempt returns the existing Job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`",
3878
+
"description": "The user-specified Dataflow job name. Only one active job with a given name can exist in a project within one region at any given time. Jobs in different regions can have the same name. If a caller attempts to create a job with the same name as an active job that already exists, the attempt returns the existing job. The name must match the regular expression `[a-z]([-a-z0-9]{0,1022}[a-z0-9])?`",
3879
3879
"type": "string"
3880
3880
},
3881
3881
"pipelineDescription": {
3882
3882
"$ref": "PipelineDescription",
3883
3883
"description": "Preliminary field: The format of this data may change at any time. A description of the user pipeline and stages through which it is executed. Created by Cloud Dataflow service. Only retrieved with JOB_VIEW_DESCRIPTION or JOB_VIEW_ALL."
3884
3884
},
3885
3885
"projectId": {
3886
-
"description": "The ID of the Cloud Platform project that the job belongs to.",
3886
+
"description": "The ID of the Google Cloud project that the job belongs to.",
3887
3887
"type": "string"
3888
3888
},
3889
3889
"replaceJobId": {
@@ -3979,7 +3979,7 @@
3979
3979
"type": "object"
3980
3980
},
3981
3981
"type": {
3982
-
"description": "The type of Cloud Dataflow job.",
3982
+
"description": "The type of Dataflow job.",
3983
3983
"enum": [
3984
3984
"JOB_TYPE_UNKNOWN",
3985
3985
"JOB_TYPE_BATCH",
@@ -5372,6 +5372,11 @@
5372
5372
"description": "The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.",
5373
5373
"format": "int32",
5374
5374
"type": "integer"
5375
+
},
5376
+
"workerUtilizationHint": {
5377
+
"description": "Target worker utilization, compared against the aggregate utilization of the worker pool by autoscaler, to determine upscaling and downscaling when absent other constraints such as backlog.",
0 commit comments