@maxim_mazurok/gapi.client.dataflow-v1b3 0.0.20240603 → 0.0.20240624

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://dataflow.googleapis.com/$discovery/rest?version=v1b3
-// Revision: 20240603
+// Revision: 20240624
 
 /// <reference types="gapi.client" />
 
@@ -291,7 +291,7 @@ declare namespace gapi.client {
     interface DebugOptions {
       /** Configuration options for sampling elements from a running pipeline. */
       dataSampling?: DataSamplingConfig;
-      /** When true, enables the logging of the literal hot key to the user's Cloud Logging. */
+      /** Optional. When true, enables the logging of the literal hot key to the user's Cloud Logging. */
       enableHotKeyLogging?: boolean;
     }
     interface DeleteSnapshotResponse {}
@@ -358,21 +358,21 @@ declare namespace gapi.client {
     interface Environment {
       /** 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". */
       clusterManagerApiService?: string;
-      /** The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} */
+      /** Optional. The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} */
       dataset?: string;
-      /** Any debugging options to be supplied to the job. */
+      /** Optional. Any debugging options to be supplied to the job. */
       debugOptions?: DebugOptions;
       /** The list of experiments to enable. This field should be used for SDK related experiments and not for service related experiments. The proper field for service related experiments is service_options. */
       experiments?: string[];
-      /** Which Flexible Resource Scheduling mode to run in. */
+      /** Optional. Which Flexible Resource Scheduling mode to run in. */
       flexResourceSchedulingGoal?: string;
       /** Experimental settings. */
       internalExperiments?: {[P in string]: any};
       /** The Cloud Dataflow SDK pipeline options specified by the user. These options are passed through the service and are used to recreate the SDK pipeline options on the worker in a language agnostic and platform independent way. */
       sdkPipelineOptions?: {[P in string]: any};
-      /** Identity to run virtual machines as. Defaults to the default account. */
+      /** Optional. Identity to run virtual machines as. Defaults to the default account. */
       serviceAccountEmail?: string;
-      /** If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY */
+      /** Optional. If set, contains the Cloud KMS key identifier used to encrypt data at rest, AKA a Customer Managed Encryption Key (CMEK). Format: projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY */
       serviceKmsKeyName?: string;
       /** Optional. The list of service options to enable. This field should be used for service related experiments only. These experiments, when graduating to GA, should be replaced by dedicated fields or become default (i.e. always on). */
       serviceOptions?: string[];
@@ -390,9 +390,9 @@ declare namespace gapi.client {
       version?: {[P in string]: any};
       /** The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. */
       workerPools?: WorkerPool[];
-      /** The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. */
+      /** Optional. The Compute Engine region (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1". Mutually exclusive with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region. */
       workerRegion?: string;
-      /** The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. */
+      /** Optional. The Compute Engine zone (https://cloud.google.com/compute/docs/regions-zones/regions-zones) in which worker processing should occur, e.g. "us-west1-a". Mutually exclusive with worker_region. If neither worker_region nor worker_zone is specified, a zone in the control plane's region is chosen based on available capacity. */
       workerZone?: string;
     }
     interface ExecutionStageState {
@@ -600,7 +600,7 @@ declare namespace gapi.client {
       jobMetadata?: JobMetadata;
       /** User-defined labels for this job. The labels map can contain no more than 64 entries. Entries of the labels map are UTF8 strings that comply with the following restrictions: * Keys must conform to regexp: \p{Ll}\p{Lo}{0,62} * Values must conform to regexp: [\p{Ll}\p{Lo}\p{N}_-]{0,63} * Both keys and values are additionally constrained to be <= 128 bytes in size. */
       labels?: {[P in string]: string};
-      /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
+      /** Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
       location?: string;
       /** Optional. 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])?` */
       name?: string;
@@ -620,6 +620,8 @@ declare namespace gapi.client {
       satisfiesPzi?: boolean;
       /** Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. */
       satisfiesPzs?: boolean;
+      /** Output only. Resources used by the Dataflow Service to run the job. */
+      serviceResources?: ServiceResources;
       /** This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */
       stageStates?: ExecutionStageState[];
       /** The timestamp when the job was started (transitioned to JOB_STATE_PENDING). Flexible resource scheduling jobs are started with some delay after job creation, so start_time is unset before start and is updated when the job is started by the Cloud Dataflow service. For other jobs, start_time always equals to create_time and is immutable and set by the Cloud Dataflow service. */
@@ -630,7 +632,7 @@ declare namespace gapi.client {
       stepsLocation?: string;
       /** A set of files the system should be aware of that are used for temporary storage. These temporary files will be removed on job completion. No duplicates are allowed. No file patterns are supported. The supported files are: Google Cloud Storage: storage.googleapis.com/{bucket}/{object} bucket.storage.googleapis.com/{object} */
       tempFiles?: string[];
-      /** The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */
+      /** Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */
       transformNameMapping?: {[P in string]: string};
       /** Optional. The type of Dataflow job. */
       type?: string;
@@ -1231,6 +1233,10 @@ declare namespace gapi.client {
       /** The id of the TupleTag the user code will tag the output value by. */
       tag?: string;
     }
+    interface ServiceResources {
+      /** Output only. List of Cloud Zones being used by the Dataflow Service for this job. Example: us-central1-c */
+      zones?: string[];
+    }
     interface ShellTask {
       /** The shell command to run. */
       command?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dataflow-v1b3",
-  "version": "0.0.20240603",
+  "version": "0.0.20240624",
   "description": "TypeScript typings for Dataflow API v1b3",
   "repository": {
     "type": "git",