1 <html><body> 2 <style> 3 4 body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13 } 14 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51 } 52 53 .toc_element { 54 margin-top: 0.5em; 55 } 56 57 .firstline { 58 margin-left: 2 em; 59 } 60 61 .method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66 } 67 68 .details { 69 font-weight: bold; 70 font-size: 14px; 71 } 72 73 </style> 74 75 <h1><a href="resourceviews_v1beta2.html">Google Compute Engine Instance Groups API</a> . <a href="resourceviews_v1beta2.zoneViews.html">zoneViews</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#addResources">addResources(project, zone, resourceView, body)</a></code></p> 79 <p class="firstline">Add resources to the view.</p> 80 <p class="toc_element"> 81 <code><a href="#delete">delete(project, zone, resourceView)</a></code></p> 82 <p class="firstline">Delete a resource view.</p> 83 <p class="toc_element"> 84 <code><a href="#get">get(project, zone, resourceView)</a></code></p> 85 <p class="firstline">Get the information of a zonal resource view.</p> 86 <p class="toc_element"> 87 <code><a href="#getService">getService(project, zone, resourceView, resourceName=None)</a></code></p> 88 <p class="firstline">Get the service information of a resource view or a resource.</p> 89 <p class="toc_element"> 90 <code><a href="#insert">insert(project, zone, body)</a></code></p> 91 <p class="firstline">Create a resource view.</p> 92 <p class="toc_element"> 93 <code><a href="#list">list(project, zone, pageToken=None, maxResults=None)</a></code></p> 94 <p class="firstline">List resource views.</p> 95 <p class="toc_element"> 96 <code><a href="#listResources">listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)</a></code></p> 97 <p class="firstline">List the resources of the resource view.</p> 98 <p class="toc_element"> 99 <code><a href="#listResources_next">listResources_next(previous_request, previous_response)</a></code></p> 100 <p class="firstline">Retrieves the next page of results.</p> 101 <p class="toc_element"> 102 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 103 <p class="firstline">Retrieves the next page of results.</p> 104 <p class="toc_element"> 105 <code><a href="#removeResources">removeResources(project, zone, resourceView, body)</a></code></p> 106 <p class="firstline">Remove resources from the view.</p> 107 <p class="toc_element"> 108 <code><a href="#setService">setService(project, zone, resourceView, body)</a></code></p> 109 <p class="firstline">Update the service information of a resource view or a resource.</p> 110 <h3>Method Details</h3> 111 <div class="method"> 112 <code class="details" id="addResources">addResources(project, zone, resourceView, body)</code> 113 <pre>Add resources to the view. 114 115 Args: 116 project: string, The project name of the resource view. (required) 117 zone: string, The zone name of the resource view. (required) 118 resourceView: string, The name of the resource view. (required) 119 body: object, The request body. (required) 120 The object takes the form of: 121 122 { # The request to add resources to the resource view. 123 "resources": [ # The list of resources to be added. 124 "A String", 125 ], 126 } 127 128 129 Returns: 130 An object of the form: 131 132 { # An operation resource, used to manage asynchronous API requests. 133 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. 134 "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. 135 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 136 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server. 137 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. 138 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete. 139 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned. 140 "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. 141 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned. 142 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 143 "status": "A String", # [Output Only] Status of the operation. 144 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 145 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned. 146 { 147 "message": "A String", # [Output only] Optional human-readable details for this warning. 148 "code": "A String", # [Output only] The warning type identifier for this warning. 149 "data": [ # [Output only] Metadata for this warning in key:value format. 150 { 151 "value": "A String", # [Output Only] Metadata value for this warning. 152 "key": "A String", # [Output Only] Metadata key for this warning. 153 }, 154 ], 155 }, 156 ], 157 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 158 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format. 159 "kind": "resourceviews#operation", # [Output only] Type of the resource. 160 "name": "A String", # [Output Only] Name of the resource. 161 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations. 162 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. 163 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 164 { 165 "message": "A String", # [Output Only] An optional, human-readable error message. 166 "code": "A String", # [Output Only] The error type identifier for this error. 167 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. 168 }, 169 ], 170 }, 171 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format. 172 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 173 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating. 174 }</pre> 175 </div> 176 177 <div class="method"> 178 <code class="details" id="delete">delete(project, zone, resourceView)</code> 179 <pre>Delete a resource view. 180 181 Args: 182 project: string, The project name of the resource view. (required) 183 zone: string, The zone name of the resource view. (required) 184 resourceView: string, The name of the resource view. (required) 185 186 Returns: 187 An object of the form: 188 189 { # An operation resource, used to manage asynchronous API requests. 190 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. 191 "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. 192 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 193 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server. 194 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. 195 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete. 196 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned. 197 "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. 198 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned. 199 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 200 "status": "A String", # [Output Only] Status of the operation. 201 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 202 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned. 203 { 204 "message": "A String", # [Output only] Optional human-readable details for this warning. 205 "code": "A String", # [Output only] The warning type identifier for this warning. 206 "data": [ # [Output only] Metadata for this warning in key:value format. 207 { 208 "value": "A String", # [Output Only] Metadata value for this warning. 209 "key": "A String", # [Output Only] Metadata key for this warning. 210 }, 211 ], 212 }, 213 ], 214 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 215 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format. 216 "kind": "resourceviews#operation", # [Output only] Type of the resource. 217 "name": "A String", # [Output Only] Name of the resource. 218 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations. 219 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. 220 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 221 { 222 "message": "A String", # [Output Only] An optional, human-readable error message. 223 "code": "A String", # [Output Only] The error type identifier for this error. 224 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. 225 }, 226 ], 227 }, 228 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format. 229 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 230 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating. 231 }</pre> 232 </div> 233 234 <div class="method"> 235 <code class="details" id="get">get(project, zone, resourceView)</code> 236 <pre>Get the information of a zonal resource view. 237 238 Args: 239 project: string, The project name of the resource view. (required) 240 zone: string, The zone name of the resource view. (required) 241 resourceView: string, The name of the resource view. (required) 242 243 Returns: 244 An object of the form: 245 246 { # The resource view object. 247 "size": 42, # The total number of resources in the resource view. 248 "kind": "resourceviews#resourceView", # Type of the resource. 249 "description": "A String", # The detailed description of the resource view. 250 "labels": [ # The labels for events. 251 { # The Label to be applied to the resource views. 252 "value": "A String", # Value of the label. 253 "key": "A String", # Key of the label. 254 }, 255 ], 256 "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong. 257 "selfLink": "A String", # [Output Only] A self-link to the resource view. 258 "fingerprint": "A String", # The fingerprint of the service endpoint information. 259 "endpoints": [ # Services endpoint information. 260 { # The service endpoint that may be started in a VM. 261 "name": "A String", # The name of the service endpoint. 262 "port": 42, # The port of the service endpoint. 263 }, 264 ], 265 "creationTimestamp": "A String", # The creation time of the resource view. 266 "id": "A String", # [Output Only] The ID of the resource view. 267 "resources": [ # A list of all resources in the resource view. 268 "A String", 269 ], 270 "name": "A String", # The name of the resource view. 271 }</pre> 272 </div> 273 274 <div class="method"> 275 <code class="details" id="getService">getService(project, zone, resourceView, resourceName=None)</code> 276 <pre>Get the service information of a resource view or a resource. 277 278 Args: 279 project: string, The project name of the resource view. (required) 280 zone: string, The zone name of the resource view. (required) 281 resourceView: string, The name of the resource view. (required) 282 resourceName: string, The name of the resource if user wants to get the service information of the resource. 283 284 Returns: 285 An object of the form: 286 287 { 288 "endpoints": [ # The service information. 289 { # The service endpoint that may be started in a VM. 290 "name": "A String", # The name of the service endpoint. 291 "port": 42, # The port of the service endpoint. 292 }, 293 ], 294 "fingerprint": "A String", # The fingerprint of the service information. 295 }</pre> 296 </div> 297 298 <div class="method"> 299 <code class="details" id="insert">insert(project, zone, body)</code> 300 <pre>Create a resource view. 301 302 Args: 303 project: string, The project name of the resource view. (required) 304 zone: string, The zone name of the resource view. (required) 305 body: object, The request body. (required) 306 The object takes the form of: 307 308 { # The resource view object. 309 "size": 42, # The total number of resources in the resource view. 310 "kind": "resourceviews#resourceView", # Type of the resource. 311 "description": "A String", # The detailed description of the resource view. 312 "labels": [ # The labels for events. 313 { # The Label to be applied to the resource views. 314 "value": "A String", # Value of the label. 315 "key": "A String", # Key of the label. 316 }, 317 ], 318 "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong. 319 "selfLink": "A String", # [Output Only] A self-link to the resource view. 320 "fingerprint": "A String", # The fingerprint of the service endpoint information. 321 "endpoints": [ # Services endpoint information. 322 { # The service endpoint that may be started in a VM. 323 "name": "A String", # The name of the service endpoint. 324 "port": 42, # The port of the service endpoint. 325 }, 326 ], 327 "creationTimestamp": "A String", # The creation time of the resource view. 328 "id": "A String", # [Output Only] The ID of the resource view. 329 "resources": [ # A list of all resources in the resource view. 330 "A String", 331 ], 332 "name": "A String", # The name of the resource view. 333 } 334 335 336 Returns: 337 An object of the form: 338 339 { # An operation resource, used to manage asynchronous API requests. 340 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. 341 "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. 342 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 343 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server. 344 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. 345 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete. 346 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned. 347 "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. 348 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned. 349 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 350 "status": "A String", # [Output Only] Status of the operation. 351 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 352 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned. 353 { 354 "message": "A String", # [Output only] Optional human-readable details for this warning. 355 "code": "A String", # [Output only] The warning type identifier for this warning. 356 "data": [ # [Output only] Metadata for this warning in key:value format. 357 { 358 "value": "A String", # [Output Only] Metadata value for this warning. 359 "key": "A String", # [Output Only] Metadata key for this warning. 360 }, 361 ], 362 }, 363 ], 364 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 365 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format. 366 "kind": "resourceviews#operation", # [Output only] Type of the resource. 367 "name": "A String", # [Output Only] Name of the resource. 368 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations. 369 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. 370 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 371 { 372 "message": "A String", # [Output Only] An optional, human-readable error message. 373 "code": "A String", # [Output Only] The error type identifier for this error. 374 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. 375 }, 376 ], 377 }, 378 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format. 379 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 380 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating. 381 }</pre> 382 </div> 383 384 <div class="method"> 385 <code class="details" id="list">list(project, zone, pageToken=None, maxResults=None)</code> 386 <pre>List resource views. 387 388 Args: 389 project: string, The project name of the resource view. (required) 390 zone: string, The zone name of the resource view. (required) 391 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. 392 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000) 393 394 Returns: 395 An object of the form: 396 397 { # The response to a list request. 398 "nextPageToken": "A String", # A token used for pagination. 399 "items": [ # The result that contains all resource views that meet the criteria. 400 { # The resource view object. 401 "size": 42, # The total number of resources in the resource view. 402 "kind": "resourceviews#resourceView", # Type of the resource. 403 "description": "A String", # The detailed description of the resource view. 404 "labels": [ # The labels for events. 405 { # The Label to be applied to the resource views. 406 "value": "A String", # Value of the label. 407 "key": "A String", # Key of the label. 408 }, 409 ], 410 "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong. 411 "selfLink": "A String", # [Output Only] A self-link to the resource view. 412 "fingerprint": "A String", # The fingerprint of the service endpoint information. 413 "endpoints": [ # Services endpoint information. 414 { # The service endpoint that may be started in a VM. 415 "name": "A String", # The name of the service endpoint. 416 "port": 42, # The port of the service endpoint. 417 }, 418 ], 419 "creationTimestamp": "A String", # The creation time of the resource view. 420 "id": "A String", # [Output Only] The ID of the resource view. 421 "resources": [ # A list of all resources in the resource view. 422 "A String", 423 ], 424 "name": "A String", # The name of the resource view. 425 }, 426 ], 427 "kind": "resourceviews#zoneViewsList", # Type of resource. 428 "selfLink": "A String", # Server defined URL for this resource (output only). 429 }</pre> 430 </div> 431 432 <div class="method"> 433 <code class="details" id="listResources">listResources(project, zone, resourceView, listState=None, format=None, maxResults=None, pageToken=None, serviceName=None)</code> 434 <pre>List the resources of the resource view. 435 436 Args: 437 project: string, The project name of the resource view. (required) 438 zone: string, The zone name of the resource view. (required) 439 resourceView: string, The name of the resource view. (required) 440 listState: string, The state of the instance to list. By default, it lists all instances. 441 Allowed values 442 ALL - 443 RUNNING - 444 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. 445 Allowed values 446 NONE - 447 URL - 448 URL_PORT - 449 maxResults: integer, Maximum count of results to be returned. Acceptable values are 0 to 5000, inclusive. (Default: 5000) 450 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. 451 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. 452 453 Returns: 454 An object of the form: 455 456 { # The response to a list resource request. 457 "nextPageToken": "A String", # A token used for pagination. 458 "items": [ # The formatted JSON that is requested by the user. 459 { # The list response item that contains the resource and end points information. 460 "endpoints": { # The list of service end points on the resource. 461 "a_key": [ # The name of the service end point. 462 42, 463 ], 464 }, 465 "resource": "A String", # The full URL of the resource. 466 }, 467 ], 468 "network": "A String", # The URL of a Compute Engine network to which the resources in the view belong. 469 }</pre> 470 </div> 471 472 <div class="method"> 473 <code class="details" id="listResources_next">listResources_next(previous_request, previous_response)</code> 474 <pre>Retrieves the next page of results. 475 476 Args: 477 previous_request: The request for the previous page. (required) 478 previous_response: The response from the request for the previous page. (required) 479 480 Returns: 481 A request object that you can call 'execute()' on to request the next 482 page. Returns None if there are no more items in the collection. 483 </pre> 484 </div> 485 486 <div class="method"> 487 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 488 <pre>Retrieves the next page of results. 489 490 Args: 491 previous_request: The request for the previous page. (required) 492 previous_response: The response from the request for the previous page. (required) 493 494 Returns: 495 A request object that you can call 'execute()' on to request the next 496 page. Returns None if there are no more items in the collection. 497 </pre> 498 </div> 499 500 <div class="method"> 501 <code class="details" id="removeResources">removeResources(project, zone, resourceView, body)</code> 502 <pre>Remove resources from the view. 503 504 Args: 505 project: string, The project name of the resource view. (required) 506 zone: string, The zone name of the resource view. (required) 507 resourceView: string, The name of the resource view. (required) 508 body: object, The request body. (required) 509 The object takes the form of: 510 511 { # The request to remove resources from the resource view. 512 "resources": [ # The list of resources to be removed. 513 "A String", 514 ], 515 } 516 517 518 Returns: 519 An object of the form: 520 521 { # An operation resource, used to manage asynchronous API requests. 522 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. 523 "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. 524 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 525 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server. 526 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. 527 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete. 528 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned. 529 "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. 530 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned. 531 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 532 "status": "A String", # [Output Only] Status of the operation. 533 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 534 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned. 535 { 536 "message": "A String", # [Output only] Optional human-readable details for this warning. 537 "code": "A String", # [Output only] The warning type identifier for this warning. 538 "data": [ # [Output only] Metadata for this warning in key:value format. 539 { 540 "value": "A String", # [Output Only] Metadata value for this warning. 541 "key": "A String", # [Output Only] Metadata key for this warning. 542 }, 543 ], 544 }, 545 ], 546 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 547 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format. 548 "kind": "resourceviews#operation", # [Output only] Type of the resource. 549 "name": "A String", # [Output Only] Name of the resource. 550 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations. 551 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. 552 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 553 { 554 "message": "A String", # [Output Only] An optional, human-readable error message. 555 "code": "A String", # [Output Only] The error type identifier for this error. 556 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. 557 }, 558 ], 559 }, 560 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format. 561 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 562 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating. 563 }</pre> 564 </div> 565 566 <div class="method"> 567 <code class="details" id="setService">setService(project, zone, resourceView, body)</code> 568 <pre>Update the service information of a resource view or a resource. 569 570 Args: 571 project: string, The project name of the resource view. (required) 572 zone: string, The zone name of the resource view. (required) 573 resourceView: string, The name of the resource view. (required) 574 body: object, The request body. (required) 575 The object takes the form of: 576 577 { 578 "resourceName": "A String", # The name of the resource if user wants to update the service information of the resource. 579 "endpoints": [ # The service information to be updated. 580 { # The service endpoint that may be started in a VM. 581 "name": "A String", # The name of the service endpoint. 582 "port": 42, # The port of the service endpoint. 583 }, 584 ], 585 "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. 586 } 587 588 589 Returns: 590 An object of the form: 591 592 { # An operation resource, used to manage asynchronous API requests. 593 "targetId": "A String", # [Output Only] Unique target ID which identifies a particular incarnation of the target. 594 "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. 595 "creationTimestamp": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 596 "id": "A String", # [Output Only] Unique identifier for the resource, generated by the server. 597 "zone": "A String", # [Output Only] URL of the zone where the operation resides. Only available when performing per-zone operations. 598 "operationType": "A String", # [Output only] Type of the operation. Operations include insert, update, and delete. 599 "httpErrorMessage": "A String", # [Output only] If operation fails, the HTTP error message returned. 600 "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. 601 "httpErrorStatusCode": 42, # [Output only] If operation fails, the HTTP error status code returned. 602 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 603 "status": "A String", # [Output Only] Status of the operation. 604 "insertTime": "A String", # [Output Only] The time that this operation was requested, in RFC3339 text format. 605 "warnings": [ # [Output Only] If there are issues with this operation, a warning is returned. 606 { 607 "message": "A String", # [Output only] Optional human-readable details for this warning. 608 "code": "A String", # [Output only] The warning type identifier for this warning. 609 "data": [ # [Output only] Metadata for this warning in key:value format. 610 { 611 "value": "A String", # [Output Only] Metadata value for this warning. 612 "key": "A String", # [Output Only] Metadata key for this warning. 613 }, 614 ], 615 }, 616 ], 617 "user": "A String", # [Output Only] User who requested the operation, for example: user (a] example.com. 618 "startTime": "A String", # [Output Only] The time that this operation was started by the server, in RFC3339 text format. 619 "kind": "resourceviews#operation", # [Output only] Type of the resource. 620 "name": "A String", # [Output Only] Name of the resource. 621 "region": "A String", # [Output Only] URL of the region where the operation resides. Only available when performing regional operations. 622 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated. 623 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 624 { 625 "message": "A String", # [Output Only] An optional, human-readable error message. 626 "code": "A String", # [Output Only] The error type identifier for this error. 627 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional. 628 }, 629 ], 630 }, 631 "endTime": "A String", # [Output Only] The time that this operation was completed, in RFC3339 text format. 632 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. 633 "targetLink": "A String", # [Output only] URL of the resource the operation is mutating. 634 }</pre> 635 </div> 636 637 </body></html>
