You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

225 lines
9.4 KiB

<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="replicapoolupdater_v1beta1.html">Google Compute Engine Instance Group Updater API</a> . <a href="replicapoolupdater_v1beta1.zoneOperations.html">zoneOperations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#get">get(project, zone, operation)</a></code></p>
<p class="firstline">Retrieves the specified zone-specific operation resource.</p>
<p class="toc_element">
<code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
<p class="firstline">Retrieves the list of Operation resources contained within the specified zone.</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>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="get">get(project, zone, operation)</code>
<pre>Retrieves the specified zone-specific operation resource.
Args:
project: string, Name of the project scoping this request. (required)
zone: string, Name of the zone scoping this request. (required)
operation: string, Name of the operation resource to return. (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",
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
"httpErrorStatusCode": 42,
"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. Can be one of the following: "PENDING", "RUNNING", or "DONE".
"insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
"warnings": [
{
"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",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides.
"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 that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] The fully qualified URL for the 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, maxResults=None, pageToken=None, filter=None)</code>
<pre>Retrieves the list of Operation resources contained within the specified zone.
Args:
project: string, Name of the project scoping this request. (required)
zone: string, Name of the zone scoping this request. (required)
maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
filter: string, Optional. Filter expression for filtering listed resources.
Returns:
An object of the form:
{ # Contains a list of Operation resources.
"nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
"items": [ # [Output Only] The Operation resources.
{ # 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",
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"zone": "A String", # [Output Only] URL of the zone where the operation resides.
"operationType": "A String",
"httpErrorMessage": "A String",
"progress": 42,
"httpErrorStatusCode": 42,
"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. Can be one of the following: "PENDING", "RUNNING", or "DONE".
"insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
"warnings": [
{
"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",
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
"kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
"name": "A String", # [Output Only] Name of the resource.
"region": "A String", # [Output Only] URL of the region where the operation resides.
"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 that caused the error. This property is optional.
},
],
},
"endTime": "A String",
"selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
"targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
},
],
"kind": "replicapoolupdater#operationList", # [Output Only] Type of resource. Always replicapoolupdater#operationList for OperationList resources.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
}</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>
</body></html>