feat(dataflow): update the api

#### dataflow:v1b3 The following keys were added: - schemas.Job.properties.runtimeUpdatableParams.$ref (Total Keys: 1) - schemas.PubsubLocation.properties.dynamicDestinations.type (Total Keys: 1) - schemas.RuntimeUpdatableParams (Total Keys: 6)
googleapis · May 24, 2023 · ffeaa42 · ffeaa42
1 parent acd9205
commit ffeaa42
Show file tree

Hide file tree

Showing 8 changed files with 114 additions and 3 deletions.
diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.html b/docs/dyn/dataflow_v1b3.projects.jobs.html
@@ -433,6 +433,10 @@ <h3>Method Details</h3>
       &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
       &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
       &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+      &quot;runtimeUpdatableParams&quot;: { # 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.
+        &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+        &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+      },
       &quot;satisfiesPzs&quot;: 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.
       &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
         { # A message describing the state of a particular execution stage.
@@ -769,6 +773,10 @@ <h3>Method Details</h3>
   &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
   &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
   &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+  &quot;runtimeUpdatableParams&quot;: { # 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.
+    &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+    &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+  },
   &quot;satisfiesPzs&quot;: 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.
   &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
     { # A message describing the state of a particular execution stage.
@@ -1089,6 +1097,10 @@ <h3>Method Details</h3>
   &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
   &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
   &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+  &quot;runtimeUpdatableParams&quot;: { # 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.
+    &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+    &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+  },
   &quot;satisfiesPzs&quot;: 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.
   &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
     { # A message describing the state of a particular execution stage.
@@ -1416,6 +1428,10 @@ <h3>Method Details</h3>
   &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
   &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
   &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+  &quot;runtimeUpdatableParams&quot;: { # 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.
+    &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+    &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+  },
   &quot;satisfiesPzs&quot;: 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.
   &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
     { # A message describing the state of a particular execution stage.
@@ -1801,6 +1817,10 @@ <h3>Method Details</h3>
       &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
       &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
       &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+      &quot;runtimeUpdatableParams&quot;: { # 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.
+        &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+        &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+      },
       &quot;satisfiesPzs&quot;: 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.
       &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
         { # A message describing the state of a particular execution stage.
@@ -2178,6 +2198,10 @@ <h3>Method Details</h3>
   &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
   &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
   &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+  &quot;runtimeUpdatableParams&quot;: { # 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.
+    &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+    &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+  },
   &quot;satisfiesPzs&quot;: 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.
   &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
     { # A message describing the state of a particular execution stage.
@@ -2492,6 +2516,10 @@ <h3>Method Details</h3>
   &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
   &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
   &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+  &quot;runtimeUpdatableParams&quot;: { # 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.
+    &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+    &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+  },
   &quot;satisfiesPzs&quot;: 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.
   &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
     { # A message describing the state of a particular execution stage.

diff --git a/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html b/docs/dyn/dataflow_v1b3.projects.jobs.workItems.html
@@ -609,6 +609,7 @@ <h3>Method Details</h3>
                   },
                   &quot;pubsubLocation&quot;: { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
                     &quot;dropLateData&quot;: True or False, # Indicates whether the pipeline allows late-arriving data.
+                    &quot;dynamicDestinations&quot;: True or False, # If true, then this location represents dynamic topics.
                     &quot;idLabel&quot;: &quot;A String&quot;, # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
                     &quot;subscription&quot;: &quot;A String&quot;, # A pubsub subscription, in the form of &quot;pubsub.googleapis.com/subscriptions//&quot;
                     &quot;timestampLabel&quot;: &quot;A String&quot;, # 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>
                   },
                   &quot;pubsubLocation&quot;: { # Identifies a pubsub location to use for transferring data into or out of a streaming Dataflow job. # The stream is a pubsub stream.
                     &quot;dropLateData&quot;: True or False, # Indicates whether the pipeline allows late-arriving data.
+                    &quot;dynamicDestinations&quot;: True or False, # If true, then this location represents dynamic topics.
                     &quot;idLabel&quot;: &quot;A String&quot;, # If set, contains a pubsub label from which to extract record ids. If left empty, record deduplication will be strictly best effort.
                     &quot;subscription&quot;: &quot;A String&quot;, # A pubsub subscription, in the form of &quot;pubsub.googleapis.com/subscriptions//&quot;
                     &quot;timestampLabel&quot;: &quot;A String&quot;, # If set, contains a pubsub label from which to extract record timestamps. If left empty, record timestamps will be generated upon arrival.

diff --git a/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html b/docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
@@ -493,6 +493,10 @@ <h3>Method Details</h3>
     &quot;replaceJobId&quot;: &quot;A String&quot;, # 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.
     &quot;replacedByJobId&quot;: &quot;A String&quot;, # 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.
     &quot;requestedState&quot;: &quot;A String&quot;, # The job&#x27;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&#x27;s requested state to `JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the job if it has not already reached a terminal state.
+    &quot;runtimeUpdatableParams&quot;: { # 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.
+      &quot;maxNumWorkers&quot;: 42, # The maximum number of workers to cap autoscaling at. This field is currently only supported for Streaming Engine jobs.
+      &quot;minNumWorkers&quot;: 42, # The minimum number of workers to scale down to. This field is currently only supported for Streaming Engine jobs.
+    },
     &quot;satisfiesPzs&quot;: 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.
     &quot;stageStates&quot;: [ # This field may be mutated by the Cloud Dataflow service; callers cannot mutate it.
       { # A message describing the state of a particular execution stage.