• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, 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
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, 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="replicapoolupdater_v1beta1.html">Google Compute Engine Instance Group Updater API</a> . <a href="replicapoolupdater_v1beta1.zoneOperations.html">zoneOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#get">get(project, zone, operation)</a></code></p>
79<p class="firstline">Retrieves the specified zone-specific operation resource.</p>
80<p class="toc_element">
81  <code><a href="#list">list(project, zone, maxResults=None, pageToken=None, filter=None)</a></code></p>
82<p class="firstline">Retrieves the list of Operation resources contained within the specified zone.</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(project, zone, operation)</code>
89  <pre>Retrieves the specified zone-specific operation resource.
90
91Args:
92  project: string, Name of the project scoping this request. (required)
93  zone: string, Name of the zone scoping this request. (required)
94  operation: string, Name of the operation resource to return. (required)
95
96Returns:
97  An object of the form:
98
99    { # An operation resource, used to manage asynchronous API requests.
100    "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
101    "clientOperationId": "A String",
102    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
103    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
104    "zone": "A String", # [Output Only] URL of the zone where the operation resides.
105    "operationType": "A String",
106    "httpErrorMessage": "A String",
107    "progress": 42,
108    "httpErrorStatusCode": 42,
109    "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
110    "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
111    "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
112    "warnings": [
113      {
114        "message": "A String", # [Output only] Optional human-readable details for this warning.
115        "code": "A String", # [Output only] The warning type identifier for this warning.
116        "data": [ # [Output only] Metadata for this warning in key:value format.
117          {
118            "value": "A String", # [Output Only] Metadata value for this warning.
119            "key": "A String", # [Output Only] Metadata key for this warning.
120          },
121        ],
122      },
123    ],
124    "user": "A String",
125    "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
126    "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
127    "name": "A String", # [Output Only] Name of the resource.
128    "region": "A String", # [Output Only] URL of the region where the operation resides.
129    "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
130      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
131        {
132          "message": "A String", # [Output Only] An optional, human-readable error message.
133          "code": "A String", # [Output Only] The error type identifier for this error.
134          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
135        },
136      ],
137    },
138    "endTime": "A String",
139    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
140    "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
141  }</pre>
142</div>
143
144<div class="method">
145    <code class="details" id="list">list(project, zone, maxResults=None, pageToken=None, filter=None)</code>
146  <pre>Retrieves the list of Operation resources contained within the specified zone.
147
148Args:
149  project: string, Name of the project scoping this request. (required)
150  zone: string, Name of the zone scoping this request. (required)
151  maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
152  pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
153  filter: string, Optional. Filter expression for filtering listed resources.
154
155Returns:
156  An object of the form:
157
158    { # Contains a list of Operation resources.
159    "nextPageToken": "A String", # [Output Only] A token used to continue a truncate.
160    "items": [ # [Output Only] The Operation resources.
161      { # An operation resource, used to manage asynchronous API requests.
162        "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
163        "clientOperationId": "A String",
164        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
165        "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
166        "zone": "A String", # [Output Only] URL of the zone where the operation resides.
167        "operationType": "A String",
168        "httpErrorMessage": "A String",
169        "progress": 42,
170        "httpErrorStatusCode": 42,
171        "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
172        "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
173        "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
174        "warnings": [
175          {
176            "message": "A String", # [Output only] Optional human-readable details for this warning.
177            "code": "A String", # [Output only] The warning type identifier for this warning.
178            "data": [ # [Output only] Metadata for this warning in key:value format.
179              {
180                "value": "A String", # [Output Only] Metadata value for this warning.
181                "key": "A String", # [Output Only] Metadata key for this warning.
182              },
183            ],
184          },
185        ],
186        "user": "A String",
187        "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
188        "kind": "replicapoolupdater#operation", # [Output Only] Type of the resource. Always replicapoolupdater#operation for Operation resources.
189        "name": "A String", # [Output Only] Name of the resource.
190        "region": "A String", # [Output Only] URL of the region where the operation resides.
191        "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
192          "errors": [ # [Output Only] The array of errors encountered while processing this operation.
193            {
194              "message": "A String", # [Output Only] An optional, human-readable error message.
195              "code": "A String", # [Output Only] The error type identifier for this error.
196              "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
197            },
198          ],
199        },
200        "endTime": "A String",
201        "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
202        "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating.
203      },
204    ],
205    "kind": "replicapoolupdater#operationList", # [Output Only] Type of resource. Always replicapoolupdater#operationList for OperationList resources.
206    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
207    "selfLink": "A String", # [Output Only] The fully qualified URL for the resource.
208  }</pre>
209</div>
210
211<div class="method">
212    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
213  <pre>Retrieves the next page of results.
214
215Args:
216  previous_request: The request for the previous page. (required)
217  previous_response: The response from the request for the previous page. (required)
218
219Returns:
220  A request object that you can call 'execute()' on to request the next
221  page. Returns None if there are no more items in the collection.
222    </pre>
223</div>
224
225</body></html>