@maxim_mazurok/gapi.client.batch-v1 0.0.20231213 → 0.0.20240112
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.
- package/index.d.ts +15 -7
- package/package.json +1 -1
- package/readme.md +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://batch.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240112
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -97,9 +97,9 @@ declare namespace gapi.client {
|
|
|
97
97
|
zone?: string;
|
|
98
98
|
}
|
|
99
99
|
interface AgentScript {
|
|
100
|
-
/** Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be
|
|
100
|
+
/** Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be executed by `/bin/sh`. */
|
|
101
101
|
path?: string;
|
|
102
|
-
/** Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be
|
|
102
|
+
/** Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be executed by `/bin/sh`. */
|
|
103
103
|
text?: string;
|
|
104
104
|
}
|
|
105
105
|
interface AgentTask {
|
|
@@ -173,7 +173,7 @@ declare namespace gapi.client {
|
|
|
173
173
|
labels?: {[P in string]: string};
|
|
174
174
|
/** Location where compute resources should be allocated for the Job. */
|
|
175
175
|
location?: LocationPolicy;
|
|
176
|
-
/** The network policy. If you define an instance template in the InstancePolicyOrTemplate field, Batch will use the network settings in the instance template instead of this field. */
|
|
176
|
+
/** The network policy. If you define an instance template in the `InstancePolicyOrTemplate` field, Batch will use the network settings in the instance template instead of this field. */
|
|
177
177
|
network?: NetworkPolicy;
|
|
178
178
|
/** The placement policy. */
|
|
179
179
|
placement?: PlacementPolicy;
|
|
@@ -194,6 +194,10 @@ declare namespace gapi.client {
|
|
|
194
194
|
name?: string;
|
|
195
195
|
}
|
|
196
196
|
interface CancelOperationRequest {}
|
|
197
|
+
interface CloudLoggingOption {
|
|
198
|
+
/** Optional. Set this flag to true to change the [monitored resource type](https://cloud.google.com/monitoring/api/resources) for Cloud Logging logs generated by this Batch job from the [`batch.googleapis.com/Job`](https://cloud.google.com/monitoring/api/resources#tag_batch.googleapis.com/Job) type to the formerly used [`generic_task`](https://cloud.google.com/monitoring/api/resources#tag_generic_task) type. */
|
|
199
|
+
useGenericTaskMonitoredResource?: boolean;
|
|
200
|
+
}
|
|
197
201
|
interface ComputeResource {
|
|
198
202
|
/** Extra boot disk size in MiB for each task. */
|
|
199
203
|
bootDiskMib?: string;
|
|
@@ -207,7 +211,7 @@ declare namespace gapi.client {
|
|
|
207
211
|
blockExternalNetwork?: boolean;
|
|
208
212
|
/** Overrides the `CMD` specified in the container. If there is an ENTRYPOINT (either in the container image or with the entrypoint field below) then commands are appended as arguments to the ENTRYPOINT. */
|
|
209
213
|
commands?: string[];
|
|
210
|
-
/** Optional. If set to true, container
|
|
214
|
+
/** Optional. If set to true, this container runnable uses Image streaming. Use Image streaming to allow the runnable to initialize without waiting for the entire container image to download, which can significantly reduce startup time for large container images. When `enableImageStreaming` is set to true, the container runtime is [containerd](https://containerd.io/) instead of Docker. Additionally, this container runnable only supports the following `container` subfields: `imageUri`, `commands[]`, `entrypoint`, and `volumes[]`; any other `container` subfields are ignored. For more information about the requirements and limitations for using Image streaming with Batch, see the [`image-streaming` sample on GitHub](https://github.com/GoogleCloudPlatform/batch-samples/tree/main/api-samples/image-streaming). */
|
|
211
215
|
enableImageStreaming?: boolean;
|
|
212
216
|
/** Overrides the `ENTRYPOINT` specified in the container. */
|
|
213
217
|
entrypoint?: string;
|
|
@@ -378,6 +382,8 @@ declare namespace gapi.client {
|
|
|
378
382
|
allowedLocations?: string[];
|
|
379
383
|
}
|
|
380
384
|
interface LogsPolicy {
|
|
385
|
+
/** Optional. Additional settings for Cloud Logging. It will only take effect when the destination of `LogsPolicy` is set to `CLOUD_LOGGING`. */
|
|
386
|
+
cloudLoggingOption?: CloudLoggingOption;
|
|
381
387
|
/** Where logs should be saved. */
|
|
382
388
|
destination?: string;
|
|
383
389
|
/** The path to which logs are saved when the destination = PATH. This can be a local file path on the VM, or under the mount point of a Persistent Disk or Filestore, or a Cloud Storage path. */
|
|
@@ -484,9 +490,9 @@ declare namespace gapi.client {
|
|
|
484
490
|
timeout?: string;
|
|
485
491
|
}
|
|
486
492
|
interface Script {
|
|
487
|
-
/** Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be
|
|
493
|
+
/** Script file path on the host VM. To specify an interpreter, please add a `#!`(also known as [shebang line](https://en.wikipedia.org/wiki/Shebang_(Unix))) as the first line of the file.(For example, to execute the script using bash, `#!/bin/bash` should be the first line of the file. To execute the script using`Python3`, `#!/usr/bin/env python3` should be the first line of the file.) Otherwise, the file will by default be executed by `/bin/sh`. */
|
|
488
494
|
path?: string;
|
|
489
|
-
/** Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be
|
|
495
|
+
/** Shell script text. To specify an interpreter, please add a `#!\n` at the beginning of the text.(For example, to execute the script using bash, `#!/bin/bash\n` should be added. To execute the script using`Python3`, `#!/usr/bin/env python3\n` should be added.) Otherwise, the script will by default be executed by `/bin/sh`. */
|
|
490
496
|
text?: string;
|
|
491
497
|
}
|
|
492
498
|
interface ServiceAccount {
|
|
@@ -534,6 +540,8 @@ declare namespace gapi.client {
|
|
|
534
540
|
permissiveSsh?: boolean;
|
|
535
541
|
/** When true, Batch will populate a file with a list of all VMs assigned to the TaskGroup and set the BATCH_HOSTS_FILE environment variable to the path of that file. Defaults to false. */
|
|
536
542
|
requireHostsFile?: boolean;
|
|
543
|
+
/** Optional. If not set or set to false, Batch uses the root user to execute runnables. If set to true, Batch will make sure to run the runnables using a non-root user. Currently, the non-root user Batch used is generated by OS Login. For more information, see [About OS Login](https://cloud.google.com/compute/docs/oslogin). */
|
|
544
|
+
runAsNonRoot?: boolean;
|
|
537
545
|
/** Scheduling policy for Tasks in the TaskGroup. The default value is AS_SOON_AS_POSSIBLE. */
|
|
538
546
|
schedulingPolicy?: string;
|
|
539
547
|
/** Number of Tasks in the TaskGroup. Default is 1. */
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TypeScript typings for Batch API v1
|
|
2
2
|
|
|
3
|
-
An API to manage the running of batch
|
|
3
|
+
An API to manage the running of batch resources on Google Cloud Platform.
|
|
4
4
|
For detailed description please check [documentation](https://cloud.google.com/batch/).
|
|
5
5
|
|
|
6
6
|
## Installing
|