-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
apphub_v1alpha.projects.locations.applications.services.html
508 lines (465 loc) 路 39.3 KB
/
apphub_v1alpha.projects.locations.applications.services.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apphub_v1alpha.html">App Hub API</a> . <a href="apphub_v1alpha.projects.html">projects</a> . <a href="apphub_v1alpha.projects.locations.html">locations</a> . <a href="apphub_v1alpha.projects.locations.applications.html">applications</a> . <a href="apphub_v1alpha.projects.locations.applications.services.html">services</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Service in an Application.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Service from an Application.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Service in an Application.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Services in an Application.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Service in an Application.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, requestId=None, serviceId=None, x__xgafv=None)</code>
<pre>Creates a Service in an Application.
Args:
parent: string, Required. Fully qualified name of the parent Application to create the Service in. Expected format: `projects/{project}/locations/{location}/applications/{application}`. (required)
body: object, The request body.
The object takes the form of:
{ # Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.
"attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
"businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
"level": "A String", # Optional. Criticality level. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"missionCritical": True or False, # Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead.
"type": "A String", # Required. Criticality Type.
},
"developerOwners": [ # Optional. Developer team that owns development and coding.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
"environment": "A String", # Optional. Environment name. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"type": "A String", # Required. Environment Type.
},
"operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.
"discoveredService": "A String", # Required. Immutable. The resource name of the original discovered service.
"displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
"name": "A String", # Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"
"serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
"gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
"location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
"zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
},
"serviceReference": { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
"path": "A String", # Output only. Additional path under the resource URI (demultiplexing one resource URI into multiple entries). Smallest unit a policy can be attached to. Examples: URL Map path entry.
"uri": "A String", # Output only. The underlying resource URI (For example, URI of Forwarding Rule, URL Map, and Backend Service).
},
"state": "A String", # Output only. Service state.
"uid": "A String", # Output only. A universally unique identifier (UUID) for the `Service` in the UUID4 format.
"updateTime": "A String", # Output only. Update time.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
serviceId: string, Required. The Service identifier. Must contain only lowercase letters, numbers or hyphens, with the first character a letter, the last a letter or a number, and a 63 character maximum.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Deletes a Service from an Application.
Args:
name: string, Required. Fully qualified name of the Service to delete from an Application. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`. (required)
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Service in an Application.
Args:
name: string, Required. Fully qualified name of the Service to fetch. Expected format: `projects/{project}/locations/{location}/applications/{application}/services/{service}`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.
"attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
"businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
"level": "A String", # Optional. Criticality level. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"missionCritical": True or False, # Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead.
"type": "A String", # Required. Criticality Type.
},
"developerOwners": [ # Optional. Developer team that owns development and coding.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
"environment": "A String", # Optional. Environment name. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"type": "A String", # Required. Environment Type.
},
"operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.
"discoveredService": "A String", # Required. Immutable. The resource name of the original discovered service.
"displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
"name": "A String", # Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"
"serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
"gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
"location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
"zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
},
"serviceReference": { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
"path": "A String", # Output only. Additional path under the resource URI (demultiplexing one resource URI into multiple entries). Smallest unit a policy can be attached to. Examples: URL Map path entry.
"uri": "A String", # Output only. The underlying resource URI (For example, URI of Forwarding Rule, URL Map, and Backend Service).
},
"state": "A String", # Output only. Service state.
"uid": "A String", # Output only. A universally unique identifier (UUID) for the `Service` in the UUID4 format.
"updateTime": "A String", # Output only. Update time.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists Services in an Application.
Args:
parent: string, Required. Fully qualified name of the parent Application to list Services for. Expected format: `projects/{project}/locations/{location}/applications/{application}`. (required)
filter: string, Optional. Filtering results
orderBy: string, Optional. Hint for how to order the results
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListServices.
"nextPageToken": "A String", # A token identifying a page of results the server should return.
"services": [ # List of Services.
{ # Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.
"attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
"businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
"level": "A String", # Optional. Criticality level. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"missionCritical": True or False, # Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead.
"type": "A String", # Required. Criticality Type.
},
"developerOwners": [ # Optional. Developer team that owns development and coding.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
"environment": "A String", # Optional. Environment name. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"type": "A String", # Required. Environment Type.
},
"operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.
"discoveredService": "A String", # Required. Immutable. The resource name of the original discovered service.
"displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
"name": "A String", # Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"
"serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
"gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
"location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
"zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
},
"serviceReference": { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
"path": "A String", # Output only. Additional path under the resource URI (demultiplexing one resource URI into multiple entries). Smallest unit a policy can be attached to. Examples: URL Map path entry.
"uri": "A String", # Output only. The underlying resource URI (For example, URI of Forwarding Rule, URL Map, and Backend Service).
},
"state": "A String", # Output only. Service state.
"uid": "A String", # Output only. A universally unique identifier (UUID) for the `Service` in the UUID4 format.
"updateTime": "A String", # Output only. Update time.
},
],
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Service in an Application.
Args:
name: string, Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}" (required)
body: object, The request body.
The object takes the form of:
{ # Service is an App Hub data model that contains a discovered service, which represents a network/api interface that exposes some functionality to clients for consumption over the network.
"attributes": { # Consumer provided attributes. # Optional. Consumer provided attributes.
"businessOwners": [ # Optional. Business team that ensures user needs are met and value is delivered
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"criticality": { # Criticality of the Application, Service, or Workload # Optional. User-defined criticality information.
"level": "A String", # Optional. Criticality level. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"missionCritical": True or False, # Optional. Indicates mission-critical Application, Service, or Workload. Deprecated: Please refer to type instead.
"type": "A String", # Required. Criticality Type.
},
"developerOwners": [ # Optional. Developer team that owns development and coding.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
"environment": { # Environment of the Application, Service, or Workload # Optional. User-defined environment information.
"environment": "A String", # Optional. Environment name. Can contain only lowercase letters, numeric characters, underscores, and dashes. Can have a maximum length of 63 characters. Deprecated: Please refer to type instead.
"type": "A String", # Required. Environment Type.
},
"operatorOwners": [ # Optional. Operator team that ensures runtime and operations.
{ # Contact information of stakeholders.
"channel": { # Separate message to accommodate custom formats across IRC and Slack. # Optional. Communication channel of the contacts.
"uri": "A String", # Required. URI of the channel.
},
"displayName": "A String", # Optional. Contact's name. Can have a maximum length of 63 characters.
"email": "A String", # Required. Email address of the contacts.
},
],
},
"createTime": "A String", # Output only. Create time.
"description": "A String", # Optional. User-defined description of a Service. Can have a maximum length of 2048 characters.
"discoveredService": "A String", # Required. Immutable. The resource name of the original discovered service.
"displayName": "A String", # Optional. User-defined name for the Service. Can have a maximum length of 63 characters.
"name": "A String", # Identifier. The resource name of a Service. Format: "projects/{host-project-id}/locations/{location}/applications/{application-id}/services/{service-id}"
"serviceProperties": { # Properties of an underlying cloud resource that can comprise a Service. # Output only. Properties of an underlying compute resource that can comprise a Service. These are immutable.
"gcpProject": "A String", # Output only. The service project identifier that the underlying cloud resource resides in.
"location": "A String", # Output only. The location that the underlying resource resides in, for example, us-west1.
"zone": "A String", # Output only. The location that the underlying resource resides in if it is zonal, for example, us-west1-a).
},
"serviceReference": { # Reference to an underlying networking resource that can comprise a Service. # Output only. Reference to an underlying networking resource that can comprise a Service. These are immutable.
"path": "A String", # Output only. Additional path under the resource URI (demultiplexing one resource URI into multiple entries). Smallest unit a policy can be attached to. Examples: URL Map path entry.
"uri": "A String", # Output only. The underlying resource URI (For example, URI of Forwarding Rule, URL Map, and Backend Service).
},
"state": "A String", # Output only. Service state.
"uid": "A String", # Output only. A universally unique identifier (UUID) for the `Service` in the UUID4 format.
"updateTime": "A String", # Output only. Update time.
}
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the Service resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. The API changes the values of the fields as specified in the update_mask. The API ignores the values of all fields not covered by the update_mask. You can also unset a field by not specifying it in the updated message, but adding the field to the mask. This clears whatever value the field previously had.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # 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.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>