@maxim_mazurok/gapi.client.apim-v1alpha 0.0.20240605
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 +995 -0
- package/package.json +20 -0
- package/readme.md +73 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,995 @@
|
|
|
1
|
+
/* Type definitions for non-npm package API Management API v1alpha 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/apigee/
|
|
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://apim.googleapis.com/$discovery/rest?version=v1alpha
|
|
12
|
+
// Revision: 20240605
|
|
13
|
+
|
|
14
|
+
/// <reference types="gapi.client" />
|
|
15
|
+
|
|
16
|
+
declare namespace gapi.client {
|
|
17
|
+
/** Load API Management API v1alpha */
|
|
18
|
+
function load(
|
|
19
|
+
urlOrObject: 'https://apim.googleapis.com/$discovery/rest?version=v1alpha'
|
|
20
|
+
): Promise<void>;
|
|
21
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
22
|
+
function load(name: 'apim', version: 'v1alpha'): Promise<void>;
|
|
23
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
24
|
+
function load(name: 'apim', version: 'v1alpha', callback: () => any): void;
|
|
25
|
+
|
|
26
|
+
namespace apim {
|
|
27
|
+
interface ApiObservation {
|
|
28
|
+
/** The number of observed API Operations. */
|
|
29
|
+
apiOperationCount?: string;
|
|
30
|
+
/** Create time stamp */
|
|
31
|
+
createTime?: string;
|
|
32
|
+
/** The hostname of requests processed for this Observation. */
|
|
33
|
+
hostname?: string;
|
|
34
|
+
/** Last event detected time stamp */
|
|
35
|
+
lastEventDetectedTime?: string;
|
|
36
|
+
/** Identifier. Name of resource */
|
|
37
|
+
name?: string;
|
|
38
|
+
/** The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`. */
|
|
39
|
+
serverIps?: string[];
|
|
40
|
+
/** Location of the Observation Source, for example "us-central1" or "europe-west1." */
|
|
41
|
+
sourceLocations?: string[];
|
|
42
|
+
/** Style of ApiObservation */
|
|
43
|
+
style?: string;
|
|
44
|
+
/** User-defined tags to organize and sort */
|
|
45
|
+
tags?: string[];
|
|
46
|
+
/** Update time stamp */
|
|
47
|
+
updateTime?: string;
|
|
48
|
+
}
|
|
49
|
+
interface ApiOperation {
|
|
50
|
+
/** The number of occurrences of this API Operation. */
|
|
51
|
+
count?: string;
|
|
52
|
+
/** First seen time stamp */
|
|
53
|
+
firstSeenTime?: string;
|
|
54
|
+
/** An HTTP Operation. */
|
|
55
|
+
httpOperation?: HttpOperation;
|
|
56
|
+
/** Last seen time stamp */
|
|
57
|
+
lastSeenTime?: string;
|
|
58
|
+
/** Identifier. Name of resource */
|
|
59
|
+
name?: string;
|
|
60
|
+
}
|
|
61
|
+
interface CancelOperationRequest {}
|
|
62
|
+
interface DisableObservationJobRequest {}
|
|
63
|
+
interface Empty {}
|
|
64
|
+
interface EnableObservationJobRequest {}
|
|
65
|
+
interface GclbObservationSource {
|
|
66
|
+
/** Required. The VPC networks where traffic will be observed. All load balancers within this network will be observed. Currently, this is limited to only one network. */
|
|
67
|
+
pscNetworkConfigs?: GclbObservationSourcePscNetworkConfig[];
|
|
68
|
+
}
|
|
69
|
+
interface GclbObservationSourcePscNetworkConfig {
|
|
70
|
+
/** Required. The VPC network. Format: `projects/{project_id}/global/networks/{network}` */
|
|
71
|
+
network?: string;
|
|
72
|
+
/** Required. The subnetwork in the source region that will be used to connect to the Cloud Load Balancers via PSC NEGs. Must belong to `network`. Format: projects/{project_id}/regions/{region}/subnetworks/{subnet} */
|
|
73
|
+
subnetwork?: string;
|
|
74
|
+
}
|
|
75
|
+
interface HttpOperation {
|
|
76
|
+
/** HTTP Method. */
|
|
77
|
+
method?: string;
|
|
78
|
+
/** Path of the HTTP request. */
|
|
79
|
+
path?: string;
|
|
80
|
+
/** Path params of HttpOperation */
|
|
81
|
+
pathParams?: HttpOperationPathParam[];
|
|
82
|
+
/** Query params of HttpOperation */
|
|
83
|
+
queryParams?: {[P in string]: HttpOperationQueryParam};
|
|
84
|
+
/** Request metadata. */
|
|
85
|
+
request?: HttpOperationHttpRequest;
|
|
86
|
+
/** Response metadata. */
|
|
87
|
+
response?: HttpOperationHttpResponse;
|
|
88
|
+
}
|
|
89
|
+
interface HttpOperationHeader {
|
|
90
|
+
/** The number of occurrences of this Header across transactions. */
|
|
91
|
+
count?: string;
|
|
92
|
+
/** Data type of header */
|
|
93
|
+
dataType?: string;
|
|
94
|
+
/** Header name. */
|
|
95
|
+
name?: string;
|
|
96
|
+
}
|
|
97
|
+
interface HttpOperationHttpRequest {
|
|
98
|
+
/** Unordered map from header name to header metadata */
|
|
99
|
+
headers?: {[P in string]: HttpOperationHeader};
|
|
100
|
+
}
|
|
101
|
+
interface HttpOperationHttpResponse {
|
|
102
|
+
/** Unordered map from header name to header metadata */
|
|
103
|
+
headers?: {[P in string]: HttpOperationHeader};
|
|
104
|
+
/** Map of status code to observed count */
|
|
105
|
+
responseCodes?: {[P in string]: string};
|
|
106
|
+
}
|
|
107
|
+
interface HttpOperationPathParam {
|
|
108
|
+
/** Data type of path param */
|
|
109
|
+
dataType?: string;
|
|
110
|
+
/** Segment location in the path, 1-indexed */
|
|
111
|
+
position?: number;
|
|
112
|
+
}
|
|
113
|
+
interface HttpOperationQueryParam {
|
|
114
|
+
/** The number of occurrences of this query parameter across transactions. */
|
|
115
|
+
count?: string;
|
|
116
|
+
/** Data type of path param */
|
|
117
|
+
dataType?: string;
|
|
118
|
+
/** Name of query param */
|
|
119
|
+
name?: string;
|
|
120
|
+
}
|
|
121
|
+
interface ListApiObservationsResponse {
|
|
122
|
+
/** The ApiObservation from the specified project and location and ObservationJobs. */
|
|
123
|
+
apiObservations?: ApiObservation[];
|
|
124
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
125
|
+
nextPageToken?: string;
|
|
126
|
+
}
|
|
127
|
+
interface ListApiOperationsResponse {
|
|
128
|
+
/** The ApiOperations from the specified project and location and ObservationJob and ApiObservation. */
|
|
129
|
+
apiOperations?: ApiOperation[];
|
|
130
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
131
|
+
nextPageToken?: string;
|
|
132
|
+
}
|
|
133
|
+
interface ListLocationsResponse {
|
|
134
|
+
/** A list of locations that matches the specified filter in the request. */
|
|
135
|
+
locations?: Location[];
|
|
136
|
+
/** The standard List next-page token. */
|
|
137
|
+
nextPageToken?: string;
|
|
138
|
+
}
|
|
139
|
+
interface ListObservationJobsResponse {
|
|
140
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
141
|
+
nextPageToken?: string;
|
|
142
|
+
/** The ObservationJob from the specified project and location. */
|
|
143
|
+
observationJobs?: ObservationJob[];
|
|
144
|
+
/** Locations that could not be reached. */
|
|
145
|
+
unreachable?: string[];
|
|
146
|
+
}
|
|
147
|
+
interface ListObservationSourcesResponse {
|
|
148
|
+
/** A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
|
|
149
|
+
nextPageToken?: string;
|
|
150
|
+
/** The ObservationSource from the specified project and location. */
|
|
151
|
+
observationSources?: ObservationSource[];
|
|
152
|
+
/** Locations that could not be reached. */
|
|
153
|
+
unreachable?: string[];
|
|
154
|
+
}
|
|
155
|
+
interface ListOperationsResponse {
|
|
156
|
+
/** The standard List next-page token. */
|
|
157
|
+
nextPageToken?: string;
|
|
158
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
159
|
+
operations?: Operation[];
|
|
160
|
+
}
|
|
161
|
+
interface Location {
|
|
162
|
+
/** The friendly name for this location, typically a nearby city name. For example, "Tokyo". */
|
|
163
|
+
displayName?: string;
|
|
164
|
+
/** Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"} */
|
|
165
|
+
labels?: {[P in string]: string};
|
|
166
|
+
/** The canonical id for this location. For example: `"us-east1"`. */
|
|
167
|
+
locationId?: string;
|
|
168
|
+
/** Service-specific metadata. For example the available capacity at the given location. */
|
|
169
|
+
metadata?: {[P in string]: any};
|
|
170
|
+
/** Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` */
|
|
171
|
+
name?: string;
|
|
172
|
+
}
|
|
173
|
+
interface ObservationJob {
|
|
174
|
+
/** Output only. [Output only] Create time stamp */
|
|
175
|
+
createTime?: string;
|
|
176
|
+
/** Identifier. name of resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} */
|
|
177
|
+
name?: string;
|
|
178
|
+
/** Optional. These should be of the same kind of source. */
|
|
179
|
+
sources?: string[];
|
|
180
|
+
/** Output only. The observation job state */
|
|
181
|
+
state?: string;
|
|
182
|
+
/** Output only. [Output only] Update time stamp */
|
|
183
|
+
updateTime?: string;
|
|
184
|
+
}
|
|
185
|
+
interface ObservationSource {
|
|
186
|
+
/** Output only. [Output only] Create time stamp */
|
|
187
|
+
createTime?: string;
|
|
188
|
+
/** The GCLB observation source */
|
|
189
|
+
gclbObservationSource?: GclbObservationSource;
|
|
190
|
+
/** Identifier. name of resource For MVP, each region can only have 1 source. */
|
|
191
|
+
name?: string;
|
|
192
|
+
/** Output only. The observation source state */
|
|
193
|
+
state?: string;
|
|
194
|
+
/** Output only. [Output only] Update time stamp */
|
|
195
|
+
updateTime?: string;
|
|
196
|
+
}
|
|
197
|
+
interface Operation {
|
|
198
|
+
/** 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. */
|
|
199
|
+
done?: boolean;
|
|
200
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
201
|
+
error?: Status;
|
|
202
|
+
/** 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 metadata. Any method that returns a long-running operation should document the metadata type, if any. */
|
|
203
|
+
metadata?: {[P in string]: any};
|
|
204
|
+
/** 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 with `operations/{unique_id}`. */
|
|
205
|
+
name?: string;
|
|
206
|
+
/** The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the 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 original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */
|
|
207
|
+
response?: {[P in string]: any};
|
|
208
|
+
}
|
|
209
|
+
interface OperationMetadata {
|
|
210
|
+
/** Output only. API version used to start the operation. */
|
|
211
|
+
apiVersion?: string;
|
|
212
|
+
/** Output only. The time the operation was created. */
|
|
213
|
+
createTime?: string;
|
|
214
|
+
/** Output only. The time the operation finished running. */
|
|
215
|
+
endTime?: string;
|
|
216
|
+
/** Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
|
|
217
|
+
requestedCancellation?: boolean;
|
|
218
|
+
/** Output only. Human-readable status of the operation, if any. */
|
|
219
|
+
statusMessage?: string;
|
|
220
|
+
/** Output only. Server-defined resource path for the target of the operation. */
|
|
221
|
+
target?: string;
|
|
222
|
+
/** Output only. Name of the verb executed by the operation. */
|
|
223
|
+
verb?: string;
|
|
224
|
+
}
|
|
225
|
+
interface Status {
|
|
226
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
227
|
+
code?: number;
|
|
228
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
229
|
+
details?: Array<{[P in string]: any}>;
|
|
230
|
+
/** 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 client. */
|
|
231
|
+
message?: string;
|
|
232
|
+
}
|
|
233
|
+
interface ApiOperationsResource {
|
|
234
|
+
/** GetApiOperation retrieves a single ApiOperation by name. */
|
|
235
|
+
get(request?: {
|
|
236
|
+
/** V1 error format. */
|
|
237
|
+
'$.xgafv'?: string;
|
|
238
|
+
/** OAuth access token. */
|
|
239
|
+
access_token?: string;
|
|
240
|
+
/** Data format for response. */
|
|
241
|
+
alt?: string;
|
|
242
|
+
/** JSONP */
|
|
243
|
+
callback?: string;
|
|
244
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
245
|
+
fields?: string;
|
|
246
|
+
/** 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. */
|
|
247
|
+
key?: string;
|
|
248
|
+
/** Required. The name of the ApiOperation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation}/apiOperation/{api_operation} */
|
|
249
|
+
name: string;
|
|
250
|
+
/** OAuth 2.0 token for the current user. */
|
|
251
|
+
oauth_token?: string;
|
|
252
|
+
/** Returns response with indentations and line breaks. */
|
|
253
|
+
prettyPrint?: boolean;
|
|
254
|
+
/** 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. */
|
|
255
|
+
quotaUser?: string;
|
|
256
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
257
|
+
upload_protocol?: string;
|
|
258
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
259
|
+
uploadType?: string;
|
|
260
|
+
}): Request<ApiOperation>;
|
|
261
|
+
/** ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation */
|
|
262
|
+
list(request?: {
|
|
263
|
+
/** V1 error format. */
|
|
264
|
+
'$.xgafv'?: string;
|
|
265
|
+
/** OAuth access token. */
|
|
266
|
+
access_token?: string;
|
|
267
|
+
/** Data format for response. */
|
|
268
|
+
alt?: string;
|
|
269
|
+
/** JSONP */
|
|
270
|
+
callback?: string;
|
|
271
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
272
|
+
fields?: string;
|
|
273
|
+
/** 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. */
|
|
274
|
+
key?: string;
|
|
275
|
+
/** OAuth 2.0 token for the current user. */
|
|
276
|
+
oauth_token?: string;
|
|
277
|
+
/** Optional. The maximum number of ApiOperations to return. The service may return fewer than this value. If unspecified, at most 10 ApiOperations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
278
|
+
pageSize?: number;
|
|
279
|
+
/** Optional. A page token, received from a previous `ListApiApiOperations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiApiOperations` must match the call that provided the page token. */
|
|
280
|
+
pageToken?: string;
|
|
281
|
+
/** Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} */
|
|
282
|
+
parent: string;
|
|
283
|
+
/** Returns response with indentations and line breaks. */
|
|
284
|
+
prettyPrint?: boolean;
|
|
285
|
+
/** 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. */
|
|
286
|
+
quotaUser?: string;
|
|
287
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
288
|
+
upload_protocol?: string;
|
|
289
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
290
|
+
uploadType?: string;
|
|
291
|
+
}): Request<ListApiOperationsResponse>;
|
|
292
|
+
}
|
|
293
|
+
interface ApiObservationsResource {
|
|
294
|
+
/** GetApiObservation retrieves a single ApiObservation by name. */
|
|
295
|
+
get(request?: {
|
|
296
|
+
/** V1 error format. */
|
|
297
|
+
'$.xgafv'?: string;
|
|
298
|
+
/** OAuth access token. */
|
|
299
|
+
access_token?: string;
|
|
300
|
+
/** Data format for response. */
|
|
301
|
+
alt?: string;
|
|
302
|
+
/** JSONP */
|
|
303
|
+
callback?: string;
|
|
304
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
305
|
+
fields?: string;
|
|
306
|
+
/** 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. */
|
|
307
|
+
key?: string;
|
|
308
|
+
/** Required. The name of the ApiObservation to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} */
|
|
309
|
+
name: string;
|
|
310
|
+
/** OAuth 2.0 token for the current user. */
|
|
311
|
+
oauth_token?: string;
|
|
312
|
+
/** Returns response with indentations and line breaks. */
|
|
313
|
+
prettyPrint?: boolean;
|
|
314
|
+
/** 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. */
|
|
315
|
+
quotaUser?: string;
|
|
316
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
317
|
+
upload_protocol?: string;
|
|
318
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
319
|
+
uploadType?: string;
|
|
320
|
+
}): Request<ApiObservation>;
|
|
321
|
+
/** ListApiObservations gets all ApiObservations for a given project and location and ObservationJob */
|
|
322
|
+
list(request?: {
|
|
323
|
+
/** V1 error format. */
|
|
324
|
+
'$.xgafv'?: string;
|
|
325
|
+
/** OAuth access token. */
|
|
326
|
+
access_token?: string;
|
|
327
|
+
/** Data format for response. */
|
|
328
|
+
alt?: string;
|
|
329
|
+
/** JSONP */
|
|
330
|
+
callback?: string;
|
|
331
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
332
|
+
fields?: string;
|
|
333
|
+
/** 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. */
|
|
334
|
+
key?: string;
|
|
335
|
+
/** OAuth 2.0 token for the current user. */
|
|
336
|
+
oauth_token?: string;
|
|
337
|
+
/** Optional. The maximum number of ApiObservations to return. The service may return fewer than this value. If unspecified, at most 10 ApiObservations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
338
|
+
pageSize?: number;
|
|
339
|
+
/** Optional. A page token, received from a previous `ListApiObservations` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservations` must match the call that provided the page token. */
|
|
340
|
+
pageToken?: string;
|
|
341
|
+
/** Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} */
|
|
342
|
+
parent: string;
|
|
343
|
+
/** Returns response with indentations and line breaks. */
|
|
344
|
+
prettyPrint?: boolean;
|
|
345
|
+
/** 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. */
|
|
346
|
+
quotaUser?: string;
|
|
347
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
348
|
+
upload_protocol?: string;
|
|
349
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
350
|
+
uploadType?: string;
|
|
351
|
+
}): Request<ListApiObservationsResponse>;
|
|
352
|
+
apiOperations: ApiOperationsResource;
|
|
353
|
+
}
|
|
354
|
+
interface ObservationJobsResource {
|
|
355
|
+
/** CreateObservationJob creates a new ObservationJob but does not have any effecton its own. It is a configuration that can be used in an Observation Job to collect data about existing APIs. */
|
|
356
|
+
create(request: {
|
|
357
|
+
/** V1 error format. */
|
|
358
|
+
'$.xgafv'?: string;
|
|
359
|
+
/** OAuth access token. */
|
|
360
|
+
access_token?: string;
|
|
361
|
+
/** Data format for response. */
|
|
362
|
+
alt?: string;
|
|
363
|
+
/** JSONP */
|
|
364
|
+
callback?: string;
|
|
365
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
366
|
+
fields?: string;
|
|
367
|
+
/** 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?: string;
|
|
369
|
+
/** OAuth 2.0 token for the current user. */
|
|
370
|
+
oauth_token?: string;
|
|
371
|
+
/** Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/. */
|
|
372
|
+
observationJobId?: string;
|
|
373
|
+
/** Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location} */
|
|
374
|
+
parent: string;
|
|
375
|
+
/** Returns response with indentations and line breaks. */
|
|
376
|
+
prettyPrint?: boolean;
|
|
377
|
+
/** 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. */
|
|
378
|
+
quotaUser?: string;
|
|
379
|
+
/** 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 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 the 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 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 supported (00000000-0000-0000-0000-000000000000). */
|
|
380
|
+
requestId?: string;
|
|
381
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
382
|
+
upload_protocol?: string;
|
|
383
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
384
|
+
uploadType?: string;
|
|
385
|
+
/** Request body */
|
|
386
|
+
resource: ObservationJob;
|
|
387
|
+
}): Request<Operation>;
|
|
388
|
+
create(
|
|
389
|
+
request: {
|
|
390
|
+
/** V1 error format. */
|
|
391
|
+
'$.xgafv'?: string;
|
|
392
|
+
/** OAuth access token. */
|
|
393
|
+
access_token?: string;
|
|
394
|
+
/** Data format for response. */
|
|
395
|
+
alt?: string;
|
|
396
|
+
/** JSONP */
|
|
397
|
+
callback?: string;
|
|
398
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
399
|
+
fields?: string;
|
|
400
|
+
/** 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. */
|
|
401
|
+
key?: string;
|
|
402
|
+
/** OAuth 2.0 token for the current user. */
|
|
403
|
+
oauth_token?: string;
|
|
404
|
+
/** Required. The ID to use for the Observation Job. This value should be 4-63 characters, and valid characters are /a-z-/. */
|
|
405
|
+
observationJobId?: string;
|
|
406
|
+
/** Required. The parent resource where this ObservationJob will be created. Format: projects/{project}/locations/{location} */
|
|
407
|
+
parent: string;
|
|
408
|
+
/** Returns response with indentations and line breaks. */
|
|
409
|
+
prettyPrint?: boolean;
|
|
410
|
+
/** 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. */
|
|
411
|
+
quotaUser?: string;
|
|
412
|
+
/** 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 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 the 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 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 supported (00000000-0000-0000-0000-000000000000). */
|
|
413
|
+
requestId?: string;
|
|
414
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
415
|
+
upload_protocol?: string;
|
|
416
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
417
|
+
uploadType?: string;
|
|
418
|
+
},
|
|
419
|
+
body: ObservationJob
|
|
420
|
+
): Request<Operation>;
|
|
421
|
+
/** DeleteObservationJob deletes an ObservationJob. This method will fail if the observation job is currently being used by any ObservationSource, even if not enabled. */
|
|
422
|
+
delete(request?: {
|
|
423
|
+
/** V1 error format. */
|
|
424
|
+
'$.xgafv'?: string;
|
|
425
|
+
/** OAuth access token. */
|
|
426
|
+
access_token?: string;
|
|
427
|
+
/** Data format for response. */
|
|
428
|
+
alt?: string;
|
|
429
|
+
/** JSONP */
|
|
430
|
+
callback?: string;
|
|
431
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
432
|
+
fields?: string;
|
|
433
|
+
/** 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. */
|
|
434
|
+
key?: string;
|
|
435
|
+
/** Required. Name of the resource Format: projects/{project}/locations/{location}/observationJobs/{observation_job} */
|
|
436
|
+
name: string;
|
|
437
|
+
/** OAuth 2.0 token for the current user. */
|
|
438
|
+
oauth_token?: string;
|
|
439
|
+
/** Returns response with indentations and line breaks. */
|
|
440
|
+
prettyPrint?: boolean;
|
|
441
|
+
/** 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. */
|
|
442
|
+
quotaUser?: string;
|
|
443
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
444
|
+
upload_protocol?: string;
|
|
445
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
446
|
+
uploadType?: string;
|
|
447
|
+
}): Request<Operation>;
|
|
448
|
+
/** Disables the given ObservationJob. */
|
|
449
|
+
disable(request: {
|
|
450
|
+
/** V1 error format. */
|
|
451
|
+
'$.xgafv'?: string;
|
|
452
|
+
/** OAuth access token. */
|
|
453
|
+
access_token?: string;
|
|
454
|
+
/** Data format for response. */
|
|
455
|
+
alt?: string;
|
|
456
|
+
/** JSONP */
|
|
457
|
+
callback?: string;
|
|
458
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
459
|
+
fields?: string;
|
|
460
|
+
/** 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. */
|
|
461
|
+
key?: string;
|
|
462
|
+
/** Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job} */
|
|
463
|
+
name: string;
|
|
464
|
+
/** OAuth 2.0 token for the current user. */
|
|
465
|
+
oauth_token?: string;
|
|
466
|
+
/** Returns response with indentations and line breaks. */
|
|
467
|
+
prettyPrint?: boolean;
|
|
468
|
+
/** 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. */
|
|
469
|
+
quotaUser?: string;
|
|
470
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
471
|
+
upload_protocol?: string;
|
|
472
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
473
|
+
uploadType?: string;
|
|
474
|
+
/** Request body */
|
|
475
|
+
resource: DisableObservationJobRequest;
|
|
476
|
+
}): Request<Operation>;
|
|
477
|
+
disable(
|
|
478
|
+
request: {
|
|
479
|
+
/** V1 error format. */
|
|
480
|
+
'$.xgafv'?: string;
|
|
481
|
+
/** OAuth access token. */
|
|
482
|
+
access_token?: string;
|
|
483
|
+
/** Data format for response. */
|
|
484
|
+
alt?: string;
|
|
485
|
+
/** JSONP */
|
|
486
|
+
callback?: string;
|
|
487
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
488
|
+
fields?: string;
|
|
489
|
+
/** 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. */
|
|
490
|
+
key?: string;
|
|
491
|
+
/** Required. The name of the ObservationJob to disable. Format: projects/{project}/locations/{location}/observationJobs/{job} */
|
|
492
|
+
name: string;
|
|
493
|
+
/** OAuth 2.0 token for the current user. */
|
|
494
|
+
oauth_token?: string;
|
|
495
|
+
/** Returns response with indentations and line breaks. */
|
|
496
|
+
prettyPrint?: boolean;
|
|
497
|
+
/** 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. */
|
|
498
|
+
quotaUser?: string;
|
|
499
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
500
|
+
upload_protocol?: string;
|
|
501
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
502
|
+
uploadType?: string;
|
|
503
|
+
},
|
|
504
|
+
body: DisableObservationJobRequest
|
|
505
|
+
): Request<Operation>;
|
|
506
|
+
/** Enables the given ObservationJob. */
|
|
507
|
+
enable(request: {
|
|
508
|
+
/** V1 error format. */
|
|
509
|
+
'$.xgafv'?: string;
|
|
510
|
+
/** OAuth access token. */
|
|
511
|
+
access_token?: string;
|
|
512
|
+
/** Data format for response. */
|
|
513
|
+
alt?: string;
|
|
514
|
+
/** JSONP */
|
|
515
|
+
callback?: string;
|
|
516
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
517
|
+
fields?: string;
|
|
518
|
+
/** 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. */
|
|
519
|
+
key?: string;
|
|
520
|
+
/** Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job} */
|
|
521
|
+
name: string;
|
|
522
|
+
/** OAuth 2.0 token for the current user. */
|
|
523
|
+
oauth_token?: string;
|
|
524
|
+
/** Returns response with indentations and line breaks. */
|
|
525
|
+
prettyPrint?: boolean;
|
|
526
|
+
/** 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. */
|
|
527
|
+
quotaUser?: string;
|
|
528
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
529
|
+
upload_protocol?: string;
|
|
530
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
531
|
+
uploadType?: string;
|
|
532
|
+
/** Request body */
|
|
533
|
+
resource: EnableObservationJobRequest;
|
|
534
|
+
}): Request<Operation>;
|
|
535
|
+
enable(
|
|
536
|
+
request: {
|
|
537
|
+
/** V1 error format. */
|
|
538
|
+
'$.xgafv'?: string;
|
|
539
|
+
/** OAuth access token. */
|
|
540
|
+
access_token?: string;
|
|
541
|
+
/** Data format for response. */
|
|
542
|
+
alt?: string;
|
|
543
|
+
/** JSONP */
|
|
544
|
+
callback?: string;
|
|
545
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
546
|
+
fields?: string;
|
|
547
|
+
/** 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. */
|
|
548
|
+
key?: string;
|
|
549
|
+
/** Required. The name of the ObservationJob to enable. Format: projects/{project}/locations/{location}/observationJobs/{job} */
|
|
550
|
+
name: string;
|
|
551
|
+
/** OAuth 2.0 token for the current user. */
|
|
552
|
+
oauth_token?: string;
|
|
553
|
+
/** Returns response with indentations and line breaks. */
|
|
554
|
+
prettyPrint?: boolean;
|
|
555
|
+
/** 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. */
|
|
556
|
+
quotaUser?: string;
|
|
557
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
558
|
+
upload_protocol?: string;
|
|
559
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
560
|
+
uploadType?: string;
|
|
561
|
+
},
|
|
562
|
+
body: EnableObservationJobRequest
|
|
563
|
+
): Request<Operation>;
|
|
564
|
+
/** GetObservationJob retrieves a single ObservationJob by name. */
|
|
565
|
+
get(request?: {
|
|
566
|
+
/** V1 error format. */
|
|
567
|
+
'$.xgafv'?: string;
|
|
568
|
+
/** OAuth access token. */
|
|
569
|
+
access_token?: string;
|
|
570
|
+
/** Data format for response. */
|
|
571
|
+
alt?: string;
|
|
572
|
+
/** JSONP */
|
|
573
|
+
callback?: string;
|
|
574
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
575
|
+
fields?: string;
|
|
576
|
+
/** 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. */
|
|
577
|
+
key?: string;
|
|
578
|
+
/** Required. The name of the ObservationJob to retrieve. Format: projects/{project}/locations/{location}/observationJobs/{job} */
|
|
579
|
+
name: string;
|
|
580
|
+
/** OAuth 2.0 token for the current user. */
|
|
581
|
+
oauth_token?: string;
|
|
582
|
+
/** Returns response with indentations and line breaks. */
|
|
583
|
+
prettyPrint?: boolean;
|
|
584
|
+
/** 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. */
|
|
585
|
+
quotaUser?: string;
|
|
586
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
587
|
+
upload_protocol?: string;
|
|
588
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
589
|
+
uploadType?: string;
|
|
590
|
+
}): Request<ObservationJob>;
|
|
591
|
+
/** ListObservationJobs gets all ObservationJobs for a given project and location */
|
|
592
|
+
list(request?: {
|
|
593
|
+
/** V1 error format. */
|
|
594
|
+
'$.xgafv'?: string;
|
|
595
|
+
/** OAuth access token. */
|
|
596
|
+
access_token?: string;
|
|
597
|
+
/** Data format for response. */
|
|
598
|
+
alt?: string;
|
|
599
|
+
/** JSONP */
|
|
600
|
+
callback?: string;
|
|
601
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
602
|
+
fields?: string;
|
|
603
|
+
/** 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. */
|
|
604
|
+
key?: string;
|
|
605
|
+
/** OAuth 2.0 token for the current user. */
|
|
606
|
+
oauth_token?: string;
|
|
607
|
+
/** Optional. The maximum number of ObservationJobs to return. The service may return fewer than this value. If unspecified, at most 10 ObservationJobs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
608
|
+
pageSize?: number;
|
|
609
|
+
/** Optional. A page token, received from a previous `ListObservationJobs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationJobs` must match the call that provided the page token. */
|
|
610
|
+
pageToken?: string;
|
|
611
|
+
/** Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} */
|
|
612
|
+
parent: string;
|
|
613
|
+
/** Returns response with indentations and line breaks. */
|
|
614
|
+
prettyPrint?: boolean;
|
|
615
|
+
/** 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. */
|
|
616
|
+
quotaUser?: string;
|
|
617
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
618
|
+
upload_protocol?: string;
|
|
619
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
620
|
+
uploadType?: string;
|
|
621
|
+
}): Request<ListObservationJobsResponse>;
|
|
622
|
+
apiObservations: ApiObservationsResource;
|
|
623
|
+
}
|
|
624
|
+
interface ObservationSourcesResource {
|
|
625
|
+
/** CreateObservationSource creates a new ObservationSource but does not affect any deployed infrastructure. It is a configuration that can be used in an Observation Job to collect data about APIs running in user's dataplane. */
|
|
626
|
+
create(request: {
|
|
627
|
+
/** V1 error format. */
|
|
628
|
+
'$.xgafv'?: string;
|
|
629
|
+
/** OAuth access token. */
|
|
630
|
+
access_token?: string;
|
|
631
|
+
/** Data format for response. */
|
|
632
|
+
alt?: string;
|
|
633
|
+
/** JSONP */
|
|
634
|
+
callback?: string;
|
|
635
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
636
|
+
fields?: string;
|
|
637
|
+
/** 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. */
|
|
638
|
+
key?: string;
|
|
639
|
+
/** OAuth 2.0 token for the current user. */
|
|
640
|
+
oauth_token?: string;
|
|
641
|
+
/** Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/. */
|
|
642
|
+
observationSourceId?: string;
|
|
643
|
+
/** Required. Value for parent. */
|
|
644
|
+
parent: string;
|
|
645
|
+
/** Returns response with indentations and line breaks. */
|
|
646
|
+
prettyPrint?: boolean;
|
|
647
|
+
/** 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. */
|
|
648
|
+
quotaUser?: string;
|
|
649
|
+
/** 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 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 the 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 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 supported (00000000-0000-0000-0000-000000000000). */
|
|
650
|
+
requestId?: string;
|
|
651
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
652
|
+
upload_protocol?: string;
|
|
653
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
654
|
+
uploadType?: string;
|
|
655
|
+
/** Request body */
|
|
656
|
+
resource: ObservationSource;
|
|
657
|
+
}): Request<Operation>;
|
|
658
|
+
create(
|
|
659
|
+
request: {
|
|
660
|
+
/** V1 error format. */
|
|
661
|
+
'$.xgafv'?: string;
|
|
662
|
+
/** OAuth access token. */
|
|
663
|
+
access_token?: string;
|
|
664
|
+
/** Data format for response. */
|
|
665
|
+
alt?: string;
|
|
666
|
+
/** JSONP */
|
|
667
|
+
callback?: string;
|
|
668
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
669
|
+
fields?: string;
|
|
670
|
+
/** 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. */
|
|
671
|
+
key?: string;
|
|
672
|
+
/** OAuth 2.0 token for the current user. */
|
|
673
|
+
oauth_token?: string;
|
|
674
|
+
/** Required. The ID to use for the Observation Source. This value should be 4-63 characters, and valid characters are /a-z-/. */
|
|
675
|
+
observationSourceId?: string;
|
|
676
|
+
/** Required. Value for parent. */
|
|
677
|
+
parent: string;
|
|
678
|
+
/** Returns response with indentations and line breaks. */
|
|
679
|
+
prettyPrint?: boolean;
|
|
680
|
+
/** 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. */
|
|
681
|
+
quotaUser?: string;
|
|
682
|
+
/** 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 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 the 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 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 supported (00000000-0000-0000-0000-000000000000). */
|
|
683
|
+
requestId?: string;
|
|
684
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
685
|
+
upload_protocol?: string;
|
|
686
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
687
|
+
uploadType?: string;
|
|
688
|
+
},
|
|
689
|
+
body: ObservationSource
|
|
690
|
+
): Request<Operation>;
|
|
691
|
+
/** DeleteObservationSource deletes an observation source. This method will fail if the observation source is currently being used by any ObservationJob, even if not enabled. */
|
|
692
|
+
delete(request?: {
|
|
693
|
+
/** V1 error format. */
|
|
694
|
+
'$.xgafv'?: string;
|
|
695
|
+
/** OAuth access token. */
|
|
696
|
+
access_token?: string;
|
|
697
|
+
/** Data format for response. */
|
|
698
|
+
alt?: string;
|
|
699
|
+
/** JSONP */
|
|
700
|
+
callback?: string;
|
|
701
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
702
|
+
fields?: string;
|
|
703
|
+
/** 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. */
|
|
704
|
+
key?: string;
|
|
705
|
+
/** Required. Name of the resource Format: projects/{project}/locations/{location}/observationSources/{source} */
|
|
706
|
+
name: string;
|
|
707
|
+
/** OAuth 2.0 token for the current user. */
|
|
708
|
+
oauth_token?: string;
|
|
709
|
+
/** Returns response with indentations and line breaks. */
|
|
710
|
+
prettyPrint?: boolean;
|
|
711
|
+
/** 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. */
|
|
712
|
+
quotaUser?: string;
|
|
713
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
714
|
+
upload_protocol?: string;
|
|
715
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
716
|
+
uploadType?: string;
|
|
717
|
+
}): Request<Operation>;
|
|
718
|
+
/** GetObservationSource retrieves a single ObservationSource by name. */
|
|
719
|
+
get(request?: {
|
|
720
|
+
/** V1 error format. */
|
|
721
|
+
'$.xgafv'?: string;
|
|
722
|
+
/** OAuth access token. */
|
|
723
|
+
access_token?: string;
|
|
724
|
+
/** Data format for response. */
|
|
725
|
+
alt?: string;
|
|
726
|
+
/** JSONP */
|
|
727
|
+
callback?: string;
|
|
728
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
729
|
+
fields?: 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
|
+
/** Required. The name of the ObservationSource to retrieve. Format: projects/{project}/locations/{location}/observationSources/{source} */
|
|
733
|
+
name: string;
|
|
734
|
+
/** OAuth 2.0 token for the current user. */
|
|
735
|
+
oauth_token?: string;
|
|
736
|
+
/** Returns response with indentations and line breaks. */
|
|
737
|
+
prettyPrint?: boolean;
|
|
738
|
+
/** 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. */
|
|
739
|
+
quotaUser?: string;
|
|
740
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
741
|
+
upload_protocol?: string;
|
|
742
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
743
|
+
uploadType?: string;
|
|
744
|
+
}): Request<ObservationSource>;
|
|
745
|
+
/** ListObservationSources gets all ObservationSources for a given project and location */
|
|
746
|
+
list(request?: {
|
|
747
|
+
/** V1 error format. */
|
|
748
|
+
'$.xgafv'?: string;
|
|
749
|
+
/** OAuth access token. */
|
|
750
|
+
access_token?: string;
|
|
751
|
+
/** Data format for response. */
|
|
752
|
+
alt?: string;
|
|
753
|
+
/** JSONP */
|
|
754
|
+
callback?: string;
|
|
755
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
756
|
+
fields?: string;
|
|
757
|
+
/** 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. */
|
|
758
|
+
key?: string;
|
|
759
|
+
/** OAuth 2.0 token for the current user. */
|
|
760
|
+
oauth_token?: string;
|
|
761
|
+
/** Optional. The maximum number of ObservationSources to return. The service may return fewer than this value. If unspecified, at most 10 ObservationSources will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
|
|
762
|
+
pageSize?: number;
|
|
763
|
+
/** Optional. A page token, received from a previous `ListObservationSources` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListObservationSources` must match the call that provided the page token. */
|
|
764
|
+
pageToken?: string;
|
|
765
|
+
/** Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} */
|
|
766
|
+
parent: string;
|
|
767
|
+
/** Returns response with indentations and line breaks. */
|
|
768
|
+
prettyPrint?: boolean;
|
|
769
|
+
/** 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. */
|
|
770
|
+
quotaUser?: string;
|
|
771
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
772
|
+
upload_protocol?: string;
|
|
773
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
774
|
+
uploadType?: string;
|
|
775
|
+
}): Request<ListObservationSourcesResponse>;
|
|
776
|
+
}
|
|
777
|
+
interface OperationsResource {
|
|
778
|
+
/** 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 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 operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
|
|
779
|
+
cancel(request: {
|
|
780
|
+
/** V1 error format. */
|
|
781
|
+
'$.xgafv'?: string;
|
|
782
|
+
/** OAuth access token. */
|
|
783
|
+
access_token?: string;
|
|
784
|
+
/** Data format for response. */
|
|
785
|
+
alt?: string;
|
|
786
|
+
/** JSONP */
|
|
787
|
+
callback?: string;
|
|
788
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
789
|
+
fields?: string;
|
|
790
|
+
/** 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. */
|
|
791
|
+
key?: string;
|
|
792
|
+
/** The name of the operation resource to be cancelled. */
|
|
793
|
+
name: string;
|
|
794
|
+
/** OAuth 2.0 token for the current user. */
|
|
795
|
+
oauth_token?: string;
|
|
796
|
+
/** Returns response with indentations and line breaks. */
|
|
797
|
+
prettyPrint?: boolean;
|
|
798
|
+
/** 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. */
|
|
799
|
+
quotaUser?: string;
|
|
800
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
801
|
+
upload_protocol?: string;
|
|
802
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
803
|
+
uploadType?: string;
|
|
804
|
+
/** Request body */
|
|
805
|
+
resource: CancelOperationRequest;
|
|
806
|
+
}): Request<{}>;
|
|
807
|
+
cancel(
|
|
808
|
+
request: {
|
|
809
|
+
/** V1 error format. */
|
|
810
|
+
'$.xgafv'?: string;
|
|
811
|
+
/** OAuth access token. */
|
|
812
|
+
access_token?: string;
|
|
813
|
+
/** Data format for response. */
|
|
814
|
+
alt?: string;
|
|
815
|
+
/** JSONP */
|
|
816
|
+
callback?: string;
|
|
817
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
818
|
+
fields?: string;
|
|
819
|
+
/** 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. */
|
|
820
|
+
key?: string;
|
|
821
|
+
/** The name of the operation resource to be cancelled. */
|
|
822
|
+
name: string;
|
|
823
|
+
/** OAuth 2.0 token for the current user. */
|
|
824
|
+
oauth_token?: string;
|
|
825
|
+
/** Returns response with indentations and line breaks. */
|
|
826
|
+
prettyPrint?: boolean;
|
|
827
|
+
/** 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. */
|
|
828
|
+
quotaUser?: string;
|
|
829
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
830
|
+
upload_protocol?: string;
|
|
831
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
832
|
+
uploadType?: string;
|
|
833
|
+
},
|
|
834
|
+
body: CancelOperationRequest
|
|
835
|
+
): Request<{}>;
|
|
836
|
+
/** 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 support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. */
|
|
837
|
+
delete(request?: {
|
|
838
|
+
/** V1 error format. */
|
|
839
|
+
'$.xgafv'?: string;
|
|
840
|
+
/** OAuth access token. */
|
|
841
|
+
access_token?: string;
|
|
842
|
+
/** Data format for response. */
|
|
843
|
+
alt?: string;
|
|
844
|
+
/** JSONP */
|
|
845
|
+
callback?: string;
|
|
846
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
847
|
+
fields?: string;
|
|
848
|
+
/** 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. */
|
|
849
|
+
key?: string;
|
|
850
|
+
/** The name of the operation resource to be deleted. */
|
|
851
|
+
name: string;
|
|
852
|
+
/** OAuth 2.0 token for the current user. */
|
|
853
|
+
oauth_token?: string;
|
|
854
|
+
/** Returns response with indentations and line breaks. */
|
|
855
|
+
prettyPrint?: boolean;
|
|
856
|
+
/** 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. */
|
|
857
|
+
quotaUser?: string;
|
|
858
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
859
|
+
upload_protocol?: string;
|
|
860
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
861
|
+
uploadType?: string;
|
|
862
|
+
}): Request<{}>;
|
|
863
|
+
/** 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. */
|
|
864
|
+
get(request?: {
|
|
865
|
+
/** V1 error format. */
|
|
866
|
+
'$.xgafv'?: string;
|
|
867
|
+
/** OAuth access token. */
|
|
868
|
+
access_token?: string;
|
|
869
|
+
/** Data format for response. */
|
|
870
|
+
alt?: string;
|
|
871
|
+
/** JSONP */
|
|
872
|
+
callback?: string;
|
|
873
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
874
|
+
fields?: string;
|
|
875
|
+
/** 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. */
|
|
876
|
+
key?: string;
|
|
877
|
+
/** The name of the operation resource. */
|
|
878
|
+
name: string;
|
|
879
|
+
/** OAuth 2.0 token for the current user. */
|
|
880
|
+
oauth_token?: string;
|
|
881
|
+
/** Returns response with indentations and line breaks. */
|
|
882
|
+
prettyPrint?: boolean;
|
|
883
|
+
/** 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. */
|
|
884
|
+
quotaUser?: string;
|
|
885
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
886
|
+
upload_protocol?: string;
|
|
887
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
888
|
+
uploadType?: string;
|
|
889
|
+
}): Request<Operation>;
|
|
890
|
+
/** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
|
|
891
|
+
list(request?: {
|
|
892
|
+
/** V1 error format. */
|
|
893
|
+
'$.xgafv'?: string;
|
|
894
|
+
/** OAuth access token. */
|
|
895
|
+
access_token?: string;
|
|
896
|
+
/** Data format for response. */
|
|
897
|
+
alt?: string;
|
|
898
|
+
/** JSONP */
|
|
899
|
+
callback?: string;
|
|
900
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
901
|
+
fields?: string;
|
|
902
|
+
/** The standard list filter. */
|
|
903
|
+
filter?: string;
|
|
904
|
+
/** 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. */
|
|
905
|
+
key?: string;
|
|
906
|
+
/** The name of the operation's parent resource. */
|
|
907
|
+
name: string;
|
|
908
|
+
/** OAuth 2.0 token for the current user. */
|
|
909
|
+
oauth_token?: string;
|
|
910
|
+
/** The standard list page size. */
|
|
911
|
+
pageSize?: number;
|
|
912
|
+
/** The standard list page token. */
|
|
913
|
+
pageToken?: string;
|
|
914
|
+
/** Returns response with indentations and line breaks. */
|
|
915
|
+
prettyPrint?: boolean;
|
|
916
|
+
/** 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. */
|
|
917
|
+
quotaUser?: string;
|
|
918
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
919
|
+
upload_protocol?: string;
|
|
920
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
921
|
+
uploadType?: string;
|
|
922
|
+
}): Request<ListOperationsResponse>;
|
|
923
|
+
}
|
|
924
|
+
interface LocationsResource {
|
|
925
|
+
/** Gets information about a location. */
|
|
926
|
+
get(request?: {
|
|
927
|
+
/** V1 error format. */
|
|
928
|
+
'$.xgafv'?: string;
|
|
929
|
+
/** OAuth access token. */
|
|
930
|
+
access_token?: string;
|
|
931
|
+
/** Data format for response. */
|
|
932
|
+
alt?: string;
|
|
933
|
+
/** JSONP */
|
|
934
|
+
callback?: string;
|
|
935
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
936
|
+
fields?: string;
|
|
937
|
+
/** 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. */
|
|
938
|
+
key?: string;
|
|
939
|
+
/** Resource name for the location. */
|
|
940
|
+
name: string;
|
|
941
|
+
/** OAuth 2.0 token for the current user. */
|
|
942
|
+
oauth_token?: string;
|
|
943
|
+
/** Returns response with indentations and line breaks. */
|
|
944
|
+
prettyPrint?: boolean;
|
|
945
|
+
/** 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. */
|
|
946
|
+
quotaUser?: string;
|
|
947
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
948
|
+
upload_protocol?: string;
|
|
949
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
950
|
+
uploadType?: string;
|
|
951
|
+
}): Request<Location>;
|
|
952
|
+
/** Lists information about the supported locations for this service. */
|
|
953
|
+
list(request?: {
|
|
954
|
+
/** V1 error format. */
|
|
955
|
+
'$.xgafv'?: string;
|
|
956
|
+
/** OAuth access token. */
|
|
957
|
+
access_token?: string;
|
|
958
|
+
/** Data format for response. */
|
|
959
|
+
alt?: string;
|
|
960
|
+
/** JSONP */
|
|
961
|
+
callback?: string;
|
|
962
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
963
|
+
fields?: string;
|
|
964
|
+
/** 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 [AIP-160](https://google.aip.dev/160). */
|
|
965
|
+
filter?: string;
|
|
966
|
+
/** 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. */
|
|
967
|
+
key?: string;
|
|
968
|
+
/** The resource that owns the locations collection, if applicable. */
|
|
969
|
+
name: string;
|
|
970
|
+
/** OAuth 2.0 token for the current user. */
|
|
971
|
+
oauth_token?: string;
|
|
972
|
+
/** The maximum number of results to return. If not set, the service selects a default. */
|
|
973
|
+
pageSize?: number;
|
|
974
|
+
/** A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. */
|
|
975
|
+
pageToken?: string;
|
|
976
|
+
/** Returns response with indentations and line breaks. */
|
|
977
|
+
prettyPrint?: boolean;
|
|
978
|
+
/** 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. */
|
|
979
|
+
quotaUser?: string;
|
|
980
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
981
|
+
upload_protocol?: string;
|
|
982
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
983
|
+
uploadType?: string;
|
|
984
|
+
}): Request<ListLocationsResponse>;
|
|
985
|
+
observationJobs: ObservationJobsResource;
|
|
986
|
+
observationSources: ObservationSourcesResource;
|
|
987
|
+
operations: OperationsResource;
|
|
988
|
+
}
|
|
989
|
+
interface ProjectsResource {
|
|
990
|
+
locations: LocationsResource;
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
const projects: ProjectsResource;
|
|
994
|
+
}
|
|
995
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@maxim_mazurok/gapi.client.apim-v1alpha",
|
|
3
|
+
"version": "0.0.20240605",
|
|
4
|
+
"description": "TypeScript typings for API Management API v1alpha",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/Maxim-Mazurok/google-api-typings-generator.git"
|
|
8
|
+
},
|
|
9
|
+
"license": "MIT",
|
|
10
|
+
"author": {
|
|
11
|
+
"name": "Maxim Mazurok",
|
|
12
|
+
"email": "maxim@mazurok.com",
|
|
13
|
+
"url": "https://maxim.mazurok.com"
|
|
14
|
+
},
|
|
15
|
+
"types": "index.d.ts",
|
|
16
|
+
"dependencies": {
|
|
17
|
+
"@types/gapi.client": "*",
|
|
18
|
+
"@types/gapi.client.discovery-v1": "*"
|
|
19
|
+
}
|
|
20
|
+
}
|
package/readme.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# TypeScript typings for API Management API v1alpha
|
|
2
|
+
|
|
3
|
+
Enables users to discover shadow APIs in existing Google Cloud infrastructure.
|
|
4
|
+
For detailed description please check [documentation](https://cloud.google.com/apigee/).
|
|
5
|
+
|
|
6
|
+
## Installing
|
|
7
|
+
|
|
8
|
+
Install typings for API Management API:
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
npm install @types/gapi.client.apim-v1alpha --save-dev
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
## Usage
|
|
15
|
+
|
|
16
|
+
You need to initialize Google API client in your code:
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
gapi.load('client', () => {
|
|
20
|
+
// now we can use gapi.client
|
|
21
|
+
// ...
|
|
22
|
+
});
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
Then load api client wrapper:
|
|
26
|
+
|
|
27
|
+
```typescript
|
|
28
|
+
gapi.client.load(
|
|
29
|
+
'https://apim.googleapis.com/$discovery/rest?version=v1alpha',
|
|
30
|
+
() => {
|
|
31
|
+
// now we can use:
|
|
32
|
+
// gapi.client.apim
|
|
33
|
+
}
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
```typescript
|
|
38
|
+
// Deprecated, use discovery document URL, see https://github.com/google/google-api-javascript-client/blob/master/docs/reference.md#----gapiclientloadname----version----callback--
|
|
39
|
+
gapi.client.load('apim', 'v1alpha', () => {
|
|
40
|
+
// now we can use:
|
|
41
|
+
// gapi.client.apim
|
|
42
|
+
});
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Don't forget to authenticate your client before sending any request to resources:
|
|
46
|
+
|
|
47
|
+
```typescript
|
|
48
|
+
// declare client_id registered in Google Developers Console
|
|
49
|
+
var client_id = '',
|
|
50
|
+
scope = [
|
|
51
|
+
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
|
52
|
+
'https://www.googleapis.com/auth/cloud-platform',
|
|
53
|
+
],
|
|
54
|
+
immediate = true;
|
|
55
|
+
// ...
|
|
56
|
+
|
|
57
|
+
gapi.auth.authorize(
|
|
58
|
+
{client_id: client_id, scope: scope, immediate: immediate},
|
|
59
|
+
authResult => {
|
|
60
|
+
if (authResult && !authResult.error) {
|
|
61
|
+
/* handle successful authorization */
|
|
62
|
+
} else {
|
|
63
|
+
/* handle authorization error */
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
);
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
After that you can use API Management API resources: <!-- TODO: make this work for multiple namespaces -->
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
|
|
73
|
+
```
|