@maxim_mazurok/gapi.client.batch-v1 0.0.20221214
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 +1330 -0
- package/package.json +20 -0
- package/readme.md +68 -0
- package/tests.ts +431 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1330 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Batch API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/batch/
|
|
3
|
+
// Definitions by: Maxim Mazurok <https://github.com/Maxim-Mazurok>
|
|
4
|
+
// Nick Amoscato <https://github.com/namoscato>
|
|
5
|
+
// Declan Vong <https://github.com/declanvong>
|
|
6
|
+
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
7
|
+
|
|
8
|
+
// IMPORTANT
|
|
9
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
|
+
// Generated from: https://batch.googleapis.com/$discovery/rest?version=v1
|
|
12
|
+
// Revision: 20221214
|
|
13
|
+
|
|
14
|
+
/// <reference types="gapi.client" />
|
|
15
|
+
|
|
16
|
+
declare namespace gapi.client {
|
|
17
|
+
/** Load Batch API v1 */
|
|
18
|
+
function load(urlOrObject: "https://batch.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
19
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
20
|
+
function load(name: "batch", version: "v1"): Promise<void>;
|
|
21
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
22
|
+
function load(name: "batch", version: "v1", callback: () => any): void;
|
|
23
|
+
|
|
24
|
+
namespace batch {
|
|
25
|
+
interface Accelerator {
|
|
26
|
+
/** The number of accelerators of this type. */
|
|
27
|
+
count?: string;
|
|
28
|
+
/** Deprecated: please use instances[0].install_gpu_drivers instead. */
|
|
29
|
+
installGpuDrivers?: boolean;
|
|
30
|
+
/** The accelerator type. For example, "nvidia-tesla-t4". See `gcloud compute accelerator-types list`. */
|
|
31
|
+
type?: string;
|
|
32
|
+
}
|
|
33
|
+
interface ActionCondition {
|
|
34
|
+
/** Exit codes of a task execution. If there are more than 1 exit codes, when task executes with any of the exit code in the list, the condition is met and the action will be executed. */
|
|
35
|
+
exitCodes?: number[];
|
|
36
|
+
}
|
|
37
|
+
interface AgentInfo {
|
|
38
|
+
/** The assigned Job ID */
|
|
39
|
+
jobId?: string;
|
|
40
|
+
/** When the AgentInfo is generated. */
|
|
41
|
+
reportTime?: string;
|
|
42
|
+
/** Agent state. */
|
|
43
|
+
state?: string;
|
|
44
|
+
/** The assigned task group ID. */
|
|
45
|
+
taskGroupId?: string;
|
|
46
|
+
/** Task Info. */
|
|
47
|
+
tasks?: AgentTaskInfo[];
|
|
48
|
+
}
|
|
49
|
+
interface AgentMetadata {
|
|
50
|
+
/** When the VM agent started. Use agent_startup_time instead. */
|
|
51
|
+
creationTime?: string;
|
|
52
|
+
/**
|
|
53
|
+
* Full name of the entity that created this vm. For MIG, this path is: projects/{project}/regions/{region}/InstanceGroupManagers/{igm} The value is retrieved from the vm metadata key
|
|
54
|
+
* of "created-by".
|
|
55
|
+
*/
|
|
56
|
+
creator?: string;
|
|
57
|
+
/** image version for the VM that this agent is installed on. */
|
|
58
|
+
imageVersion?: string;
|
|
59
|
+
/** GCP instance name (go/instance-name). */
|
|
60
|
+
instance?: string;
|
|
61
|
+
/** GCP instance ID (go/instance-id). */
|
|
62
|
+
instanceId?: string;
|
|
63
|
+
/** If the GCP instance has received preemption notice. */
|
|
64
|
+
instancePreemptionNoticeReceived?: boolean;
|
|
65
|
+
/** parsed contents of /etc/os-release */
|
|
66
|
+
osRelease?: { [P in string]: string };
|
|
67
|
+
/** agent binary version running on VM */
|
|
68
|
+
version?: string;
|
|
69
|
+
/** Agent zone. */
|
|
70
|
+
zone?: string;
|
|
71
|
+
}
|
|
72
|
+
interface AgentTask {
|
|
73
|
+
/** The intended state of the task. */
|
|
74
|
+
intendedState?: string;
|
|
75
|
+
/** The highest barrier reached by all tasks in the task's TaskGroup. */
|
|
76
|
+
reachedBarrier?: string;
|
|
77
|
+
/** Task Spec. */
|
|
78
|
+
spec?: TaskSpec;
|
|
79
|
+
/** Task status. */
|
|
80
|
+
status?: TaskStatus;
|
|
81
|
+
/** Task name. */
|
|
82
|
+
task?: string;
|
|
83
|
+
}
|
|
84
|
+
interface AgentTaskInfo {
|
|
85
|
+
/** The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined. */
|
|
86
|
+
runnable?: string;
|
|
87
|
+
/** ID of the Task */
|
|
88
|
+
taskId?: string;
|
|
89
|
+
/** The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below. */
|
|
90
|
+
taskStatus?: TaskStatus;
|
|
91
|
+
}
|
|
92
|
+
interface AgentTimingInfo {
|
|
93
|
+
/** Agent startup time */
|
|
94
|
+
agentStartupTime?: string;
|
|
95
|
+
/** Boot timestamp of the VM OS */
|
|
96
|
+
bootTime?: string;
|
|
97
|
+
/** Startup time of the Batch VM script. */
|
|
98
|
+
scriptStartupTime?: string;
|
|
99
|
+
}
|
|
100
|
+
interface AllocationPolicy {
|
|
101
|
+
/** Describe instances that can be created by this AllocationPolicy. Only instances[0] is supported now. */
|
|
102
|
+
instances?: InstancePolicyOrTemplate[];
|
|
103
|
+
/**
|
|
104
|
+
* Labels applied to all VM instances and other resources created by AllocationPolicy. Labels could be user provided or system generated. You can assign up to 64 labels. [Google
|
|
105
|
+
* Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are reserved.
|
|
106
|
+
*/
|
|
107
|
+
labels?: { [P in string]: string };
|
|
108
|
+
/** Location where compute resources should be allocated for the Job. */
|
|
109
|
+
location?: LocationPolicy;
|
|
110
|
+
/** The network policy. */
|
|
111
|
+
network?: NetworkPolicy;
|
|
112
|
+
/** Service account that VMs will run as. */
|
|
113
|
+
serviceAccount?: ServiceAccount;
|
|
114
|
+
}
|
|
115
|
+
interface AttachedDisk {
|
|
116
|
+
/**
|
|
117
|
+
* Device name that the guest operating system will see. It is used by Runnable.volumes field to mount disks. So please specify the device_name if you want Batch to help mount the
|
|
118
|
+
* disk, and it should match the device_name field in volumes.
|
|
119
|
+
*/
|
|
120
|
+
deviceName?: string;
|
|
121
|
+
/** Name of an existing PD. */
|
|
122
|
+
existingDisk?: string;
|
|
123
|
+
newDisk?: Disk;
|
|
124
|
+
}
|
|
125
|
+
interface AuditConfig {
|
|
126
|
+
/** The configuration for logging of each type of permission. */
|
|
127
|
+
auditLogConfigs?: AuditLogConfig[];
|
|
128
|
+
/**
|
|
129
|
+
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all
|
|
130
|
+
* services.
|
|
131
|
+
*/
|
|
132
|
+
service?: string;
|
|
133
|
+
}
|
|
134
|
+
interface AuditLogConfig {
|
|
135
|
+
/** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
|
|
136
|
+
exemptedMembers?: string[];
|
|
137
|
+
/** The log type that this config enables. */
|
|
138
|
+
logType?: string;
|
|
139
|
+
}
|
|
140
|
+
interface Barrier {
|
|
141
|
+
/** Barriers are identified by their index in runnable list. Names are not required, but if present should be an identifier. */
|
|
142
|
+
name?: string;
|
|
143
|
+
}
|
|
144
|
+
interface Binding {
|
|
145
|
+
/**
|
|
146
|
+
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`,
|
|
147
|
+
* then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which
|
|
148
|
+
* resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
149
|
+
*/
|
|
150
|
+
condition?: Expr;
|
|
151
|
+
/**
|
|
152
|
+
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
|
|
153
|
+
* the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service
|
|
154
|
+
* account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific
|
|
155
|
+
* Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example,
|
|
156
|
+
* `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service
|
|
157
|
+
* account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. *
|
|
158
|
+
* `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
|
|
159
|
+
* identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to
|
|
160
|
+
* `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing
|
|
161
|
+
* a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value
|
|
162
|
+
* reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
|
|
163
|
+
* identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to
|
|
164
|
+
* `group:{emailid}` and the recovered group retains the role in the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For
|
|
165
|
+
* example, `google.com` or `example.com`.
|
|
166
|
+
*/
|
|
167
|
+
members?: string[];
|
|
168
|
+
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
|
|
169
|
+
role?: string;
|
|
170
|
+
}
|
|
171
|
+
// tslint:disable-next-line:no-empty-interface
|
|
172
|
+
interface CancelOperationRequest {
|
|
173
|
+
}
|
|
174
|
+
interface ComputeResource {
|
|
175
|
+
/** Extra boot disk size in MiB for each task. */
|
|
176
|
+
bootDiskMib?: string;
|
|
177
|
+
/** The milliCPU count. */
|
|
178
|
+
cpuMilli?: string;
|
|
179
|
+
/** Memory in MiB. */
|
|
180
|
+
memoryMib?: string;
|
|
181
|
+
}
|
|
182
|
+
interface Container {
|
|
183
|
+
/** If set to true, external network access to and from container will be blocked. The container will use the default internal network 'goog-internal'. */
|
|
184
|
+
blockExternalNetwork?: boolean;
|
|
185
|
+
/**
|
|
186
|
+
* 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
|
|
187
|
+
* to the ENTRYPOINT.
|
|
188
|
+
*/
|
|
189
|
+
commands?: string[];
|
|
190
|
+
/** Overrides the `ENTRYPOINT` specified in the container. */
|
|
191
|
+
entrypoint?: string;
|
|
192
|
+
/** The URI to pull the container image from. */
|
|
193
|
+
imageUri?: string;
|
|
194
|
+
/** Arbitrary additional options to include in the "docker run" command when running this container, e.g. "--network host". */
|
|
195
|
+
options?: string;
|
|
196
|
+
/** Optional password for logging in to a docker registry. If password matches `projects/*/secrets/*/versions/*` then Batch will read the password from the Secret Manager; */
|
|
197
|
+
password?: string;
|
|
198
|
+
/** Optional username for logging in to a docker registry. If username matches `projects/*/secrets/*/versions/*` then Batch will read the username from the Secret Manager. */
|
|
199
|
+
username?: string;
|
|
200
|
+
/** Volumes to mount (bind mount) from the host machine files or directories into the container, formatted to match docker run's --volume option, e.g. /foo:/bar, or /foo:/bar:ro */
|
|
201
|
+
volumes?: string[];
|
|
202
|
+
}
|
|
203
|
+
interface Disk {
|
|
204
|
+
/** Local SSDs are available through both "SCSI" and "NVMe" interfaces. If not indicated, "NVMe" will be the default one for local ssds. We only support "SCSI" for persistent disks now. */
|
|
205
|
+
diskInterface?: string;
|
|
206
|
+
/** Name of a public or custom image used as the data source. */
|
|
207
|
+
image?: string;
|
|
208
|
+
/**
|
|
209
|
+
* Disk size in GB. This field is ignored if `data_source` is `disk` or `image`. If `type` is `local-ssd`, size_gb should be a multiple of 375GB, otherwise, the final size will be the
|
|
210
|
+
* next greater multiple of 375 GB.
|
|
211
|
+
*/
|
|
212
|
+
sizeGb?: string;
|
|
213
|
+
/** Name of a snapshot used as the data source. */
|
|
214
|
+
snapshot?: string;
|
|
215
|
+
/** Disk type as shown in `gcloud compute disk-types list` For example, "pd-ssd", "pd-standard", "pd-balanced", "local-ssd". */
|
|
216
|
+
type?: string;
|
|
217
|
+
}
|
|
218
|
+
// tslint:disable-next-line:no-empty-interface
|
|
219
|
+
interface Empty {
|
|
220
|
+
}
|
|
221
|
+
interface Environment {
|
|
222
|
+
/** An encrypted JSON dictionary where the key/value pairs correspond to environment variable names and their values. */
|
|
223
|
+
encryptedVariables?: KMSEnvMap;
|
|
224
|
+
/** A map of environment variable names to Secret Manager secret names. The VM will access the named secrets to set the value of each environment variable. */
|
|
225
|
+
secretVariables?: { [P in string]: string };
|
|
226
|
+
/** A map of environment variable names to values. */
|
|
227
|
+
variables?: { [P in string]: string };
|
|
228
|
+
}
|
|
229
|
+
interface Expr {
|
|
230
|
+
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
231
|
+
description?: string;
|
|
232
|
+
/** Textual representation of an expression in Common Expression Language syntax. */
|
|
233
|
+
expression?: string;
|
|
234
|
+
/** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
|
|
235
|
+
location?: string;
|
|
236
|
+
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
237
|
+
title?: string;
|
|
238
|
+
}
|
|
239
|
+
interface GCS {
|
|
240
|
+
/** Remote path, either a bucket name or a subdirectory of a bucket, e.g.: bucket_name, bucket_name/subdirectory/ */
|
|
241
|
+
remotePath?: string;
|
|
242
|
+
}
|
|
243
|
+
interface InstancePolicy {
|
|
244
|
+
/** The accelerators attached to each VM instance. */
|
|
245
|
+
accelerators?: Accelerator[];
|
|
246
|
+
/** Non-boot disks to be attached for each VM created by this InstancePolicy. New disks will be deleted when the VM is deleted. */
|
|
247
|
+
disks?: AttachedDisk[];
|
|
248
|
+
/** The Compute Engine machine type. */
|
|
249
|
+
machineType?: string;
|
|
250
|
+
/** The minimum CPU platform. See `https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform`. Not yet implemented. */
|
|
251
|
+
minCpuPlatform?: string;
|
|
252
|
+
/** The provisioning model. */
|
|
253
|
+
provisioningModel?: string;
|
|
254
|
+
}
|
|
255
|
+
interface InstancePolicyOrTemplate {
|
|
256
|
+
/**
|
|
257
|
+
* Set this field true if users want Batch to help fetch drivers from a third party location and install them for GPUs specified in policy.accelerators or instance_template on their
|
|
258
|
+
* behalf. Default is false.
|
|
259
|
+
*/
|
|
260
|
+
installGpuDrivers?: boolean;
|
|
261
|
+
/** Name of an instance template used to create VMs. Named the field as 'instance_template' instead of 'template' to avoid c++ keyword conflict. */
|
|
262
|
+
instanceTemplate?: string;
|
|
263
|
+
/** InstancePolicy. */
|
|
264
|
+
policy?: InstancePolicy;
|
|
265
|
+
}
|
|
266
|
+
interface InstanceStatus {
|
|
267
|
+
/** The Compute Engine machine type. */
|
|
268
|
+
machineType?: string;
|
|
269
|
+
/** The VM instance provisioning model. */
|
|
270
|
+
provisioningModel?: string;
|
|
271
|
+
/** The max number of tasks can be assigned to this instance type. */
|
|
272
|
+
taskPack?: string;
|
|
273
|
+
}
|
|
274
|
+
interface Job {
|
|
275
|
+
/** Compute resource allocation for all TaskGroups in the Job. */
|
|
276
|
+
allocationPolicy?: AllocationPolicy;
|
|
277
|
+
/** Output only. When the Job was created. */
|
|
278
|
+
createTime?: string;
|
|
279
|
+
/**
|
|
280
|
+
* Labels for the Job. Labels could be user provided or system generated. For example, "labels": { "department": "finance", "environment": "test" } You can assign up to 64 labels.
|
|
281
|
+
* [Google Compute Engine label restrictions](https://cloud.google.com/compute/docs/labeling-resources#restrictions) apply. Label names that start with "goog-" or "google-" are
|
|
282
|
+
* reserved.
|
|
283
|
+
*/
|
|
284
|
+
labels?: { [P in string]: string };
|
|
285
|
+
/** Log preservation policy for the Job. */
|
|
286
|
+
logsPolicy?: LogsPolicy;
|
|
287
|
+
/** Output only. Job name. For example: "projects/123456/locations/us-central1/jobs/job01". */
|
|
288
|
+
name?: string;
|
|
289
|
+
/** Notification configurations. */
|
|
290
|
+
notifications?: JobNotification[];
|
|
291
|
+
/** Priority of the Job. The valid value range is [0, 100). A job with higher priority value is more likely to run earlier if all other requirements are satisfied. */
|
|
292
|
+
priority?: string;
|
|
293
|
+
/** Output only. Job status. It is read only for users. */
|
|
294
|
+
status?: JobStatus;
|
|
295
|
+
/** Required. TaskGroups in the Job. Only one TaskGroup is supported now. */
|
|
296
|
+
taskGroups?: TaskGroup[];
|
|
297
|
+
/** Output only. A system generated unique ID (in UUID4 format) for the Job. */
|
|
298
|
+
uid?: string;
|
|
299
|
+
/** Output only. The last time the Job was updated. */
|
|
300
|
+
updateTime?: string;
|
|
301
|
+
}
|
|
302
|
+
interface JobNotification {
|
|
303
|
+
/** The attribute requirements of messages to be sent to this Pub/Sub topic. Without this field, no message will be sent. */
|
|
304
|
+
message?: Message;
|
|
305
|
+
/**
|
|
306
|
+
* The Pub/Sub topic where notifications like the job state changes will be published. This topic exist in the same project as the job and billings will be charged to this project. If
|
|
307
|
+
* not specified, no Pub/Sub messages will be sent. Topic format: `projects/{project}/topics/{topic}`.
|
|
308
|
+
*/
|
|
309
|
+
pubsubTopic?: string;
|
|
310
|
+
}
|
|
311
|
+
interface JobStatus {
|
|
312
|
+
/** The duration of time that the Job spent in status RUNNING. */
|
|
313
|
+
runDuration?: string;
|
|
314
|
+
/** Job state */
|
|
315
|
+
state?: string;
|
|
316
|
+
/** Job status events */
|
|
317
|
+
statusEvents?: StatusEvent[];
|
|
318
|
+
/** Aggregated task status for each TaskGroup in the Job. The map key is TaskGroup ID. */
|
|
319
|
+
taskGroups?: { [P in string]: TaskGroupStatus };
|
|
320
|
+
}
|
|
321
|
+
interface KMSEnvMap {
|
|
322
|
+
/** The value of the cipherText response from the `encrypt` method. */
|
|
323
|
+
cipherText?: string;
|
|
324
|
+
/** The name of the KMS key that will be used to decrypt the cipher text. */
|
|
325
|
+
keyName?: string;
|
|
326
|
+
}
|
|
327
|
+
interface LifecyclePolicy {
|
|
328
|
+
/** Action to execute when ActionCondition is true. */
|
|
329
|
+
action?: string;
|
|
330
|
+
/** Conditions that decide why a task failure is dealt with a specific action. */
|
|
331
|
+
actionCondition?: ActionCondition;
|
|
332
|
+
}
|
|
333
|
+
interface ListJobsResponse {
|
|
334
|
+
/** Jobs. */
|
|
335
|
+
jobs?: Job[];
|
|
336
|
+
/** Next page token. */
|
|
337
|
+
nextPageToken?: string;
|
|
338
|
+
/** Locations that could not be reached. */
|
|
339
|
+
unreachable?: string[];
|
|
340
|
+
}
|
|
341
|
+
interface ListLocationsResponse {
|
|
342
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
343
|
+
locations?: Location[];
|
|
344
|
+
/** The standard List next-page token. */
|
|
345
|
+
nextPageToken?: string;
|
|
346
|
+
}
|
|
347
|
+
interface ListOperationsResponse {
|
|
348
|
+
/** The standard List next-page token. */
|
|
349
|
+
nextPageToken?: string;
|
|
350
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
351
|
+
operations?: Operation[];
|
|
352
|
+
}
|
|
353
|
+
interface ListTasksResponse {
|
|
354
|
+
/** Next page token. */
|
|
355
|
+
nextPageToken?: string;
|
|
356
|
+
/** Tasks. */
|
|
357
|
+
tasks?: Task[];
|
|
358
|
+
/** Locations that could not be reached. */
|
|
359
|
+
unreachable?: string[];
|
|
360
|
+
}
|
|
361
|
+
interface Location {
|
|
362
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
363
|
+
displayName?: string;
|
|
364
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
365
|
+
labels?: { [P in string]: string };
|
|
366
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
367
|
+
locationId?: string;
|
|
368
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
369
|
+
metadata?: { [P in string]: any };
|
|
370
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
371
|
+
name?: string;
|
|
372
|
+
}
|
|
373
|
+
interface LocationPolicy {
|
|
374
|
+
/**
|
|
375
|
+
* A list of allowed location names represented by internal URLs. Each location can be a region or a zone. Only one region or multiple zones in one region is supported now. For
|
|
376
|
+
* example, ["regions/us-central1"] allow VMs in any zones in region us-central1. ["zones/us-central1-a", "zones/us-central1-c"] only allow VMs in zones us-central1-a and
|
|
377
|
+
* us-central1-c. All locations end up in different regions would cause errors. For example, ["regions/us-central1", "zones/us-central1-a", "zones/us-central1-b", "zones/us-west1-a"]
|
|
378
|
+
* contains 2 regions "us-central1" and "us-west1". An error is expected in this case.
|
|
379
|
+
*/
|
|
380
|
+
allowedLocations?: string[];
|
|
381
|
+
}
|
|
382
|
+
interface LogsPolicy {
|
|
383
|
+
/** Where logs should be saved. */
|
|
384
|
+
destination?: string;
|
|
385
|
+
/**
|
|
386
|
+
* 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
|
|
387
|
+
* path.
|
|
388
|
+
*/
|
|
389
|
+
logsPath?: string;
|
|
390
|
+
}
|
|
391
|
+
interface Message {
|
|
392
|
+
/** The new job state. */
|
|
393
|
+
newJobState?: string;
|
|
394
|
+
/** The new task state. */
|
|
395
|
+
newTaskState?: string;
|
|
396
|
+
/** The message type. */
|
|
397
|
+
type?: string;
|
|
398
|
+
}
|
|
399
|
+
interface NetworkInterface {
|
|
400
|
+
/**
|
|
401
|
+
* The URL of an existing network resource. You can specify the network as a full or partial URL. For example, the following are all valid URLs:
|
|
402
|
+
* https://www.googleapis.com/compute/v1/projects/{project}/global/networks/{network} projects/{project}/global/networks/{network} global/networks/{network}
|
|
403
|
+
*/
|
|
404
|
+
network?: string;
|
|
405
|
+
/**
|
|
406
|
+
* Default is false (with an external IP address). Required if no external public IP address is attached to the VM. If no external public IP address, additional configuration is
|
|
407
|
+
* required to allow the VM to access Google Services. See https://cloud.google.com/vpc/docs/configure-private-google-access and
|
|
408
|
+
* https://cloud.google.com/nat/docs/gce-example#create-nat for more information.
|
|
409
|
+
*/
|
|
410
|
+
noExternalIpAddress?: boolean;
|
|
411
|
+
/**
|
|
412
|
+
* The URL of an existing subnetwork resource in the network. You can specify the subnetwork as a full or partial URL. For example, the following are all valid URLs:
|
|
413
|
+
* https://www.googleapis.com/compute/v1/projects/{project}/regions/{region}/subnetworks/{subnetwork} projects/{project}/regions/{region}/subnetworks/{subnetwork}
|
|
414
|
+
* regions/{region}/subnetworks/{subnetwork}
|
|
415
|
+
*/
|
|
416
|
+
subnetwork?: string;
|
|
417
|
+
}
|
|
418
|
+
interface NetworkPolicy {
|
|
419
|
+
/** Network configurations. */
|
|
420
|
+
networkInterfaces?: NetworkInterface[];
|
|
421
|
+
}
|
|
422
|
+
interface NFS {
|
|
423
|
+
/** Remote source path exported from the NFS, e.g., "/share". */
|
|
424
|
+
remotePath?: string;
|
|
425
|
+
/** The IP address of the NFS. */
|
|
426
|
+
server?: string;
|
|
427
|
+
}
|
|
428
|
+
interface Operation {
|
|
429
|
+
/** If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
|
|
430
|
+
done?: boolean;
|
|
431
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
432
|
+
error?: Status;
|
|
433
|
+
/**
|
|
434
|
+
* Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such
|
|
435
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
436
|
+
*/
|
|
437
|
+
metadata?: { [P in string]: any };
|
|
438
|
+
/**
|
|
439
|
+
* The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending
|
|
440
|
+
* with `operations/{unique_id}`.
|
|
441
|
+
*/
|
|
442
|
+
name?: string;
|
|
443
|
+
/**
|
|
444
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
445
|
+
* original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the
|
|
446
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
447
|
+
*/
|
|
448
|
+
response?: { [P in string]: any };
|
|
449
|
+
}
|
|
450
|
+
interface OperationMetadata {
|
|
451
|
+
/** Output only. API version used to start the operation. */
|
|
452
|
+
apiVersion?: string;
|
|
453
|
+
/** Output only. The time the operation was created. */
|
|
454
|
+
createTime?: string;
|
|
455
|
+
/** Output only. The time the operation finished running. */
|
|
456
|
+
endTime?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a
|
|
459
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
460
|
+
*/
|
|
461
|
+
requestedCancellation?: boolean;
|
|
462
|
+
/** Output only. Human-readable status of the operation, if any. */
|
|
463
|
+
statusMessage?: string;
|
|
464
|
+
/** Output only. Server-defined resource path for the target of the operation. */
|
|
465
|
+
target?: string;
|
|
466
|
+
/** Output only. Name of the verb executed by the operation. */
|
|
467
|
+
verb?: string;
|
|
468
|
+
}
|
|
469
|
+
interface Policy {
|
|
470
|
+
/** Specifies cloud audit logging configuration for this policy. */
|
|
471
|
+
auditConfigs?: AuditConfig[];
|
|
472
|
+
/**
|
|
473
|
+
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
|
|
474
|
+
* must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
|
|
475
|
+
* principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
|
|
476
|
+
* 1,450 principals to the `bindings` in the `Policy`.
|
|
477
|
+
*/
|
|
478
|
+
bindings?: Binding[];
|
|
479
|
+
/**
|
|
480
|
+
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make
|
|
481
|
+
* use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems
|
|
482
|
+
* are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM
|
|
483
|
+
* Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
484
|
+
* policy, and all of the conditions in the version `3` policy are lost.
|
|
485
|
+
*/
|
|
486
|
+
etag?: string;
|
|
487
|
+
/**
|
|
488
|
+
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
|
|
489
|
+
* must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
|
|
490
|
+
* policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
|
|
491
|
+
* IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
492
|
+
* policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
|
|
493
|
+
* the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
494
|
+
*/
|
|
495
|
+
version?: number;
|
|
496
|
+
}
|
|
497
|
+
interface ReportAgentStateRequest {
|
|
498
|
+
/** Agent info. */
|
|
499
|
+
agentInfo?: AgentInfo;
|
|
500
|
+
/** Agent timing info. */
|
|
501
|
+
agentTimingInfo?: AgentTimingInfo;
|
|
502
|
+
/** Agent metadata. */
|
|
503
|
+
metadata?: AgentMetadata;
|
|
504
|
+
}
|
|
505
|
+
interface ReportAgentStateResponse {
|
|
506
|
+
/** Default report interval override */
|
|
507
|
+
defaultReportInterval?: string;
|
|
508
|
+
/** Minimum report interval override */
|
|
509
|
+
minReportInterval?: string;
|
|
510
|
+
/** Tasks assigned to the agent */
|
|
511
|
+
tasks?: AgentTask[];
|
|
512
|
+
}
|
|
513
|
+
interface Runnable {
|
|
514
|
+
/**
|
|
515
|
+
* By default, after a Runnable fails, no further Runnable are executed. This flag indicates that this Runnable must be run even if the Task has already failed. This is useful for
|
|
516
|
+
* Runnables that copy output files off of the VM or for debugging. The always_run flag does not override the Task's overall max_run_duration. If the max_run_duration has expired then
|
|
517
|
+
* no further Runnables will execute, not even always_run Runnables.
|
|
518
|
+
*/
|
|
519
|
+
alwaysRun?: boolean;
|
|
520
|
+
/**
|
|
521
|
+
* This flag allows a Runnable to continue running in the background while the Task executes subsequent Runnables. This is useful to provide services to other Runnables (or to provide
|
|
522
|
+
* debugging support tools like SSH servers).
|
|
523
|
+
*/
|
|
524
|
+
background?: boolean;
|
|
525
|
+
/** Barrier runnable. */
|
|
526
|
+
barrier?: Barrier;
|
|
527
|
+
/** Container runnable. */
|
|
528
|
+
container?: Container;
|
|
529
|
+
/** Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). */
|
|
530
|
+
environment?: Environment;
|
|
531
|
+
/** Normally, a non-zero exit status causes the Task to fail. This flag allows execution of other Runnables to continue instead. */
|
|
532
|
+
ignoreExitStatus?: boolean;
|
|
533
|
+
/** Script runnable. */
|
|
534
|
+
script?: Script;
|
|
535
|
+
/** Timeout for this Runnable. */
|
|
536
|
+
timeout?: string;
|
|
537
|
+
}
|
|
538
|
+
interface Script {
|
|
539
|
+
/** Script file path on the host VM. */
|
|
540
|
+
path?: string;
|
|
541
|
+
/** Shell script text. */
|
|
542
|
+
text?: string;
|
|
543
|
+
}
|
|
544
|
+
interface ServiceAccount {
|
|
545
|
+
/**
|
|
546
|
+
* Email address of the service account. If not specified, the default Compute Engine service account for the project will be used. If instance template is being used, the service
|
|
547
|
+
* account has to be specified in the instance template and it has to match the email field here.
|
|
548
|
+
*/
|
|
549
|
+
email?: string;
|
|
550
|
+
}
|
|
551
|
+
interface SetIamPolicyRequest {
|
|
552
|
+
/**
|
|
553
|
+
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
|
|
554
|
+
* services (such as Projects) might reject them.
|
|
555
|
+
*/
|
|
556
|
+
policy?: Policy;
|
|
557
|
+
/**
|
|
558
|
+
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:
|
|
559
|
+
* `paths: "bindings, etag"`
|
|
560
|
+
*/
|
|
561
|
+
updateMask?: string;
|
|
562
|
+
}
|
|
563
|
+
interface Status {
|
|
564
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
565
|
+
code?: number;
|
|
566
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
567
|
+
details?: Array<{ [P in string]: any }>;
|
|
568
|
+
/**
|
|
569
|
+
* A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the
|
|
570
|
+
* client.
|
|
571
|
+
*/
|
|
572
|
+
message?: string;
|
|
573
|
+
}
|
|
574
|
+
interface StatusEvent {
|
|
575
|
+
/** Description of the event. */
|
|
576
|
+
description?: string;
|
|
577
|
+
/** The time this event occurred. */
|
|
578
|
+
eventTime?: string;
|
|
579
|
+
/** Task Execution */
|
|
580
|
+
taskExecution?: TaskExecution;
|
|
581
|
+
/** Type of the event. */
|
|
582
|
+
type?: string;
|
|
583
|
+
}
|
|
584
|
+
interface Task {
|
|
585
|
+
/** Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". */
|
|
586
|
+
name?: string;
|
|
587
|
+
/** Task Status. */
|
|
588
|
+
status?: TaskStatus;
|
|
589
|
+
}
|
|
590
|
+
interface TaskExecution {
|
|
591
|
+
/** When task is completed as the status of FAILED or SUCCEEDED, exit code is for one task execution result, default is 0 as success. */
|
|
592
|
+
exitCode?: number;
|
|
593
|
+
}
|
|
594
|
+
interface TaskGroup {
|
|
595
|
+
/** Output only. TaskGroup name. The system generates this field based on parent Job name. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01". */
|
|
596
|
+
name?: string;
|
|
597
|
+
/** Max number of tasks that can run in parallel. Default to min(task_count, 1000). */
|
|
598
|
+
parallelism?: string;
|
|
599
|
+
/** When true, Batch will configure SSH to allow passwordless login between VMs running the Batch tasks in the same TaskGroup. */
|
|
600
|
+
permissiveSsh?: boolean;
|
|
601
|
+
/** 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. */
|
|
602
|
+
requireHostsFile?: boolean;
|
|
603
|
+
/** Number of Tasks in the TaskGroup. default is 1 */
|
|
604
|
+
taskCount?: string;
|
|
605
|
+
/** Max number of tasks that can be run on a VM at the same time. If not specified, the system will decide a value based on available compute resources on a VM and task requirements. */
|
|
606
|
+
taskCountPerNode?: string;
|
|
607
|
+
/**
|
|
608
|
+
* An array of environment variable mappings, which are passed to Tasks with matching indices. If task_environments is used then task_count should not be specified in the request (and
|
|
609
|
+
* will be ignored). Task count will be the length of task_environments. Tasks get a BATCH_TASK_INDEX and BATCH_TASK_COUNT environment variable, in addition to any environment
|
|
610
|
+
* variables set in task_environments, specifying the number of Tasks in the Task's parent TaskGroup, and the specific Task's index in the TaskGroup (0 through BATCH_TASK_COUNT - 1).
|
|
611
|
+
* task_environments supports up to 200 entries.
|
|
612
|
+
*/
|
|
613
|
+
taskEnvironments?: Environment[];
|
|
614
|
+
/** Required. Tasks in the group share the same task spec. */
|
|
615
|
+
taskSpec?: TaskSpec;
|
|
616
|
+
}
|
|
617
|
+
interface TaskGroupStatus {
|
|
618
|
+
/** Count of task in each state in the TaskGroup. The map key is task state name. */
|
|
619
|
+
counts?: { [P in string]: string };
|
|
620
|
+
/** Status of instances allocated for the TaskGroup. */
|
|
621
|
+
instances?: InstanceStatus[];
|
|
622
|
+
}
|
|
623
|
+
interface TaskSpec {
|
|
624
|
+
/** ComputeResource requirements. */
|
|
625
|
+
computeResource?: ComputeResource;
|
|
626
|
+
/** Environment variables to set before running the Task. */
|
|
627
|
+
environment?: Environment;
|
|
628
|
+
/** Deprecated: please use environment(non-plural) instead. */
|
|
629
|
+
environments?: { [P in string]: string };
|
|
630
|
+
/**
|
|
631
|
+
* Lifecycle management schema when any task in a task group is failed. The valid size of lifecycle policies are [0, 10]. For each lifecycle policy, when the condition is met, the
|
|
632
|
+
* action in that policy will execute. If there are multiple policies that the task execution result matches, we use the action from the first matched policy. If task execution result
|
|
633
|
+
* does not meet with any of the defined lifecycle policy, we consider it as the default policy. Default policy means if the exit code is 0, exit task. If task ends with non-zero exit
|
|
634
|
+
* code, retry the task with max_retry_count.
|
|
635
|
+
*/
|
|
636
|
+
lifecyclePolicies?: LifecyclePolicy[];
|
|
637
|
+
/** Maximum number of retries on failures. The default, 0, which means never retry. The valid value range is [0, 10]. */
|
|
638
|
+
maxRetryCount?: number;
|
|
639
|
+
/** Maximum duration the task should run. The task will be killed and marked as FAILED if over this limit. */
|
|
640
|
+
maxRunDuration?: string;
|
|
641
|
+
/**
|
|
642
|
+
* The sequence of scripts or containers to run for this Task. Each Task using this TaskSpec executes its list of runnables in order. The Task succeeds if all of its runnables either
|
|
643
|
+
* exit with a zero status or any that exit with a non-zero status have the ignore_exit_status flag. Background runnables are killed automatically (if they have not already exited) a
|
|
644
|
+
* short time after all foreground runnables have completed. Even though this is likely to result in a non-zero exit status for the background runnable, these automatic kills are not
|
|
645
|
+
* treated as Task failures.
|
|
646
|
+
*/
|
|
647
|
+
runnables?: Runnable[];
|
|
648
|
+
/** Volumes to mount before running Tasks using this TaskSpec. */
|
|
649
|
+
volumes?: Volume[];
|
|
650
|
+
}
|
|
651
|
+
interface TaskStatus {
|
|
652
|
+
/** Task state */
|
|
653
|
+
state?: string;
|
|
654
|
+
/** Detailed info about why the state is reached. */
|
|
655
|
+
statusEvents?: StatusEvent[];
|
|
656
|
+
}
|
|
657
|
+
interface TestIamPermissionsRequest {
|
|
658
|
+
/**
|
|
659
|
+
* The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
|
|
660
|
+
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
|
661
|
+
*/
|
|
662
|
+
permissions?: string[];
|
|
663
|
+
}
|
|
664
|
+
interface TestIamPermissionsResponse {
|
|
665
|
+
/** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
|
|
666
|
+
permissions?: string[];
|
|
667
|
+
}
|
|
668
|
+
interface Volume {
|
|
669
|
+
/**
|
|
670
|
+
* Device name of an attached disk volume, which should align with a device_name specified by job.allocation_policy.instances[0].policy.disks[i].device_name or defined by the given
|
|
671
|
+
* instance template in job.allocation_policy.instances[0].instance_template.
|
|
672
|
+
*/
|
|
673
|
+
deviceName?: string;
|
|
674
|
+
/** A Google Cloud Storage (GCS) volume. */
|
|
675
|
+
gcs?: GCS;
|
|
676
|
+
/**
|
|
677
|
+
* For Google Cloud Storage (GCS), mount options are the options supported by the gcsfuse tool (https://github.com/GoogleCloudPlatform/gcsfuse). For existing persistent disks, mount
|
|
678
|
+
* options provided by the mount command (https://man7.org/linux/man-pages/man8/mount.8.html) except writing are supported. This is due to restrictions of multi-writer mode
|
|
679
|
+
* (https://cloud.google.com/compute/docs/disks/sharing-disks-between-vms). For other attached disks and Network File System (NFS), mount options are these supported by the mount
|
|
680
|
+
* command (https://man7.org/linux/man-pages/man8/mount.8.html).
|
|
681
|
+
*/
|
|
682
|
+
mountOptions?: string[];
|
|
683
|
+
/** The mount path for the volume, e.g. /mnt/disks/share. */
|
|
684
|
+
mountPath?: string;
|
|
685
|
+
/** A Network File System (NFS) volume. For example, a Filestore file share. */
|
|
686
|
+
nfs?: NFS;
|
|
687
|
+
}
|
|
688
|
+
interface TasksResource {
|
|
689
|
+
/** Return a single Task. */
|
|
690
|
+
get(request?: {
|
|
691
|
+
/** V1 error format. */
|
|
692
|
+
"$.xgafv"?: string;
|
|
693
|
+
/** OAuth access token. */
|
|
694
|
+
access_token?: string;
|
|
695
|
+
/** Data format for response. */
|
|
696
|
+
alt?: string;
|
|
697
|
+
/** JSONP */
|
|
698
|
+
callback?: string;
|
|
699
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
700
|
+
fields?: string;
|
|
701
|
+
/** 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. */
|
|
702
|
+
key?: string;
|
|
703
|
+
/** Required. Task name. */
|
|
704
|
+
name: string;
|
|
705
|
+
/** OAuth 2.0 token for the current user. */
|
|
706
|
+
oauth_token?: string;
|
|
707
|
+
/** Returns response with indentations and line breaks. */
|
|
708
|
+
prettyPrint?: boolean;
|
|
709
|
+
/** 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. */
|
|
710
|
+
quotaUser?: string;
|
|
711
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
712
|
+
upload_protocol?: string;
|
|
713
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
714
|
+
uploadType?: string;
|
|
715
|
+
}): Request<Task>;
|
|
716
|
+
/** List Tasks associated with a job. */
|
|
717
|
+
list(request?: {
|
|
718
|
+
/** V1 error format. */
|
|
719
|
+
"$.xgafv"?: string;
|
|
720
|
+
/** OAuth access token. */
|
|
721
|
+
access_token?: string;
|
|
722
|
+
/** Data format for response. */
|
|
723
|
+
alt?: string;
|
|
724
|
+
/** JSONP */
|
|
725
|
+
callback?: string;
|
|
726
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
727
|
+
fields?: string;
|
|
728
|
+
/** Task filter, null filter matches all Tasks. Filter string should be of the format State=TaskStatus.State e.g. State=RUNNING */
|
|
729
|
+
filter?: string;
|
|
730
|
+
/** 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. */
|
|
731
|
+
key?: string;
|
|
732
|
+
/** OAuth 2.0 token for the current user. */
|
|
733
|
+
oauth_token?: string;
|
|
734
|
+
/** Page size. */
|
|
735
|
+
pageSize?: number;
|
|
736
|
+
/** Page token. */
|
|
737
|
+
pageToken?: string;
|
|
738
|
+
/** Required. Name of a TaskGroup from which Tasks are being requested. Pattern: "projects/{project}/locations/{location}/jobs/{job}/taskGroups/{task_group}" */
|
|
739
|
+
parent: string;
|
|
740
|
+
/** Returns response with indentations and line breaks. */
|
|
741
|
+
prettyPrint?: boolean;
|
|
742
|
+
/** 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. */
|
|
743
|
+
quotaUser?: string;
|
|
744
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
745
|
+
upload_protocol?: string;
|
|
746
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
747
|
+
uploadType?: string;
|
|
748
|
+
}): Request<ListTasksResponse>;
|
|
749
|
+
}
|
|
750
|
+
interface TaskGroupsResource {
|
|
751
|
+
tasks: TasksResource;
|
|
752
|
+
}
|
|
753
|
+
interface JobsResource {
|
|
754
|
+
/** Create a Job. */
|
|
755
|
+
create(request: {
|
|
756
|
+
/** V1 error format. */
|
|
757
|
+
"$.xgafv"?: string;
|
|
758
|
+
/** OAuth access token. */
|
|
759
|
+
access_token?: string;
|
|
760
|
+
/** Data format for response. */
|
|
761
|
+
alt?: string;
|
|
762
|
+
/** JSONP */
|
|
763
|
+
callback?: string;
|
|
764
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
765
|
+
fields?: string;
|
|
766
|
+
/**
|
|
767
|
+
* ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase
|
|
768
|
+
* characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field
|
|
769
|
+
* in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
|
|
770
|
+
*/
|
|
771
|
+
jobId?: string;
|
|
772
|
+
/** 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. */
|
|
773
|
+
key?: string;
|
|
774
|
+
/** OAuth 2.0 token for the current user. */
|
|
775
|
+
oauth_token?: string;
|
|
776
|
+
/** Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" */
|
|
777
|
+
parent: string;
|
|
778
|
+
/** Returns response with indentations and line breaks. */
|
|
779
|
+
prettyPrint?: boolean;
|
|
780
|
+
/** 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. */
|
|
781
|
+
quotaUser?: string;
|
|
782
|
+
/**
|
|
783
|
+
* Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has
|
|
784
|
+
* already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t
|
|
785
|
+
* he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will
|
|
786
|
+
* ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not
|
|
787
|
+
* supported (00000000-0000-0000-0000-000000000000).
|
|
788
|
+
*/
|
|
789
|
+
requestId?: string;
|
|
790
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
791
|
+
upload_protocol?: string;
|
|
792
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
793
|
+
uploadType?: string;
|
|
794
|
+
/** Request body */
|
|
795
|
+
resource: Job;
|
|
796
|
+
}): Request<Job>;
|
|
797
|
+
create(request: {
|
|
798
|
+
/** V1 error format. */
|
|
799
|
+
"$.xgafv"?: string;
|
|
800
|
+
/** OAuth access token. */
|
|
801
|
+
access_token?: string;
|
|
802
|
+
/** Data format for response. */
|
|
803
|
+
alt?: string;
|
|
804
|
+
/** JSONP */
|
|
805
|
+
callback?: string;
|
|
806
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
807
|
+
fields?: string;
|
|
808
|
+
/**
|
|
809
|
+
* ID used to uniquely identify the Job within its parent scope. This field should contain at most 63 characters and must start with lowercase characters. Only lowercase
|
|
810
|
+
* characters, numbers and '-' are accepted. The '-' character cannot be the first or the last one. A system generated ID will be used if the field is not set. The job.name field
|
|
811
|
+
* in the request will be ignored and the created resource name of the Job will be "{parent}/jobs/{job_id}".
|
|
812
|
+
*/
|
|
813
|
+
jobId?: string;
|
|
814
|
+
/** 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. */
|
|
815
|
+
key?: string;
|
|
816
|
+
/** OAuth 2.0 token for the current user. */
|
|
817
|
+
oauth_token?: string;
|
|
818
|
+
/** Required. The parent resource name where the Job will be created. Pattern: "projects/{project}/locations/{location}" */
|
|
819
|
+
parent: string;
|
|
820
|
+
/** Returns response with indentations and line breaks. */
|
|
821
|
+
prettyPrint?: boolean;
|
|
822
|
+
/** 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. */
|
|
823
|
+
quotaUser?: string;
|
|
824
|
+
/**
|
|
825
|
+
* Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has
|
|
826
|
+
* already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and t
|
|
827
|
+
* he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will
|
|
828
|
+
* ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not
|
|
829
|
+
* supported (00000000-0000-0000-0000-000000000000).
|
|
830
|
+
*/
|
|
831
|
+
requestId?: string;
|
|
832
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
833
|
+
upload_protocol?: string;
|
|
834
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
835
|
+
uploadType?: string;
|
|
836
|
+
},
|
|
837
|
+
body: Job): Request<Job>;
|
|
838
|
+
/** Delete a Job. */
|
|
839
|
+
delete(request?: {
|
|
840
|
+
/** V1 error format. */
|
|
841
|
+
"$.xgafv"?: string;
|
|
842
|
+
/** OAuth access token. */
|
|
843
|
+
access_token?: string;
|
|
844
|
+
/** Data format for response. */
|
|
845
|
+
alt?: string;
|
|
846
|
+
/** JSONP */
|
|
847
|
+
callback?: string;
|
|
848
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
849
|
+
fields?: string;
|
|
850
|
+
/** 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. */
|
|
851
|
+
key?: string;
|
|
852
|
+
/** Job name. */
|
|
853
|
+
name: string;
|
|
854
|
+
/** OAuth 2.0 token for the current user. */
|
|
855
|
+
oauth_token?: string;
|
|
856
|
+
/** Returns response with indentations and line breaks. */
|
|
857
|
+
prettyPrint?: boolean;
|
|
858
|
+
/** 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. */
|
|
859
|
+
quotaUser?: string;
|
|
860
|
+
/** Optional. Reason for this deletion. */
|
|
861
|
+
reason?: string;
|
|
862
|
+
/**
|
|
863
|
+
* Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has
|
|
864
|
+
* already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and t
|
|
865
|
+
* he request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will
|
|
866
|
+
* ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not
|
|
867
|
+
* supported (00000000-0000-0000-0000-000000000000).
|
|
868
|
+
*/
|
|
869
|
+
requestId?: string;
|
|
870
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
871
|
+
upload_protocol?: string;
|
|
872
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
873
|
+
uploadType?: string;
|
|
874
|
+
}): Request<Operation>;
|
|
875
|
+
/** Get a Job specified by its resource name. */
|
|
876
|
+
get(request?: {
|
|
877
|
+
/** V1 error format. */
|
|
878
|
+
"$.xgafv"?: string;
|
|
879
|
+
/** OAuth access token. */
|
|
880
|
+
access_token?: string;
|
|
881
|
+
/** Data format for response. */
|
|
882
|
+
alt?: string;
|
|
883
|
+
/** JSONP */
|
|
884
|
+
callback?: string;
|
|
885
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
886
|
+
fields?: string;
|
|
887
|
+
/** 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. */
|
|
888
|
+
key?: string;
|
|
889
|
+
/** Required. Job name. */
|
|
890
|
+
name: string;
|
|
891
|
+
/** OAuth 2.0 token for the current user. */
|
|
892
|
+
oauth_token?: string;
|
|
893
|
+
/** Returns response with indentations and line breaks. */
|
|
894
|
+
prettyPrint?: boolean;
|
|
895
|
+
/** 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. */
|
|
896
|
+
quotaUser?: string;
|
|
897
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
898
|
+
upload_protocol?: string;
|
|
899
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
900
|
+
uploadType?: string;
|
|
901
|
+
}): Request<Job>;
|
|
902
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
903
|
+
getIamPolicy(request?: {
|
|
904
|
+
/** V1 error format. */
|
|
905
|
+
"$.xgafv"?: string;
|
|
906
|
+
/** OAuth access token. */
|
|
907
|
+
access_token?: string;
|
|
908
|
+
/** Data format for response. */
|
|
909
|
+
alt?: string;
|
|
910
|
+
/** JSONP */
|
|
911
|
+
callback?: string;
|
|
912
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
913
|
+
fields?: string;
|
|
914
|
+
/** 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. */
|
|
915
|
+
key?: string;
|
|
916
|
+
/** OAuth 2.0 token for the current user. */
|
|
917
|
+
oauth_token?: string;
|
|
918
|
+
/**
|
|
919
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
920
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy
|
|
921
|
+
* in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional
|
|
922
|
+
* role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
923
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
924
|
+
*/
|
|
925
|
+
"options.requestedPolicyVersion"?: number;
|
|
926
|
+
/** Returns response with indentations and line breaks. */
|
|
927
|
+
prettyPrint?: boolean;
|
|
928
|
+
/** 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. */
|
|
929
|
+
quotaUser?: string;
|
|
930
|
+
/**
|
|
931
|
+
* REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
932
|
+
* field.
|
|
933
|
+
*/
|
|
934
|
+
resource: string;
|
|
935
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
936
|
+
upload_protocol?: string;
|
|
937
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
938
|
+
uploadType?: string;
|
|
939
|
+
}): Request<Policy>;
|
|
940
|
+
/** List all Jobs for a project within a region. */
|
|
941
|
+
list(request?: {
|
|
942
|
+
/** V1 error format. */
|
|
943
|
+
"$.xgafv"?: string;
|
|
944
|
+
/** OAuth access token. */
|
|
945
|
+
access_token?: string;
|
|
946
|
+
/** Data format for response. */
|
|
947
|
+
alt?: string;
|
|
948
|
+
/** JSONP */
|
|
949
|
+
callback?: string;
|
|
950
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
951
|
+
fields?: string;
|
|
952
|
+
/** List filter. */
|
|
953
|
+
filter?: string;
|
|
954
|
+
/** 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. */
|
|
955
|
+
key?: string;
|
|
956
|
+
/** OAuth 2.0 token for the current user. */
|
|
957
|
+
oauth_token?: string;
|
|
958
|
+
/** Page size. */
|
|
959
|
+
pageSize?: number;
|
|
960
|
+
/** Page token. */
|
|
961
|
+
pageToken?: string;
|
|
962
|
+
/** Parent path. */
|
|
963
|
+
parent: string;
|
|
964
|
+
/** Returns response with indentations and line breaks. */
|
|
965
|
+
prettyPrint?: boolean;
|
|
966
|
+
/** 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. */
|
|
967
|
+
quotaUser?: string;
|
|
968
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
969
|
+
upload_protocol?: string;
|
|
970
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
971
|
+
uploadType?: string;
|
|
972
|
+
}): Request<ListJobsResponse>;
|
|
973
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
974
|
+
setIamPolicy(request: {
|
|
975
|
+
/** V1 error format. */
|
|
976
|
+
"$.xgafv"?: string;
|
|
977
|
+
/** OAuth access token. */
|
|
978
|
+
access_token?: string;
|
|
979
|
+
/** Data format for response. */
|
|
980
|
+
alt?: string;
|
|
981
|
+
/** JSONP */
|
|
982
|
+
callback?: string;
|
|
983
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
984
|
+
fields?: string;
|
|
985
|
+
/** 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. */
|
|
986
|
+
key?: string;
|
|
987
|
+
/** OAuth 2.0 token for the current user. */
|
|
988
|
+
oauth_token?: string;
|
|
989
|
+
/** Returns response with indentations and line breaks. */
|
|
990
|
+
prettyPrint?: boolean;
|
|
991
|
+
/** 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. */
|
|
992
|
+
quotaUser?: string;
|
|
993
|
+
/**
|
|
994
|
+
* REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
995
|
+
* field.
|
|
996
|
+
*/
|
|
997
|
+
resource: string;
|
|
998
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
999
|
+
upload_protocol?: string;
|
|
1000
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1001
|
+
uploadType?: string;
|
|
1002
|
+
},
|
|
1003
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
1004
|
+
/**
|
|
1005
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
1006
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
1007
|
+
*/
|
|
1008
|
+
testIamPermissions(request: {
|
|
1009
|
+
/** V1 error format. */
|
|
1010
|
+
"$.xgafv"?: string;
|
|
1011
|
+
/** OAuth access token. */
|
|
1012
|
+
access_token?: string;
|
|
1013
|
+
/** Data format for response. */
|
|
1014
|
+
alt?: string;
|
|
1015
|
+
/** JSONP */
|
|
1016
|
+
callback?: string;
|
|
1017
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1018
|
+
fields?: string;
|
|
1019
|
+
/** 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. */
|
|
1020
|
+
key?: string;
|
|
1021
|
+
/** OAuth 2.0 token for the current user. */
|
|
1022
|
+
oauth_token?: string;
|
|
1023
|
+
/** Returns response with indentations and line breaks. */
|
|
1024
|
+
prettyPrint?: boolean;
|
|
1025
|
+
/** 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. */
|
|
1026
|
+
quotaUser?: string;
|
|
1027
|
+
/**
|
|
1028
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
1029
|
+
* this field.
|
|
1030
|
+
*/
|
|
1031
|
+
resource: string;
|
|
1032
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1033
|
+
upload_protocol?: string;
|
|
1034
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1035
|
+
uploadType?: string;
|
|
1036
|
+
},
|
|
1037
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
1038
|
+
taskGroups: TaskGroupsResource;
|
|
1039
|
+
}
|
|
1040
|
+
interface OperationsResource {
|
|
1041
|
+
/**
|
|
1042
|
+
* Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support
|
|
1043
|
+
* this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the
|
|
1044
|
+
* operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a
|
|
1045
|
+
* google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.
|
|
1046
|
+
*/
|
|
1047
|
+
cancel(request: {
|
|
1048
|
+
/** V1 error format. */
|
|
1049
|
+
"$.xgafv"?: string;
|
|
1050
|
+
/** OAuth access token. */
|
|
1051
|
+
access_token?: string;
|
|
1052
|
+
/** Data format for response. */
|
|
1053
|
+
alt?: string;
|
|
1054
|
+
/** JSONP */
|
|
1055
|
+
callback?: string;
|
|
1056
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1057
|
+
fields?: string;
|
|
1058
|
+
/** 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. */
|
|
1059
|
+
key?: string;
|
|
1060
|
+
/** The name of the operation resource to be cancelled. */
|
|
1061
|
+
name: string;
|
|
1062
|
+
/** OAuth 2.0 token for the current user. */
|
|
1063
|
+
oauth_token?: string;
|
|
1064
|
+
/** Returns response with indentations and line breaks. */
|
|
1065
|
+
prettyPrint?: boolean;
|
|
1066
|
+
/** 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. */
|
|
1067
|
+
quotaUser?: string;
|
|
1068
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1069
|
+
upload_protocol?: string;
|
|
1070
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1071
|
+
uploadType?: string;
|
|
1072
|
+
/** Request body */
|
|
1073
|
+
resource: CancelOperationRequest;
|
|
1074
|
+
}): Request<{}>;
|
|
1075
|
+
cancel(request: {
|
|
1076
|
+
/** V1 error format. */
|
|
1077
|
+
"$.xgafv"?: string;
|
|
1078
|
+
/** OAuth access token. */
|
|
1079
|
+
access_token?: string;
|
|
1080
|
+
/** Data format for response. */
|
|
1081
|
+
alt?: string;
|
|
1082
|
+
/** JSONP */
|
|
1083
|
+
callback?: string;
|
|
1084
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1085
|
+
fields?: string;
|
|
1086
|
+
/** 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. */
|
|
1087
|
+
key?: string;
|
|
1088
|
+
/** The name of the operation resource to be cancelled. */
|
|
1089
|
+
name: string;
|
|
1090
|
+
/** OAuth 2.0 token for the current user. */
|
|
1091
|
+
oauth_token?: string;
|
|
1092
|
+
/** Returns response with indentations and line breaks. */
|
|
1093
|
+
prettyPrint?: boolean;
|
|
1094
|
+
/** 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. */
|
|
1095
|
+
quotaUser?: string;
|
|
1096
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1097
|
+
upload_protocol?: string;
|
|
1098
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1099
|
+
uploadType?: string;
|
|
1100
|
+
},
|
|
1101
|
+
body: CancelOperationRequest): Request<{}>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't
|
|
1104
|
+
* support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
|
|
1105
|
+
*/
|
|
1106
|
+
delete(request?: {
|
|
1107
|
+
/** V1 error format. */
|
|
1108
|
+
"$.xgafv"?: string;
|
|
1109
|
+
/** OAuth access token. */
|
|
1110
|
+
access_token?: string;
|
|
1111
|
+
/** Data format for response. */
|
|
1112
|
+
alt?: string;
|
|
1113
|
+
/** JSONP */
|
|
1114
|
+
callback?: string;
|
|
1115
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1116
|
+
fields?: string;
|
|
1117
|
+
/** 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. */
|
|
1118
|
+
key?: string;
|
|
1119
|
+
/** The name of the operation resource to be deleted. */
|
|
1120
|
+
name: string;
|
|
1121
|
+
/** OAuth 2.0 token for the current user. */
|
|
1122
|
+
oauth_token?: string;
|
|
1123
|
+
/** Returns response with indentations and line breaks. */
|
|
1124
|
+
prettyPrint?: boolean;
|
|
1125
|
+
/** 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. */
|
|
1126
|
+
quotaUser?: string;
|
|
1127
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1128
|
+
upload_protocol?: string;
|
|
1129
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1130
|
+
uploadType?: string;
|
|
1131
|
+
}): Request<{}>;
|
|
1132
|
+
/** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
|
|
1133
|
+
get(request?: {
|
|
1134
|
+
/** V1 error format. */
|
|
1135
|
+
"$.xgafv"?: string;
|
|
1136
|
+
/** OAuth access token. */
|
|
1137
|
+
access_token?: string;
|
|
1138
|
+
/** Data format for response. */
|
|
1139
|
+
alt?: string;
|
|
1140
|
+
/** JSONP */
|
|
1141
|
+
callback?: string;
|
|
1142
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1143
|
+
fields?: string;
|
|
1144
|
+
/** 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. */
|
|
1145
|
+
key?: string;
|
|
1146
|
+
/** The name of the operation resource. */
|
|
1147
|
+
name: string;
|
|
1148
|
+
/** OAuth 2.0 token for the current user. */
|
|
1149
|
+
oauth_token?: string;
|
|
1150
|
+
/** Returns response with indentations and line breaks. */
|
|
1151
|
+
prettyPrint?: boolean;
|
|
1152
|
+
/** 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. */
|
|
1153
|
+
quotaUser?: string;
|
|
1154
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1155
|
+
upload_protocol?: string;
|
|
1156
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1157
|
+
uploadType?: string;
|
|
1158
|
+
}): Request<Operation>;
|
|
1159
|
+
/**
|
|
1160
|
+
* Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services
|
|
1161
|
+
* to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as
|
|
1162
|
+
* `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must
|
|
1163
|
+
* ensure the name binding is the parent resource, without the operations collection id.
|
|
1164
|
+
*/
|
|
1165
|
+
list(request?: {
|
|
1166
|
+
/** V1 error format. */
|
|
1167
|
+
"$.xgafv"?: string;
|
|
1168
|
+
/** OAuth access token. */
|
|
1169
|
+
access_token?: string;
|
|
1170
|
+
/** Data format for response. */
|
|
1171
|
+
alt?: string;
|
|
1172
|
+
/** JSONP */
|
|
1173
|
+
callback?: string;
|
|
1174
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1175
|
+
fields?: string;
|
|
1176
|
+
/** The standard list filter. */
|
|
1177
|
+
filter?: string;
|
|
1178
|
+
/** 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. */
|
|
1179
|
+
key?: string;
|
|
1180
|
+
/** The name of the operation's parent resource. */
|
|
1181
|
+
name: string;
|
|
1182
|
+
/** OAuth 2.0 token for the current user. */
|
|
1183
|
+
oauth_token?: string;
|
|
1184
|
+
/** The standard list page size. */
|
|
1185
|
+
pageSize?: number;
|
|
1186
|
+
/** The standard list page token. */
|
|
1187
|
+
pageToken?: string;
|
|
1188
|
+
/** Returns response with indentations and line breaks. */
|
|
1189
|
+
prettyPrint?: boolean;
|
|
1190
|
+
/** 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. */
|
|
1191
|
+
quotaUser?: string;
|
|
1192
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1193
|
+
upload_protocol?: string;
|
|
1194
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1195
|
+
uploadType?: string;
|
|
1196
|
+
}): Request<ListOperationsResponse>;
|
|
1197
|
+
}
|
|
1198
|
+
interface StateResource {
|
|
1199
|
+
/** Report agent's state, e.g. agent status and tasks information */
|
|
1200
|
+
report(request: {
|
|
1201
|
+
/** V1 error format. */
|
|
1202
|
+
"$.xgafv"?: string;
|
|
1203
|
+
/** OAuth access token. */
|
|
1204
|
+
access_token?: string;
|
|
1205
|
+
/** Data format for response. */
|
|
1206
|
+
alt?: string;
|
|
1207
|
+
/** JSONP */
|
|
1208
|
+
callback?: string;
|
|
1209
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1210
|
+
fields?: string;
|
|
1211
|
+
/** 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. */
|
|
1212
|
+
key?: string;
|
|
1213
|
+
/** OAuth 2.0 token for the current user. */
|
|
1214
|
+
oauth_token?: string;
|
|
1215
|
+
/** Required. Format: projects/{project}/locations/{location} {project} should be a project number. */
|
|
1216
|
+
parent: string;
|
|
1217
|
+
/** Returns response with indentations and line breaks. */
|
|
1218
|
+
prettyPrint?: boolean;
|
|
1219
|
+
/** 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. */
|
|
1220
|
+
quotaUser?: string;
|
|
1221
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1222
|
+
upload_protocol?: string;
|
|
1223
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1224
|
+
uploadType?: string;
|
|
1225
|
+
/** Request body */
|
|
1226
|
+
resource: ReportAgentStateRequest;
|
|
1227
|
+
}): Request<ReportAgentStateResponse>;
|
|
1228
|
+
report(request: {
|
|
1229
|
+
/** V1 error format. */
|
|
1230
|
+
"$.xgafv"?: string;
|
|
1231
|
+
/** OAuth access token. */
|
|
1232
|
+
access_token?: string;
|
|
1233
|
+
/** Data format for response. */
|
|
1234
|
+
alt?: string;
|
|
1235
|
+
/** JSONP */
|
|
1236
|
+
callback?: string;
|
|
1237
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1238
|
+
fields?: string;
|
|
1239
|
+
/** 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. */
|
|
1240
|
+
key?: string;
|
|
1241
|
+
/** OAuth 2.0 token for the current user. */
|
|
1242
|
+
oauth_token?: string;
|
|
1243
|
+
/** Required. Format: projects/{project}/locations/{location} {project} should be a project number. */
|
|
1244
|
+
parent: string;
|
|
1245
|
+
/** Returns response with indentations and line breaks. */
|
|
1246
|
+
prettyPrint?: boolean;
|
|
1247
|
+
/** 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. */
|
|
1248
|
+
quotaUser?: string;
|
|
1249
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1250
|
+
upload_protocol?: string;
|
|
1251
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1252
|
+
uploadType?: string;
|
|
1253
|
+
},
|
|
1254
|
+
body: ReportAgentStateRequest): Request<ReportAgentStateResponse>;
|
|
1255
|
+
}
|
|
1256
|
+
interface LocationsResource {
|
|
1257
|
+
/** Gets information about a location. */
|
|
1258
|
+
get(request?: {
|
|
1259
|
+
/** V1 error format. */
|
|
1260
|
+
"$.xgafv"?: string;
|
|
1261
|
+
/** OAuth access token. */
|
|
1262
|
+
access_token?: string;
|
|
1263
|
+
/** Data format for response. */
|
|
1264
|
+
alt?: string;
|
|
1265
|
+
/** JSONP */
|
|
1266
|
+
callback?: string;
|
|
1267
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1268
|
+
fields?: string;
|
|
1269
|
+
/** 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. */
|
|
1270
|
+
key?: string;
|
|
1271
|
+
/** Resource name for the location. */
|
|
1272
|
+
name: string;
|
|
1273
|
+
/** OAuth 2.0 token for the current user. */
|
|
1274
|
+
oauth_token?: string;
|
|
1275
|
+
/** Returns response with indentations and line breaks. */
|
|
1276
|
+
prettyPrint?: boolean;
|
|
1277
|
+
/** 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. */
|
|
1278
|
+
quotaUser?: string;
|
|
1279
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1280
|
+
upload_protocol?: string;
|
|
1281
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1282
|
+
uploadType?: string;
|
|
1283
|
+
}): Request<Location>;
|
|
1284
|
+
/** Lists information about the supported locations for this service. */
|
|
1285
|
+
list(request?: {
|
|
1286
|
+
/** V1 error format. */
|
|
1287
|
+
"$.xgafv"?: string;
|
|
1288
|
+
/** OAuth access token. */
|
|
1289
|
+
access_token?: string;
|
|
1290
|
+
/** Data format for response. */
|
|
1291
|
+
alt?: string;
|
|
1292
|
+
/** JSONP */
|
|
1293
|
+
callback?: string;
|
|
1294
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1295
|
+
fields?: string;
|
|
1296
|
+
/**
|
|
1297
|
+
* A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in
|
|
1298
|
+
* [AIP-160](https://google.aip.dev/160).
|
|
1299
|
+
*/
|
|
1300
|
+
filter?: string;
|
|
1301
|
+
/** 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. */
|
|
1302
|
+
key?: string;
|
|
1303
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
1304
|
+
name: string;
|
|
1305
|
+
/** OAuth 2.0 token for the current user. */
|
|
1306
|
+
oauth_token?: string;
|
|
1307
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
1308
|
+
pageSize?: number;
|
|
1309
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
1310
|
+
pageToken?: string;
|
|
1311
|
+
/** Returns response with indentations and line breaks. */
|
|
1312
|
+
prettyPrint?: boolean;
|
|
1313
|
+
/** 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. */
|
|
1314
|
+
quotaUser?: string;
|
|
1315
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1316
|
+
upload_protocol?: string;
|
|
1317
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1318
|
+
uploadType?: string;
|
|
1319
|
+
}): Request<ListLocationsResponse>;
|
|
1320
|
+
jobs: JobsResource;
|
|
1321
|
+
operations: OperationsResource;
|
|
1322
|
+
state: StateResource;
|
|
1323
|
+
}
|
|
1324
|
+
interface ProjectsResource {
|
|
1325
|
+
locations: LocationsResource;
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
const projects: ProjectsResource;
|
|
1329
|
+
}
|
|
1330
|
+
}
|