@maxim_mazurok/gapi.client.cloudscheduler-v1beta1 0.0.20230331 → 0.0.20230421
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 +516 -259
- package/package.json +1 -1
- package/tests.ts +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://cloudscheduler.googleapis.com/$discovery/rest?version=v1beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230421
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -24,12 +24,14 @@ declare namespace gapi.client {
|
|
|
24
24
|
namespace cloudscheduler {
|
|
25
25
|
interface AppEngineHttpTarget {
|
|
26
26
|
/** App Engine Routing setting for the job. */
|
|
27
|
-
appEngineRouting?:
|
|
27
|
+
appEngineRouting?:
|
|
28
|
+
AppEngineRouting;
|
|
28
29
|
/**
|
|
29
30
|
* Body. HTTP request body. A request body is allowed only if the HTTP method is POST or PUT. It will result in invalid argument error to set a body on a job with an incompatible
|
|
30
31
|
* HttpMethod.
|
|
31
32
|
*/
|
|
32
|
-
body?:
|
|
33
|
+
body?:
|
|
34
|
+
string;
|
|
33
35
|
/**
|
|
34
36
|
* HTTP request headers. This map contains the header field names and values. Headers can be set when the job is created. Cloud Scheduler sets some headers to default values: *
|
|
35
37
|
* `User-Agent`: By default, this header is `"AppEngine-Google; (+http://code.google.com/appengine)"`. This header can be modified, but Cloud Scheduler will append `"AppEngine-Google;
|
|
@@ -41,14 +43,17 @@ declare namespace gapi.client {
|
|
|
41
43
|
* `X-Google-*`: For Google internal use only. * `X-AppEngine-*`: For Google internal use only. In addition, some App Engine headers, which contain job-specific information, are also
|
|
42
44
|
* be sent to the job handler.
|
|
43
45
|
*/
|
|
44
|
-
headers?:
|
|
46
|
+
headers?:
|
|
47
|
+
{ [P in string]: string };
|
|
45
48
|
/** The HTTP method to use for the request. PATCH and OPTIONS are not permitted. */
|
|
46
|
-
httpMethod?:
|
|
49
|
+
httpMethod?:
|
|
50
|
+
string;
|
|
47
51
|
/**
|
|
48
52
|
* The relative URI. The relative URL must begin with "/" and must be a valid HTTP relative URL. It can contain a path, query string arguments, and `#` fragments. If the relative URL
|
|
49
53
|
* is empty, then the root path "/" will be used. No spaces are allowed, and the maximum length allowed is 2083 characters.
|
|
50
54
|
*/
|
|
51
|
-
relativeUri?:
|
|
55
|
+
relativeUri?:
|
|
56
|
+
string;
|
|
52
57
|
}
|
|
53
58
|
interface AppEngineRouting {
|
|
54
59
|
/**
|
|
@@ -63,25 +68,30 @@ declare namespace gapi.client {
|
|
|
63
68
|
* version when the job is attempted. If instance is empty, then the job will be sent to an instance which is available when the job is attempted. If service, version, or instance is
|
|
64
69
|
* invalid, then the job will be sent to the default version of the default service when the job is attempted.
|
|
65
70
|
*/
|
|
66
|
-
host?:
|
|
71
|
+
host?:
|
|
72
|
+
string;
|
|
67
73
|
/**
|
|
68
74
|
* App instance. By default, the job is sent to an instance which is available when the job is attempted. Requests can only be sent to a specific instance if [manual scaling is used in
|
|
69
75
|
* App Engine Standard](https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?#scaling_types_and_instance_classes). App Engine Flex does not support instances. For
|
|
70
76
|
* more information, see [App Engine Standard request routing](https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed) and [App Engine Flex request
|
|
71
77
|
* routing](https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed).
|
|
72
78
|
*/
|
|
73
|
-
instance?:
|
|
79
|
+
instance?:
|
|
80
|
+
string;
|
|
74
81
|
/** App service. By default, the job is sent to the service which is the default service when the job is attempted. */
|
|
75
|
-
service?:
|
|
82
|
+
service?:
|
|
83
|
+
string;
|
|
76
84
|
/** App version. By default, the job is sent to the version which is the default version when the job is attempted. */
|
|
77
|
-
version?:
|
|
85
|
+
version?:
|
|
86
|
+
string;
|
|
78
87
|
}
|
|
79
88
|
// tslint:disable-next-line:no-empty-interface
|
|
80
89
|
interface Empty {
|
|
81
90
|
}
|
|
82
91
|
interface HttpTarget {
|
|
83
92
|
/** HTTP request body. A request body is allowed only if the HTTP method is POST, PUT, or PATCH. It is an error to set body on a job with an incompatible HttpMethod. */
|
|
84
|
-
body?:
|
|
93
|
+
body?:
|
|
94
|
+
string;
|
|
85
95
|
/**
|
|
86
96
|
* The user can specify HTTP request headers to send with the job's HTTP request. This map contains the header field names and values. Repeated headers are not supported, but a header
|
|
87
97
|
* value can contain commas. These headers represent a subset of the headers that will accompany the job's HTTP request. Some HTTP request headers will be ignored or replaced. A
|
|
@@ -90,29 +100,35 @@ declare namespace gapi.client {
|
|
|
90
100
|
* `X-CloudScheduler`: This header will be set to true. * `X-CloudScheduler-JobName`: This header will contain the job name. * `X-CloudScheduler-ScheduleTime`: For Cloud Scheduler jobs
|
|
91
101
|
* specified in the unix-cron format, this header will contain the job schedule time in RFC3339 UTC "Zulu" format. The total size of headers must be less than 80KB.
|
|
92
102
|
*/
|
|
93
|
-
headers?:
|
|
103
|
+
headers?:
|
|
104
|
+
{ [P in string]: string };
|
|
94
105
|
/** Which HTTP method to use for the request. */
|
|
95
|
-
httpMethod?:
|
|
106
|
+
httpMethod?:
|
|
107
|
+
string;
|
|
96
108
|
/**
|
|
97
109
|
* If specified, an [OAuth token](https://developers.google.com/identity/protocols/OAuth2) will be generated and attached as an `Authorization` header in the HTTP request. This type of
|
|
98
110
|
* authorization should generally only be used when calling Google APIs hosted on *.googleapis.com.
|
|
99
111
|
*/
|
|
100
|
-
oauthToken?:
|
|
112
|
+
oauthToken?:
|
|
113
|
+
OAuthToken;
|
|
101
114
|
/**
|
|
102
115
|
* If specified, an [OIDC](https://developers.google.com/identity/protocols/OpenIDConnect) token will be generated and attached as an `Authorization` header in the HTTP request. This
|
|
103
116
|
* type of authorization can be used for many scenarios, including calling Cloud Run, or endpoints where you intend to validate the token yourself.
|
|
104
117
|
*/
|
|
105
|
-
oidcToken?:
|
|
118
|
+
oidcToken?:
|
|
119
|
+
OidcToken;
|
|
106
120
|
/**
|
|
107
121
|
* Required. The full URI path that the request will be sent to. This string must begin with either "http://" or "https://". Some examples of valid values for uri are:
|
|
108
122
|
* `http://acme.com` and `https://acme.com/sales:8080`. Cloud Scheduler will encode some characters for safety and compatibility. The maximum allowed URL length is 2083 characters
|
|
109
123
|
* after encoding.
|
|
110
124
|
*/
|
|
111
|
-
uri?:
|
|
125
|
+
uri?:
|
|
126
|
+
string;
|
|
112
127
|
}
|
|
113
128
|
interface Job {
|
|
114
129
|
/** App Engine HTTP target. */
|
|
115
|
-
appEngineHttpTarget?:
|
|
130
|
+
appEngineHttpTarget?:
|
|
131
|
+
AppEngineHttpTarget;
|
|
116
132
|
/**
|
|
117
133
|
* The deadline for job attempts. If the request handler does not respond by this deadline then the request is cancelled and the attempt is marked as a `DEADLINE_EXCEEDED` failure. The
|
|
118
134
|
* failed attempt can be viewed in execution logs. Cloud Scheduler will retry the job according to the RetryConfig. The default and the allowed values depend on the type of target: *
|
|
@@ -121,18 +137,23 @@ declare namespace gapi.client {
|
|
|
121
137
|
* basic scaling, and 60 minutes for flex apps. If the request deadline is set, it must be in the interval [15 seconds, 24 hours 15 seconds]. * For Pub/Sub targets, this field is
|
|
122
138
|
* ignored.
|
|
123
139
|
*/
|
|
124
|
-
attemptDeadline?:
|
|
140
|
+
attemptDeadline?:
|
|
141
|
+
string;
|
|
125
142
|
/** Optionally caller-specified in CreateJob or UpdateJob. A human-readable description for the job. This string must not contain more than 500 characters. */
|
|
126
|
-
description?:
|
|
143
|
+
description?:
|
|
144
|
+
string;
|
|
127
145
|
/** HTTP target. */
|
|
128
|
-
httpTarget?:
|
|
146
|
+
httpTarget?:
|
|
147
|
+
HttpTarget;
|
|
129
148
|
/** Output only. The time the last job attempt started. */
|
|
130
|
-
lastAttemptTime?:
|
|
149
|
+
lastAttemptTime?:
|
|
150
|
+
string;
|
|
131
151
|
/**
|
|
132
152
|
* Immutable. This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job will be considered a legacy job. Note
|
|
133
153
|
* that App Engine Cron jobs have fewer features than Cloud Scheduler jobs, e.g., are only limited to App Engine targets.
|
|
134
154
|
*/
|
|
135
|
-
legacyAppEngineCron?:
|
|
155
|
+
legacyAppEngineCron?:
|
|
156
|
+
boolean;
|
|
136
157
|
/**
|
|
137
158
|
* Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID` can
|
|
138
159
|
* contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying
|
|
@@ -140,11 +161,14 @@ declare namespace gapi.client {
|
|
|
140
161
|
* available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters ([A-Za-z]),
|
|
141
162
|
* numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
|
|
142
163
|
*/
|
|
143
|
-
name?:
|
|
164
|
+
name?:
|
|
165
|
+
string;
|
|
144
166
|
/** Pub/Sub target. */
|
|
145
|
-
pubsubTarget?:
|
|
167
|
+
pubsubTarget?:
|
|
168
|
+
PubsubTarget;
|
|
146
169
|
/** Settings that determine the retry behavior. */
|
|
147
|
-
retryConfig?:
|
|
170
|
+
retryConfig?:
|
|
171
|
+
RetryConfig;
|
|
148
172
|
/**
|
|
149
173
|
* Required, except when used with UpdateJob. Describes the schedule on which the job will be executed. The schedule can be either of the following types: *
|
|
150
174
|
* [Crontab](https://en.wikipedia.org/wiki/Cron#Overview) * English-like [schedule](https://cloud.google.com/scheduler/docs/configuring/cron-job-schedules) As a general rule, execution
|
|
@@ -153,308 +177,410 @@ declare namespace gapi.client {
|
|
|
153
177
|
* if the previous execution has not ended when its scheduled time occurs. If retry_count > 0 and a job attempt fails, the job will be tried a total of retry_count times, with
|
|
154
178
|
* exponential backoff, until the next scheduled start time.
|
|
155
179
|
*/
|
|
156
|
-
schedule?:
|
|
180
|
+
schedule?:
|
|
181
|
+
string;
|
|
157
182
|
/** Output only. The next time the job is scheduled. Note that this may be a retry of a previously failed attempt or the next execution time according to the schedule. */
|
|
158
|
-
scheduleTime?:
|
|
183
|
+
scheduleTime?:
|
|
184
|
+
string;
|
|
159
185
|
/** Output only. State of the job. */
|
|
160
|
-
state?:
|
|
186
|
+
state?:
|
|
187
|
+
string;
|
|
161
188
|
/** Output only. The response from the target for the last attempted execution. */
|
|
162
|
-
status?:
|
|
189
|
+
status?:
|
|
190
|
+
Status;
|
|
163
191
|
/**
|
|
164
192
|
* Specifies the time zone to be used in interpreting schedule. The value of this field must be a time zone name from the [tz database](http://en.wikipedia.org/wiki/Tz_database). Note
|
|
165
193
|
* that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone
|
|
166
194
|
* is not specified, the default will be in UTC (also known as GMT).
|
|
167
195
|
*/
|
|
168
|
-
timeZone?:
|
|
196
|
+
timeZone?:
|
|
197
|
+
string;
|
|
169
198
|
/** Output only. The creation time of the job. */
|
|
170
|
-
userUpdateTime?:
|
|
199
|
+
userUpdateTime?:
|
|
200
|
+
string;
|
|
171
201
|
}
|
|
172
202
|
interface ListJobsResponse {
|
|
173
203
|
/** The list of jobs. */
|
|
174
|
-
jobs?:
|
|
204
|
+
jobs?:
|
|
205
|
+
Job[];
|
|
175
206
|
/**
|
|
176
207
|
* A token to retrieve next page of results. Pass this value in the page_token field in the subsequent call to ListJobs to retrieve the next page of results. If this is empty it
|
|
177
208
|
* indicates that there are no more results through which to paginate. The page token is valid for only 2 hours.
|
|
178
209
|
*/
|
|
179
|
-
nextPageToken?:
|
|
210
|
+
nextPageToken?:
|
|
211
|
+
string;
|
|
180
212
|
}
|
|
181
213
|
interface ListLocationsResponse {
|
|
182
214
|
/** A list of locations that matches the specified filter in the request. */
|
|
183
|
-
locations?:
|
|
215
|
+
locations?:
|
|
216
|
+
Location[];
|
|
184
217
|
/** The standard List next-page token. */
|
|
185
|
-
nextPageToken?:
|
|
218
|
+
nextPageToken?:
|
|
219
|
+
string;
|
|
186
220
|
}
|
|
187
221
|
interface Location {
|
|
188
222
|
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
189
|
-
displayName?:
|
|
223
|
+
displayName?:
|
|
224
|
+
string;
|
|
190
225
|
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
191
|
-
labels?:
|
|
226
|
+
labels?:
|
|
227
|
+
{ [P in string]: string };
|
|
192
228
|
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
193
|
-
locationId?:
|
|
229
|
+
locationId?:
|
|
230
|
+
string;
|
|
194
231
|
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
195
|
-
metadata?:
|
|
232
|
+
metadata?:
|
|
233
|
+
{ [P in string]: any };
|
|
196
234
|
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
197
|
-
name?:
|
|
235
|
+
name?:
|
|
236
|
+
string;
|
|
198
237
|
}
|
|
199
238
|
interface OAuthToken {
|
|
200
239
|
/** OAuth scope to be used for generating OAuth access token. If not specified, "https://www.googleapis.com/auth/cloud-platform" will be used. */
|
|
201
|
-
scope?:
|
|
240
|
+
scope?:
|
|
241
|
+
string;
|
|
202
242
|
/**
|
|
203
243
|
* [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OAuth token. The service account must be within the same project as the job.
|
|
204
244
|
* The caller must have iam.serviceAccounts.actAs permission for the service account.
|
|
205
245
|
*/
|
|
206
|
-
serviceAccountEmail?:
|
|
246
|
+
serviceAccountEmail?:
|
|
247
|
+
string;
|
|
207
248
|
}
|
|
208
249
|
interface OidcToken {
|
|
209
250
|
/** Audience to be used when generating OIDC token. If not specified, the URI specified in target will be used. */
|
|
210
|
-
audience?:
|
|
251
|
+
audience?:
|
|
252
|
+
string;
|
|
211
253
|
/**
|
|
212
254
|
* [Service account email](https://cloud.google.com/iam/docs/service-accounts) to be used for generating OIDC token. The service account must be within the same project as the job. The
|
|
213
255
|
* caller must have iam.serviceAccounts.actAs permission for the service account.
|
|
214
256
|
*/
|
|
215
|
-
serviceAccountEmail?:
|
|
257
|
+
serviceAccountEmail?:
|
|
258
|
+
string;
|
|
216
259
|
}
|
|
217
260
|
// tslint:disable-next-line:no-empty-interface
|
|
218
261
|
interface PauseJobRequest {
|
|
219
262
|
}
|
|
220
263
|
interface PubsubMessage {
|
|
221
264
|
/** Attributes for this message. If this field is empty, the message must contain non-empty data. This can be used to filter messages on the subscription. */
|
|
222
|
-
attributes?:
|
|
265
|
+
attributes?:
|
|
266
|
+
{ [P in string]: string };
|
|
223
267
|
/** The message data field. If this field is empty, the message must contain at least one attribute. */
|
|
224
|
-
data?:
|
|
268
|
+
data?:
|
|
269
|
+
string;
|
|
225
270
|
/**
|
|
226
271
|
* ID of this message, assigned by the server when the message is published. Guaranteed to be unique within the topic. This value may be read by a subscriber that receives a
|
|
227
272
|
* `PubsubMessage` via a `Pull` call or a push delivery. It must not be populated by the publisher in a `Publish` call.
|
|
228
273
|
*/
|
|
229
|
-
messageId?:
|
|
274
|
+
messageId?:
|
|
275
|
+
string;
|
|
230
276
|
/**
|
|
231
277
|
* If non-empty, identifies related messages for which publish order should be respected. If a `Subscription` has `enable_message_ordering` set to `true`, messages published with the
|
|
232
278
|
* same non-empty `ordering_key` value will be delivered to subscribers in the order in which they are received by the Pub/Sub system. All `PubsubMessage`s published in a given
|
|
233
279
|
* `PublishRequest` must specify the same `ordering_key` value. For more information, see [ordering messages](https://cloud.google.com/pubsub/docs/ordering).
|
|
234
280
|
*/
|
|
235
|
-
orderingKey?:
|
|
281
|
+
orderingKey?:
|
|
282
|
+
string;
|
|
236
283
|
/** The time at which the message was published, populated by the server when it receives the `Publish` call. It must not be populated by the publisher in a `Publish` call. */
|
|
237
|
-
publishTime?:
|
|
284
|
+
publishTime?:
|
|
285
|
+
string;
|
|
238
286
|
}
|
|
239
287
|
interface PubsubTarget {
|
|
240
288
|
/** Attributes for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */
|
|
241
|
-
attributes?:
|
|
289
|
+
attributes?:
|
|
290
|
+
{ [P in string]: string };
|
|
242
291
|
/** The message payload for PubsubMessage. Pubsub message must contain either non-empty data, or at least one attribute. */
|
|
243
|
-
data?:
|
|
292
|
+
data?:
|
|
293
|
+
string;
|
|
244
294
|
/**
|
|
245
295
|
* Required. The name of the Cloud Pub/Sub topic to which messages will be published when a job is delivered. The topic name must be in the same format as required by Pub/Sub's
|
|
246
296
|
* [PublishRequest.name](https://cloud.google.com/pubsub/docs/reference/rpc/google.pubsub.v1#publishrequest), for example `projects/PROJECT_ID/topics/TOPIC_ID`. The topic must be in
|
|
247
297
|
* the same project as the Cloud Scheduler job.
|
|
248
298
|
*/
|
|
249
|
-
topicName?:
|
|
299
|
+
topicName?:
|
|
300
|
+
string;
|
|
250
301
|
}
|
|
251
302
|
// tslint:disable-next-line:no-empty-interface
|
|
252
303
|
interface ResumeJobRequest {
|
|
253
304
|
}
|
|
254
305
|
interface RetryConfig {
|
|
255
306
|
/** The maximum amount of time to wait before retrying a job after it fails. The default value of this field is 1 hour. */
|
|
256
|
-
maxBackoffDuration?:
|
|
307
|
+
maxBackoffDuration?:
|
|
308
|
+
string;
|
|
257
309
|
/**
|
|
258
310
|
* The time between retries will double `max_doublings` times. A job's retry interval starts at min_backoff_duration, then doubles `max_doublings` times, then increases linearly, and
|
|
259
311
|
* finally retries at intervals of max_backoff_duration up to retry_count times. For example, if min_backoff_duration is 10s, max_backoff_duration is 300s, and `max_doublings` is 3,
|
|
260
|
-
* then the
|
|
312
|
+
* then the job will first be retried in 10s. The retry interval will double three times, and then increase linearly by 2^3 * 10s. Finally, the job will retry at intervals of
|
|
261
313
|
* max_backoff_duration until the job has been attempted retry_count times. Thus, the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, .... The default value of this
|
|
262
314
|
* field is 5.
|
|
263
315
|
*/
|
|
264
|
-
maxDoublings?:
|
|
316
|
+
maxDoublings?:
|
|
317
|
+
number;
|
|
265
318
|
/**
|
|
266
319
|
* The time limit for retrying a failed job, measured from time when an execution was first attempted. If specified with retry_count, the job will be retried until both limits are
|
|
267
320
|
* reached. The default value for max_retry_duration is zero, which means retry duration is unlimited.
|
|
268
321
|
*/
|
|
269
|
-
maxRetryDuration?:
|
|
322
|
+
maxRetryDuration?:
|
|
323
|
+
string;
|
|
270
324
|
/** The minimum amount of time to wait before retrying a job after it fails. The default value of this field is 5 seconds. */
|
|
271
|
-
minBackoffDuration?:
|
|
325
|
+
minBackoffDuration?:
|
|
326
|
+
string;
|
|
272
327
|
/**
|
|
273
328
|
* The number of attempts that the system will make to run a job using the exponential backoff procedure described by max_doublings. The default value of retry_count is zero. If
|
|
274
329
|
* retry_count is zero, a job attempt will *not* be retried if it fails. Instead the Cloud Scheduler system will wait for the next scheduled execution time. If retry_count is set to a
|
|
275
330
|
* non-zero number then Cloud Scheduler will retry failed attempts, using exponential backoff, retry_count times, or until the next scheduled execution time, whichever comes first.
|
|
276
331
|
* Values greater than 5 and negative values are not allowed.
|
|
277
332
|
*/
|
|
278
|
-
retryCount?:
|
|
333
|
+
retryCount?:
|
|
334
|
+
number;
|
|
279
335
|
}
|
|
280
336
|
interface RunJobRequest {
|
|
281
337
|
/**
|
|
282
338
|
* This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name will
|
|
283
339
|
* be forced to run instead.
|
|
284
340
|
*/
|
|
285
|
-
legacyAppEngineCron?:
|
|
341
|
+
legacyAppEngineCron?:
|
|
342
|
+
boolean;
|
|
286
343
|
}
|
|
287
344
|
interface Status {
|
|
288
345
|
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
289
|
-
code?:
|
|
346
|
+
code?:
|
|
347
|
+
number;
|
|
290
348
|
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
291
|
-
details?:
|
|
349
|
+
details?:
|
|
350
|
+
Array<{ [P in string]: any }>;
|
|
292
351
|
/**
|
|
293
352
|
* 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
|
|
294
353
|
* client.
|
|
295
354
|
*/
|
|
296
|
-
message?:
|
|
355
|
+
message?:
|
|
356
|
+
string;
|
|
297
357
|
}
|
|
298
358
|
interface JobsResource {
|
|
299
359
|
/** Creates a job. */
|
|
300
360
|
create(request: {
|
|
301
361
|
/** V1 error format. */
|
|
302
|
-
"$.xgafv"?:
|
|
362
|
+
"$.xgafv"?:
|
|
363
|
+
string;
|
|
303
364
|
/** OAuth access token. */
|
|
304
|
-
access_token?:
|
|
365
|
+
access_token?:
|
|
366
|
+
string;
|
|
305
367
|
/** Data format for response. */
|
|
306
|
-
alt?:
|
|
368
|
+
alt?:
|
|
369
|
+
string;
|
|
307
370
|
/** JSONP */
|
|
308
|
-
callback?:
|
|
371
|
+
callback?:
|
|
372
|
+
string;
|
|
309
373
|
/** Selector specifying which fields to include in a partial response. */
|
|
310
|
-
fields?:
|
|
374
|
+
fields?:
|
|
375
|
+
string;
|
|
311
376
|
/** 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. */
|
|
312
|
-
key?:
|
|
377
|
+
key?:
|
|
378
|
+
string;
|
|
313
379
|
/** OAuth 2.0 token for the current user. */
|
|
314
|
-
oauth_token?:
|
|
380
|
+
oauth_token?:
|
|
381
|
+
string;
|
|
315
382
|
/** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
|
|
316
|
-
parent:
|
|
383
|
+
parent:
|
|
384
|
+
string;
|
|
317
385
|
/** Returns response with indentations and line breaks. */
|
|
318
|
-
prettyPrint?:
|
|
386
|
+
prettyPrint?:
|
|
387
|
+
boolean;
|
|
319
388
|
/** 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. */
|
|
320
|
-
quotaUser?:
|
|
389
|
+
quotaUser?:
|
|
390
|
+
string;
|
|
321
391
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
322
|
-
upload_protocol?:
|
|
392
|
+
upload_protocol?:
|
|
393
|
+
string;
|
|
323
394
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
324
|
-
uploadType?:
|
|
395
|
+
uploadType?:
|
|
396
|
+
string;
|
|
325
397
|
/** Request body */
|
|
326
|
-
resource:
|
|
398
|
+
resource:
|
|
399
|
+
Job;
|
|
327
400
|
}): Request<Job>;
|
|
328
401
|
create(request: {
|
|
329
402
|
/** V1 error format. */
|
|
330
|
-
"$.xgafv"?:
|
|
403
|
+
"$.xgafv"?:
|
|
404
|
+
string;
|
|
331
405
|
/** OAuth access token. */
|
|
332
|
-
access_token?:
|
|
406
|
+
access_token?:
|
|
407
|
+
string;
|
|
333
408
|
/** Data format for response. */
|
|
334
|
-
alt?:
|
|
409
|
+
alt?:
|
|
410
|
+
string;
|
|
335
411
|
/** JSONP */
|
|
336
|
-
callback?:
|
|
412
|
+
callback?:
|
|
413
|
+
string;
|
|
337
414
|
/** Selector specifying which fields to include in a partial response. */
|
|
338
|
-
fields?:
|
|
415
|
+
fields?:
|
|
416
|
+
string;
|
|
339
417
|
/** 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. */
|
|
340
|
-
key?:
|
|
418
|
+
key?:
|
|
419
|
+
string;
|
|
341
420
|
/** OAuth 2.0 token for the current user. */
|
|
342
|
-
oauth_token?:
|
|
421
|
+
oauth_token?:
|
|
422
|
+
string;
|
|
343
423
|
/** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
|
|
344
|
-
parent:
|
|
424
|
+
parent:
|
|
425
|
+
string;
|
|
345
426
|
/** Returns response with indentations and line breaks. */
|
|
346
|
-
prettyPrint?:
|
|
427
|
+
prettyPrint?:
|
|
428
|
+
boolean;
|
|
347
429
|
/** 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. */
|
|
348
|
-
quotaUser?:
|
|
430
|
+
quotaUser?:
|
|
431
|
+
string;
|
|
349
432
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
350
|
-
upload_protocol?:
|
|
433
|
+
upload_protocol?:
|
|
434
|
+
string;
|
|
351
435
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
352
|
-
uploadType?:
|
|
436
|
+
uploadType?:
|
|
437
|
+
string;
|
|
353
438
|
},
|
|
354
439
|
body: Job): Request<Job>;
|
|
355
440
|
/** Deletes a job. */
|
|
356
441
|
delete(request?: {
|
|
357
442
|
/** V1 error format. */
|
|
358
|
-
"$.xgafv"?:
|
|
443
|
+
"$.xgafv"?:
|
|
444
|
+
string;
|
|
359
445
|
/** OAuth access token. */
|
|
360
|
-
access_token?:
|
|
446
|
+
access_token?:
|
|
447
|
+
string;
|
|
361
448
|
/** Data format for response. */
|
|
362
|
-
alt?:
|
|
449
|
+
alt?:
|
|
450
|
+
string;
|
|
363
451
|
/** JSONP */
|
|
364
|
-
callback?:
|
|
452
|
+
callback?:
|
|
453
|
+
string;
|
|
365
454
|
/** Selector specifying which fields to include in a partial response. */
|
|
366
|
-
fields?:
|
|
455
|
+
fields?:
|
|
456
|
+
string;
|
|
367
457
|
/** 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. */
|
|
368
|
-
key?:
|
|
458
|
+
key?:
|
|
459
|
+
string;
|
|
369
460
|
/**
|
|
370
461
|
* This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the job in the __cron queue with the corresponding name
|
|
371
462
|
* will be deleted instead.
|
|
372
463
|
*/
|
|
373
|
-
legacyAppEngineCron?:
|
|
464
|
+
legacyAppEngineCron?:
|
|
465
|
+
boolean;
|
|
374
466
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
375
|
-
name:
|
|
467
|
+
name:
|
|
468
|
+
string;
|
|
376
469
|
/** OAuth 2.0 token for the current user. */
|
|
377
|
-
oauth_token?:
|
|
470
|
+
oauth_token?:
|
|
471
|
+
string;
|
|
378
472
|
/** Returns response with indentations and line breaks. */
|
|
379
|
-
prettyPrint?:
|
|
473
|
+
prettyPrint?:
|
|
474
|
+
boolean;
|
|
380
475
|
/** 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. */
|
|
381
|
-
quotaUser?:
|
|
476
|
+
quotaUser?:
|
|
477
|
+
string;
|
|
382
478
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
383
|
-
upload_protocol?:
|
|
479
|
+
upload_protocol?:
|
|
480
|
+
string;
|
|
384
481
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
385
|
-
uploadType?:
|
|
482
|
+
uploadType?:
|
|
483
|
+
string;
|
|
386
484
|
}): Request<{}>;
|
|
387
485
|
/** Gets a job. */
|
|
388
486
|
get(request?: {
|
|
389
487
|
/** V1 error format. */
|
|
390
|
-
"$.xgafv"?:
|
|
488
|
+
"$.xgafv"?:
|
|
489
|
+
string;
|
|
391
490
|
/** OAuth access token. */
|
|
392
|
-
access_token?:
|
|
491
|
+
access_token?:
|
|
492
|
+
string;
|
|
393
493
|
/** Data format for response. */
|
|
394
|
-
alt?:
|
|
494
|
+
alt?:
|
|
495
|
+
string;
|
|
395
496
|
/** JSONP */
|
|
396
|
-
callback?:
|
|
497
|
+
callback?:
|
|
498
|
+
string;
|
|
397
499
|
/** Selector specifying which fields to include in a partial response. */
|
|
398
|
-
fields?:
|
|
500
|
+
fields?:
|
|
501
|
+
string;
|
|
399
502
|
/** 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. */
|
|
400
|
-
key?:
|
|
503
|
+
key?:
|
|
504
|
+
string;
|
|
401
505
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
402
|
-
name:
|
|
506
|
+
name:
|
|
507
|
+
string;
|
|
403
508
|
/** OAuth 2.0 token for the current user. */
|
|
404
|
-
oauth_token?:
|
|
509
|
+
oauth_token?:
|
|
510
|
+
string;
|
|
405
511
|
/** Returns response with indentations and line breaks. */
|
|
406
|
-
prettyPrint?:
|
|
512
|
+
prettyPrint?:
|
|
513
|
+
boolean;
|
|
407
514
|
/** 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. */
|
|
408
|
-
quotaUser?:
|
|
515
|
+
quotaUser?:
|
|
516
|
+
string;
|
|
409
517
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
410
|
-
upload_protocol?:
|
|
518
|
+
upload_protocol?:
|
|
519
|
+
string;
|
|
411
520
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
412
|
-
uploadType?:
|
|
521
|
+
uploadType?:
|
|
522
|
+
string;
|
|
413
523
|
}): Request<Job>;
|
|
414
524
|
/** Lists jobs. */
|
|
415
525
|
list(request?: {
|
|
416
526
|
/** V1 error format. */
|
|
417
|
-
"$.xgafv"?:
|
|
527
|
+
"$.xgafv"?:
|
|
528
|
+
string;
|
|
418
529
|
/** OAuth access token. */
|
|
419
|
-
access_token?:
|
|
530
|
+
access_token?:
|
|
531
|
+
string;
|
|
420
532
|
/** Data format for response. */
|
|
421
|
-
alt?:
|
|
533
|
+
alt?:
|
|
534
|
+
string;
|
|
422
535
|
/** JSONP */
|
|
423
|
-
callback?:
|
|
536
|
+
callback?:
|
|
537
|
+
string;
|
|
424
538
|
/** Selector specifying which fields to include in a partial response. */
|
|
425
|
-
fields?:
|
|
539
|
+
fields?:
|
|
540
|
+
string;
|
|
426
541
|
/**
|
|
427
542
|
* `filter` can be used to specify a subset of jobs. If `filter` equals `target_config="HttpConfig"`, then the http target jobs are retrieved. If `filter` equals
|
|
428
543
|
* `target_config="PubSubConfig"`, then the Pub/Sub target jobs are retrieved. If `filter` equals `labels.foo=value1 labels.foo=value2` then only jobs which are labeled with
|
|
429
544
|
* foo=value1 AND foo=value2 will be returned.
|
|
430
545
|
*/
|
|
431
|
-
filter?:
|
|
546
|
+
filter?:
|
|
547
|
+
string;
|
|
432
548
|
/** 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. */
|
|
433
|
-
key?:
|
|
549
|
+
key?:
|
|
550
|
+
string;
|
|
434
551
|
/** This field is used to manage the legacy App Engine Cron jobs using the Cloud Scheduler API. If the field is set to true, the jobs in the __cron queue will be listed instead. */
|
|
435
|
-
legacyAppEngineCron?:
|
|
552
|
+
legacyAppEngineCron?:
|
|
553
|
+
boolean;
|
|
436
554
|
/** OAuth 2.0 token for the current user. */
|
|
437
|
-
oauth_token?:
|
|
555
|
+
oauth_token?:
|
|
556
|
+
string;
|
|
438
557
|
/**
|
|
439
558
|
* Requested page size. The maximum page size is 500. If unspecified, the page size will be the maximum. Fewer jobs than requested might be returned, even if more jobs exist; use
|
|
440
559
|
* next_page_token to determine if more jobs exist.
|
|
441
560
|
*/
|
|
442
|
-
pageSize?:
|
|
561
|
+
pageSize?:
|
|
562
|
+
number;
|
|
443
563
|
/**
|
|
444
564
|
* A token identifying a page of results the server will return. To request the first page results, page_token must be empty. To request the next page of results, page_token must
|
|
445
565
|
* be the value of next_page_token returned from the previous call to ListJobs. It is an error to switch the value of filter or order_by while iterating through pages.
|
|
446
566
|
*/
|
|
447
|
-
pageToken?:
|
|
567
|
+
pageToken?:
|
|
568
|
+
string;
|
|
448
569
|
/** Required. The location name. For example: `projects/PROJECT_ID/locations/LOCATION_ID`. */
|
|
449
|
-
parent:
|
|
570
|
+
parent:
|
|
571
|
+
string;
|
|
450
572
|
/** Returns response with indentations and line breaks. */
|
|
451
|
-
prettyPrint?:
|
|
573
|
+
prettyPrint?:
|
|
574
|
+
boolean;
|
|
452
575
|
/** 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. */
|
|
453
|
-
quotaUser?:
|
|
576
|
+
quotaUser?:
|
|
577
|
+
string;
|
|
454
578
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
455
|
-
upload_protocol?:
|
|
579
|
+
upload_protocol?:
|
|
580
|
+
string;
|
|
456
581
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
457
|
-
uploadType?:
|
|
582
|
+
uploadType?:
|
|
583
|
+
string;
|
|
458
584
|
}): Request<ListJobsResponse>;
|
|
459
585
|
/**
|
|
460
586
|
* Updates a job. If successful, the updated Job is returned. If the job does not exist, `NOT_FOUND` is returned. If UpdateJob does not successfully return, it is possible for the job
|
|
@@ -462,17 +588,23 @@ declare namespace gapi.client {
|
|
|
462
588
|
*/
|
|
463
589
|
patch(request: {
|
|
464
590
|
/** V1 error format. */
|
|
465
|
-
"$.xgafv"?:
|
|
591
|
+
"$.xgafv"?:
|
|
592
|
+
string;
|
|
466
593
|
/** OAuth access token. */
|
|
467
|
-
access_token?:
|
|
594
|
+
access_token?:
|
|
595
|
+
string;
|
|
468
596
|
/** Data format for response. */
|
|
469
|
-
alt?:
|
|
597
|
+
alt?:
|
|
598
|
+
string;
|
|
470
599
|
/** JSONP */
|
|
471
|
-
callback?:
|
|
600
|
+
callback?:
|
|
601
|
+
string;
|
|
472
602
|
/** Selector specifying which fields to include in a partial response. */
|
|
473
|
-
fields?:
|
|
603
|
+
fields?:
|
|
604
|
+
string;
|
|
474
605
|
/** 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. */
|
|
475
|
-
key?:
|
|
606
|
+
key?:
|
|
607
|
+
string;
|
|
476
608
|
/**
|
|
477
609
|
* Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID`
|
|
478
610
|
* can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying
|
|
@@ -480,35 +612,49 @@ declare namespace gapi.client {
|
|
|
480
612
|
* available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters
|
|
481
613
|
* ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
|
|
482
614
|
*/
|
|
483
|
-
name:
|
|
615
|
+
name:
|
|
616
|
+
string;
|
|
484
617
|
/** OAuth 2.0 token for the current user. */
|
|
485
|
-
oauth_token?:
|
|
618
|
+
oauth_token?:
|
|
619
|
+
string;
|
|
486
620
|
/** Returns response with indentations and line breaks. */
|
|
487
|
-
prettyPrint?:
|
|
621
|
+
prettyPrint?:
|
|
622
|
+
boolean;
|
|
488
623
|
/** 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. */
|
|
489
|
-
quotaUser?:
|
|
624
|
+
quotaUser?:
|
|
625
|
+
string;
|
|
490
626
|
/** A mask used to specify which fields of the job are being updated. */
|
|
491
|
-
updateMask?:
|
|
627
|
+
updateMask?:
|
|
628
|
+
string;
|
|
492
629
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
493
|
-
upload_protocol?:
|
|
630
|
+
upload_protocol?:
|
|
631
|
+
string;
|
|
494
632
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
495
|
-
uploadType?:
|
|
633
|
+
uploadType?:
|
|
634
|
+
string;
|
|
496
635
|
/** Request body */
|
|
497
|
-
resource:
|
|
636
|
+
resource:
|
|
637
|
+
Job;
|
|
498
638
|
}): Request<Job>;
|
|
499
639
|
patch(request: {
|
|
500
640
|
/** V1 error format. */
|
|
501
|
-
"$.xgafv"?:
|
|
641
|
+
"$.xgafv"?:
|
|
642
|
+
string;
|
|
502
643
|
/** OAuth access token. */
|
|
503
|
-
access_token?:
|
|
644
|
+
access_token?:
|
|
645
|
+
string;
|
|
504
646
|
/** Data format for response. */
|
|
505
|
-
alt?:
|
|
647
|
+
alt?:
|
|
648
|
+
string;
|
|
506
649
|
/** JSONP */
|
|
507
|
-
callback?:
|
|
650
|
+
callback?:
|
|
651
|
+
string;
|
|
508
652
|
/** Selector specifying which fields to include in a partial response. */
|
|
509
|
-
fields?:
|
|
653
|
+
fields?:
|
|
654
|
+
string;
|
|
510
655
|
/** 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. */
|
|
511
|
-
key?:
|
|
656
|
+
key?:
|
|
657
|
+
string;
|
|
512
658
|
/**
|
|
513
659
|
* Optionally caller-specified in CreateJob, after which it becomes output only. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. * `PROJECT_ID`
|
|
514
660
|
* can contain letters ([A-Za-z]), numbers ([0-9]), hyphens (-), colons (:), or periods (.). For more information, see [Identifying
|
|
@@ -516,19 +662,26 @@ declare namespace gapi.client {
|
|
|
516
662
|
* available locations can be obtained by calling ListLocations. For more information, see https://cloud.google.com/about/locations/. * `JOB_ID` can contain only letters
|
|
517
663
|
* ([A-Za-z]), numbers ([0-9]), hyphens (-), or underscores (_). The maximum length is 500 characters.
|
|
518
664
|
*/
|
|
519
|
-
name:
|
|
665
|
+
name:
|
|
666
|
+
string;
|
|
520
667
|
/** OAuth 2.0 token for the current user. */
|
|
521
|
-
oauth_token?:
|
|
668
|
+
oauth_token?:
|
|
669
|
+
string;
|
|
522
670
|
/** Returns response with indentations and line breaks. */
|
|
523
|
-
prettyPrint?:
|
|
671
|
+
prettyPrint?:
|
|
672
|
+
boolean;
|
|
524
673
|
/** 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. */
|
|
525
|
-
quotaUser?:
|
|
674
|
+
quotaUser?:
|
|
675
|
+
string;
|
|
526
676
|
/** A mask used to specify which fields of the job are being updated. */
|
|
527
|
-
updateMask?:
|
|
677
|
+
updateMask?:
|
|
678
|
+
string;
|
|
528
679
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
529
|
-
upload_protocol?:
|
|
680
|
+
upload_protocol?:
|
|
681
|
+
string;
|
|
530
682
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
531
|
-
uploadType?:
|
|
683
|
+
uploadType?:
|
|
684
|
+
string;
|
|
532
685
|
},
|
|
533
686
|
body: Job): Request<Job>;
|
|
534
687
|
/**
|
|
@@ -537,57 +690,82 @@ declare namespace gapi.client {
|
|
|
537
690
|
*/
|
|
538
691
|
pause(request: {
|
|
539
692
|
/** V1 error format. */
|
|
540
|
-
"$.xgafv"?:
|
|
693
|
+
"$.xgafv"?:
|
|
694
|
+
string;
|
|
541
695
|
/** OAuth access token. */
|
|
542
|
-
access_token?:
|
|
696
|
+
access_token?:
|
|
697
|
+
string;
|
|
543
698
|
/** Data format for response. */
|
|
544
|
-
alt?:
|
|
699
|
+
alt?:
|
|
700
|
+
string;
|
|
545
701
|
/** JSONP */
|
|
546
|
-
callback?:
|
|
702
|
+
callback?:
|
|
703
|
+
string;
|
|
547
704
|
/** Selector specifying which fields to include in a partial response. */
|
|
548
|
-
fields?:
|
|
705
|
+
fields?:
|
|
706
|
+
string;
|
|
549
707
|
/** 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. */
|
|
550
|
-
key?:
|
|
708
|
+
key?:
|
|
709
|
+
string;
|
|
551
710
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
552
|
-
name:
|
|
711
|
+
name:
|
|
712
|
+
string;
|
|
553
713
|
/** OAuth 2.0 token for the current user. */
|
|
554
|
-
oauth_token?:
|
|
714
|
+
oauth_token?:
|
|
715
|
+
string;
|
|
555
716
|
/** Returns response with indentations and line breaks. */
|
|
556
|
-
prettyPrint?:
|
|
717
|
+
prettyPrint?:
|
|
718
|
+
boolean;
|
|
557
719
|
/** 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. */
|
|
558
|
-
quotaUser?:
|
|
720
|
+
quotaUser?:
|
|
721
|
+
string;
|
|
559
722
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
560
|
-
upload_protocol?:
|
|
723
|
+
upload_protocol?:
|
|
724
|
+
string;
|
|
561
725
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
562
|
-
uploadType?:
|
|
726
|
+
uploadType?:
|
|
727
|
+
string;
|
|
563
728
|
/** Request body */
|
|
564
|
-
resource:
|
|
729
|
+
resource:
|
|
730
|
+
PauseJobRequest;
|
|
565
731
|
}): Request<Job>;
|
|
566
732
|
pause(request: {
|
|
567
733
|
/** V1 error format. */
|
|
568
|
-
"$.xgafv"?:
|
|
734
|
+
"$.xgafv"?:
|
|
735
|
+
string;
|
|
569
736
|
/** OAuth access token. */
|
|
570
|
-
access_token?:
|
|
737
|
+
access_token?:
|
|
738
|
+
string;
|
|
571
739
|
/** Data format for response. */
|
|
572
|
-
alt?:
|
|
740
|
+
alt?:
|
|
741
|
+
string;
|
|
573
742
|
/** JSONP */
|
|
574
|
-
callback?:
|
|
743
|
+
callback?:
|
|
744
|
+
string;
|
|
575
745
|
/** Selector specifying which fields to include in a partial response. */
|
|
576
|
-
fields?:
|
|
746
|
+
fields?:
|
|
747
|
+
string;
|
|
577
748
|
/** 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. */
|
|
578
|
-
key?:
|
|
749
|
+
key?:
|
|
750
|
+
string;
|
|
579
751
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
580
|
-
name:
|
|
752
|
+
name:
|
|
753
|
+
string;
|
|
581
754
|
/** OAuth 2.0 token for the current user. */
|
|
582
|
-
oauth_token?:
|
|
755
|
+
oauth_token?:
|
|
756
|
+
string;
|
|
583
757
|
/** Returns response with indentations and line breaks. */
|
|
584
|
-
prettyPrint?:
|
|
758
|
+
prettyPrint?:
|
|
759
|
+
boolean;
|
|
585
760
|
/** 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. */
|
|
586
|
-
quotaUser?:
|
|
761
|
+
quotaUser?:
|
|
762
|
+
string;
|
|
587
763
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
588
|
-
upload_protocol?:
|
|
764
|
+
upload_protocol?:
|
|
765
|
+
string;
|
|
589
766
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
590
|
-
uploadType?:
|
|
767
|
+
uploadType?:
|
|
768
|
+
string;
|
|
591
769
|
},
|
|
592
770
|
body: PauseJobRequest): Request<Job>;
|
|
593
771
|
/**
|
|
@@ -596,113 +774,163 @@ declare namespace gapi.client {
|
|
|
596
774
|
*/
|
|
597
775
|
resume(request: {
|
|
598
776
|
/** V1 error format. */
|
|
599
|
-
"$.xgafv"?:
|
|
777
|
+
"$.xgafv"?:
|
|
778
|
+
string;
|
|
600
779
|
/** OAuth access token. */
|
|
601
|
-
access_token?:
|
|
780
|
+
access_token?:
|
|
781
|
+
string;
|
|
602
782
|
/** Data format for response. */
|
|
603
|
-
alt?:
|
|
783
|
+
alt?:
|
|
784
|
+
string;
|
|
604
785
|
/** JSONP */
|
|
605
|
-
callback?:
|
|
786
|
+
callback?:
|
|
787
|
+
string;
|
|
606
788
|
/** Selector specifying which fields to include in a partial response. */
|
|
607
|
-
fields?:
|
|
789
|
+
fields?:
|
|
790
|
+
string;
|
|
608
791
|
/** 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. */
|
|
609
|
-
key?:
|
|
792
|
+
key?:
|
|
793
|
+
string;
|
|
610
794
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
611
|
-
name:
|
|
795
|
+
name:
|
|
796
|
+
string;
|
|
612
797
|
/** OAuth 2.0 token for the current user. */
|
|
613
|
-
oauth_token?:
|
|
798
|
+
oauth_token?:
|
|
799
|
+
string;
|
|
614
800
|
/** Returns response with indentations and line breaks. */
|
|
615
|
-
prettyPrint?:
|
|
801
|
+
prettyPrint?:
|
|
802
|
+
boolean;
|
|
616
803
|
/** 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. */
|
|
617
|
-
quotaUser?:
|
|
804
|
+
quotaUser?:
|
|
805
|
+
string;
|
|
618
806
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
619
|
-
upload_protocol?:
|
|
807
|
+
upload_protocol?:
|
|
808
|
+
string;
|
|
620
809
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
621
|
-
uploadType?:
|
|
810
|
+
uploadType?:
|
|
811
|
+
string;
|
|
622
812
|
/** Request body */
|
|
623
|
-
resource:
|
|
813
|
+
resource:
|
|
814
|
+
ResumeJobRequest;
|
|
624
815
|
}): Request<Job>;
|
|
625
816
|
resume(request: {
|
|
626
817
|
/** V1 error format. */
|
|
627
|
-
"$.xgafv"?:
|
|
818
|
+
"$.xgafv"?:
|
|
819
|
+
string;
|
|
628
820
|
/** OAuth access token. */
|
|
629
|
-
access_token?:
|
|
821
|
+
access_token?:
|
|
822
|
+
string;
|
|
630
823
|
/** Data format for response. */
|
|
631
|
-
alt?:
|
|
824
|
+
alt?:
|
|
825
|
+
string;
|
|
632
826
|
/** JSONP */
|
|
633
|
-
callback?:
|
|
827
|
+
callback?:
|
|
828
|
+
string;
|
|
634
829
|
/** Selector specifying which fields to include in a partial response. */
|
|
635
|
-
fields?:
|
|
830
|
+
fields?:
|
|
831
|
+
string;
|
|
636
832
|
/** 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. */
|
|
637
|
-
key?:
|
|
833
|
+
key?:
|
|
834
|
+
string;
|
|
638
835
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
639
|
-
name:
|
|
836
|
+
name:
|
|
837
|
+
string;
|
|
640
838
|
/** OAuth 2.0 token for the current user. */
|
|
641
|
-
oauth_token?:
|
|
839
|
+
oauth_token?:
|
|
840
|
+
string;
|
|
642
841
|
/** Returns response with indentations and line breaks. */
|
|
643
|
-
prettyPrint?:
|
|
842
|
+
prettyPrint?:
|
|
843
|
+
boolean;
|
|
644
844
|
/** 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. */
|
|
645
|
-
quotaUser?:
|
|
845
|
+
quotaUser?:
|
|
846
|
+
string;
|
|
646
847
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
647
|
-
upload_protocol?:
|
|
848
|
+
upload_protocol?:
|
|
849
|
+
string;
|
|
648
850
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
649
|
-
uploadType?:
|
|
851
|
+
uploadType?:
|
|
852
|
+
string;
|
|
650
853
|
},
|
|
651
854
|
body: ResumeJobRequest): Request<Job>;
|
|
652
855
|
/** Forces a job to run now. When this method is called, Cloud Scheduler will dispatch the job, even if the job is already running. */
|
|
653
856
|
run(request: {
|
|
654
857
|
/** V1 error format. */
|
|
655
|
-
"$.xgafv"?:
|
|
858
|
+
"$.xgafv"?:
|
|
859
|
+
string;
|
|
656
860
|
/** OAuth access token. */
|
|
657
|
-
access_token?:
|
|
861
|
+
access_token?:
|
|
862
|
+
string;
|
|
658
863
|
/** Data format for response. */
|
|
659
|
-
alt?:
|
|
864
|
+
alt?:
|
|
865
|
+
string;
|
|
660
866
|
/** JSONP */
|
|
661
|
-
callback?:
|
|
867
|
+
callback?:
|
|
868
|
+
string;
|
|
662
869
|
/** Selector specifying which fields to include in a partial response. */
|
|
663
|
-
fields?:
|
|
870
|
+
fields?:
|
|
871
|
+
string;
|
|
664
872
|
/** 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. */
|
|
665
|
-
key?:
|
|
873
|
+
key?:
|
|
874
|
+
string;
|
|
666
875
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
667
|
-
name:
|
|
876
|
+
name:
|
|
877
|
+
string;
|
|
668
878
|
/** OAuth 2.0 token for the current user. */
|
|
669
|
-
oauth_token?:
|
|
879
|
+
oauth_token?:
|
|
880
|
+
string;
|
|
670
881
|
/** Returns response with indentations and line breaks. */
|
|
671
|
-
prettyPrint?:
|
|
882
|
+
prettyPrint?:
|
|
883
|
+
boolean;
|
|
672
884
|
/** 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. */
|
|
673
|
-
quotaUser?:
|
|
885
|
+
quotaUser?:
|
|
886
|
+
string;
|
|
674
887
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
675
|
-
upload_protocol?:
|
|
888
|
+
upload_protocol?:
|
|
889
|
+
string;
|
|
676
890
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
677
|
-
uploadType?:
|
|
891
|
+
uploadType?:
|
|
892
|
+
string;
|
|
678
893
|
/** Request body */
|
|
679
|
-
resource:
|
|
894
|
+
resource:
|
|
895
|
+
RunJobRequest;
|
|
680
896
|
}): Request<Job>;
|
|
681
897
|
run(request: {
|
|
682
898
|
/** V1 error format. */
|
|
683
|
-
"$.xgafv"?:
|
|
899
|
+
"$.xgafv"?:
|
|
900
|
+
string;
|
|
684
901
|
/** OAuth access token. */
|
|
685
|
-
access_token?:
|
|
902
|
+
access_token?:
|
|
903
|
+
string;
|
|
686
904
|
/** Data format for response. */
|
|
687
|
-
alt?:
|
|
905
|
+
alt?:
|
|
906
|
+
string;
|
|
688
907
|
/** JSONP */
|
|
689
|
-
callback?:
|
|
908
|
+
callback?:
|
|
909
|
+
string;
|
|
690
910
|
/** Selector specifying which fields to include in a partial response. */
|
|
691
|
-
fields?:
|
|
911
|
+
fields?:
|
|
912
|
+
string;
|
|
692
913
|
/** 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. */
|
|
693
|
-
key?:
|
|
914
|
+
key?:
|
|
915
|
+
string;
|
|
694
916
|
/** Required. The job name. For example: `projects/PROJECT_ID/locations/LOCATION_ID/jobs/JOB_ID`. */
|
|
695
|
-
name:
|
|
917
|
+
name:
|
|
918
|
+
string;
|
|
696
919
|
/** OAuth 2.0 token for the current user. */
|
|
697
|
-
oauth_token?:
|
|
920
|
+
oauth_token?:
|
|
921
|
+
string;
|
|
698
922
|
/** Returns response with indentations and line breaks. */
|
|
699
|
-
prettyPrint?:
|
|
923
|
+
prettyPrint?:
|
|
924
|
+
boolean;
|
|
700
925
|
/** 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. */
|
|
701
|
-
quotaUser?:
|
|
926
|
+
quotaUser?:
|
|
927
|
+
string;
|
|
702
928
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
703
|
-
upload_protocol?:
|
|
929
|
+
upload_protocol?:
|
|
930
|
+
string;
|
|
704
931
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
705
|
-
uploadType?:
|
|
932
|
+
uploadType?:
|
|
933
|
+
string;
|
|
706
934
|
},
|
|
707
935
|
body: RunJobRequest): Request<Job>;
|
|
708
936
|
}
|
|
@@ -710,70 +938,99 @@ declare namespace gapi.client {
|
|
|
710
938
|
/** Gets information about a location. */
|
|
711
939
|
get(request?: {
|
|
712
940
|
/** V1 error format. */
|
|
713
|
-
"$.xgafv"?:
|
|
941
|
+
"$.xgafv"?:
|
|
942
|
+
string;
|
|
714
943
|
/** OAuth access token. */
|
|
715
|
-
access_token?:
|
|
944
|
+
access_token?:
|
|
945
|
+
string;
|
|
716
946
|
/** Data format for response. */
|
|
717
|
-
alt?:
|
|
947
|
+
alt?:
|
|
948
|
+
string;
|
|
718
949
|
/** JSONP */
|
|
719
|
-
callback?:
|
|
950
|
+
callback?:
|
|
951
|
+
string;
|
|
720
952
|
/** Selector specifying which fields to include in a partial response. */
|
|
721
|
-
fields?:
|
|
953
|
+
fields?:
|
|
954
|
+
string;
|
|
722
955
|
/** 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. */
|
|
723
|
-
key?:
|
|
956
|
+
key?:
|
|
957
|
+
string;
|
|
724
958
|
/** Resource name for the location. */
|
|
725
|
-
name:
|
|
959
|
+
name:
|
|
960
|
+
string;
|
|
726
961
|
/** OAuth 2.0 token for the current user. */
|
|
727
|
-
oauth_token?:
|
|
962
|
+
oauth_token?:
|
|
963
|
+
string;
|
|
728
964
|
/** Returns response with indentations and line breaks. */
|
|
729
|
-
prettyPrint?:
|
|
965
|
+
prettyPrint?:
|
|
966
|
+
boolean;
|
|
730
967
|
/** 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. */
|
|
731
|
-
quotaUser?:
|
|
968
|
+
quotaUser?:
|
|
969
|
+
string;
|
|
732
970
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
733
|
-
upload_protocol?:
|
|
971
|
+
upload_protocol?:
|
|
972
|
+
string;
|
|
734
973
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
735
|
-
uploadType?:
|
|
974
|
+
uploadType?:
|
|
975
|
+
string;
|
|
736
976
|
}): Request<Location>;
|
|
737
977
|
/** Lists information about the supported locations for this service. */
|
|
738
978
|
list(request?: {
|
|
739
979
|
/** V1 error format. */
|
|
740
|
-
"$.xgafv"?:
|
|
980
|
+
"$.xgafv"?:
|
|
981
|
+
string;
|
|
741
982
|
/** OAuth access token. */
|
|
742
|
-
access_token?:
|
|
983
|
+
access_token?:
|
|
984
|
+
string;
|
|
743
985
|
/** Data format for response. */
|
|
744
|
-
alt?:
|
|
986
|
+
alt?:
|
|
987
|
+
string;
|
|
745
988
|
/** JSONP */
|
|
746
|
-
callback?:
|
|
989
|
+
callback?:
|
|
990
|
+
string;
|
|
747
991
|
/** Selector specifying which fields to include in a partial response. */
|
|
748
|
-
fields?:
|
|
992
|
+
fields?:
|
|
993
|
+
string;
|
|
749
994
|
/**
|
|
750
995
|
* 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
|
|
751
996
|
* [AIP-160](https://google.aip.dev/160).
|
|
752
997
|
*/
|
|
753
|
-
filter?:
|
|
998
|
+
filter?:
|
|
999
|
+
string;
|
|
754
1000
|
/** 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. */
|
|
755
|
-
key?:
|
|
1001
|
+
key?:
|
|
1002
|
+
string;
|
|
756
1003
|
/** The resource that owns the locations collection, if applicable. */
|
|
757
|
-
name:
|
|
1004
|
+
name:
|
|
1005
|
+
string;
|
|
758
1006
|
/** OAuth 2.0 token for the current user. */
|
|
759
|
-
oauth_token?:
|
|
1007
|
+
oauth_token?:
|
|
1008
|
+
string;
|
|
760
1009
|
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
761
|
-
pageSize?:
|
|
1010
|
+
pageSize?:
|
|
1011
|
+
number;
|
|
762
1012
|
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
763
|
-
pageToken?:
|
|
1013
|
+
pageToken?:
|
|
1014
|
+
string;
|
|
764
1015
|
/** Returns response with indentations and line breaks. */
|
|
765
|
-
prettyPrint?:
|
|
1016
|
+
prettyPrint?:
|
|
1017
|
+
boolean;
|
|
766
1018
|
/** 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. */
|
|
767
|
-
quotaUser?:
|
|
1019
|
+
quotaUser?:
|
|
1020
|
+
string;
|
|
768
1021
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
769
|
-
upload_protocol?:
|
|
1022
|
+
upload_protocol?:
|
|
1023
|
+
string;
|
|
770
1024
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
771
|
-
uploadType?:
|
|
1025
|
+
uploadType?:
|
|
1026
|
+
string;
|
|
772
1027
|
}): Request<ListLocationsResponse>;
|
|
773
|
-
jobs:
|
|
1028
|
+
jobs:
|
|
1029
|
+
JobsResource;
|
|
774
1030
|
}
|
|
775
1031
|
interface ProjectsResource {
|
|
776
|
-
locations:
|
|
1032
|
+
locations:
|
|
1033
|
+
LocationsResource;
|
|
777
1034
|
}
|
|
778
1035
|
|
|
779
1036
|
const projects: ProjectsResource;
|
package/package.json
CHANGED
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:
|
|
6
|
+
// Revision: 20230421
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|