@maxim_mazurok/gapi.client.servicemanagement-v1 0.0.20220805
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 +1973 -0
- package/package.json +20 -0
- package/readme.md +137 -0
- package/tests.ts +742 -0
- package/tsconfig.json +18 -0
- package/tslint.json +6 -0
package/index.d.ts
ADDED
|
@@ -0,0 +1,1973 @@
|
|
|
1
|
+
/* Type definitions for non-npm package Service Management API v1 0.0 */
|
|
2
|
+
// Project: https://cloud.google.com/service-management/
|
|
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
|
+
// TypeScript Version: 2.8
|
|
8
|
+
|
|
9
|
+
// IMPORTANT
|
|
10
|
+
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
11
|
+
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
12
|
+
// Generated from: https://servicemanagement.googleapis.com/$discovery/rest?version=v1
|
|
13
|
+
// Revision: 20220805
|
|
14
|
+
|
|
15
|
+
/// <reference types="gapi.client" />
|
|
16
|
+
|
|
17
|
+
declare namespace gapi.client {
|
|
18
|
+
/** Load Service Management API v1 */
|
|
19
|
+
function load(urlOrObject: "https://servicemanagement.googleapis.com/$discovery/rest?version=v1"): Promise<void>;
|
|
20
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
21
|
+
function load(name: "servicemanagement", version: "v1"): Promise<void>;
|
|
22
|
+
/** @deprecated Please load APIs with discovery documents. */
|
|
23
|
+
function load(name: "servicemanagement", version: "v1", callback: () => any): void;
|
|
24
|
+
|
|
25
|
+
namespace servicemanagement {
|
|
26
|
+
interface Advice {
|
|
27
|
+
/** Useful description for why this advice was applied and what actions should be taken to mitigate any implied risks. */
|
|
28
|
+
description?: string;
|
|
29
|
+
}
|
|
30
|
+
interface Api {
|
|
31
|
+
/** The methods of this interface, in unspecified order. */
|
|
32
|
+
methods?: Method[];
|
|
33
|
+
/** Included interfaces. See Mixin. */
|
|
34
|
+
mixins?: Mixin[];
|
|
35
|
+
/** The fully qualified name of this interface, including package name followed by the interface's simple name. */
|
|
36
|
+
name?: string;
|
|
37
|
+
/** Any metadata attached to the interface. */
|
|
38
|
+
options?: Option[];
|
|
39
|
+
/** Source context for the protocol buffer service represented by this message. */
|
|
40
|
+
sourceContext?: SourceContext;
|
|
41
|
+
/** The source syntax of the service. */
|
|
42
|
+
syntax?: string;
|
|
43
|
+
/**
|
|
44
|
+
* A version string for this interface. If specified, must have the form `major-version.minor-version`, as in `1.10`. If the minor version is omitted, it defaults to zero. If the
|
|
45
|
+
* entire version field is empty, the major version is derived from the package name, as outlined below. If the field is not empty, the version in the package name will be verified to
|
|
46
|
+
* be consistent with what is provided here. The versioning schema uses [semantic versioning](http://semver.org) where the major version number indicates a breaking change and the
|
|
47
|
+
* minor version an additive, non-breaking change. Both version numbers are signals to users what to expect from different versions, and should be carefully chosen based on the product
|
|
48
|
+
* plan. The major version is also reflected in the package name of the interface, which must end in `v`, as in `google.feature.v1`. For major versions 0 and 1, the suffix can be
|
|
49
|
+
* omitted. Zero major versions must only be used for experimental, non-GA interfaces.
|
|
50
|
+
*/
|
|
51
|
+
version?: string;
|
|
52
|
+
}
|
|
53
|
+
interface AuditConfig {
|
|
54
|
+
/** The configuration for logging of each type of permission. */
|
|
55
|
+
auditLogConfigs?: AuditLogConfig[];
|
|
56
|
+
/**
|
|
57
|
+
* Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all
|
|
58
|
+
* services.
|
|
59
|
+
*/
|
|
60
|
+
service?: string;
|
|
61
|
+
}
|
|
62
|
+
interface AuditLogConfig {
|
|
63
|
+
/** Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. */
|
|
64
|
+
exemptedMembers?: string[];
|
|
65
|
+
/** The log type that this config enables. */
|
|
66
|
+
logType?: string;
|
|
67
|
+
}
|
|
68
|
+
interface Authentication {
|
|
69
|
+
/** Defines a set of authentication providers that a service supports. */
|
|
70
|
+
providers?: AuthProvider[];
|
|
71
|
+
/** A list of authentication rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
72
|
+
rules?: AuthenticationRule[];
|
|
73
|
+
}
|
|
74
|
+
interface AuthenticationRule {
|
|
75
|
+
/** If true, the service accepts API keys without any other credential. This flag only applies to HTTP and gRPC requests. */
|
|
76
|
+
allowWithoutCredential?: boolean;
|
|
77
|
+
/** The requirements for OAuth credentials. */
|
|
78
|
+
oauth?: OAuthRequirements;
|
|
79
|
+
/** Requirements for additional authentication providers. */
|
|
80
|
+
requirements?: AuthRequirement[];
|
|
81
|
+
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
82
|
+
selector?: string;
|
|
83
|
+
}
|
|
84
|
+
interface AuthProvider {
|
|
85
|
+
/**
|
|
86
|
+
* The list of JWT [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will
|
|
87
|
+
* be accepted. When this setting is absent, JWTs with audiences: - "https://[service.name]/[google.protobuf.Api.name]" - "https://[service.name]/" will be accepted. For example, if no
|
|
88
|
+
* audiences are in the setting, LibraryService API will accept JWTs with the following audiences: - https://library-example.googleapis.com/google.example.library.v1.LibraryService -
|
|
89
|
+
* https://library-example.googleapis.com/ Example: audiences: bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
|
|
90
|
+
*/
|
|
91
|
+
audiences?: string;
|
|
92
|
+
/** Redirect URL if JWT token is required but not present or is expired. Implement authorizationUrl of securityDefinitions in OpenAPI spec. */
|
|
93
|
+
authorizationUrl?: string;
|
|
94
|
+
/** The unique identifier of the auth provider. It will be referred to by `AuthRequirement.provider_id`. Example: "bookstore_auth". */
|
|
95
|
+
id?: string;
|
|
96
|
+
/**
|
|
97
|
+
* Identifies the principal that issued the JWT. See https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1 Usually a URL or an email address. Example:
|
|
98
|
+
* https://securetoken.google.com Example: 1234567-compute@developer.gserviceaccount.com
|
|
99
|
+
*/
|
|
100
|
+
issuer?: string;
|
|
101
|
+
/**
|
|
102
|
+
* URL of the provider's public key set to validate signature of the JWT. See [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). Optional
|
|
103
|
+
* if the key set document: - can be retrieved from [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html) of the issuer. - can be inferred from the email
|
|
104
|
+
* domain of the issuer (e.g. a Google service account). Example: https://www.googleapis.com/oauth2/v1/certs
|
|
105
|
+
*/
|
|
106
|
+
jwksUri?: string;
|
|
107
|
+
/**
|
|
108
|
+
* Defines the locations to extract the JWT. For now it is only used by the Cloud Endpoints to store the OpenAPI extension [x-google-jwt-locations]
|
|
109
|
+
* (https://cloud.google.com/endpoints/docs/openapi/openapi-extensions#x-google-jwt-locations) JWT locations can be one of HTTP headers, URL query parameters or cookies. The rule is
|
|
110
|
+
* that the first match wins. If not specified, default to use following 3 locations: 1) Authorization: Bearer 2) x-goog-iap-jwt-assertion 3) access_token query parameter Default
|
|
111
|
+
* locations can be specified as followings: jwt_locations: - header: Authorization value_prefix: "Bearer " - header: x-goog-iap-jwt-assertion - query: access_token
|
|
112
|
+
*/
|
|
113
|
+
jwtLocations?: JwtLocation[];
|
|
114
|
+
}
|
|
115
|
+
interface AuthRequirement {
|
|
116
|
+
/**
|
|
117
|
+
* NOTE: This will be deprecated soon, once AuthProvider.audiences is implemented and accepted in all the runtime components. The list of JWT
|
|
118
|
+
* [audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3). that are allowed to access. A JWT containing any of these audiences will be accepted. When
|
|
119
|
+
* this setting is absent, only JWTs with audience "https://Service_name/API_name" will be accepted. For example, if no audiences are in the setting, LibraryService API will only
|
|
120
|
+
* accept JWTs with the following audience "https://library-example.googleapis.com/google.example.library.v1.LibraryService". Example: audiences:
|
|
121
|
+
* bookstore_android.apps.googleusercontent.com, bookstore_web.apps.googleusercontent.com
|
|
122
|
+
*/
|
|
123
|
+
audiences?: string;
|
|
124
|
+
/** id from authentication provider. Example: provider_id: bookstore_auth */
|
|
125
|
+
providerId?: string;
|
|
126
|
+
}
|
|
127
|
+
interface Backend {
|
|
128
|
+
/** A list of API backend rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
129
|
+
rules?: BackendRule[];
|
|
130
|
+
}
|
|
131
|
+
interface BackendRule {
|
|
132
|
+
/**
|
|
133
|
+
* The address of the API backend. The scheme is used to determine the backend protocol and security. The following schemes are accepted: SCHEME PROTOCOL SECURITY http:// HTTP None
|
|
134
|
+
* https:// HTTP TLS grpc:// gRPC None grpcs:// gRPC TLS It is recommended to explicitly include a scheme. Leaving out the scheme may cause constrasting behaviors across platforms. If
|
|
135
|
+
* the port is unspecified, the default is: - 80 for schemes without TLS - 443 for schemes with TLS For HTTP backends, use protocol to specify the protocol version.
|
|
136
|
+
*/
|
|
137
|
+
address?: string;
|
|
138
|
+
/** The number of seconds to wait for a response from a request. The default varies based on the request protocol and deployment environment. */
|
|
139
|
+
deadline?: number;
|
|
140
|
+
/**
|
|
141
|
+
* When disable_auth is true, a JWT ID token won't be generated and the original "Authorization" HTTP header will be preserved. If the header is used to carry the original token and is
|
|
142
|
+
* expected by the backend, this field must be set to true to preserve the header.
|
|
143
|
+
*/
|
|
144
|
+
disableAuth?: boolean;
|
|
145
|
+
/** The JWT audience is used when generating a JWT ID token for the backend. This ID token will be added in the HTTP "authorization" header, and sent to the backend. */
|
|
146
|
+
jwtAudience?: string;
|
|
147
|
+
/** The number of seconds to wait for the completion of a long running operation. The default is no deadline. */
|
|
148
|
+
operationDeadline?: number;
|
|
149
|
+
pathTranslation?: string;
|
|
150
|
+
/**
|
|
151
|
+
* The protocol used for sending a request to the backend. The supported values are "http/1.1" and "h2". The default value is inferred from the scheme in the address field: SCHEME
|
|
152
|
+
* PROTOCOL http:// http/1.1 https:// http/1.1 grpc:// h2 grpcs:// h2 For secure HTTP backends (https://) that support HTTP/2, set this field to "h2" for improved performance.
|
|
153
|
+
* Configuring this field to non-default values is only supported for secure HTTP backends. This field will be ignored for all other backends. See
|
|
154
|
+
* https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for more details on the supported values.
|
|
155
|
+
*/
|
|
156
|
+
protocol?: string;
|
|
157
|
+
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
158
|
+
selector?: string;
|
|
159
|
+
}
|
|
160
|
+
interface Billing {
|
|
161
|
+
/**
|
|
162
|
+
* Billing configurations for sending metrics to the consumer project. There can be multiple consumer destinations per service, each one must have a different monitored resource type.
|
|
163
|
+
* A metric can be used in at most one consumer destination.
|
|
164
|
+
*/
|
|
165
|
+
consumerDestinations?: BillingDestination[];
|
|
166
|
+
}
|
|
167
|
+
interface BillingDestination {
|
|
168
|
+
/** Names of the metrics to report to this billing destination. Each name must be defined in Service.metrics section. */
|
|
169
|
+
metrics?: string[];
|
|
170
|
+
/** The monitored resource type. The type must be defined in Service.monitored_resources section. */
|
|
171
|
+
monitoredResource?: string;
|
|
172
|
+
}
|
|
173
|
+
interface Binding {
|
|
174
|
+
/**
|
|
175
|
+
* The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`,
|
|
176
|
+
* then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which
|
|
177
|
+
* resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
178
|
+
*/
|
|
179
|
+
condition?: Expr;
|
|
180
|
+
/**
|
|
181
|
+
* Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on
|
|
182
|
+
* the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service
|
|
183
|
+
* account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that
|
|
184
|
+
* represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier
|
|
185
|
+
* for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example,
|
|
186
|
+
* `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. *
|
|
187
|
+
* `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example,
|
|
188
|
+
* `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. *
|
|
189
|
+
* `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example,
|
|
190
|
+
* `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service
|
|
191
|
+
* account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently
|
|
192
|
+
* deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in
|
|
193
|
+
* the binding. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.
|
|
194
|
+
*/
|
|
195
|
+
members?: string[];
|
|
196
|
+
/** Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. */
|
|
197
|
+
role?: string;
|
|
198
|
+
}
|
|
199
|
+
interface ChangeReport {
|
|
200
|
+
/**
|
|
201
|
+
* List of changes between two service configurations. The changes will be alphabetically sorted based on the identifier of each change. A ConfigChange identifier is a dot separated
|
|
202
|
+
* path to the configuration. Example: visibility.rules[selector='LibraryService.CreateBook'].restriction
|
|
203
|
+
*/
|
|
204
|
+
configChanges?: ConfigChange[];
|
|
205
|
+
}
|
|
206
|
+
interface ConfigChange {
|
|
207
|
+
/** Collection of advice provided for this change, useful for determining the possible impact of this change. */
|
|
208
|
+
advices?: Advice[];
|
|
209
|
+
/** The type for this change, either ADDED, REMOVED, or MODIFIED. */
|
|
210
|
+
changeType?: string;
|
|
211
|
+
/**
|
|
212
|
+
* Object hierarchy path to the change, with levels separated by a '.' character. For repeated fields, an applicable unique identifier field is used for the index (usually selector,
|
|
213
|
+
* name, or id). For maps, the term 'key' is used. If the field has no unique identifier, the numeric index is used. Examples: -
|
|
214
|
+
* visibility.rules[selector=="google.LibraryService.ListBooks"].restriction - quota.metric_rules[selector=="google"].metric_costs[key=="reads"].value -
|
|
215
|
+
* logging.producer_destinations[0]
|
|
216
|
+
*/
|
|
217
|
+
element?: string;
|
|
218
|
+
/** Value of the changed object in the new Service configuration, in JSON format. This field will not be populated if ChangeType == REMOVED. */
|
|
219
|
+
newValue?: string;
|
|
220
|
+
/** Value of the changed object in the old Service configuration, in JSON format. This field will not be populated if ChangeType == ADDED. */
|
|
221
|
+
oldValue?: string;
|
|
222
|
+
}
|
|
223
|
+
interface ConfigFile {
|
|
224
|
+
/** The bytes that constitute the file. */
|
|
225
|
+
fileContents?: string;
|
|
226
|
+
/** The file name of the configuration file (full or relative path). */
|
|
227
|
+
filePath?: string;
|
|
228
|
+
/** The type of configuration file this represents. */
|
|
229
|
+
fileType?: string;
|
|
230
|
+
}
|
|
231
|
+
interface ConfigRef {
|
|
232
|
+
/** Resource name of a service config. It must have the following format: "services/{service name}/configs/{config id}". */
|
|
233
|
+
name?: string;
|
|
234
|
+
}
|
|
235
|
+
interface ConfigSource {
|
|
236
|
+
/** Set of source configuration files that are used to generate a service configuration (`google.api.Service`). */
|
|
237
|
+
files?: ConfigFile[];
|
|
238
|
+
/** A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. If empty, the server may choose to generate one instead. */
|
|
239
|
+
id?: string;
|
|
240
|
+
}
|
|
241
|
+
interface Context {
|
|
242
|
+
/** A list of RPC context rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
243
|
+
rules?: ContextRule[];
|
|
244
|
+
}
|
|
245
|
+
interface ContextRule {
|
|
246
|
+
/** A list of full type names or extension IDs of extensions allowed in grpc side channel from client to backend. */
|
|
247
|
+
allowedRequestExtensions?: string[];
|
|
248
|
+
/** A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. */
|
|
249
|
+
allowedResponseExtensions?: string[];
|
|
250
|
+
/** A list of full type names of provided contexts. */
|
|
251
|
+
provided?: string[];
|
|
252
|
+
/** A list of full type names of requested contexts. */
|
|
253
|
+
requested?: string[];
|
|
254
|
+
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
255
|
+
selector?: string;
|
|
256
|
+
}
|
|
257
|
+
interface Control {
|
|
258
|
+
/**
|
|
259
|
+
* The service controller environment to use. If empty, no control plane feature (like quota and billing) will be enabled. The recommended value for most services is
|
|
260
|
+
* servicecontrol.googleapis.com
|
|
261
|
+
*/
|
|
262
|
+
environment?: string;
|
|
263
|
+
}
|
|
264
|
+
interface CustomError {
|
|
265
|
+
/** The list of custom error rules that apply to individual API messages. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
266
|
+
rules?: CustomErrorRule[];
|
|
267
|
+
/** The list of custom error detail types, e.g. 'google.foo.v1.CustomError'. */
|
|
268
|
+
types?: string[];
|
|
269
|
+
}
|
|
270
|
+
interface CustomErrorRule {
|
|
271
|
+
/** Mark this message as possible payload in error response. Otherwise, objects of this type will be filtered when they appear in error payload. */
|
|
272
|
+
isErrorType?: boolean;
|
|
273
|
+
/** Selects messages to which this rule applies. Refer to selector for syntax details. */
|
|
274
|
+
selector?: string;
|
|
275
|
+
}
|
|
276
|
+
interface CustomHttpPattern {
|
|
277
|
+
/** The name of this custom HTTP verb. */
|
|
278
|
+
kind?: string;
|
|
279
|
+
/** The path matched by this custom verb. */
|
|
280
|
+
path?: string;
|
|
281
|
+
}
|
|
282
|
+
// tslint:disable-next-line:no-empty-interface
|
|
283
|
+
interface DeleteServiceStrategy {
|
|
284
|
+
}
|
|
285
|
+
interface Diagnostic {
|
|
286
|
+
/** The kind of diagnostic information provided. */
|
|
287
|
+
kind?: string;
|
|
288
|
+
/** File name and line number of the error or warning. */
|
|
289
|
+
location?: string;
|
|
290
|
+
/** Message describing the error or warning. */
|
|
291
|
+
message?: string;
|
|
292
|
+
}
|
|
293
|
+
interface Documentation {
|
|
294
|
+
/** The URL to the root of documentation. */
|
|
295
|
+
documentationRootUrl?: string;
|
|
296
|
+
/**
|
|
297
|
+
* Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style):
|
|
298
|
+
* documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field.
|
|
299
|
+
*/
|
|
300
|
+
overview?: string;
|
|
301
|
+
/** The top level pages for the documentation set. */
|
|
302
|
+
pages?: Page[];
|
|
303
|
+
/** A list of documentation rules that apply to individual API elements. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
304
|
+
rules?: DocumentationRule[];
|
|
305
|
+
/**
|
|
306
|
+
* Specifies the service root url if the default one (the service name from the yaml file) is not suitable. This can be seen in any fully specified service urls as well as sections
|
|
307
|
+
* that show a base that other urls are relative to.
|
|
308
|
+
*/
|
|
309
|
+
serviceRootUrl?: string;
|
|
310
|
+
/**
|
|
311
|
+
* A short description of what the service does. The summary must be plain text. It becomes the overview of the service displayed in Google Cloud Console. NOTE: This field is
|
|
312
|
+
* equivalent to the standard field `description`.
|
|
313
|
+
*/
|
|
314
|
+
summary?: string;
|
|
315
|
+
}
|
|
316
|
+
interface DocumentationRule {
|
|
317
|
+
/** Deprecation description of the selected element(s). It can be provided if an element is marked as `deprecated`. */
|
|
318
|
+
deprecationDescription?: string;
|
|
319
|
+
/**
|
|
320
|
+
* Description of the selected proto element (e.g. a message, a method, a 'service' definition, or a field). Defaults to leading & trailing comments taken from the proto source
|
|
321
|
+
* definition of the proto element.
|
|
322
|
+
*/
|
|
323
|
+
description?: string;
|
|
324
|
+
/**
|
|
325
|
+
* The selector is a comma-separated list of patterns for any element such as a method, a field, an enum value. Each pattern is a qualified name of the element which may end in "*",
|
|
326
|
+
* indicating a wildcard. Wildcards are only allowed at the end and for a whole component of the qualified name, i.e. "foo.*" is ok, but not "foo.b*" or "foo.*.bar". A wildcard will
|
|
327
|
+
* match one or more components. To specify a default for all applicable elements, the whole pattern "*" is used.
|
|
328
|
+
*/
|
|
329
|
+
selector?: string;
|
|
330
|
+
}
|
|
331
|
+
// tslint:disable-next-line:no-empty-interface
|
|
332
|
+
interface EnableServiceResponse {
|
|
333
|
+
}
|
|
334
|
+
interface Endpoint {
|
|
335
|
+
/**
|
|
336
|
+
* Allowing [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka cross-domain traffic, would allow the backends served from this endpoint to receive and respond to
|
|
337
|
+
* HTTP OPTIONS requests. The response will be used by the browser to determine whether the subsequent cross-origin request is allowed to proceed.
|
|
338
|
+
*/
|
|
339
|
+
allowCors?: boolean;
|
|
340
|
+
/** The canonical name of this endpoint. */
|
|
341
|
+
name?: string;
|
|
342
|
+
/**
|
|
343
|
+
* The specification of an Internet routable address of API frontend that will handle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary). It should be
|
|
344
|
+
* either a valid IPv4 address or a fully-qualified domain name. For example, "8.8.8.8" or "myservice.appspot.com".
|
|
345
|
+
*/
|
|
346
|
+
target?: string;
|
|
347
|
+
}
|
|
348
|
+
interface Enum {
|
|
349
|
+
/** Enum value definitions. */
|
|
350
|
+
enumvalue?: EnumValue[];
|
|
351
|
+
/** Enum type name. */
|
|
352
|
+
name?: string;
|
|
353
|
+
/** Protocol buffer options. */
|
|
354
|
+
options?: Option[];
|
|
355
|
+
/** The source context. */
|
|
356
|
+
sourceContext?: SourceContext;
|
|
357
|
+
/** The source syntax. */
|
|
358
|
+
syntax?: string;
|
|
359
|
+
}
|
|
360
|
+
interface EnumValue {
|
|
361
|
+
/** Enum value name. */
|
|
362
|
+
name?: string;
|
|
363
|
+
/** Enum value number. */
|
|
364
|
+
number?: number;
|
|
365
|
+
/** Protocol buffer options. */
|
|
366
|
+
options?: Option[];
|
|
367
|
+
}
|
|
368
|
+
interface Expr {
|
|
369
|
+
/** Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. */
|
|
370
|
+
description?: string;
|
|
371
|
+
/** Textual representation of an expression in Common Expression Language syntax. */
|
|
372
|
+
expression?: string;
|
|
373
|
+
/** Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. */
|
|
374
|
+
location?: string;
|
|
375
|
+
/** Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. */
|
|
376
|
+
title?: string;
|
|
377
|
+
}
|
|
378
|
+
interface Field {
|
|
379
|
+
/** The field cardinality. */
|
|
380
|
+
cardinality?: string;
|
|
381
|
+
/** The string value of the default value of this field. Proto2 syntax only. */
|
|
382
|
+
defaultValue?: string;
|
|
383
|
+
/** The field JSON name. */
|
|
384
|
+
jsonName?: string;
|
|
385
|
+
/** The field type. */
|
|
386
|
+
kind?: string;
|
|
387
|
+
/** The field name. */
|
|
388
|
+
name?: string;
|
|
389
|
+
/** The field number. */
|
|
390
|
+
number?: number;
|
|
391
|
+
/** The index of the field type in `Type.oneofs`, for message or enumeration types. The first type has index 1; zero means the type is not in the list. */
|
|
392
|
+
oneofIndex?: number;
|
|
393
|
+
/** The protocol buffer options. */
|
|
394
|
+
options?: Option[];
|
|
395
|
+
/** Whether to use alternative packed wire representation. */
|
|
396
|
+
packed?: boolean;
|
|
397
|
+
/** The field type URL, without the scheme, for message or enumeration types. Example: `"type.googleapis.com/google.protobuf.Timestamp"`. */
|
|
398
|
+
typeUrl?: string;
|
|
399
|
+
}
|
|
400
|
+
interface FlowErrorDetails {
|
|
401
|
+
/** The type of exception (as a class name). */
|
|
402
|
+
exceptionType?: string;
|
|
403
|
+
/** The step that failed. */
|
|
404
|
+
flowStepId?: string;
|
|
405
|
+
}
|
|
406
|
+
interface GenerateConfigReportRequest {
|
|
407
|
+
/**
|
|
408
|
+
* Required. Service configuration for which we want to generate the report. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef,
|
|
409
|
+
* google.api.servicemanagement.v1.ConfigSource, and google.api.Service
|
|
410
|
+
*/
|
|
411
|
+
newConfig?: { [P in string]: any };
|
|
412
|
+
/**
|
|
413
|
+
* Optional. Service configuration against which the comparison will be done. For this version of API, the supported types are google.api.servicemanagement.v1.ConfigRef,
|
|
414
|
+
* google.api.servicemanagement.v1.ConfigSource, and google.api.Service
|
|
415
|
+
*/
|
|
416
|
+
oldConfig?: { [P in string]: any };
|
|
417
|
+
}
|
|
418
|
+
interface GenerateConfigReportResponse {
|
|
419
|
+
/** list of ChangeReport, each corresponding to comparison between two service configurations. */
|
|
420
|
+
changeReports?: ChangeReport[];
|
|
421
|
+
/** Errors / Linter warnings associated with the service definition this report belongs to. */
|
|
422
|
+
diagnostics?: Diagnostic[];
|
|
423
|
+
/** ID of the service configuration this report belongs to. */
|
|
424
|
+
id?: string;
|
|
425
|
+
/** Name of the service this report belongs to. */
|
|
426
|
+
serviceName?: string;
|
|
427
|
+
}
|
|
428
|
+
interface GetIamPolicyRequest {
|
|
429
|
+
/** OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`. */
|
|
430
|
+
options?: GetPolicyOptions;
|
|
431
|
+
}
|
|
432
|
+
interface GetPolicyOptions {
|
|
433
|
+
/**
|
|
434
|
+
* Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for
|
|
435
|
+
* policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in
|
|
436
|
+
* the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role
|
|
437
|
+
* bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM
|
|
438
|
+
* documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
439
|
+
*/
|
|
440
|
+
requestedPolicyVersion?: number;
|
|
441
|
+
}
|
|
442
|
+
interface Http {
|
|
443
|
+
/**
|
|
444
|
+
* When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default
|
|
445
|
+
* behavior is to not decode RFC 6570 reserved characters in multi segment matches.
|
|
446
|
+
*/
|
|
447
|
+
fullyDecodeReservedExpansion?: boolean;
|
|
448
|
+
/** A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
449
|
+
rules?: HttpRule[];
|
|
450
|
+
}
|
|
451
|
+
interface HttpRule {
|
|
452
|
+
/** Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). */
|
|
453
|
+
additionalBindings?: HttpRule[];
|
|
454
|
+
/**
|
|
455
|
+
* The name of the request field whose value is mapped to the HTTP request body, or `*` for mapping all request fields not captured by the path pattern to the HTTP body, or omitted for
|
|
456
|
+
* not having any HTTP request body. NOTE: the referred field must be present at the top-level of the request message type.
|
|
457
|
+
*/
|
|
458
|
+
body?: string;
|
|
459
|
+
/**
|
|
460
|
+
* The custom pattern is used for specifying an HTTP method that is not included in the `pattern` field, such as HEAD, or "*" to leave the HTTP method unspecified for this rule. The
|
|
461
|
+
* wild-card rule is useful for services that provide content to Web (HTML) clients.
|
|
462
|
+
*/
|
|
463
|
+
custom?: CustomHttpPattern;
|
|
464
|
+
/** Maps to HTTP DELETE. Used for deleting a resource. */
|
|
465
|
+
delete?: string;
|
|
466
|
+
/** Maps to HTTP GET. Used for listing and getting information about resources. */
|
|
467
|
+
get?: string;
|
|
468
|
+
/** Maps to HTTP PATCH. Used for updating a resource. */
|
|
469
|
+
patch?: string;
|
|
470
|
+
/** Maps to HTTP POST. Used for creating a resource or performing an action. */
|
|
471
|
+
post?: string;
|
|
472
|
+
/** Maps to HTTP PUT. Used for replacing a resource. */
|
|
473
|
+
put?: string;
|
|
474
|
+
/**
|
|
475
|
+
* Optional. The name of the response field whose value is mapped to the HTTP response body. When omitted, the entire response message will be used as the HTTP response body. NOTE: The
|
|
476
|
+
* referred field must be present at the top-level of the response message type.
|
|
477
|
+
*/
|
|
478
|
+
responseBody?: string;
|
|
479
|
+
/** Selects a method to which this rule applies. Refer to selector for syntax details. */
|
|
480
|
+
selector?: string;
|
|
481
|
+
}
|
|
482
|
+
interface JwtLocation {
|
|
483
|
+
/** Specifies cookie name to extract JWT token. */
|
|
484
|
+
cookie?: string;
|
|
485
|
+
/** Specifies HTTP header name to extract JWT token. */
|
|
486
|
+
header?: string;
|
|
487
|
+
/** Specifies URL query parameter name to extract JWT token. */
|
|
488
|
+
query?: string;
|
|
489
|
+
/**
|
|
490
|
+
* The value prefix. The value format is "value_prefix{token}" Only applies to "in" header type. Must be empty for "in" query type. If not empty, the header value has to match (case
|
|
491
|
+
* sensitive) this prefix. If not matched, JWT will not be extracted. If matched, JWT will be extracted after the prefix is removed. For example, for "Authorization: Bearer {JWT}",
|
|
492
|
+
* value_prefix="Bearer " with a space at the end.
|
|
493
|
+
*/
|
|
494
|
+
valuePrefix?: string;
|
|
495
|
+
}
|
|
496
|
+
interface LabelDescriptor {
|
|
497
|
+
/** A human-readable description for the label. */
|
|
498
|
+
description?: string;
|
|
499
|
+
/** The label key. */
|
|
500
|
+
key?: string;
|
|
501
|
+
/** The type of data that can be assigned to the label. */
|
|
502
|
+
valueType?: string;
|
|
503
|
+
}
|
|
504
|
+
interface ListOperationsResponse {
|
|
505
|
+
/** The standard List next-page token. */
|
|
506
|
+
nextPageToken?: string;
|
|
507
|
+
/** A list of operations that matches the specified filter in the request. */
|
|
508
|
+
operations?: Operation[];
|
|
509
|
+
}
|
|
510
|
+
interface ListServiceConfigsResponse {
|
|
511
|
+
/** The token of the next page of results. */
|
|
512
|
+
nextPageToken?: string;
|
|
513
|
+
/** The list of service configuration resources. */
|
|
514
|
+
serviceConfigs?: Service[];
|
|
515
|
+
}
|
|
516
|
+
interface ListServiceRolloutsResponse {
|
|
517
|
+
/** The token of the next page of results. */
|
|
518
|
+
nextPageToken?: string;
|
|
519
|
+
/** The list of rollout resources. */
|
|
520
|
+
rollouts?: Rollout[];
|
|
521
|
+
}
|
|
522
|
+
interface ListServicesResponse {
|
|
523
|
+
/** Token that can be passed to `ListServices` to resume a paginated query. */
|
|
524
|
+
nextPageToken?: string;
|
|
525
|
+
/** The returned services will only have the name field set. */
|
|
526
|
+
services?: ManagedService[];
|
|
527
|
+
}
|
|
528
|
+
interface LogDescriptor {
|
|
529
|
+
/** A human-readable description of this log. This information appears in the documentation and can contain details. */
|
|
530
|
+
description?: string;
|
|
531
|
+
/** The human-readable name for this log. This information appears on the user interface and should be concise. */
|
|
532
|
+
displayName?: string;
|
|
533
|
+
/** The set of labels that are available to describe a specific log entry. Runtime requests that contain labels not specified here are considered invalid. */
|
|
534
|
+
labels?: LabelDescriptor[];
|
|
535
|
+
/**
|
|
536
|
+
* The name of the log. It must be less than 512 characters long and can include the following characters: upper- and lower-case alphanumeric characters [A-Za-z0-9], and punctuation
|
|
537
|
+
* characters including slash, underscore, hyphen, period [/_-.].
|
|
538
|
+
*/
|
|
539
|
+
name?: string;
|
|
540
|
+
}
|
|
541
|
+
interface Logging {
|
|
542
|
+
/**
|
|
543
|
+
* Logging configurations for sending logs to the consumer project. There can be multiple consumer destinations, each one must have a different monitored resource type. A log can be
|
|
544
|
+
* used in at most one consumer destination.
|
|
545
|
+
*/
|
|
546
|
+
consumerDestinations?: LoggingDestination[];
|
|
547
|
+
/**
|
|
548
|
+
* Logging configurations for sending logs to the producer project. There can be multiple producer destinations, each one must have a different monitored resource type. A log can be
|
|
549
|
+
* used in at most one producer destination.
|
|
550
|
+
*/
|
|
551
|
+
producerDestinations?: LoggingDestination[];
|
|
552
|
+
}
|
|
553
|
+
interface LoggingDestination {
|
|
554
|
+
/**
|
|
555
|
+
* Names of the logs to be sent to this destination. Each name must be defined in the Service.logs section. If the log name is not a domain scoped name, it will be automatically
|
|
556
|
+
* prefixed with the service name followed by "/".
|
|
557
|
+
*/
|
|
558
|
+
logs?: string[];
|
|
559
|
+
/** The monitored resource type. The type must be defined in the Service.monitored_resources section. */
|
|
560
|
+
monitoredResource?: string;
|
|
561
|
+
}
|
|
562
|
+
interface ManagedService {
|
|
563
|
+
/** ID of the project that produces and owns this service. */
|
|
564
|
+
producerProjectId?: string;
|
|
565
|
+
/** The name of the service. See the [overview](https://cloud.google.com/service-infrastructure/docs/overview) for naming requirements. */
|
|
566
|
+
serviceName?: string;
|
|
567
|
+
}
|
|
568
|
+
interface Method {
|
|
569
|
+
/** The simple name of this method. */
|
|
570
|
+
name?: string;
|
|
571
|
+
/** Any metadata attached to the method. */
|
|
572
|
+
options?: Option[];
|
|
573
|
+
/** If true, the request is streamed. */
|
|
574
|
+
requestStreaming?: boolean;
|
|
575
|
+
/** A URL of the input message type. */
|
|
576
|
+
requestTypeUrl?: string;
|
|
577
|
+
/** If true, the response is streamed. */
|
|
578
|
+
responseStreaming?: boolean;
|
|
579
|
+
/** The URL of the output message type. */
|
|
580
|
+
responseTypeUrl?: string;
|
|
581
|
+
/** The source syntax of this method. */
|
|
582
|
+
syntax?: string;
|
|
583
|
+
}
|
|
584
|
+
interface MetricDescriptor {
|
|
585
|
+
/** A detailed description of the metric, which can be used in documentation. */
|
|
586
|
+
description?: string;
|
|
587
|
+
/**
|
|
588
|
+
* A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example "Request count". This field is optional but it is
|
|
589
|
+
* recommended to be set for any metrics associated with user-visible concepts, such as Quota.
|
|
590
|
+
*/
|
|
591
|
+
displayName?: string;
|
|
592
|
+
/**
|
|
593
|
+
* The set of labels that can be used to describe a specific instance of this metric type. For example, the `appengine.googleapis.com/http/server/response_latencies` metric type has a
|
|
594
|
+
* label for the HTTP response code, `response_code`, so you can look at latencies for successful responses or just for responses that failed.
|
|
595
|
+
*/
|
|
596
|
+
labels?: LabelDescriptor[];
|
|
597
|
+
/** Optional. The launch stage of the metric definition. */
|
|
598
|
+
launchStage?: string;
|
|
599
|
+
/** Optional. Metadata which can be used to guide usage of the metric. */
|
|
600
|
+
metadata?: MetricDescriptorMetadata;
|
|
601
|
+
/** Whether the metric records instantaneous values, changes to a value, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
|
|
602
|
+
metricKind?: string;
|
|
603
|
+
/**
|
|
604
|
+
* Read-only. If present, then a time series, which is identified partially by a metric type and a MonitoredResourceDescriptor, that is associated with this metric type can only be
|
|
605
|
+
* associated with one of the monitored resource types listed here.
|
|
606
|
+
*/
|
|
607
|
+
monitoredResourceTypes?: string[];
|
|
608
|
+
/** The resource name of the metric descriptor. */
|
|
609
|
+
name?: string;
|
|
610
|
+
/**
|
|
611
|
+
* The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined metric types have the DNS name `custom.googleapis.com` or `external.googleapis.com`.
|
|
612
|
+
* Metric types should use a natural hierarchical grouping. For example: "custom.googleapis.com/invoice/paid/amount" "external.googleapis.com/prometheus/up"
|
|
613
|
+
* "appengine.googleapis.com/http/server/response_latencies"
|
|
614
|
+
*/
|
|
615
|
+
type?: string;
|
|
616
|
+
/**
|
|
617
|
+
* The units in which the metric value is reported. It is only applicable if the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The `unit` defines the representation of the
|
|
618
|
+
* stored metric values. Different systems might scale the values to be more easily displayed (so a value of `0.02kBy` _might_ be displayed as `20By`, and a value of `3523kBy` _might_
|
|
619
|
+
* be displayed as `3.5MBy`). However, if the `unit` is `kBy`, then the value of the metric is always in thousands of bytes, no matter how it might be displayed. If you want a custom
|
|
620
|
+
* metric to record the exact number of CPU-seconds used by a job, you can create an `INT64 CUMULATIVE` metric whose `unit` is `s{CPU}` (or equivalently `1s{CPU}` or just `s`). If the
|
|
621
|
+
* job uses 12,005 CPU-seconds, then the value is written as `12005`. Alternatively, if you want a custom metric to record data in a more granular way, you can create a `DOUBLE
|
|
622
|
+
* CUMULATIVE` metric whose `unit` is `ks{CPU}`, and then write the value `12.005` (which is `12005/1000`), or use `Kis{CPU}` and write `11.723` (which is `12005/1024`). The supported
|
|
623
|
+
* units are a subset of [The Unified Code for Units of Measure](https://unitsofmeasure.org/ucum.html) standard: **Basic units (UNIT)** * `bit` bit * `By` byte * `s` second * `min`
|
|
624
|
+
* minute * `h` hour * `d` day * `1` dimensionless **Prefixes (PREFIX)** * `k` kilo (10^3) * `M` mega (10^6) * `G` giga (10^9) * `T` tera (10^12) * `P` peta (10^15) * `E` exa (10^18) *
|
|
625
|
+
* `Z` zetta (10^21) * `Y` yotta (10^24) * `m` milli (10^-3) * `u` micro (10^-6) * `n` nano (10^-9) * `p` pico (10^-12) * `f` femto (10^-15) * `a` atto (10^-18) * `z` zepto (10^-21) *
|
|
626
|
+
* `y` yocto (10^-24) * `Ki` kibi (2^10) * `Mi` mebi (2^20) * `Gi` gibi (2^30) * `Ti` tebi (2^40) * `Pi` pebi (2^50) **Grammar** The grammar also includes these connectors: * `/`
|
|
627
|
+
* division or ratio (as an infix operator). For examples, `kBy/{email}` or `MiBy/10ms` (although you should almost never have `/s` in a metric `unit`; rates should always be computed
|
|
628
|
+
* at query time from the underlying cumulative or delta value). * `.` multiplication or composition (as an infix operator). For examples, `GBy.d` or `k{watt}.h`. The grammar for a
|
|
629
|
+
* unit is as follows: Expression = Component { "." Component } { "/" Component } ; Component = ( [ PREFIX ] UNIT | "%" ) [ Annotation ] | Annotation | "1" ; Annotation = "{" NAME "}"
|
|
630
|
+
* ; Notes: * `Annotation` is just a comment if it follows a `UNIT`. If the annotation is used alone, then the unit is equivalent to `1`. For examples, `{request}/s == 1/s`,
|
|
631
|
+
* `By{transmitted}/s == By/s`. * `NAME` is a sequence of non-blank printable ASCII characters not containing `{` or `}`. * `1` represents a unitary [dimensionless
|
|
632
|
+
* unit](https://en.wikipedia.org/wiki/Dimensionless_quantity) of 1, such as in `1/s`. It is typically used when none of the basic units are appropriate. For example, "new users per
|
|
633
|
+
* day" can be represented as `1/d` or `{new-users}/d` (and a metric value `5` would mean "5 new users). Alternatively, "thousands of page views per day" would be represented as
|
|
634
|
+
* `1000/d` or `k1/d` or `k{page_views}/d` (and a metric value of `5.3` would mean "5300 page views per day"). * `%` represents dimensionless value of 1/100, and annotates values
|
|
635
|
+
* giving a percentage (so the metric values are typically in the range of 0..100, and a metric value `3` means "3 percent"). * `10^2.%` indicates a metric contains a ratio, typically
|
|
636
|
+
* in the range 0..1, that will be multiplied by 100 and displayed as a percentage (so a metric value `0.03` means "3 percent").
|
|
637
|
+
*/
|
|
638
|
+
unit?: string;
|
|
639
|
+
/** Whether the measurement is an integer, a floating-point number, etc. Some combinations of `metric_kind` and `value_type` might not be supported. */
|
|
640
|
+
valueType?: string;
|
|
641
|
+
}
|
|
642
|
+
interface MetricDescriptorMetadata {
|
|
643
|
+
/** The delay of data points caused by ingestion. Data points older than this age are guaranteed to be ingested and available to be read, excluding data loss due to errors. */
|
|
644
|
+
ingestDelay?: string;
|
|
645
|
+
/** Deprecated. Must use the MetricDescriptor.launch_stage instead. */
|
|
646
|
+
launchStage?: string;
|
|
647
|
+
/**
|
|
648
|
+
* The sampling period of metric data points. For metrics which are written periodically, consecutive data points are stored at this time interval, excluding data loss due to errors.
|
|
649
|
+
* Metrics with a higher granularity have a smaller sampling period.
|
|
650
|
+
*/
|
|
651
|
+
samplePeriod?: string;
|
|
652
|
+
}
|
|
653
|
+
interface MetricRule {
|
|
654
|
+
/**
|
|
655
|
+
* Metrics to update when the selected methods are called, and the associated cost applied to each metric. The key of the map is the metric name, and the values are the amount
|
|
656
|
+
* increased for the metric against which the quota limits are defined. The value must not be negative.
|
|
657
|
+
*/
|
|
658
|
+
metricCosts?: { [P in string]: string };
|
|
659
|
+
/** Selects the methods to which this rule applies. Refer to selector for syntax details. */
|
|
660
|
+
selector?: string;
|
|
661
|
+
}
|
|
662
|
+
interface Mixin {
|
|
663
|
+
/** The fully qualified name of the interface which is included. */
|
|
664
|
+
name?: string;
|
|
665
|
+
/** If non-empty specifies a path under which inherited HTTP paths are rooted. */
|
|
666
|
+
root?: string;
|
|
667
|
+
}
|
|
668
|
+
interface MonitoredResourceDescriptor {
|
|
669
|
+
/** Optional. A detailed description of the monitored resource type that might be used in documentation. */
|
|
670
|
+
description?: string;
|
|
671
|
+
/**
|
|
672
|
+
* Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other
|
|
673
|
+
* determiners. For example, `"Google Cloud SQL Database"`.
|
|
674
|
+
*/
|
|
675
|
+
displayName?: string;
|
|
676
|
+
/**
|
|
677
|
+
* Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels
|
|
678
|
+
* `"database_id"` and `"zone"`.
|
|
679
|
+
*/
|
|
680
|
+
labels?: LabelDescriptor[];
|
|
681
|
+
/** Optional. The launch stage of the monitored resource definition. */
|
|
682
|
+
launchStage?: string;
|
|
683
|
+
/**
|
|
684
|
+
* Optional. The resource name of the monitored resource descriptor: `"projects/{project_id}/monitoredResourceDescriptors/{type}"` where {type} is the value of the `type` field in this
|
|
685
|
+
* object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format
|
|
686
|
+
* `"monitoredResourceDescriptors/{type}"`.
|
|
687
|
+
*/
|
|
688
|
+
name?: string;
|
|
689
|
+
/**
|
|
690
|
+
* Required. The monitored resource type. For example, the type `"cloudsql_database"` represents databases in Google Cloud SQL. For a list of types, see [Monitoring resource
|
|
691
|
+
* types](https://cloud.google.com/monitoring/api/resources) and [Logging resource types](https://cloud.google.com/logging/docs/api/v2/resource-list).
|
|
692
|
+
*/
|
|
693
|
+
type?: string;
|
|
694
|
+
}
|
|
695
|
+
interface Monitoring {
|
|
696
|
+
/**
|
|
697
|
+
* Monitoring configurations for sending metrics to the consumer project. There can be multiple consumer destinations. A monitored resource type may appear in multiple monitoring
|
|
698
|
+
* destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used
|
|
699
|
+
* once in the Monitoring configuration.
|
|
700
|
+
*/
|
|
701
|
+
consumerDestinations?: MonitoringDestination[];
|
|
702
|
+
/**
|
|
703
|
+
* Monitoring configurations for sending metrics to the producer project. There can be multiple producer destinations. A monitored resource type may appear in multiple monitoring
|
|
704
|
+
* destinations if different aggregations are needed for different sets of metrics associated with that monitored resource type. A monitored resource and metric pair may only be used
|
|
705
|
+
* once in the Monitoring configuration.
|
|
706
|
+
*/
|
|
707
|
+
producerDestinations?: MonitoringDestination[];
|
|
708
|
+
}
|
|
709
|
+
interface MonitoringDestination {
|
|
710
|
+
/** Types of the metrics to report to this monitoring destination. Each type must be defined in Service.metrics section. */
|
|
711
|
+
metrics?: string[];
|
|
712
|
+
/** The monitored resource type. The type must be defined in Service.monitored_resources section. */
|
|
713
|
+
monitoredResource?: string;
|
|
714
|
+
}
|
|
715
|
+
interface OAuthRequirements {
|
|
716
|
+
/**
|
|
717
|
+
* The list of publicly documented OAuth scopes that are allowed access. An OAuth token containing any of these scopes will be accepted. Example: canonical_scopes:
|
|
718
|
+
* https://www.googleapis.com/auth/calendar, https://www.googleapis.com/auth/calendar.read
|
|
719
|
+
*/
|
|
720
|
+
canonicalScopes?: string;
|
|
721
|
+
}
|
|
722
|
+
interface Operation {
|
|
723
|
+
/** 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. */
|
|
724
|
+
done?: boolean;
|
|
725
|
+
/** The error result of the operation in case of failure or cancellation. */
|
|
726
|
+
error?: Status;
|
|
727
|
+
/**
|
|
728
|
+
* 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
|
|
729
|
+
* metadata. Any method that returns a long-running operation should document the metadata type, if any.
|
|
730
|
+
*/
|
|
731
|
+
metadata?: { [P in string]: any };
|
|
732
|
+
/**
|
|
733
|
+
* 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
|
|
734
|
+
* with `operations/{unique_id}`.
|
|
735
|
+
*/
|
|
736
|
+
name?: string;
|
|
737
|
+
/**
|
|
738
|
+
* The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the
|
|
739
|
+
* 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
|
|
740
|
+
* original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
|
|
741
|
+
*/
|
|
742
|
+
response?: { [P in string]: any };
|
|
743
|
+
}
|
|
744
|
+
interface OperationInfo {
|
|
745
|
+
/**
|
|
746
|
+
* Required. The message name of the metadata type for this long-running operation. If the response is in a different package from the rpc, a fully-qualified message name must be used
|
|
747
|
+
* (e.g. `google.protobuf.Struct`). Note: Altering this value constitutes a breaking change.
|
|
748
|
+
*/
|
|
749
|
+
metadataType?: string;
|
|
750
|
+
/**
|
|
751
|
+
* Required. The message name of the primary return type for this long-running operation. This type will be used to deserialize the LRO's response. If the response is in a different
|
|
752
|
+
* package from the rpc, a fully-qualified message name must be used (e.g. `google.protobuf.Struct`). Note: Altering this value constitutes a breaking change.
|
|
753
|
+
*/
|
|
754
|
+
responseType?: string;
|
|
755
|
+
}
|
|
756
|
+
interface OperationMetadata {
|
|
757
|
+
/** Percentage of completion of this operation, ranging from 0 to 100. */
|
|
758
|
+
progressPercentage?: number;
|
|
759
|
+
/** The full name of the resources that this operation is directly associated with. */
|
|
760
|
+
resourceNames?: string[];
|
|
761
|
+
/** The start time of the operation. */
|
|
762
|
+
startTime?: string;
|
|
763
|
+
/** Detailed status information for each step. The order is undetermined. */
|
|
764
|
+
steps?: Step[];
|
|
765
|
+
}
|
|
766
|
+
interface Option {
|
|
767
|
+
/**
|
|
768
|
+
* The option's name. For protobuf built-in options (options defined in descriptor.proto), this is the short name. For example, `"map_entry"`. For custom options, it should be the
|
|
769
|
+
* fully-qualified name. For example, `"google.api.http"`.
|
|
770
|
+
*/
|
|
771
|
+
name?: string;
|
|
772
|
+
/**
|
|
773
|
+
* The option's value packed in an Any message. If the value is a primitive, the corresponding wrapper type defined in google/protobuf/wrappers.proto should be used. If the value is an
|
|
774
|
+
* enum, it should be stored as an int32 value using the google.protobuf.Int32Value type.
|
|
775
|
+
*/
|
|
776
|
+
value?: { [P in string]: any };
|
|
777
|
+
}
|
|
778
|
+
interface Page {
|
|
779
|
+
/**
|
|
780
|
+
* The Markdown content of the page. You can use (== include {path} ==) to include content from a Markdown file. The content can be used to produce the documentation page such as HTML
|
|
781
|
+
* format page.
|
|
782
|
+
*/
|
|
783
|
+
content?: string;
|
|
784
|
+
/**
|
|
785
|
+
* The name of the page. It will be used as an identity of the page to generate URI of the page, text of the link to this page in navigation, etc. The full page name (start from the
|
|
786
|
+
* root page name to this page concatenated with `.`) can be used as reference to the page in your documentation. For example: pages: - name: Tutorial content: (== include tutorial.md
|
|
787
|
+
* ==) subpages: - name: Java content: (== include tutorial_java.md ==) You can reference `Java` page using Markdown reference link syntax: `Java`.
|
|
788
|
+
*/
|
|
789
|
+
name?: string;
|
|
790
|
+
/** Subpages of this page. The order of subpages specified here will be honored in the generated docset. */
|
|
791
|
+
subpages?: Page[];
|
|
792
|
+
}
|
|
793
|
+
interface Policy {
|
|
794
|
+
/** Specifies cloud audit logging configuration for this policy. */
|
|
795
|
+
auditConfigs?: AuditConfig[];
|
|
796
|
+
/**
|
|
797
|
+
* Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings`
|
|
798
|
+
* must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a
|
|
799
|
+
* principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another
|
|
800
|
+
* 1,450 principals to the `bindings` in the `Policy`.
|
|
801
|
+
*/
|
|
802
|
+
bindings?: Binding[];
|
|
803
|
+
/**
|
|
804
|
+
* `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make
|
|
805
|
+
* use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems
|
|
806
|
+
* are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM
|
|
807
|
+
* Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
808
|
+
* policy, and all of the conditions in the version `3` policy are lost.
|
|
809
|
+
*/
|
|
810
|
+
etag?: string;
|
|
811
|
+
/**
|
|
812
|
+
* Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings
|
|
813
|
+
* must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a
|
|
814
|
+
* policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use
|
|
815
|
+
* IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1`
|
|
816
|
+
* policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave
|
|
817
|
+
* the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).
|
|
818
|
+
*/
|
|
819
|
+
version?: number;
|
|
820
|
+
}
|
|
821
|
+
interface Quota {
|
|
822
|
+
/** List of `QuotaLimit` definitions for the service. */
|
|
823
|
+
limits?: QuotaLimit[];
|
|
824
|
+
/** List of `MetricRule` definitions, each one mapping a selected method to one or more metrics. */
|
|
825
|
+
metricRules?: MetricRule[];
|
|
826
|
+
}
|
|
827
|
+
interface QuotaLimit {
|
|
828
|
+
/**
|
|
829
|
+
* Default number of tokens that can be consumed during the specified duration. This is the number of tokens assigned when a client application developer activates the service for
|
|
830
|
+
* his/her project. Specifying a value of 0 will block all requests. This can be used if you are provisioning quota to selected consumers and blocking others. Similarly, a value of -1
|
|
831
|
+
* will indicate an unlimited quota. No other negative values are allowed. Used by group-based quotas only.
|
|
832
|
+
*/
|
|
833
|
+
defaultLimit?: string;
|
|
834
|
+
/**
|
|
835
|
+
* Optional. User-visible, extended description for this quota limit. Should be used only when more context is needed to understand this limit than provided by the limit's display name
|
|
836
|
+
* (see: `display_name`).
|
|
837
|
+
*/
|
|
838
|
+
description?: string;
|
|
839
|
+
/**
|
|
840
|
+
* User-visible display name for this limit. Optional. If not set, the UI will provide a default display name based on the quota configuration. This field can be used to override the
|
|
841
|
+
* default display name generated from the configuration.
|
|
842
|
+
*/
|
|
843
|
+
displayName?: string;
|
|
844
|
+
/** Duration of this limit in textual notation. Must be "100s" or "1d". Used by group-based quotas only. */
|
|
845
|
+
duration?: string;
|
|
846
|
+
/**
|
|
847
|
+
* Free tier value displayed in the Developers Console for this limit. The free tier is the number of tokens that will be subtracted from the billed amount when billing is enabled.
|
|
848
|
+
* This field can only be set on a limit with duration "1d", in a billable group; it is invalid on any other limit. If this field is not set, it defaults to 0, indicating that there is
|
|
849
|
+
* no free tier for this service. Used by group-based quotas only.
|
|
850
|
+
*/
|
|
851
|
+
freeTier?: string;
|
|
852
|
+
/**
|
|
853
|
+
* Maximum number of tokens that can be consumed during the specified duration. Client application developers can override the default limit up to this maximum. If specified, this
|
|
854
|
+
* value cannot be set to a value less than the default limit. If not specified, it is set to the default limit. To allow clients to apply overrides with no upper bound, set this to
|
|
855
|
+
* -1, indicating unlimited maximum quota. Used by group-based quotas only.
|
|
856
|
+
*/
|
|
857
|
+
maxLimit?: string;
|
|
858
|
+
/**
|
|
859
|
+
* The name of the metric this quota limit applies to. The quota limits with the same metric will be checked together during runtime. The metric must be defined within the service
|
|
860
|
+
* config.
|
|
861
|
+
*/
|
|
862
|
+
metric?: string;
|
|
863
|
+
/**
|
|
864
|
+
* Name of the quota limit. The name must be provided, and it must be unique within the service. The name can only include alphanumeric characters as well as '-'. The maximum length of
|
|
865
|
+
* the limit name is 64 characters.
|
|
866
|
+
*/
|
|
867
|
+
name?: string;
|
|
868
|
+
/**
|
|
869
|
+
* Specify the unit of the quota limit. It uses the same syntax as Metric.unit. The supported unit kinds are determined by the quota backend system. Here are some examples: *
|
|
870
|
+
* "1/min/{project}" for quota per minute per project. Note: the order of unit components is insignificant. The "1" at the beginning is required to follow the metric unit syntax.
|
|
871
|
+
*/
|
|
872
|
+
unit?: string;
|
|
873
|
+
/**
|
|
874
|
+
* Tiered limit values. You must specify this as a key:value pair, with an integer value that is the maximum number of requests allowed for the specified unit. Currently only STANDARD
|
|
875
|
+
* is supported.
|
|
876
|
+
*/
|
|
877
|
+
values?: { [P in string]: string };
|
|
878
|
+
}
|
|
879
|
+
interface ResourceReference {
|
|
880
|
+
/**
|
|
881
|
+
* The resource type of a child collection that the annotated field references. This is useful for annotating the `parent` field that doesn't have a fixed resource type. Example:
|
|
882
|
+
* message ListLogEntriesRequest { string parent = 1 [(google.api.resource_reference) = { child_type: "logging.googleapis.com/LogEntry" }; }
|
|
883
|
+
*/
|
|
884
|
+
childType?: string;
|
|
885
|
+
/**
|
|
886
|
+
* The resource type that the annotated field references. Example: message Subscription { string topic = 2 [(google.api.resource_reference) = { type: "pubsub.googleapis.com/Topic" }];
|
|
887
|
+
* } Occasionally, a field may reference an arbitrary resource. In this case, APIs use the special value * in their resource reference. Example: message GetIamPolicyRequest { string
|
|
888
|
+
* resource = 2 [(google.api.resource_reference) = { type: "*" }]; }
|
|
889
|
+
*/
|
|
890
|
+
type?: string;
|
|
891
|
+
}
|
|
892
|
+
interface Rollout {
|
|
893
|
+
/** The user who created the Rollout. Readonly. */
|
|
894
|
+
createdBy?: string;
|
|
895
|
+
/** Creation time of the rollout. Readonly. */
|
|
896
|
+
createTime?: string;
|
|
897
|
+
/** The strategy associated with a rollout to delete a `ManagedService`. Readonly. */
|
|
898
|
+
deleteServiceStrategy?: any;
|
|
899
|
+
/**
|
|
900
|
+
* Optional. Unique identifier of this Rollout. Must be no longer than 63 characters and only lower case letters, digits, '.', '_' and '-' are allowed. If not specified by client, the
|
|
901
|
+
* server will generate one. The generated id will have the form of , where "date" is the create date in ISO 8601 format. "revision number" is a monotonically increasing positive
|
|
902
|
+
* number that is reset every day for each service. An example of the generated rollout_id is '2016-02-16r1'
|
|
903
|
+
*/
|
|
904
|
+
rolloutId?: string;
|
|
905
|
+
/** The name of the service associated with this Rollout. */
|
|
906
|
+
serviceName?: string;
|
|
907
|
+
/** The status of this rollout. Readonly. In case of a failed rollout, the system will automatically rollback to the current Rollout version. Readonly. */
|
|
908
|
+
status?: string;
|
|
909
|
+
/** Google Service Control selects service configurations based on traffic percentage. */
|
|
910
|
+
trafficPercentStrategy?: TrafficPercentStrategy;
|
|
911
|
+
}
|
|
912
|
+
interface Service {
|
|
913
|
+
/**
|
|
914
|
+
* A list of API interfaces exported by this service. Only the `name` field of the google.protobuf.Api needs to be provided by the configuration author, as the remaining fields will be
|
|
915
|
+
* derived from the IDL during the normalization process. It is an error to specify an API interface here which cannot be resolved against the associated IDL files.
|
|
916
|
+
*/
|
|
917
|
+
apis?: Api[];
|
|
918
|
+
/** Auth configuration. */
|
|
919
|
+
authentication?: Authentication;
|
|
920
|
+
/** API backend configuration. */
|
|
921
|
+
backend?: Backend;
|
|
922
|
+
/** Billing configuration. */
|
|
923
|
+
billing?: Billing;
|
|
924
|
+
/** Obsolete. Do not use. This field has no semantic meaning. The service config compiler always sets this field to `3`. */
|
|
925
|
+
configVersion?: number;
|
|
926
|
+
/** Context configuration. */
|
|
927
|
+
context?: Context;
|
|
928
|
+
/** Configuration for the service control plane. */
|
|
929
|
+
control?: Control;
|
|
930
|
+
/** Custom error configuration. */
|
|
931
|
+
customError?: CustomError;
|
|
932
|
+
/** Additional API documentation. */
|
|
933
|
+
documentation?: Documentation;
|
|
934
|
+
/** Configuration for network endpoints. If this is empty, then an endpoint with the same name as the service is automatically generated to service all defined APIs. */
|
|
935
|
+
endpoints?: Endpoint[];
|
|
936
|
+
/**
|
|
937
|
+
* A list of all enum types included in this API service. Enums referenced directly or indirectly by the `apis` are automatically included. Enums which are not referenced but shall be
|
|
938
|
+
* included should be listed here by name by the configuration author. Example: enums: - name: google.someapi.v1.SomeEnum
|
|
939
|
+
*/
|
|
940
|
+
enums?: Enum[];
|
|
941
|
+
/** HTTP configuration. */
|
|
942
|
+
http?: Http;
|
|
943
|
+
/**
|
|
944
|
+
* A unique ID for a specific instance of this message, typically assigned by the client for tracking purpose. Must be no longer than 63 characters and only lower case letters, digits,
|
|
945
|
+
* '.', '_' and '-' are allowed. If empty, the server may choose to generate one instead.
|
|
946
|
+
*/
|
|
947
|
+
id?: string;
|
|
948
|
+
/** Logging configuration. */
|
|
949
|
+
logging?: Logging;
|
|
950
|
+
/** Defines the logs used by this service. */
|
|
951
|
+
logs?: LogDescriptor[];
|
|
952
|
+
/** Defines the metrics used by this service. */
|
|
953
|
+
metrics?: MetricDescriptor[];
|
|
954
|
+
/** Defines the monitored resources used by this service. This is required by the Service.monitoring and Service.logging configurations. */
|
|
955
|
+
monitoredResources?: MonitoredResourceDescriptor[];
|
|
956
|
+
/** Monitoring configuration. */
|
|
957
|
+
monitoring?: Monitoring;
|
|
958
|
+
/**
|
|
959
|
+
* The service name, which is a DNS-like logical identifier for the service, such as `calendar.googleapis.com`. The service name typically goes through DNS verification to make sure
|
|
960
|
+
* the owner of the service also owns the DNS name.
|
|
961
|
+
*/
|
|
962
|
+
name?: string;
|
|
963
|
+
/** The Google project that owns this service. */
|
|
964
|
+
producerProjectId?: string;
|
|
965
|
+
/** Quota configuration. */
|
|
966
|
+
quota?: Quota;
|
|
967
|
+
/** Output only. The source information for this configuration if available. */
|
|
968
|
+
sourceInfo?: SourceInfo;
|
|
969
|
+
/** System parameter configuration. */
|
|
970
|
+
systemParameters?: SystemParameters;
|
|
971
|
+
/**
|
|
972
|
+
* A list of all proto message types included in this API service. It serves similar purpose as [google.api.Service.types], except that these types are not needed by user-defined APIs.
|
|
973
|
+
* Therefore, they will not show up in the generated discovery doc. This field should only be used to define system APIs in ESF.
|
|
974
|
+
*/
|
|
975
|
+
systemTypes?: Type[];
|
|
976
|
+
/** The product title for this service, it is the name displayed in Google Cloud Console. */
|
|
977
|
+
title?: string;
|
|
978
|
+
/**
|
|
979
|
+
* A list of all proto message types included in this API service. Types referenced directly or indirectly by the `apis` are automatically included. Messages which are not referenced
|
|
980
|
+
* but shall be included, such as types used by the `google.protobuf.Any` type, should be listed here by name by the configuration author. Example: types: - name: google.protobuf.Int32
|
|
981
|
+
*/
|
|
982
|
+
types?: Type[];
|
|
983
|
+
/** Configuration controlling usage of this service. */
|
|
984
|
+
usage?: Usage;
|
|
985
|
+
}
|
|
986
|
+
interface SetIamPolicyRequest {
|
|
987
|
+
/**
|
|
988
|
+
* REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud
|
|
989
|
+
* services (such as Projects) might reject them.
|
|
990
|
+
*/
|
|
991
|
+
policy?: Policy;
|
|
992
|
+
/**
|
|
993
|
+
* OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:
|
|
994
|
+
* `paths: "bindings, etag"`
|
|
995
|
+
*/
|
|
996
|
+
updateMask?: string;
|
|
997
|
+
}
|
|
998
|
+
interface SourceContext {
|
|
999
|
+
/** The path-qualified name of the .proto file that contained the associated protobuf element. For example: `"google/protobuf/source_context.proto"`. */
|
|
1000
|
+
fileName?: string;
|
|
1001
|
+
}
|
|
1002
|
+
interface SourceInfo {
|
|
1003
|
+
/** All files used during config generation. */
|
|
1004
|
+
sourceFiles?: Array<{ [P in string]: any }>;
|
|
1005
|
+
}
|
|
1006
|
+
interface Status {
|
|
1007
|
+
/** The status code, which should be an enum value of google.rpc.Code. */
|
|
1008
|
+
code?: number;
|
|
1009
|
+
/** A list of messages that carry the error details. There is a common set of message types for APIs to use. */
|
|
1010
|
+
details?: Array<{ [P in string]: any }>;
|
|
1011
|
+
/**
|
|
1012
|
+
* 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
|
|
1013
|
+
* client.
|
|
1014
|
+
*/
|
|
1015
|
+
message?: string;
|
|
1016
|
+
}
|
|
1017
|
+
interface Step {
|
|
1018
|
+
/** The short description of the step. */
|
|
1019
|
+
description?: string;
|
|
1020
|
+
/** The status code. */
|
|
1021
|
+
status?: string;
|
|
1022
|
+
}
|
|
1023
|
+
interface SubmitConfigSourceRequest {
|
|
1024
|
+
/** Required. The source configuration for the service. */
|
|
1025
|
+
configSource?: ConfigSource;
|
|
1026
|
+
/**
|
|
1027
|
+
* Optional. If set, this will result in the generation of a `google.api.Service` configuration based on the `ConfigSource` provided, but the generated config and the sources will NOT
|
|
1028
|
+
* be persisted.
|
|
1029
|
+
*/
|
|
1030
|
+
validateOnly?: boolean;
|
|
1031
|
+
}
|
|
1032
|
+
interface SubmitConfigSourceResponse {
|
|
1033
|
+
/** The generated service configuration. */
|
|
1034
|
+
serviceConfig?: Service;
|
|
1035
|
+
}
|
|
1036
|
+
interface SystemParameter {
|
|
1037
|
+
/** Define the HTTP header name to use for the parameter. It is case insensitive. */
|
|
1038
|
+
httpHeader?: string;
|
|
1039
|
+
/** Define the name of the parameter, such as "api_key" . It is case sensitive. */
|
|
1040
|
+
name?: string;
|
|
1041
|
+
/** Define the URL query parameter name to use for the parameter. It is case sensitive. */
|
|
1042
|
+
urlQueryParameter?: string;
|
|
1043
|
+
}
|
|
1044
|
+
interface SystemParameterRule {
|
|
1045
|
+
/**
|
|
1046
|
+
* Define parameters. Multiple names may be defined for a parameter. For a given method call, only one of them should be used. If multiple names are used the behavior is
|
|
1047
|
+
* implementation-dependent. If none of the specified names are present the behavior is parameter-dependent.
|
|
1048
|
+
*/
|
|
1049
|
+
parameters?: SystemParameter[];
|
|
1050
|
+
/** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
|
|
1051
|
+
selector?: string;
|
|
1052
|
+
}
|
|
1053
|
+
interface SystemParameters {
|
|
1054
|
+
/**
|
|
1055
|
+
* Define system parameters. The parameters defined here will override the default parameters implemented by the system. If this field is missing from the service config, default
|
|
1056
|
+
* system parameters will be used. Default system parameters and names is implementation-dependent. Example: define api key for all methods system_parameters rules: - selector: "*"
|
|
1057
|
+
* parameters: - name: api_key url_query_parameter: api_key Example: define 2 api key names for a specific method. system_parameters rules: - selector: "/ListShelves" parameters: -
|
|
1058
|
+
* name: api_key http_header: Api-Key1 - name: api_key http_header: Api-Key2 **NOTE:** All service configuration rules follow "last one wins" order.
|
|
1059
|
+
*/
|
|
1060
|
+
rules?: SystemParameterRule[];
|
|
1061
|
+
}
|
|
1062
|
+
interface TestIamPermissionsRequest {
|
|
1063
|
+
/**
|
|
1064
|
+
* The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM
|
|
1065
|
+
* Overview](https://cloud.google.com/iam/docs/overview#permissions).
|
|
1066
|
+
*/
|
|
1067
|
+
permissions?: string[];
|
|
1068
|
+
}
|
|
1069
|
+
interface TestIamPermissionsResponse {
|
|
1070
|
+
/** A subset of `TestPermissionsRequest.permissions` that the caller is allowed. */
|
|
1071
|
+
permissions?: string[];
|
|
1072
|
+
}
|
|
1073
|
+
interface TrafficPercentStrategy {
|
|
1074
|
+
/**
|
|
1075
|
+
* Maps service configuration IDs to their corresponding traffic percentage. Key is the service configuration ID, Value is the traffic percentage which must be greater than 0.0 and the
|
|
1076
|
+
* sum must equal to 100.0.
|
|
1077
|
+
*/
|
|
1078
|
+
percentages?: { [P in string]: number };
|
|
1079
|
+
}
|
|
1080
|
+
interface Type {
|
|
1081
|
+
/** The list of fields. */
|
|
1082
|
+
fields?: Field[];
|
|
1083
|
+
/** The fully qualified message name. */
|
|
1084
|
+
name?: string;
|
|
1085
|
+
/** The list of types appearing in `oneof` definitions in this type. */
|
|
1086
|
+
oneofs?: string[];
|
|
1087
|
+
/** The protocol buffer options. */
|
|
1088
|
+
options?: Option[];
|
|
1089
|
+
/** The source context. */
|
|
1090
|
+
sourceContext?: SourceContext;
|
|
1091
|
+
/** The source syntax. */
|
|
1092
|
+
syntax?: string;
|
|
1093
|
+
}
|
|
1094
|
+
interface UndeleteServiceResponse {
|
|
1095
|
+
/** Revived service resource. */
|
|
1096
|
+
service?: ManagedService;
|
|
1097
|
+
}
|
|
1098
|
+
interface Usage {
|
|
1099
|
+
/**
|
|
1100
|
+
* The full resource name of a channel used for sending notifications to the service producer. Google Service Management currently only supports [Google Cloud
|
|
1101
|
+
* Pub/Sub](https://cloud.google.com/pubsub) as a notification channel. To use Google Cloud Pub/Sub as the channel, this must be the name of a Cloud Pub/Sub topic that uses the Cloud
|
|
1102
|
+
* Pub/Sub topic name format documented in https://cloud.google.com/pubsub/docs/overview.
|
|
1103
|
+
*/
|
|
1104
|
+
producerNotificationChannel?: string;
|
|
1105
|
+
/**
|
|
1106
|
+
* Requirements that must be satisfied before a consumer project can use the service. Each requirement is of the form /; for example 'serviceusage.googleapis.com/billing-enabled'. For
|
|
1107
|
+
* Google APIs, a Terms of Service requirement must be included here. Google Cloud APIs must include "serviceusage.googleapis.com/tos/cloud". Other Google APIs should include
|
|
1108
|
+
* "serviceusage.googleapis.com/tos/universal". Additional ToS can be included based on the business needs.
|
|
1109
|
+
*/
|
|
1110
|
+
requirements?: string[];
|
|
1111
|
+
/** A list of usage rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. */
|
|
1112
|
+
rules?: UsageRule[];
|
|
1113
|
+
}
|
|
1114
|
+
interface UsageRule {
|
|
1115
|
+
/** If true, the selected method allows unregistered calls, e.g. calls that don't identify any user or application. */
|
|
1116
|
+
allowUnregisteredCalls?: boolean;
|
|
1117
|
+
/** Selects the methods to which this rule applies. Use '*' to indicate all methods in all APIs. Refer to selector for syntax details. */
|
|
1118
|
+
selector?: string;
|
|
1119
|
+
/**
|
|
1120
|
+
* If true, the selected method should skip service control and the control plane features, such as quota and billing, will not be available. This flag is used by Google Cloud
|
|
1121
|
+
* Endpoints to bypass checks for internal methods, such as service health check methods.
|
|
1122
|
+
*/
|
|
1123
|
+
skipServiceControl?: boolean;
|
|
1124
|
+
}
|
|
1125
|
+
interface OperationsResource {
|
|
1126
|
+
/** 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. */
|
|
1127
|
+
get(request?: {
|
|
1128
|
+
/** V1 error format. */
|
|
1129
|
+
"$.xgafv"?: string;
|
|
1130
|
+
/** OAuth access token. */
|
|
1131
|
+
access_token?: string;
|
|
1132
|
+
/** Data format for response. */
|
|
1133
|
+
alt?: string;
|
|
1134
|
+
/** JSONP */
|
|
1135
|
+
callback?: string;
|
|
1136
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1137
|
+
fields?: string;
|
|
1138
|
+
/** 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. */
|
|
1139
|
+
key?: string;
|
|
1140
|
+
/** The name of the operation resource. */
|
|
1141
|
+
name: string;
|
|
1142
|
+
/** OAuth 2.0 token for the current user. */
|
|
1143
|
+
oauth_token?: string;
|
|
1144
|
+
/** Returns response with indentations and line breaks. */
|
|
1145
|
+
prettyPrint?: boolean;
|
|
1146
|
+
/** 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. */
|
|
1147
|
+
quotaUser?: string;
|
|
1148
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1149
|
+
upload_protocol?: string;
|
|
1150
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1151
|
+
uploadType?: string;
|
|
1152
|
+
}): Request<Operation>;
|
|
1153
|
+
/** Lists service operations that match the specified filter in the request. */
|
|
1154
|
+
list(request?: {
|
|
1155
|
+
/** V1 error format. */
|
|
1156
|
+
"$.xgafv"?: string;
|
|
1157
|
+
/** OAuth access token. */
|
|
1158
|
+
access_token?: string;
|
|
1159
|
+
/** Data format for response. */
|
|
1160
|
+
alt?: string;
|
|
1161
|
+
/** JSONP */
|
|
1162
|
+
callback?: string;
|
|
1163
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1164
|
+
fields?: string;
|
|
1165
|
+
/**
|
|
1166
|
+
* A string for filtering Operations. The following filter fields are supported: * serviceName: Required. Only `=` operator is allowed. * startTime: The time this job was started,
|
|
1167
|
+
* in ISO 8601 format. Allowed operators are `>=`, `>`, `<=`, and `<`. * status: Can be `done`, `in_progress`, or `failed`. Allowed operators are `=`, and `!=`. Filter expression
|
|
1168
|
+
* supports conjunction (AND) and disjunction (OR) logical operators. However, the serviceName restriction must be at the top-level and can only be combined with other restrictions
|
|
1169
|
+
* via the AND logical operator. Examples: * `serviceName={some-service}.googleapis.com` * `serviceName={some-service}.googleapis.com AND startTime>="2017-02-01"` *
|
|
1170
|
+
* `serviceName={some-service}.googleapis.com AND status=done` * `serviceName={some-service}.googleapis.com AND (status=done OR startTime>="2017-02-01")`
|
|
1171
|
+
*/
|
|
1172
|
+
filter?: string;
|
|
1173
|
+
/** 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. */
|
|
1174
|
+
key?: string;
|
|
1175
|
+
/** Not used. */
|
|
1176
|
+
name?: string;
|
|
1177
|
+
/** OAuth 2.0 token for the current user. */
|
|
1178
|
+
oauth_token?: string;
|
|
1179
|
+
/** The maximum number of operations to return. If unspecified, defaults to 50. The maximum value is 100. */
|
|
1180
|
+
pageSize?: number;
|
|
1181
|
+
/** The standard list page token. */
|
|
1182
|
+
pageToken?: string;
|
|
1183
|
+
/** Returns response with indentations and line breaks. */
|
|
1184
|
+
prettyPrint?: boolean;
|
|
1185
|
+
/** 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. */
|
|
1186
|
+
quotaUser?: string;
|
|
1187
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1188
|
+
upload_protocol?: string;
|
|
1189
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1190
|
+
uploadType?: string;
|
|
1191
|
+
}): Request<ListOperationsResponse>;
|
|
1192
|
+
}
|
|
1193
|
+
interface ConfigsResource {
|
|
1194
|
+
/**
|
|
1195
|
+
* Creates a new service configuration (version) for a managed service. This method only stores the service configuration. To roll out the service configuration to backend systems
|
|
1196
|
+
* please call CreateServiceRollout. Only the 100 most recent service configurations and ones referenced by existing rollouts are kept for each service. The rest will be deleted
|
|
1197
|
+
* eventually.
|
|
1198
|
+
*/
|
|
1199
|
+
create(request: {
|
|
1200
|
+
/** V1 error format. */
|
|
1201
|
+
"$.xgafv"?: string;
|
|
1202
|
+
/** OAuth access token. */
|
|
1203
|
+
access_token?: string;
|
|
1204
|
+
/** Data format for response. */
|
|
1205
|
+
alt?: string;
|
|
1206
|
+
/** JSONP */
|
|
1207
|
+
callback?: string;
|
|
1208
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1209
|
+
fields?: string;
|
|
1210
|
+
/** 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. */
|
|
1211
|
+
key?: string;
|
|
1212
|
+
/** OAuth 2.0 token for the current user. */
|
|
1213
|
+
oauth_token?: string;
|
|
1214
|
+
/** Returns response with indentations and line breaks. */
|
|
1215
|
+
prettyPrint?: boolean;
|
|
1216
|
+
/** 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. */
|
|
1217
|
+
quotaUser?: string;
|
|
1218
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1219
|
+
serviceName: string;
|
|
1220
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1221
|
+
upload_protocol?: string;
|
|
1222
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1223
|
+
uploadType?: string;
|
|
1224
|
+
/** Request body */
|
|
1225
|
+
resource: Service;
|
|
1226
|
+
}): Request<Service>;
|
|
1227
|
+
create(request: {
|
|
1228
|
+
/** V1 error format. */
|
|
1229
|
+
"$.xgafv"?: string;
|
|
1230
|
+
/** OAuth access token. */
|
|
1231
|
+
access_token?: string;
|
|
1232
|
+
/** Data format for response. */
|
|
1233
|
+
alt?: string;
|
|
1234
|
+
/** JSONP */
|
|
1235
|
+
callback?: string;
|
|
1236
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1237
|
+
fields?: string;
|
|
1238
|
+
/** 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. */
|
|
1239
|
+
key?: string;
|
|
1240
|
+
/** OAuth 2.0 token for the current user. */
|
|
1241
|
+
oauth_token?: string;
|
|
1242
|
+
/** Returns response with indentations and line breaks. */
|
|
1243
|
+
prettyPrint?: boolean;
|
|
1244
|
+
/** 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. */
|
|
1245
|
+
quotaUser?: string;
|
|
1246
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1247
|
+
serviceName: string;
|
|
1248
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1249
|
+
upload_protocol?: string;
|
|
1250
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1251
|
+
uploadType?: string;
|
|
1252
|
+
},
|
|
1253
|
+
body: Service): Request<Service>;
|
|
1254
|
+
/** Gets a service configuration (version) for a managed service. */
|
|
1255
|
+
get(request?: {
|
|
1256
|
+
/** V1 error format. */
|
|
1257
|
+
"$.xgafv"?: string;
|
|
1258
|
+
/** OAuth access token. */
|
|
1259
|
+
access_token?: string;
|
|
1260
|
+
/** Data format for response. */
|
|
1261
|
+
alt?: string;
|
|
1262
|
+
/** JSONP */
|
|
1263
|
+
callback?: string;
|
|
1264
|
+
/** Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */
|
|
1265
|
+
configId: string;
|
|
1266
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1267
|
+
fields?: string;
|
|
1268
|
+
/** 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. */
|
|
1269
|
+
key?: string;
|
|
1270
|
+
/** OAuth 2.0 token for the current user. */
|
|
1271
|
+
oauth_token?: string;
|
|
1272
|
+
/** Returns response with indentations and line breaks. */
|
|
1273
|
+
prettyPrint?: boolean;
|
|
1274
|
+
/** 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. */
|
|
1275
|
+
quotaUser?: string;
|
|
1276
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1277
|
+
serviceName: string;
|
|
1278
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1279
|
+
upload_protocol?: string;
|
|
1280
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1281
|
+
uploadType?: string;
|
|
1282
|
+
/** Specifies which parts of the Service Config should be returned in the response. */
|
|
1283
|
+
view?: string;
|
|
1284
|
+
}): Request<Service>;
|
|
1285
|
+
/** Lists the history of the service configuration for a managed service, from the newest to the oldest. */
|
|
1286
|
+
list(request?: {
|
|
1287
|
+
/** V1 error format. */
|
|
1288
|
+
"$.xgafv"?: string;
|
|
1289
|
+
/** OAuth access token. */
|
|
1290
|
+
access_token?: string;
|
|
1291
|
+
/** Data format for response. */
|
|
1292
|
+
alt?: string;
|
|
1293
|
+
/** JSONP */
|
|
1294
|
+
callback?: string;
|
|
1295
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1296
|
+
fields?: string;
|
|
1297
|
+
/** 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. */
|
|
1298
|
+
key?: string;
|
|
1299
|
+
/** OAuth 2.0 token for the current user. */
|
|
1300
|
+
oauth_token?: string;
|
|
1301
|
+
/** The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. */
|
|
1302
|
+
pageSize?: number;
|
|
1303
|
+
/** The token of the page to retrieve. */
|
|
1304
|
+
pageToken?: string;
|
|
1305
|
+
/** Returns response with indentations and line breaks. */
|
|
1306
|
+
prettyPrint?: boolean;
|
|
1307
|
+
/** 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. */
|
|
1308
|
+
quotaUser?: string;
|
|
1309
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1310
|
+
serviceName: string;
|
|
1311
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1312
|
+
upload_protocol?: string;
|
|
1313
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1314
|
+
uploadType?: string;
|
|
1315
|
+
}): Request<ListServiceConfigsResponse>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Creates a new service configuration (version) for a managed service based on user-supplied configuration source files (for example: OpenAPI Specification). This method stores the
|
|
1318
|
+
* source configurations as well as the generated service configuration. To rollout the service configuration to other services, please call CreateServiceRollout. Only the 100 most
|
|
1319
|
+
* recent configuration sources and ones referenced by existing service configurtions are kept for each service. The rest will be deleted eventually. Operation
|
|
1320
|
+
*/
|
|
1321
|
+
submit(request: {
|
|
1322
|
+
/** V1 error format. */
|
|
1323
|
+
"$.xgafv"?: string;
|
|
1324
|
+
/** OAuth access token. */
|
|
1325
|
+
access_token?: string;
|
|
1326
|
+
/** Data format for response. */
|
|
1327
|
+
alt?: string;
|
|
1328
|
+
/** JSONP */
|
|
1329
|
+
callback?: string;
|
|
1330
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1331
|
+
fields?: string;
|
|
1332
|
+
/** 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. */
|
|
1333
|
+
key?: string;
|
|
1334
|
+
/** OAuth 2.0 token for the current user. */
|
|
1335
|
+
oauth_token?: string;
|
|
1336
|
+
/** Returns response with indentations and line breaks. */
|
|
1337
|
+
prettyPrint?: boolean;
|
|
1338
|
+
/** 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. */
|
|
1339
|
+
quotaUser?: string;
|
|
1340
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1341
|
+
serviceName: string;
|
|
1342
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1343
|
+
upload_protocol?: string;
|
|
1344
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1345
|
+
uploadType?: string;
|
|
1346
|
+
/** Request body */
|
|
1347
|
+
resource: SubmitConfigSourceRequest;
|
|
1348
|
+
}): Request<Operation>;
|
|
1349
|
+
submit(request: {
|
|
1350
|
+
/** V1 error format. */
|
|
1351
|
+
"$.xgafv"?: string;
|
|
1352
|
+
/** OAuth access token. */
|
|
1353
|
+
access_token?: string;
|
|
1354
|
+
/** Data format for response. */
|
|
1355
|
+
alt?: string;
|
|
1356
|
+
/** JSONP */
|
|
1357
|
+
callback?: string;
|
|
1358
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1359
|
+
fields?: string;
|
|
1360
|
+
/** 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. */
|
|
1361
|
+
key?: string;
|
|
1362
|
+
/** OAuth 2.0 token for the current user. */
|
|
1363
|
+
oauth_token?: string;
|
|
1364
|
+
/** Returns response with indentations and line breaks. */
|
|
1365
|
+
prettyPrint?: boolean;
|
|
1366
|
+
/** 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. */
|
|
1367
|
+
quotaUser?: string;
|
|
1368
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1369
|
+
serviceName: string;
|
|
1370
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1371
|
+
upload_protocol?: string;
|
|
1372
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1373
|
+
uploadType?: string;
|
|
1374
|
+
},
|
|
1375
|
+
body: SubmitConfigSourceRequest): Request<Operation>;
|
|
1376
|
+
}
|
|
1377
|
+
interface ConsumersResource {
|
|
1378
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
1379
|
+
getIamPolicy(request: {
|
|
1380
|
+
/** V1 error format. */
|
|
1381
|
+
"$.xgafv"?: string;
|
|
1382
|
+
/** OAuth access token. */
|
|
1383
|
+
access_token?: string;
|
|
1384
|
+
/** Data format for response. */
|
|
1385
|
+
alt?: string;
|
|
1386
|
+
/** JSONP */
|
|
1387
|
+
callback?: string;
|
|
1388
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1389
|
+
fields?: string;
|
|
1390
|
+
/** 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. */
|
|
1391
|
+
key?: string;
|
|
1392
|
+
/** OAuth 2.0 token for the current user. */
|
|
1393
|
+
oauth_token?: string;
|
|
1394
|
+
/** Returns response with indentations and line breaks. */
|
|
1395
|
+
prettyPrint?: boolean;
|
|
1396
|
+
/** 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. */
|
|
1397
|
+
quotaUser?: string;
|
|
1398
|
+
/**
|
|
1399
|
+
* REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
1400
|
+
* field.
|
|
1401
|
+
*/
|
|
1402
|
+
resource: string;
|
|
1403
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1404
|
+
upload_protocol?: string;
|
|
1405
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1406
|
+
uploadType?: string;
|
|
1407
|
+
},
|
|
1408
|
+
body: GetIamPolicyRequest): Request<Policy>;
|
|
1409
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
1410
|
+
setIamPolicy(request: {
|
|
1411
|
+
/** V1 error format. */
|
|
1412
|
+
"$.xgafv"?: string;
|
|
1413
|
+
/** OAuth access token. */
|
|
1414
|
+
access_token?: string;
|
|
1415
|
+
/** Data format for response. */
|
|
1416
|
+
alt?: string;
|
|
1417
|
+
/** JSONP */
|
|
1418
|
+
callback?: string;
|
|
1419
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1420
|
+
fields?: string;
|
|
1421
|
+
/** 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. */
|
|
1422
|
+
key?: string;
|
|
1423
|
+
/** OAuth 2.0 token for the current user. */
|
|
1424
|
+
oauth_token?: string;
|
|
1425
|
+
/** Returns response with indentations and line breaks. */
|
|
1426
|
+
prettyPrint?: boolean;
|
|
1427
|
+
/** 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. */
|
|
1428
|
+
quotaUser?: string;
|
|
1429
|
+
/**
|
|
1430
|
+
* REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
1431
|
+
* field.
|
|
1432
|
+
*/
|
|
1433
|
+
resource: string;
|
|
1434
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1435
|
+
upload_protocol?: string;
|
|
1436
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1437
|
+
uploadType?: string;
|
|
1438
|
+
},
|
|
1439
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
1440
|
+
/**
|
|
1441
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
1442
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
1443
|
+
*/
|
|
1444
|
+
testIamPermissions(request: {
|
|
1445
|
+
/** V1 error format. */
|
|
1446
|
+
"$.xgafv"?: string;
|
|
1447
|
+
/** OAuth access token. */
|
|
1448
|
+
access_token?: string;
|
|
1449
|
+
/** Data format for response. */
|
|
1450
|
+
alt?: string;
|
|
1451
|
+
/** JSONP */
|
|
1452
|
+
callback?: string;
|
|
1453
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1454
|
+
fields?: string;
|
|
1455
|
+
/** 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. */
|
|
1456
|
+
key?: string;
|
|
1457
|
+
/** OAuth 2.0 token for the current user. */
|
|
1458
|
+
oauth_token?: string;
|
|
1459
|
+
/** Returns response with indentations and line breaks. */
|
|
1460
|
+
prettyPrint?: boolean;
|
|
1461
|
+
/** 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. */
|
|
1462
|
+
quotaUser?: string;
|
|
1463
|
+
/**
|
|
1464
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
1465
|
+
* this field.
|
|
1466
|
+
*/
|
|
1467
|
+
resource: string;
|
|
1468
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1469
|
+
upload_protocol?: string;
|
|
1470
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1471
|
+
uploadType?: string;
|
|
1472
|
+
},
|
|
1473
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
1474
|
+
}
|
|
1475
|
+
interface RolloutsResource {
|
|
1476
|
+
/**
|
|
1477
|
+
* Creates a new service configuration rollout. Based on rollout, the Google Service Management will roll out the service configurations to different backend services. For example, the
|
|
1478
|
+
* logging configuration will be pushed to Google Cloud Logging. Please note that any previous pending and running Rollouts and associated Operations will be automatically cancelled so
|
|
1479
|
+
* that the latest Rollout will not be blocked by previous Rollouts. Only the 100 most recent (in any state) and the last 10 successful (if not already part of the set of 100 most
|
|
1480
|
+
* recent) rollouts are kept for each service. The rest will be deleted eventually. Operation
|
|
1481
|
+
*/
|
|
1482
|
+
create(request: {
|
|
1483
|
+
/** V1 error format. */
|
|
1484
|
+
"$.xgafv"?: string;
|
|
1485
|
+
/** OAuth access token. */
|
|
1486
|
+
access_token?: string;
|
|
1487
|
+
/** Data format for response. */
|
|
1488
|
+
alt?: string;
|
|
1489
|
+
/** JSONP */
|
|
1490
|
+
callback?: string;
|
|
1491
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1492
|
+
fields?: string;
|
|
1493
|
+
/** 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. */
|
|
1494
|
+
key?: string;
|
|
1495
|
+
/** OAuth 2.0 token for the current user. */
|
|
1496
|
+
oauth_token?: string;
|
|
1497
|
+
/** Returns response with indentations and line breaks. */
|
|
1498
|
+
prettyPrint?: boolean;
|
|
1499
|
+
/** 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. */
|
|
1500
|
+
quotaUser?: string;
|
|
1501
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1502
|
+
serviceName: string;
|
|
1503
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1504
|
+
upload_protocol?: string;
|
|
1505
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1506
|
+
uploadType?: string;
|
|
1507
|
+
/** Request body */
|
|
1508
|
+
resource: Rollout;
|
|
1509
|
+
}): Request<Operation>;
|
|
1510
|
+
create(request: {
|
|
1511
|
+
/** V1 error format. */
|
|
1512
|
+
"$.xgafv"?: string;
|
|
1513
|
+
/** OAuth access token. */
|
|
1514
|
+
access_token?: string;
|
|
1515
|
+
/** Data format for response. */
|
|
1516
|
+
alt?: string;
|
|
1517
|
+
/** JSONP */
|
|
1518
|
+
callback?: string;
|
|
1519
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1520
|
+
fields?: string;
|
|
1521
|
+
/** 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. */
|
|
1522
|
+
key?: string;
|
|
1523
|
+
/** OAuth 2.0 token for the current user. */
|
|
1524
|
+
oauth_token?: string;
|
|
1525
|
+
/** Returns response with indentations and line breaks. */
|
|
1526
|
+
prettyPrint?: boolean;
|
|
1527
|
+
/** 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. */
|
|
1528
|
+
quotaUser?: string;
|
|
1529
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1530
|
+
serviceName: string;
|
|
1531
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1532
|
+
upload_protocol?: string;
|
|
1533
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1534
|
+
uploadType?: string;
|
|
1535
|
+
},
|
|
1536
|
+
body: Rollout): Request<Operation>;
|
|
1537
|
+
/** Gets a service configuration rollout. */
|
|
1538
|
+
get(request?: {
|
|
1539
|
+
/** V1 error format. */
|
|
1540
|
+
"$.xgafv"?: string;
|
|
1541
|
+
/** OAuth access token. */
|
|
1542
|
+
access_token?: string;
|
|
1543
|
+
/** Data format for response. */
|
|
1544
|
+
alt?: string;
|
|
1545
|
+
/** JSONP */
|
|
1546
|
+
callback?: string;
|
|
1547
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1548
|
+
fields?: string;
|
|
1549
|
+
/** 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. */
|
|
1550
|
+
key?: string;
|
|
1551
|
+
/** OAuth 2.0 token for the current user. */
|
|
1552
|
+
oauth_token?: string;
|
|
1553
|
+
/** Returns response with indentations and line breaks. */
|
|
1554
|
+
prettyPrint?: boolean;
|
|
1555
|
+
/** 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. */
|
|
1556
|
+
quotaUser?: string;
|
|
1557
|
+
/** Required. The id of the rollout resource. */
|
|
1558
|
+
rolloutId: string;
|
|
1559
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1560
|
+
serviceName: string;
|
|
1561
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1562
|
+
upload_protocol?: string;
|
|
1563
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1564
|
+
uploadType?: string;
|
|
1565
|
+
}): Request<Rollout>;
|
|
1566
|
+
/** Lists the history of the service configuration rollouts for a managed service, from the newest to the oldest. */
|
|
1567
|
+
list(request?: {
|
|
1568
|
+
/** V1 error format. */
|
|
1569
|
+
"$.xgafv"?: string;
|
|
1570
|
+
/** OAuth access token. */
|
|
1571
|
+
access_token?: string;
|
|
1572
|
+
/** Data format for response. */
|
|
1573
|
+
alt?: string;
|
|
1574
|
+
/** JSONP */
|
|
1575
|
+
callback?: string;
|
|
1576
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1577
|
+
fields?: string;
|
|
1578
|
+
/**
|
|
1579
|
+
* Required. Use `filter` to return subset of rollouts. The following filters are supported: -- By status. For example, `filter='status=SUCCESS'` -- By strategy. For example,
|
|
1580
|
+
* `filter='strategy=TrafficPercentStrategy'`
|
|
1581
|
+
*/
|
|
1582
|
+
filter?: string;
|
|
1583
|
+
/** 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. */
|
|
1584
|
+
key?: string;
|
|
1585
|
+
/** OAuth 2.0 token for the current user. */
|
|
1586
|
+
oauth_token?: string;
|
|
1587
|
+
/** The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 100. */
|
|
1588
|
+
pageSize?: number;
|
|
1589
|
+
/** The token of the page to retrieve. */
|
|
1590
|
+
pageToken?: string;
|
|
1591
|
+
/** Returns response with indentations and line breaks. */
|
|
1592
|
+
prettyPrint?: boolean;
|
|
1593
|
+
/** 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. */
|
|
1594
|
+
quotaUser?: string;
|
|
1595
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1596
|
+
serviceName: string;
|
|
1597
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1598
|
+
upload_protocol?: string;
|
|
1599
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1600
|
+
uploadType?: string;
|
|
1601
|
+
}): Request<ListServiceRolloutsResponse>;
|
|
1602
|
+
}
|
|
1603
|
+
interface ServicesResource {
|
|
1604
|
+
/**
|
|
1605
|
+
* Creates a new managed service. A managed service is immutable, and is subject to mandatory 30-day data retention. You cannot move a service or recreate it within 30 days after
|
|
1606
|
+
* deletion. One producer project can own no more than 500 services. For security and reliability purposes, a production service should be hosted in a dedicated producer project.
|
|
1607
|
+
* Operation
|
|
1608
|
+
*/
|
|
1609
|
+
create(request: {
|
|
1610
|
+
/** V1 error format. */
|
|
1611
|
+
"$.xgafv"?: string;
|
|
1612
|
+
/** OAuth access token. */
|
|
1613
|
+
access_token?: string;
|
|
1614
|
+
/** Data format for response. */
|
|
1615
|
+
alt?: string;
|
|
1616
|
+
/** JSONP */
|
|
1617
|
+
callback?: string;
|
|
1618
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1619
|
+
fields?: string;
|
|
1620
|
+
/** 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. */
|
|
1621
|
+
key?: string;
|
|
1622
|
+
/** OAuth 2.0 token for the current user. */
|
|
1623
|
+
oauth_token?: string;
|
|
1624
|
+
/** Returns response with indentations and line breaks. */
|
|
1625
|
+
prettyPrint?: boolean;
|
|
1626
|
+
/** 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. */
|
|
1627
|
+
quotaUser?: string;
|
|
1628
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1629
|
+
upload_protocol?: string;
|
|
1630
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1631
|
+
uploadType?: string;
|
|
1632
|
+
/** Request body */
|
|
1633
|
+
resource: ManagedService;
|
|
1634
|
+
}): Request<Operation>;
|
|
1635
|
+
create(request: {
|
|
1636
|
+
/** V1 error format. */
|
|
1637
|
+
"$.xgafv"?: string;
|
|
1638
|
+
/** OAuth access token. */
|
|
1639
|
+
access_token?: string;
|
|
1640
|
+
/** Data format for response. */
|
|
1641
|
+
alt?: string;
|
|
1642
|
+
/** JSONP */
|
|
1643
|
+
callback?: string;
|
|
1644
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1645
|
+
fields?: string;
|
|
1646
|
+
/** 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. */
|
|
1647
|
+
key?: string;
|
|
1648
|
+
/** OAuth 2.0 token for the current user. */
|
|
1649
|
+
oauth_token?: string;
|
|
1650
|
+
/** Returns response with indentations and line breaks. */
|
|
1651
|
+
prettyPrint?: boolean;
|
|
1652
|
+
/** 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. */
|
|
1653
|
+
quotaUser?: string;
|
|
1654
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1655
|
+
upload_protocol?: string;
|
|
1656
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1657
|
+
uploadType?: string;
|
|
1658
|
+
},
|
|
1659
|
+
body: ManagedService): Request<Operation>;
|
|
1660
|
+
/**
|
|
1661
|
+
* Deletes a managed service. This method will change the service to the `Soft-Delete` state for 30 days. Within this period, service producers may call UndeleteService to restore the
|
|
1662
|
+
* service. After 30 days, the service will be permanently deleted. Operation
|
|
1663
|
+
*/
|
|
1664
|
+
delete(request?: {
|
|
1665
|
+
/** V1 error format. */
|
|
1666
|
+
"$.xgafv"?: string;
|
|
1667
|
+
/** OAuth access token. */
|
|
1668
|
+
access_token?: string;
|
|
1669
|
+
/** Data format for response. */
|
|
1670
|
+
alt?: string;
|
|
1671
|
+
/** JSONP */
|
|
1672
|
+
callback?: string;
|
|
1673
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1674
|
+
fields?: string;
|
|
1675
|
+
/** 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. */
|
|
1676
|
+
key?: string;
|
|
1677
|
+
/** OAuth 2.0 token for the current user. */
|
|
1678
|
+
oauth_token?: string;
|
|
1679
|
+
/** Returns response with indentations and line breaks. */
|
|
1680
|
+
prettyPrint?: boolean;
|
|
1681
|
+
/** 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. */
|
|
1682
|
+
quotaUser?: string;
|
|
1683
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1684
|
+
serviceName: string;
|
|
1685
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1686
|
+
upload_protocol?: string;
|
|
1687
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1688
|
+
uploadType?: string;
|
|
1689
|
+
}): Request<Operation>;
|
|
1690
|
+
/**
|
|
1691
|
+
* Generates and returns a report (errors, warnings and changes from existing configurations) associated with GenerateConfigReportRequest.new_value If
|
|
1692
|
+
* GenerateConfigReportRequest.old_value is specified, GenerateConfigReportRequest will contain a single ChangeReport based on the comparison between
|
|
1693
|
+
* GenerateConfigReportRequest.new_value and GenerateConfigReportRequest.old_value. If GenerateConfigReportRequest.old_value is not specified, this method will compare
|
|
1694
|
+
* GenerateConfigReportRequest.new_value with the last pushed service configuration.
|
|
1695
|
+
*/
|
|
1696
|
+
generateConfigReport(request: {
|
|
1697
|
+
/** V1 error format. */
|
|
1698
|
+
"$.xgafv"?: string;
|
|
1699
|
+
/** OAuth access token. */
|
|
1700
|
+
access_token?: string;
|
|
1701
|
+
/** Data format for response. */
|
|
1702
|
+
alt?: string;
|
|
1703
|
+
/** JSONP */
|
|
1704
|
+
callback?: string;
|
|
1705
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1706
|
+
fields?: string;
|
|
1707
|
+
/** 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. */
|
|
1708
|
+
key?: string;
|
|
1709
|
+
/** OAuth 2.0 token for the current user. */
|
|
1710
|
+
oauth_token?: string;
|
|
1711
|
+
/** Returns response with indentations and line breaks. */
|
|
1712
|
+
prettyPrint?: boolean;
|
|
1713
|
+
/** 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. */
|
|
1714
|
+
quotaUser?: string;
|
|
1715
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1716
|
+
upload_protocol?: string;
|
|
1717
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1718
|
+
uploadType?: string;
|
|
1719
|
+
/** Request body */
|
|
1720
|
+
resource: GenerateConfigReportRequest;
|
|
1721
|
+
}): Request<GenerateConfigReportResponse>;
|
|
1722
|
+
generateConfigReport(request: {
|
|
1723
|
+
/** V1 error format. */
|
|
1724
|
+
"$.xgafv"?: string;
|
|
1725
|
+
/** OAuth access token. */
|
|
1726
|
+
access_token?: string;
|
|
1727
|
+
/** Data format for response. */
|
|
1728
|
+
alt?: string;
|
|
1729
|
+
/** JSONP */
|
|
1730
|
+
callback?: string;
|
|
1731
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1732
|
+
fields?: string;
|
|
1733
|
+
/** 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. */
|
|
1734
|
+
key?: string;
|
|
1735
|
+
/** OAuth 2.0 token for the current user. */
|
|
1736
|
+
oauth_token?: string;
|
|
1737
|
+
/** Returns response with indentations and line breaks. */
|
|
1738
|
+
prettyPrint?: boolean;
|
|
1739
|
+
/** 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. */
|
|
1740
|
+
quotaUser?: string;
|
|
1741
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1742
|
+
upload_protocol?: string;
|
|
1743
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1744
|
+
uploadType?: string;
|
|
1745
|
+
},
|
|
1746
|
+
body: GenerateConfigReportRequest): Request<GenerateConfigReportResponse>;
|
|
1747
|
+
/** Gets a managed service. Authentication is required unless the service is public. */
|
|
1748
|
+
get(request?: {
|
|
1749
|
+
/** V1 error format. */
|
|
1750
|
+
"$.xgafv"?: string;
|
|
1751
|
+
/** OAuth access token. */
|
|
1752
|
+
access_token?: string;
|
|
1753
|
+
/** Data format for response. */
|
|
1754
|
+
alt?: string;
|
|
1755
|
+
/** JSONP */
|
|
1756
|
+
callback?: string;
|
|
1757
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1758
|
+
fields?: string;
|
|
1759
|
+
/** 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. */
|
|
1760
|
+
key?: string;
|
|
1761
|
+
/** OAuth 2.0 token for the current user. */
|
|
1762
|
+
oauth_token?: string;
|
|
1763
|
+
/** Returns response with indentations and line breaks. */
|
|
1764
|
+
prettyPrint?: boolean;
|
|
1765
|
+
/** 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. */
|
|
1766
|
+
quotaUser?: string;
|
|
1767
|
+
/** Required. The name of the service. See the `ServiceManager` overview for naming requirements. For example: `example.googleapis.com`. */
|
|
1768
|
+
serviceName: string;
|
|
1769
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1770
|
+
upload_protocol?: string;
|
|
1771
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1772
|
+
uploadType?: string;
|
|
1773
|
+
}): Request<ManagedService>;
|
|
1774
|
+
/** Gets a service configuration (version) for a managed service. */
|
|
1775
|
+
getConfig(request?: {
|
|
1776
|
+
/** V1 error format. */
|
|
1777
|
+
"$.xgafv"?: string;
|
|
1778
|
+
/** OAuth access token. */
|
|
1779
|
+
access_token?: string;
|
|
1780
|
+
/** Data format for response. */
|
|
1781
|
+
alt?: string;
|
|
1782
|
+
/** JSONP */
|
|
1783
|
+
callback?: string;
|
|
1784
|
+
/** Required. The id of the service configuration resource. This field must be specified for the server to return all fields, including `SourceInfo`. */
|
|
1785
|
+
configId?: string;
|
|
1786
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1787
|
+
fields?: string;
|
|
1788
|
+
/** 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. */
|
|
1789
|
+
key?: string;
|
|
1790
|
+
/** OAuth 2.0 token for the current user. */
|
|
1791
|
+
oauth_token?: string;
|
|
1792
|
+
/** Returns response with indentations and line breaks. */
|
|
1793
|
+
prettyPrint?: boolean;
|
|
1794
|
+
/** 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. */
|
|
1795
|
+
quotaUser?: string;
|
|
1796
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1797
|
+
serviceName: string;
|
|
1798
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1799
|
+
upload_protocol?: string;
|
|
1800
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1801
|
+
uploadType?: string;
|
|
1802
|
+
/** Specifies which parts of the Service Config should be returned in the response. */
|
|
1803
|
+
view?: string;
|
|
1804
|
+
}): Request<Service>;
|
|
1805
|
+
/** Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. */
|
|
1806
|
+
getIamPolicy(request: {
|
|
1807
|
+
/** V1 error format. */
|
|
1808
|
+
"$.xgafv"?: string;
|
|
1809
|
+
/** OAuth access token. */
|
|
1810
|
+
access_token?: string;
|
|
1811
|
+
/** Data format for response. */
|
|
1812
|
+
alt?: string;
|
|
1813
|
+
/** JSONP */
|
|
1814
|
+
callback?: string;
|
|
1815
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1816
|
+
fields?: string;
|
|
1817
|
+
/** 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. */
|
|
1818
|
+
key?: string;
|
|
1819
|
+
/** OAuth 2.0 token for the current user. */
|
|
1820
|
+
oauth_token?: string;
|
|
1821
|
+
/** Returns response with indentations and line breaks. */
|
|
1822
|
+
prettyPrint?: boolean;
|
|
1823
|
+
/** 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. */
|
|
1824
|
+
quotaUser?: string;
|
|
1825
|
+
/**
|
|
1826
|
+
* REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
1827
|
+
* field.
|
|
1828
|
+
*/
|
|
1829
|
+
resource: string;
|
|
1830
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1831
|
+
upload_protocol?: string;
|
|
1832
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1833
|
+
uploadType?: string;
|
|
1834
|
+
},
|
|
1835
|
+
body: GetIamPolicyRequest): Request<Policy>;
|
|
1836
|
+
/** Lists managed services. Returns all public services. For authenticated users, also returns all services the calling user has "servicemanagement.services.get" permission for. */
|
|
1837
|
+
list(request?: {
|
|
1838
|
+
/** V1 error format. */
|
|
1839
|
+
"$.xgafv"?: string;
|
|
1840
|
+
/** OAuth access token. */
|
|
1841
|
+
access_token?: string;
|
|
1842
|
+
/** Data format for response. */
|
|
1843
|
+
alt?: string;
|
|
1844
|
+
/** JSONP */
|
|
1845
|
+
callback?: string;
|
|
1846
|
+
/** Include services consumed by the specified consumer. The Google Service Management implementation accepts the following forms: - project: */
|
|
1847
|
+
consumerId?: string;
|
|
1848
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1849
|
+
fields?: string;
|
|
1850
|
+
/** 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. */
|
|
1851
|
+
key?: string;
|
|
1852
|
+
/** OAuth 2.0 token for the current user. */
|
|
1853
|
+
oauth_token?: string;
|
|
1854
|
+
/** The max number of items to include in the response list. Page size is 50 if not specified. Maximum value is 500. */
|
|
1855
|
+
pageSize?: number;
|
|
1856
|
+
/** Token identifying which result to start with; returned by a previous list call. */
|
|
1857
|
+
pageToken?: string;
|
|
1858
|
+
/** Returns response with indentations and line breaks. */
|
|
1859
|
+
prettyPrint?: boolean;
|
|
1860
|
+
/** Include services produced by the specified project. */
|
|
1861
|
+
producerProjectId?: string;
|
|
1862
|
+
/** 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. */
|
|
1863
|
+
quotaUser?: string;
|
|
1864
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1865
|
+
upload_protocol?: string;
|
|
1866
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1867
|
+
uploadType?: string;
|
|
1868
|
+
}): Request<ListServicesResponse>;
|
|
1869
|
+
/** Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. */
|
|
1870
|
+
setIamPolicy(request: {
|
|
1871
|
+
/** V1 error format. */
|
|
1872
|
+
"$.xgafv"?: string;
|
|
1873
|
+
/** OAuth access token. */
|
|
1874
|
+
access_token?: string;
|
|
1875
|
+
/** Data format for response. */
|
|
1876
|
+
alt?: string;
|
|
1877
|
+
/** JSONP */
|
|
1878
|
+
callback?: string;
|
|
1879
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1880
|
+
fields?: string;
|
|
1881
|
+
/** 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. */
|
|
1882
|
+
key?: string;
|
|
1883
|
+
/** OAuth 2.0 token for the current user. */
|
|
1884
|
+
oauth_token?: string;
|
|
1885
|
+
/** Returns response with indentations and line breaks. */
|
|
1886
|
+
prettyPrint?: boolean;
|
|
1887
|
+
/** 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. */
|
|
1888
|
+
quotaUser?: string;
|
|
1889
|
+
/**
|
|
1890
|
+
* REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this
|
|
1891
|
+
* field.
|
|
1892
|
+
*/
|
|
1893
|
+
resource: string;
|
|
1894
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1895
|
+
upload_protocol?: string;
|
|
1896
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1897
|
+
uploadType?: string;
|
|
1898
|
+
},
|
|
1899
|
+
body: SetIamPolicyRequest): Request<Policy>;
|
|
1900
|
+
/**
|
|
1901
|
+
* Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This
|
|
1902
|
+
* operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
|
|
1903
|
+
*/
|
|
1904
|
+
testIamPermissions(request: {
|
|
1905
|
+
/** V1 error format. */
|
|
1906
|
+
"$.xgafv"?: string;
|
|
1907
|
+
/** OAuth access token. */
|
|
1908
|
+
access_token?: string;
|
|
1909
|
+
/** Data format for response. */
|
|
1910
|
+
alt?: string;
|
|
1911
|
+
/** JSONP */
|
|
1912
|
+
callback?: string;
|
|
1913
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1914
|
+
fields?: string;
|
|
1915
|
+
/** 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. */
|
|
1916
|
+
key?: string;
|
|
1917
|
+
/** OAuth 2.0 token for the current user. */
|
|
1918
|
+
oauth_token?: string;
|
|
1919
|
+
/** Returns response with indentations and line breaks. */
|
|
1920
|
+
prettyPrint?: boolean;
|
|
1921
|
+
/** 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. */
|
|
1922
|
+
quotaUser?: string;
|
|
1923
|
+
/**
|
|
1924
|
+
* REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for
|
|
1925
|
+
* this field.
|
|
1926
|
+
*/
|
|
1927
|
+
resource: string;
|
|
1928
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1929
|
+
upload_protocol?: string;
|
|
1930
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1931
|
+
uploadType?: string;
|
|
1932
|
+
},
|
|
1933
|
+
body: TestIamPermissionsRequest): Request<TestIamPermissionsResponse>;
|
|
1934
|
+
/**
|
|
1935
|
+
* Revives a previously deleted managed service. The method restores the service using the configuration at the time the service was deleted. The target service must exist and must
|
|
1936
|
+
* have been deleted within the last 30 days. Operation
|
|
1937
|
+
*/
|
|
1938
|
+
undelete(request?: {
|
|
1939
|
+
/** V1 error format. */
|
|
1940
|
+
"$.xgafv"?: string;
|
|
1941
|
+
/** OAuth access token. */
|
|
1942
|
+
access_token?: string;
|
|
1943
|
+
/** Data format for response. */
|
|
1944
|
+
alt?: string;
|
|
1945
|
+
/** JSONP */
|
|
1946
|
+
callback?: string;
|
|
1947
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1948
|
+
fields?: string;
|
|
1949
|
+
/** 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. */
|
|
1950
|
+
key?: string;
|
|
1951
|
+
/** OAuth 2.0 token for the current user. */
|
|
1952
|
+
oauth_token?: string;
|
|
1953
|
+
/** Returns response with indentations and line breaks. */
|
|
1954
|
+
prettyPrint?: boolean;
|
|
1955
|
+
/** 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. */
|
|
1956
|
+
quotaUser?: string;
|
|
1957
|
+
/** Required. The name of the service. See the [overview](https://cloud.google.com/service-management/overview) for naming requirements. For example: `example.googleapis.com`. */
|
|
1958
|
+
serviceName: string;
|
|
1959
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1960
|
+
upload_protocol?: string;
|
|
1961
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1962
|
+
uploadType?: string;
|
|
1963
|
+
}): Request<Operation>;
|
|
1964
|
+
configs: ConfigsResource;
|
|
1965
|
+
consumers: ConsumersResource;
|
|
1966
|
+
rollouts: RolloutsResource;
|
|
1967
|
+
}
|
|
1968
|
+
|
|
1969
|
+
const operations: OperationsResource;
|
|
1970
|
+
|
|
1971
|
+
const services: ServicesResource;
|
|
1972
|
+
}
|
|
1973
|
+
}
|