@maxim_mazurok/gapi.client.dataflow-v1b3 0.0.20221229 → 0.0.20230119

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 (3) hide show
  1. package/index.d.ts +21 -68
  2. package/package.json +1 -1
  3. package/tests.ts +1 -10
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: 20221229
12
+ // Revision: 20230119
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -1096,10 +1096,6 @@ declare namespace gapi.client {
1096
1096
  /** The name of the Pubsub topic. */
1097
1097
  topicName?: string;
1098
1098
  }
1099
- interface QueryInfo {
1100
- /** Includes an entry for each satisfied QueryProperty. */
1101
- queryProperty?: string[];
1102
- }
1103
1099
  interface ReadInstruction {
1104
1100
  /** The source to read from. */
1105
1101
  source?: Source;
@@ -1149,54 +1145,54 @@ declare namespace gapi.client {
1149
1145
  interface ResourceUtilizationReportResponse {
1150
1146
  }
1151
1147
  interface RuntimeEnvironment {
1152
- /** Additional experiment flags for the job, specified with the `--experiments` option. */
1148
+ /** Optional. Additional experiment flags for the job, specified with the `--experiments` option. */
1153
1149
  additionalExperiments?: string[];
1154
1150
  /**
1155
- * Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
1151
+ * Optional. Additional user labels to be specified for the job. Keys and values should follow the restrictions specified in the [labeling
1156
1152
  * restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) page. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass":
1157
1153
  * "1kg", "count": "3" }.
1158
1154
  */
1159
1155
  additionalUserLabels?: { [P in string]: string };
1160
- /** Whether to bypass the safety checks for the job's temporary directory. Use with caution. */
1156
+ /** Optional. Whether to bypass the safety checks for the job's temporary directory. Use with caution. */
1161
1157
  bypassTempDirValidation?: boolean;
1162
- /** Whether to enable Streaming Engine for the job. */
1158
+ /** Optional. Whether to enable Streaming Engine for the job. */
1163
1159
  enableStreamingEngine?: boolean;
1164
- /** Configuration for VM IPs. */
1160
+ /** Optional. Configuration for VM IPs. */
1165
1161
  ipConfiguration?: string;
1166
- /** Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
1162
+ /** Optional. Name for the Cloud KMS key for the job. Key format is: projects//locations//keyRings//cryptoKeys/ */
1167
1163
  kmsKeyName?: string;
1168
- /** The machine type to use for the job. Defaults to the value from the template if not specified. */
1164
+ /** Optional. The machine type to use for the job. Defaults to the value from the template if not specified. */
1169
1165
  machineType?: string;
1170
- /** The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. */
1166
+ /** Optional. The maximum number of Google Compute Engine instances to be made available to your pipeline during execution, from 1 to 1000. The default value is 1. */
1171
1167
  maxWorkers?: number;
1172
- /** Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */
1168
+ /** Optional. Network to which VMs will be assigned. If empty or unspecified, the service will use the network "default". */
1173
1169
  network?: string;
1174
- /** The initial number of Google Compute Engine instances for the job. */
1170
+ /** Optional. The initial number of Google Compute Engine instances for the job. The default value is 11. */
1175
1171
  numWorkers?: number;
1176
- /** The email address of the service account to run the job as. */
1172
+ /** Optional. The email address of the service account to run the job as. */
1177
1173
  serviceAccountEmail?: string;
1178
1174
  /**
1179
- * 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
1175
+ * 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
1180
1176
  * "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
1181
1177
  * Shared VPC network, you must use the complete URL.
1182
1178
  */
1183
1179
  subnetwork?: string;
1184
- /** The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
1180
+ /** Required. The Cloud Storage path to use for temporary files. Must be a valid Cloud Storage URL, beginning with `gs://`. */
1185
1181
  tempLocation?: string;
1186
1182
  /**
1187
- * 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
1188
- * worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
1183
+ * Required. 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
1184
+ * with worker_zone. If neither worker_region nor worker_zone is specified, default to the control plane's region.
1189
1185
  */
1190
1186
  workerRegion?: string;
1191
1187
  /**
1192
- * 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
1193
- * 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. If both `worker_zone` and `zone`
1194
- * are set, `worker_zone` takes precedence.
1188
+ * 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
1189
+ * 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. If both `worker_zone` and
1190
+ * `zone` are set, `worker_zone` takes precedence.
1195
1191
  */
1196
1192
  workerZone?: string;
1197
1193
  /**
1198
- * The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the future,
1199
- * worker_zone will take precedence.
1194
+ * Optional. The Compute Engine [availability zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones) for launching worker instances to run your pipeline. In the
1195
+ * future, worker_zone will take precedence.
1200
1196
  */
1201
1197
  zone?: string;
1202
1198
  }
@@ -1725,12 +1721,6 @@ declare namespace gapi.client {
1725
1721
  /** User names for all collection outputs to this transform. */
1726
1722
  outputCollectionName?: string[];
1727
1723
  }
1728
- interface ValidateResponse {
1729
- /** Will be empty if validation succeeds. */
1730
- errorMessage?: string;
1731
- /** Information about the validated query. Not defined if validation fails. */
1732
- queryInfo?: QueryInfo;
1733
- }
1734
1724
  interface WorkerDetails {
1735
1725
  /** Name of this worker */
1736
1726
  workerName?: string;
@@ -3619,42 +3609,6 @@ declare namespace gapi.client {
3619
3609
  uploadType?: string;
3620
3610
  }): Request<ListSnapshotsResponse>;
3621
3611
  }
3622
- interface SqlResource {
3623
- /**
3624
- * Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will
3625
- * validate that the query analyzes properly as well.
3626
- */
3627
- validate(request?: {
3628
- /** V1 error format. */
3629
- "$.xgafv"?: string;
3630
- /** OAuth access token. */
3631
- access_token?: string;
3632
- /** Data format for response. */
3633
- alt?: string;
3634
- /** JSONP */
3635
- callback?: string;
3636
- /** Selector specifying which fields to include in a partial response. */
3637
- fields?: string;
3638
- /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
3639
- key?: string;
3640
- /** The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) to which to direct the request. */
3641
- location: string;
3642
- /** OAuth 2.0 token for the current user. */
3643
- oauth_token?: string;
3644
- /** Returns response with indentations and line breaks. */
3645
- prettyPrint?: boolean;
3646
- /** Required. The ID of the Cloud Platform project that the job belongs to. */
3647
- projectId: string;
3648
- /** The sql query to validate. */
3649
- query?: string;
3650
- /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
3651
- quotaUser?: string;
3652
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3653
- upload_protocol?: string;
3654
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3655
- uploadType?: string;
3656
- }): Request<ValidateResponse>;
3657
- }
3658
3612
  interface TemplatesResource {
3659
3613
  /** Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. */
3660
3614
  create(request: {
@@ -3890,7 +3844,6 @@ declare namespace gapi.client {
3890
3844
  flexTemplates: FlexTemplatesResource;
3891
3845
  jobs: JobsResource;
3892
3846
  snapshots: SnapshotsResource;
3893
- sql: SqlResource;
3894
3847
  templates: TemplatesResource;
3895
3848
  }
3896
3849
  interface SnapshotsResource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dataflow-v1b3",
3
- "version": "0.0.20221229",
3
+ "version": "0.0.20230119",
4
4
  "description": "TypeScript typings for Dataflow API v1b3",
5
5
  "license": "MIT",
6
6
  "author": {
package/tests.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
4
4
  // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
5
5
 
6
- // Revision: 20221229
6
+ // Revision: 20230119
7
7
 
8
8
  gapi.load('client', async () => {
9
9
  /** now we can use gapi.client */
@@ -2580,15 +2580,6 @@ gapi.load('client', async () => {
2580
2580
  location: "Test string",
2581
2581
  projectId: "Test string",
2582
2582
  });
2583
- /**
2584
- * Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the given query parses correctly, and if able to look up schema information from DataCatalog, will validate
2585
- * that the query analyzes properly as well.
2586
- */
2587
- await gapi.client.dataflow.projects.locations.sql.validate({
2588
- location: "Test string",
2589
- projectId: "Test string",
2590
- query: "Test string",
2591
- });
2592
2583
  /** Creates a Cloud Dataflow job from a template. Do not enter confidential information when you supply string values using the API. */
2593
2584
  await gapi.client.dataflow.projects.locations.templates.create({
2594
2585
  location: "Test string",