Debian Codegraph @

docs/dyn/compute_alpha.regionMultiMigMembers.html

raw
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="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionMultiMigMembers.html">regionMultiMigMembers</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#close">close()</a></code></p>
79 <p class="firstline">Close httplib2 connections.</p>
80 <p class="toc_element">
81 <code><a href="#get">get(project, region, multiMig, multiMigMember, x__xgafv=None)</a></code></p>
82 <p class="firstline">Retrieves information about the specified multi-MIG member.</p>
83 <p class="toc_element">
84 <code><a href="#list">list(project, region, multiMig, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Retrieves a list of members of a specific multi-MIG.</p>
86 <p class="toc_element">
87 <code><a href="#list_next">list_next()</a></code></p>
88 <p class="firstline">Retrieves the next page of results.</p>
89 <h3>Method Details</h3>
90 <div class="method">
91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93 </div>
94
95 <div class="method">
96 <code class="details" id="get">get(project, region, multiMig, multiMigMember, x__xgafv=None)</code>
97 <pre>Retrieves information about the specified multi-MIG member.
98
99 Args:
100 project: string, Project ID for this request. (required)
101 region: string, Name of the region for this request. Region name should conform to RFC1035. (required)
102 multiMig: string, The name of the multi-MIG.
103 Name should conform to RFC1035 or be a resource ID. (required)
104 multiMigMember: string, The name of the multi-MIG member.
105 Name should conform to RFC1035 or be a resource ID. (required)
106 x__xgafv: string, V1 error format.
107 Allowed values
108 1 - v1 error format
109 2 - v2 error format
110
111 Returns:
112 An object of the form:
113
114 { # Represents a Multi-MIG member resource.
115 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp of this multi-MIG member inRFC3339 text format.
116 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output only] The unique identifier for this resource type. The server
117 # generates this identifier.
118 &quot;kind&quot;: &quot;compute#multiMigMember&quot;, # Output only. Type of the resource. Alwayscompute#multiMigMember for a list of multi-MIG members.
119 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined name for the multi-MIG member.
120 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the region where the multi-MIG resides.
121 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
122 &quot;status&quot;: { # Output only. [Output Only] The status of this multi-MIG member
123 &quot;instanceGroupManager&quot;: &quot;A String&quot;, # [Output Only] URL of member instance group manager
124 },
125 }</pre>
126 </div>
127
128 <div class="method">
129 <code class="details" id="list">list(project, region, multiMig, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code>
130 <pre>Retrieves a list of members of a specific multi-MIG.
131
132 Args:
133 project: string, Project ID for this request. (required)
134 region: string, Name of the region for this request. Region name should conform to RFC1035. (required)
135 multiMig: string, The name of the multi-MIG.
136 Name should conform to RFC1035 or be a resource ID. (required)
137 filter: string, A filter expression that filters resources listed in the response. Most
138 Compute resources support two types of filter expressions:
139 expressions that support regular expressions and expressions that follow
140 API improvement proposal AIP-160.
141 These two types of filter expressions cannot be mixed in one request.
142
143 If you want to use AIP-160, your expression must specify the field name, an
144 operator, and the value that you want to use for filtering. The value
145 must be a string, a number, or a boolean. The operator
146 must be either `=`, `!=`, `&gt;`, `&lt;`, `&lt;=`, `&gt;=` or `:`.
147
148 For example, if you are filtering Compute Engine instances, you can
149 exclude instances named `example-instance` by specifying
150 `name != example-instance`.
151
152 The `:*` comparison can be used to test whether a key has been defined.
153 For example, to find all objects with `owner` label use:
154 ```
155 labels.owner:*
156 ```
157
158 You can also filter nested fields. For example, you could specify
159 `scheduling.automaticRestart = false` to include instances only
160 if they are not scheduled for automatic restarts. You can use filtering
161 on nested fields to filter based onresource labels.
162
163 To filter on multiple expressions, provide each separate expression within
164 parentheses. For example:
165 ```
166 (scheduling.automaticRestart = true)
167 (cpuPlatform = &quot;Intel Skylake&quot;)
168 ```
169 By default, each expression is an `AND` expression. However, you
170 can include `AND` and `OR` expressions explicitly.
171 For example:
172 ```
173 (cpuPlatform = &quot;Intel Skylake&quot;) OR
174 (cpuPlatform = &quot;Intel Broadwell&quot;) AND
175 (scheduling.automaticRestart = true)
176 ```
177
178 If you want to use a regular expression, use the `eq` (equal) or `ne`
179 (not equal) operator against a single un-parenthesized expression with or
180 without quotes or against multiple parenthesized expressions. Examples:
181
182 `fieldname eq unquoted literal`
183 `fieldname eq &#x27;single quoted literal&#x27;`
184 `fieldname eq &quot;double quoted literal&quot;`
185 `(fieldname1 eq literal) (fieldname2 ne &quot;literal&quot;)`
186
187 The literal value is interpreted as a regular expression using GoogleRE2 library syntax.
188 The literal value must match the entire field.
189
190 For example, to filter for instances that do not end with name &quot;instance&quot;,
191 you would use `name ne .*instance`.
192
193 You cannot combine constraints on multiple fields using regular
194 expressions.
195 maxResults: integer, The maximum number of results per page that should be returned.
196 If the number of available results is larger than `maxResults`,
197 Compute Engine returns a `nextPageToken` that can be used to get
198 the next page of results in subsequent list requests. Acceptable values are
199 `0` to `500`, inclusive. (Default: `500`)
200 orderBy: string, Sorts list results by a certain order. By default, results
201 are returned in alphanumerical order based on the resource name.
202
203 You can also sort results in descending order based on the creation
204 timestamp using `orderBy=&quot;creationTimestamp desc&quot;`. This sorts
205 results based on the `creationTimestamp` field in
206 reverse chronological order (newest result first). Use this to sort
207 resources like operations so that the newest operation is returned first.
208
209 Currently, only sorting by `name` or
210 `creationTimestamp desc` is supported.
211 pageToken: string, Specifies a page token to use. Set `pageToken` to the
212 `nextPageToken` returned by a previous list request to get
213 the next page of results.
214 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case
215 of failure. The default value is false.
216
217 For example, when partial success behavior is enabled, aggregatedList for a
218 single zone scope either returns all resources in the zone or no resources,
219 with an error code.
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225 Returns:
226 An object of the form:
227
228 {
229 &quot;id&quot;: &quot;A String&quot;, # Unique identifier for the resource; defined by the server.
230 &quot;items&quot;: [ # A list of multi-MIG member resources.
231 { # Represents a Multi-MIG member resource.
232 &quot;creationTimestamp&quot;: &quot;A String&quot;, # Output only. [Output Only] Creation timestamp of this multi-MIG member inRFC3339 text format.
233 &quot;id&quot;: &quot;A String&quot;, # Output only. [Output only] The unique identifier for this resource type. The server
234 # generates this identifier.
235 &quot;kind&quot;: &quot;compute#multiMigMember&quot;, # Output only. Type of the resource. Alwayscompute#multiMigMember for a list of multi-MIG members.
236 &quot;name&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined name for the multi-MIG member.
237 &quot;region&quot;: &quot;A String&quot;, # Output only. [Output Only] The URL of the region where the multi-MIG resides.
238 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output Only] Server-defined fully-qualified URL for this resource.
239 &quot;status&quot;: { # Output only. [Output Only] The status of this multi-MIG member
240 &quot;instanceGroupManager&quot;: &quot;A String&quot;, # [Output Only] URL of member instance group manager
241 },
242 },
243 ],
244 &quot;kind&quot;: &quot;compute#multiMigMemberList&quot;, # Output only. Type of the resource. Alwayscompute#multiMigMember for a list of multi-MIG members.
245 &quot;nextPageToken&quot;: &quot;A String&quot;, # This token allows you to get the next page of results for
246 # list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for
247 # the query parameter pageToken in the next list request.
248 # Subsequent list requests will have their own nextPageToken to
249 # continue paging through the results.
250 &quot;selfLink&quot;: &quot;A String&quot;, # Output only. [Output only] Server-defined URL for this resource.
251 &quot;warning&quot;: { # Informational warning message.
252 &quot;code&quot;: &quot;A String&quot;, # [Output Only] A warning code, if applicable. For example, Compute
253 # Engine returns NO_RESULTS_ON_PAGE if there
254 # are no results in the response.
255 &quot;data&quot;: [ # [Output Only] Metadata about this warning in key:
256 # value format. For example:
257 #
258 # &quot;data&quot;: [
259 # {
260 # &quot;key&quot;: &quot;scope&quot;,
261 # &quot;value&quot;: &quot;zones/us-east1-d&quot;
262 # }
263 {
264 &quot;key&quot;: &quot;A String&quot;, # [Output Only] A key that provides more detail on the warning being
265 # returned. For example, for warnings where there are no results in a list
266 # request for a particular zone, this key might be scope and
267 # the key value might be the zone name. Other examples might be a key
268 # indicating a deprecated resource and a suggested replacement, or a
269 # warning about invalid network settings (for example, if an instance
270 # attempts to perform IP forwarding but is not enabled for IP forwarding).
271 &quot;value&quot;: &quot;A String&quot;, # [Output Only] A warning data value corresponding to the key.
272 },
273 ],
274 &quot;message&quot;: &quot;A String&quot;, # [Output Only] A human-readable description of the warning code.
275 },
276 }</pre>
277 </div>
278
279 <div class="method">
280 <code class="details" id="list_next">list_next()</code>
281 <pre>Retrieves the next page of results.
282
283 Args:
284 previous_request: The request for the previous page. (required)
285 previous_response: The response from the request for the previous page. (required)
286
287 Returns:
288 A request object that you can call &#x27;execute()&#x27; on to request the next
289 page. Returns None if there are no more items in the collection.
290 </pre>
291 </div>
292
293 </body></html>