Skip to content

Commit

Permalink
feat(dataflow): update the api
Browse files Browse the repository at this point in the history
#### dataflow:v1b3

The following keys were added:
- schemas.FlexTemplateRuntimeEnvironment.properties.streamingMode.type (Total Keys: 1)
- schemas.RuntimeEnvironment.properties.streamingMode.type (Total Keys: 1)
- schemas.StreamingScalingReport.properties.activeBundleCount.deprecated (Total Keys: 1)
- schemas.StreamingScalingReport.properties.maximumBytes (Total Keys: 3)
- schemas.StreamingScalingReport.properties.outstandingBundleCount (Total Keys: 2)
- schemas.StreamingScalingReport.properties.outstandingBytes (Total Keys: 3)
  • Loading branch information
yoshi-automation committed Jan 23, 2024
1 parent a23804b commit ac90f1e
Show file tree
Hide file tree
Showing 6 changed files with 68 additions and 13 deletions.
11 changes: 7 additions & 4 deletions docs/dyn/dataflow_v1b3.projects.html
Original file line number Diff line number Diff line change
Expand Up @@ -195,12 +195,15 @@ <h3>Method Details</h3>
],
},
&quot;streamingScalingReport&quot;: { # Contains per-user worker telemetry used in streaming autoscaling. # Contains per-user worker telemetry used in streaming autoscaling.
&quot;activeBundleCount&quot;: 42, # Current acive bundle count.
&quot;activeBundleCount&quot;: 42,
&quot;activeThreadCount&quot;: 42, # Current acive thread count.
&quot;maximumBundleCount&quot;: 42, # Maximum bundle count limit.
&quot;maximumBytesCount&quot;: 42, # Maximum bytes count limit.
&quot;maximumBundleCount&quot;: 42, # Maximum bundle count.
&quot;maximumBytes&quot;: &quot;A String&quot;, # Maximum bytes.
&quot;maximumBytesCount&quot;: 42,
&quot;maximumThreadCount&quot;: 42, # Maximum thread count limit.
&quot;outstandingBytesCount&quot;: 42, # Current outstanding bytes count.
&quot;outstandingBundleCount&quot;: 42, # Current outstanding bundle count.
&quot;outstandingBytes&quot;: &quot;A String&quot;, # Current outstanding bytes.
&quot;outstandingBytesCount&quot;: 42,
},
&quot;time&quot;: &quot;A String&quot;, # The timestamp of the worker_message.
&quot;workerHealthReport&quot;: { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker.
Expand Down
2 changes: 2 additions & 0 deletions docs/dyn/dataflow_v1b3.projects.locations.flexTemplates.html
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@ <h3>Method Details</h3>
&quot;sdkContainerImage&quot;: &quot;A String&quot;, # Docker registry location of container image to use for the &#x27;worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
&quot;stagingLocation&quot;: &quot;A String&quot;, # The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down Expand Up @@ -195,6 +196,7 @@ <h3>Method Details</h3>
&quot;sdkContainerImage&quot;: &quot;A String&quot;, # Docker registry location of container image to use for the &#x27;worker harness. Default is the container for the version of the SDK. Note this field is only valid for portable pipelines.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # The email address of the service account to run the job as.
&quot;stagingLocation&quot;: &quot;A String&quot;, # The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down
11 changes: 7 additions & 4 deletions docs/dyn/dataflow_v1b3.projects.locations.html
Original file line number Diff line number Diff line change
Expand Up @@ -173,12 +173,15 @@ <h3>Method Details</h3>
],
},
&quot;streamingScalingReport&quot;: { # Contains per-user worker telemetry used in streaming autoscaling. # Contains per-user worker telemetry used in streaming autoscaling.
&quot;activeBundleCount&quot;: 42, # Current acive bundle count.
&quot;activeBundleCount&quot;: 42,
&quot;activeThreadCount&quot;: 42, # Current acive thread count.
&quot;maximumBundleCount&quot;: 42, # Maximum bundle count limit.
&quot;maximumBytesCount&quot;: 42, # Maximum bytes count limit.
&quot;maximumBundleCount&quot;: 42, # Maximum bundle count.
&quot;maximumBytes&quot;: &quot;A String&quot;, # Maximum bytes.
&quot;maximumBytesCount&quot;: 42,
&quot;maximumThreadCount&quot;: 42, # Maximum thread count limit.
&quot;outstandingBytesCount&quot;: 42, # Current outstanding bytes count.
&quot;outstandingBundleCount&quot;: 42, # Current outstanding bundle count.
&quot;outstandingBytes&quot;: &quot;A String&quot;, # Current outstanding bytes.
&quot;outstandingBytesCount&quot;: 42,
},
&quot;time&quot;: &quot;A String&quot;, # The timestamp of the worker_message.
&quot;workerHealthReport&quot;: { # WorkerHealthReport contains information about the health of a worker. The VM should be identified by the labels attached to the WorkerMessage that this health ping belongs to. # The health of a worker.
Expand Down
2 changes: 2 additions & 0 deletions docs/dyn/dataflow_v1b3.projects.locations.templates.html
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down Expand Up @@ -594,6 +595,7 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down
2 changes: 2 additions & 0 deletions docs/dyn/dataflow_v1b3.projects.templates.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down Expand Up @@ -592,6 +593,7 @@ <h3>Method Details</h3>
&quot;network&quot;: &quot;A String&quot;, # Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network &quot;default&quot;.
&quot;numWorkers&quot;: 42, # Optional. The initial number of Google Compute Engine instances for the job. The default value is 11.
&quot;serviceAccountEmail&quot;: &quot;A String&quot;, # Optional. The email address of the service account to run the job as.
&quot;streamingMode&quot;: &quot;A String&quot;, # Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.
&quot;subnetwork&quot;: &quot;A String&quot;, # Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form &quot;https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK&quot; or &quot;regions/REGION/subnetworks/SUBNETWORK&quot;. If the subnetwork is located in a Shared VPC network, you must use the complete URL.
&quot;tempLocation&quot;: &quot;A String&quot;, # Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`.
&quot;workerRegion&quot;: &quot;A String&quot;, # Required. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. &quot;us-west1&quot;. Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane&#x27;s region.
Expand Down
53 changes: 48 additions & 5 deletions googleapiclient/discovery_cache/documents/dataflow.v1b3.json
Original file line number Diff line number Diff line change
Expand Up @@ -2221,7 +2221,7 @@
}
}
},
"revision": "20240107",
"revision": "20240113",
"rootUrl": "https://dataflow.googleapis.com/",
"schemas": {
"ApproximateProgress": {
Expand Down Expand Up @@ -3577,6 +3577,20 @@
"description": "The Cloud Storage path for staging local files. Must be a valid Cloud Storage URL, beginning with `gs://`.",
"type": "string"
},
"streamingMode": {
"description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.",
"enum": [
"STREAMING_MODE_UNSPECIFIED",
"STREAMING_MODE_EXACTLY_ONCE",
"STREAMING_MODE_AT_LEAST_ONCE"
],
"enumDescriptions": [
"Run in the default mode.",
"In this mode, message deduplication is performed against persistent state to make sure each message is processed and committed to storage exactly once.",
"Message deduplication is not performed. Messages might be processed multiple times, and the results are applied multiple times. Note: Setting this value also enables Streaming Engine and Streaming Engine resource-based billing."
],
"type": "string"
},
"subnetwork": {
"description": "Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form \"https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK\" or \"regions/REGION/subnetworks/SUBNETWORK\". If the subnetwork is located in a Shared VPC network, you must use the complete URL.",
"type": "string"
Expand Down Expand Up @@ -5504,6 +5518,20 @@
"description": "Optional. The email address of the service account to run the job as.",
"type": "string"
},
"streamingMode": {
"description": "Optional. Specifies the Streaming Engine message processing guarantees. Reduces cost and latency but might result in duplicate messages committed to storage. Designed to run simple mapping streaming ETL jobs at the lowest cost. For example, Change Data Capture (CDC) to BigQuery is a canonical use case.",
"enum": [
"STREAMING_MODE_UNSPECIFIED",
"STREAMING_MODE_EXACTLY_ONCE",
"STREAMING_MODE_AT_LEAST_ONCE"
],
"enumDescriptions": [
"Run in the default mode.",
"In this mode, message deduplication is performed against persistent state to make sure each message is processed and committed to storage exactly once.",
"Message deduplication is not performed. Messages might be processed multiple times, and the results are applied multiple times. Note: Setting this value also enables Streaming Engine and Streaming Engine resource-based billing."
],
"type": "string"
},
"subnetwork": {
"description": "Optional. Subnetwork to which VMs will be assigned, if desired. You can specify a subnetwork using either a complete URL or an abbreviated path. Expected to be of the form \"https://www.googleapis.com/compute/v1/projects/HOST_PROJECT_ID/regions/REGION/subnetworks/SUBNETWORK\" or \"regions/REGION/subnetworks/SUBNETWORK\". If the subnetwork is located in a Shared VPC network, you must use the complete URL.",
"type": "string"
Expand Down Expand Up @@ -6694,7 +6722,7 @@
"id": "StreamingScalingReport",
"properties": {
"activeBundleCount": {
"description": "Current acive bundle count.",
"deprecated": true,
"format": "int32",
"type": "integer"
},
Expand All @@ -6704,12 +6732,17 @@
"type": "integer"
},
"maximumBundleCount": {
"description": "Maximum bundle count limit.",
"description": "Maximum bundle count.",
"format": "int32",
"type": "integer"
},
"maximumBytes": {
"description": "Maximum bytes.",
"format": "int64",
"type": "string"
},
"maximumBytesCount": {
"description": "Maximum bytes count limit.",
"deprecated": true,
"format": "int32",
"type": "integer"
},
Expand All @@ -6718,8 +6751,18 @@
"format": "int32",
"type": "integer"
},
"outstandingBundleCount": {
"description": "Current outstanding bundle count.",
"format": "int32",
"type": "integer"
},
"outstandingBytes": {
"description": "Current outstanding bytes.",
"format": "int64",
"type": "string"
},
"outstandingBytesCount": {
"description": "Current outstanding bytes count.",
"deprecated": true,
"format": "int32",
"type": "integer"
}
Expand Down

0 comments on commit ac90f1e

Please sign in to comment.