@maxim_mazurok/gapi.client.dataflow-v1b3 0.0.20240611 → 0.0.20240626

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +17 -11
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -9,7 +9,7 @@
9
9
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
10
10
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
11
11
  // Generated from: https://dataflow.googleapis.com/$discovery/rest?version=v1b3
12
- // Revision: 20240611
12
+ // Revision: 20240626
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -291,7 +291,7 @@ declare namespace gapi.client {
291
291
  interface DebugOptions {
292
292
  /** Configuration options for sampling elements from a running pipeline. */
293
293
  dataSampling?: DataSamplingConfig;
294
- /** When true, enables the logging of the literal hot key to the user's Cloud Logging. */
294
+ /** Optional. When true, enables the logging of the literal hot key to the user's Cloud Logging. */
295
295
  enableHotKeyLogging?: boolean;
296
296
  }
297
297
  interface DeleteSnapshotResponse {}
@@ -358,21 +358,21 @@ declare namespace gapi.client {
358
358
  interface Environment {
359
359
  /** 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
360
  clusterManagerApiService?: string;
361
- /** The dataset for the current project where various workflow related tables are stored. The supported resource type is: Google BigQuery: bigquery.googleapis.com/{dataset} */
361
+ /** 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} */
362
362
  dataset?: string;
363
- /** Any debugging options to be supplied to the job. */
363
+ /** Optional. Any debugging options to be supplied to the job. */
364
364
  debugOptions?: DebugOptions;
365
365
  /** 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. */
366
366
  experiments?: string[];
367
- /** Which Flexible Resource Scheduling mode to run in. */
367
+ /** Optional. Which Flexible Resource Scheduling mode to run in. */
368
368
  flexResourceSchedulingGoal?: string;
369
369
  /** Experimental settings. */
370
370
  internalExperiments?: {[P in string]: any};
371
371
  /** 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. */
372
372
  sdkPipelineOptions?: {[P in string]: any};
373
- /** Identity to run virtual machines as. Defaults to the default account. */
373
+ /** Optional. Identity to run virtual machines as. Defaults to the default account. */
374
374
  serviceAccountEmail?: string;
375
- /** 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 */
375
+ /** 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 */
376
376
  serviceKmsKeyName?: string;
377
377
  /** 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). */
378
378
  serviceOptions?: string[];
@@ -390,9 +390,9 @@ declare namespace gapi.client {
390
390
  version?: {[P in string]: any};
391
391
  /** The worker pools. At least one "harness" worker pool must be specified in order for the job to have workers. */
392
392
  workerPools?: WorkerPool[];
393
- /** 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. */
393
+ /** 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. */
394
394
  workerRegion?: string;
395
- /** 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. */
395
+ /** 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. */
396
396
  workerZone?: string;
397
397
  }
398
398
  interface ExecutionStageState {
@@ -600,7 +600,7 @@ declare namespace gapi.client {
600
600
  jobMetadata?: JobMetadata;
601
601
  /** 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. */
602
602
  labels?: {[P in string]: string};
603
- /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
603
+ /** Optional. The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job. */
604
604
  location?: string;
605
605
  /** 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])?` */
606
606
  name?: string;
@@ -620,6 +620,8 @@ declare namespace gapi.client {
620
620
  satisfiesPzi?: boolean;
621
621
  /** Reserved for future use. This field is set only in responses from the server; it is ignored if it is set in any requests. */
622
622
  satisfiesPzs?: boolean;
623
+ /** Output only. Resources used by the Dataflow Service to run the job. */
624
+ serviceResources?: ServiceResources;
623
625
  /** This field may be mutated by the Cloud Dataflow service; callers cannot mutate it. */
624
626
  stageStates?: ExecutionStageState[];
625
627
  /** 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 {
630
632
  stepsLocation?: string;
631
633
  /** 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} */
632
634
  tempFiles?: string[];
633
- /** The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */
635
+ /** Optional. The map of transform name prefixes of the job to be replaced to the corresponding name prefixes of the new job. */
634
636
  transformNameMapping?: {[P in string]: string};
635
637
  /** Optional. The type of Dataflow job. */
636
638
  type?: string;
@@ -1231,6 +1233,10 @@ declare namespace gapi.client {
1231
1233
  /** The id of the TupleTag the user code will tag the output value by. */
1232
1234
  tag?: string;
1233
1235
  }
1236
+ interface ServiceResources {
1237
+ /** Output only. List of Cloud Zones being used by the Dataflow Service for this job. Example: us-central1-c */
1238
+ zones?: string[];
1239
+ }
1234
1240
  interface ShellTask {
1235
1241
  /** The shell command to run. */
1236
1242
  command?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataflow-v1b3",
3
- "version": "0.0.20240611",
3
+ "version": "0.0.20240626",
4
4
  "description": "TypeScript typings for Dataflow API v1b3",
5
5
  "repository": {
6
6
  "type": "git",