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 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
|
<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="resourceviews_v1beta2.html">Google Compute Engine Instance Groups API</a> . <a href="resourceviews_v1beta2.zoneViews.html">zoneViews</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#addResources">addResources(project, zone, resourceView, body)</a></code></p>
<p class="firstline">Add resources to the view.</p>
<p class="toc_element">
<code><a href="#delete">delete(project, zone, resourceView)</a></code></p>
<p class="firstline">Delete a resource view.</p>
<p class="toc_element">
<code><a href="#get">get(project, zone, resourceView)</a></code></p>
<p class="firstline">Get the information of a zonal resource view.</p>
<p class="toc_element">
<code><a href="#getService">getService(project, zone, resourceView, resourceName=None)</a></code></p>
<p class="firstline">Get the service information of a resource view or a resource.</p>
<p class="toc_element">
<code><a href="#insert">insert(project, zone, body)</a></code></p>
<p class="firstline">Create a resource view.</p>
<p class="toc_element">
<code><a href="#list">list(project, zone, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">List resource views.</p>
<p class="toc_element">
<code><a href="#listResources">listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)</a></code></p>
<p class="firstline">List the resources of the resource view.</p>
<p class="toc_element">
<code><a href="#listResources_next">listResources_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#removeResources">removeResources(project, zone, resourceView, body)</a></code></p>
<p class="firstline">Remove resources from the view.</p>
<p class="toc_element">
<code><a href="#setService">setService(project, zone, resourceView, body)</a></code></p>
<p class="firstline">Update the service information of a resource view or a resource.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="addResources">addResources(project, zone, resourceView, body)</code>
<pre>Add resources to the view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The request to add resources to the resource view.
"resources": [ # The list of resources to be added.
"A String",
],
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "resourceviews#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(project, zone, resourceView)</code>
<pre>Delete a resource view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "resourceviews#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(project, zone, resourceView)</code>
<pre>Get the information of a zonal resource view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
Returns:
An object of the form:
{ # The resource view object.
"size": 42, # The total number of resources in the resource view.
"kind": "resourceviews#resourceView", # Type of the resource.
"description": "A String", # The detailed description of the resource view.
"labels": [ # The labels for events.
{ # The Label to be applied to the resource views.
"value": "A String", # Value of the label.
"key": "A String", # Key of the label.
},
],
"network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
"selfLink": "A String", # [Output Only] A self-link to the resource view.
"fingerprint": "A String", # The fingerprint of the service endpoint information.
"endpoints": [ # Services endpoint information.
{ # The service endpoint that may be started in a VM.
"name": "A String", # The name of the service endpoint.
"port": 42, # The port of the service endpoint.
},
],
"creationTimestamp": "A String", # The creation time of the resource view.
"id": "A String", # [Output Only] The ID of the resource view.
"resources": [ # A list of all resources in the resource view.
"A String",
],
"name": "A String", # The name of the resource view.
}</pre>
</div>
<div class="method">
<code class="details" id="getService">getService(project, zone, resourceView, resourceName=None)</code>
<pre>Get the service information of a resource view or a resource.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
resourceName: string, The name of the resource if user wants to get the service information of the resource.
Returns:
An object of the form:
{
"endpoints": [ # The service information.
{ # The service endpoint that may be started in a VM.
"name": "A String", # The name of the service endpoint.
"port": 42, # The port of the service endpoint.
},
],
"fingerprint": "A String", # The fingerprint of the service information.
}</pre>
</div>
<div class="method">
<code class="details" id="insert">insert(project, zone, body)</code>
<pre>Create a resource view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The resource view object.
"size": 42, # The total number of resources in the resource view.
"kind": "resourceviews#resourceView", # Type of the resource.
"description": "A String", # The detailed description of the resource view.
"labels": [ # The labels for events.
{ # The Label to be applied to the resource views.
"value": "A String", # Value of the label.
"key": "A String", # Key of the label.
},
],
"network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
"selfLink": "A String", # [Output Only] A self-link to the resource view.
"fingerprint": "A String", # The fingerprint of the service endpoint information.
"endpoints": [ # Services endpoint information.
{ # The service endpoint that may be started in a VM.
"name": "A String", # The name of the service endpoint.
"port": 42, # The port of the service endpoint.
},
],
"creationTimestamp": "A String", # The creation time of the resource view.
"id": "A String", # [Output Only] The ID of the resource view.
"resources": [ # A list of all resources in the resource view.
"A String",
],
"name": "A String", # The name of the resource view.
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "resourceviews#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(project, zone, pageToken=None, maxResults=None)</code>
<pre>List resource views.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
Returns:
An object of the form:
{ # The response to a list request.
"nextPageToken": "A String", # A token used for pagination.
"items": [ # The result that contains all resource views that meet the criteria.
{ # The resource view object.
"size": 42, # The total number of resources in the resource view.
"kind": "resourceviews#resourceView", # Type of the resource.
"description": "A String", # The detailed description of the resource view.
"labels": [ # The labels for events.
{ # The Label to be applied to the resource views.
"value": "A String", # Value of the label.
"key": "A String", # Key of the label.
},
],
"network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
"selfLink": "A String", # [Output Only] A self-link to the resource view.
"fingerprint": "A String", # The fingerprint of the service endpoint information.
"endpoints": [ # Services endpoint information.
{ # The service endpoint that may be started in a VM.
"name": "A String", # The name of the service endpoint.
"port": 42, # The port of the service endpoint.
},
],
"creationTimestamp": "A String", # The creation time of the resource view.
"id": "A String", # [Output Only] The ID of the resource view.
"resources": [ # A list of all resources in the resource view.
"A String",
],
"name": "A String", # The name of the resource view.
},
],
"kind": "resourceviews#zoneViewsList", # Type of resource.
"selfLink": "A String", # Server defined URL for this resource (output only).
}</pre>
</div>
<div class="method">
<code class="details" id="listResources">listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)</code>
<pre>List the resources of the resource view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
listState: string, The state of the instance to list. By default, it lists all instances.
Allowed values
ALL -
RUNNING -
format: string, The requested format of the return value. It can be URL or URL_PORT. A JSON object will be included in the response based on the format. The default format is NONE, which results in no JSON in the response.
Allowed values
NONE -
URL -
URL_PORT -
maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000)
pageToken: string, Specifies a nextPageToken returned by a previous list request. This token can be used to request the next page of results from a previous list request.
serviceName: string, The service name to return in the response. It is optional and if it is not set, all the service end points will be returned.
Returns:
An object of the form:
{ # The response to a list resource request.
"nextPageToken": "A String", # A token used for pagination.
"items": [ # The formatted JSON that is requested by the user.
{ # The list response item that contains the resource and end points information.
"endpoints": { # The list of service end points on the resource.
"a_key": [ # The name of the service end point.
42,
],
},
"resource": "A String", # The full URL of the resource.
},
],
"network": "A String", # The URL of a Compute Engine network to which the resources in the view belong.
}</pre>
</div>
<div class="method">
<code class="details" id="listResources_next">listResources_next(previous_request, previous_response)</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="list_next">list_next(previous_request, previous_response)</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="removeResources">removeResources(project, zone, resourceView, body)</code>
<pre>Remove resources from the view.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
body: object, The request body. (required)
The object takes the form of:
{ # The request to remove resources from the resource view.
"resources": [ # The list of resources to be removed.
"A String",
],
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "resourceviews#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
<div class="method">
<code class="details" id="setService">setService(project, zone, resourceView, body)</code>
<pre>Update the service information of a resource view or a resource.
Args:
project: string, The project name of the resource view. (required)
zone: string, The zone name of the resource view. (required)
resourceView: string, The name of the resource view. (required)
body: object, The request body. (required)
The object takes the form of:
{
"resourceName": "A String", # The name of the resource if user wants to update the service information of the resource.
"endpoints": [ # The service information to be updated.
{ # The service endpoint that may be started in a VM.
"name": "A String", # The name of the service endpoint.
"port": 42, # The port of the service endpoint.
},
],
"fingerprint": "A String", # Fingerprint of the service information; a hash of the contents. This field is used for optimistic locking when updating the service entries.
}
Returns:
An object of the form:
{ # An operation resource, used to manage asynchronous API requests.
"targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target.
"clientOperationId": "A String", # [Output only] An optional identifier specified by the client when the mutation was initiated. Must be unique for all operation resources in the project.
"creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource, generated by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations.
"operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete.
"httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned.
"progress": 42, # [Output only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess at when the operation will be complete. This number should be monotonically increasing as the operation progresses.
"httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"status": "A String", # [Output Only] Status of the operation.
"insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format.
"warnings": [ # [Output Only] If there are issues with this operation, a warning is returned.
{
"message": "A String", # [Output only] Optional human-readable details for this warning.
"code": "A String", # [Output only] The warning type identifier for this warning.
"data": [ # [Output only] Metadata for this warning in key:value format.
{
"value": "A String", # [Output Only] Metadata value for this warning.
"key": "A String", # [Output Only] Metadata key for this warning.
},
],
},
],
"user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
"startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format.
"kind": "resourceviews#operation", # [Output only] Type of the resource.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations.
"error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
{
"message": "A String", # [Output Only] An optional, human-readable error message.
"code": "A String", # [Output Only] The error type identifier for this error.
"location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
},
],
},
"endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"targetLink": "A String", # [Output only] URL of the resource the operation is mutating.
}</pre>
</div>
</body></html>
|