Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 64b25041f06b049f122bff3b67b7e0ca691fbb52 / . / docs / dyn / compute_v1.instanceTemplates.html
blob: cec70e02557b3d413e0b988c2f8aadaf5f156d9b [file] [log] [blame]
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]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="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.instanceTemplates.html">instanceTemplates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#delete">delete(project, instanceTemplate)</a></code></p>
79<p class="firstline">Deletes the specified instance template resource.</p>
80<p class="toc_element">
81 <code><a href="#get">get(project, instanceTemplate)</a></code></p>
82<p class="firstline">Returns the specified instance template resource.</p>
83<p class="toc_element">
84 <code><a href="#insert">insert(project, body)</a></code></p>
85<p class="firstline">Creates an instance template resource in the specified project using the data included in the request.</p>
86<p class="toc_element">
87 <code><a href="#list">list(project, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves the list of instance template resources contained within the specified project.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="delete">delete(project, instanceTemplate)</code>
95 <pre>Deletes the specified instance template resource.
96
97Args:
98 project: string, Name of the project scoping this request. (required)
99 instanceTemplate: string, Name of the instance template resource to delete. (required)
100
101Returns:
102 An object of the form:
103
104 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]105 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
106 "clientOperationId": "A String",
107 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
108 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
109 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
110 "operationType": "A String",
111 "httpErrorMessage": "A String",
112 "progress": 42,
113 "httpErrorStatusCode": 42,
114 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
115 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
116 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
117 "warnings": [
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]118 {
119 "message": "A String", # Optional human-readable details for this warning.
120 "code": "A String", # The warning type identifier for this warning.
121 "data": [ # Metadata for this warning in 'key: value' format.
122 {
123 "value": "A String", # A warning data value corresponding to the key.
124 "key": "A String", # A key for the warning data.
125 },
126 ],
127 },
128 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]129 "user": "A String",
130 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
131 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
132 "name": "A String", # [Output Only] Name of the resource (output only).
133 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
134 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
135 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]136 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]137 "message": "A String", # [Output Only] An optional, human-readable error message.
138 "code": "A String", # [Output Only] The error type identifier for this error.
139 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]140 },
141 ],
142 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]143 "endTime": "A String",
144 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
145 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]146 }</pre>
147</div>
148
149<div class="method">
150 <code class="details" id="get">get(project, instanceTemplate)</code>
151 <pre>Returns the specified instance template resource.
152
153Args:
154 project: string, Name of the project scoping this request. (required)
155 instanceTemplate: string, Name of the instance template resource to return. (required)
156
157Returns:
158 An object of the form:
159
160 { # An Instance Template resource.
161 "kind": "compute#instanceTemplate", # Type of the resource.
162 "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
163 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
164 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
165 "properties": { # The instance properties portion of this instance template resource.
166 "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
167 "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
168 "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
169 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
170 "A String",
171 ],
172 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
173 },
174 "disks": [ # Array of disks associated with instance created based on this template.
175 { # An instance-attached disk resource.
176 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
177 "kind": "compute#attachedDisk", # Type of the resource.
178 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
179 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
180 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
181 "sourceImage": "A String", # The source image used to create this disk.
182 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
183 },
184 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
185 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
186 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]187 "licenses": [ # Public visible licenses.
188 "A String",
189 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]190 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
191 "interface": "A String",
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]192 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]193 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]194 },
195 ],
196 "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
197 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
198 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
199 },
200 "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
201 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
202 { # A service account.
203 "scopes": [ # The list of scopes to be made available for this service account.
204 "A String",
205 ],
206 "email": "A String", # Email address of the service account.
207 },
208 ],
209 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
210 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
211 {
212 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
213 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
214 },
215 ],
216 "kind": "compute#metadata", # Type of the resource.
217 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
218 },
219 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
220 { # A network interface resource attached to an instance.
221 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
222 { # An access configuration attached to an instance's network interface.
223 "kind": "compute#accessConfig", # Type of the resource.
224 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
225 "name": "A String", # Name of this access configuration.
226 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
227 },
228 ],
229 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
230 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
231 "network": "A String", # URL of the network resource attached to this interface.
232 },
233 ],
234 },
235 "selfLink": "A String", # Server defined URL for the resource (output only).
236 "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
237 }</pre>
238</div>
239
240<div class="method">
241 <code class="details" id="insert">insert(project, body)</code>
242 <pre>Creates an instance template resource in the specified project using the data included in the request.
243
244Args:
245 project: string, Name of the project scoping this request. (required)
246 body: object, The request body. (required)
247 The object takes the form of:
248
249{ # An Instance Template resource.
250 "kind": "compute#instanceTemplate", # Type of the resource.
251 "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
252 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
253 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
254 "properties": { # The instance properties portion of this instance template resource.
255 "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
256 "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
257 "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
258 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
259 "A String",
260 ],
261 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
262 },
263 "disks": [ # Array of disks associated with instance created based on this template.
264 { # An instance-attached disk resource.
265 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
266 "kind": "compute#attachedDisk", # Type of the resource.
267 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
268 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
269 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
270 "sourceImage": "A String", # The source image used to create this disk.
271 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
272 },
273 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
274 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
275 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]276 "licenses": [ # Public visible licenses.
277 "A String",
278 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]279 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
280 "interface": "A String",
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]281 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]282 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]283 },
284 ],
285 "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
286 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
287 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
288 },
289 "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
290 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
291 { # A service account.
292 "scopes": [ # The list of scopes to be made available for this service account.
293 "A String",
294 ],
295 "email": "A String", # Email address of the service account.
296 },
297 ],
298 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
299 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
300 {
301 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
302 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
303 },
304 ],
305 "kind": "compute#metadata", # Type of the resource.
306 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
307 },
308 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
309 { # A network interface resource attached to an instance.
310 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
311 { # An access configuration attached to an instance's network interface.
312 "kind": "compute#accessConfig", # Type of the resource.
313 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
314 "name": "A String", # Name of this access configuration.
315 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
316 },
317 ],
318 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
319 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
320 "network": "A String", # URL of the network resource attached to this interface.
321 },
322 ],
323 },
324 "selfLink": "A String", # Server defined URL for the resource (output only).
325 "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
326 }
327
328
329Returns:
330 An object of the form:
331
332 { # An operation resource, used to manage asynchronous API requests.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]333 "targetId": "A String", # [Output Only] Unique target id which identifies a particular incarnation of the target.
334 "clientOperationId": "A String",
335 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format (output only).
336 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
337 "zone": "A String", # [Output Only] URL of the zone where the operation resides (output only).
338 "operationType": "A String",
339 "httpErrorMessage": "A String",
340 "progress": 42,
341 "httpErrorStatusCode": 42,
342 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
343 "status": "A String", # [Output Only] Status of the operation. Can be one of the following: "PENDING", "RUNNING", or "DONE".
344 "insertTime": "A String", # [Output Only] The time that this operation was requested. This is in RFC 3339 format.
345 "warnings": [
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]346 {
347 "message": "A String", # Optional human-readable details for this warning.
348 "code": "A String", # The warning type identifier for this warning.
349 "data": [ # Metadata for this warning in 'key: value' format.
350 {
351 "value": "A String", # A warning data value corresponding to the key.
352 "key": "A String", # A key for the warning data.
353 },
354 ],
355 },
356 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]357 "user": "A String",
358 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This is in RFC 3339 format.
359 "kind": "compute#operation", # [Output Only] Type of the resource. Always kind#operation for Operation resources.
360 "name": "A String", # [Output Only] Name of the resource (output only).
361 "region": "A String", # [Output Only] URL of the region where the operation resides (output only).
362 "error": { # [Output Only] If errors occurred during processing of this operation, this field will be populated.
363 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]364 {
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]365 "message": "A String", # [Output Only] An optional, human-readable error message.
366 "code": "A String", # [Output Only] The error type identifier for this error.
367 "location": "A String", # [Output Only] Indicates the field in the request which caused the error. This property is optional.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]368 },
369 ],
370 },
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]371 "endTime": "A String",
372 "selfLink": "A String", # [Output Only] Server defined URL for the resource.
373 "targetLink": "A String", # [Output Only] URL of the resource the operation is mutating (output only).
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]374 }</pre>
375</div>
376
377<div class="method">
378 <code class="details" id="list">list(project, maxResults=None, pageToken=None, filter=None)</code>
379 <pre>Retrieves the list of instance template resources contained within the specified project.
380
381Args:
382 project: string, Name of the project scoping this request. (required)
383 maxResults: integer, Optional. Maximum count of results to be returned. Maximum value is 500 and default value is 500.
384 pageToken: string, Optional. Tag returned by a previous list request truncated by maxResults. Used to continue a previous list request.
385 filter: string, Optional. Filter expression for filtering listed resources.
386
387Returns:
388 An object of the form:
389
390 { # Contains a list of instance template resources.
391 "nextPageToken": "A String", # A token used to continue a truncated list request (output only).
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]392 "items": [ # A list of InstanceTemplate resources.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]393 { # An Instance Template resource.
394 "kind": "compute#instanceTemplate", # Type of the resource.
395 "description": "A String", # An optional textual description of the instance template resource; provided by the client when the resource is created.
396 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
397 "creationTimestamp": "A String", # Creation timestamp in RFC3339 text format (output only).
398 "properties": { # The instance properties portion of this instance template resource.
399 "machineType": "A String", # Name of the machine type resource describing which machine type to use to host the instances created based on this template; provided by the client when the instance template is created.
400 "description": "A String", # An optional textual description for the instances created based on the instance template resource; provided by the client when the template is created.
401 "tags": { # A set of instance tags. # A list of tags to be applied to the instances created based on this template used to identify valid sources or targets for network firewalls. Provided by the client on instance creation. The tags can be later modified by the setTags method. Each tag within the list must comply with RFC1035.
402 "items": [ # An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
403 "A String",
404 ],
405 "fingerprint": "A String", # Fingerprint of this resource. A hash of the tags stored in this object. This field is used optimistic locking. An up-to-date tags fingerprint must be provided in order to modify tags.
406 },
407 "disks": [ # Array of disks associated with instance created based on this template.
408 { # An instance-attached disk resource.
409 "deviceName": "A String", # Persistent disk only; must be unique within the instance when specified. This represents a unique device name that is reflected into the /dev/ tree of a Linux operating system running within the instance. If not specified, a default will be chosen by the system.
410 "kind": "compute#attachedDisk", # Type of the resource.
411 "initializeParams": { # Initialization parameters for the new disk (input-only). Can only be specified on the boot disk or local SSDs. Mutually exclusive with 'source'. # Initialization parameters.
412 "diskSizeGb": "A String", # Size of the disk in base-2 GB.
413 "diskName": "A String", # Name of the disk (when not provided defaults to the name of the instance).
414 "sourceImage": "A String", # The source image used to create this disk.
415 "diskType": "A String", # URL of the disk type resource describing which disk type to use to create the disk; provided by the client when the disk is created.
416 },
417 "autoDelete": True or False, # Whether the disk will be auto-deleted when the instance is deleted (but not when the disk is detached from the instance).
418 "index": 42, # A zero-based index to assign to this disk, where 0 is reserved for the boot disk. If not specified, the server will choose an appropriate value (output only).
419 "boot": True or False, # Indicates that this is a boot disk. VM will use the first partition of the disk for its root filesystem.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]420 "licenses": [ # Public visible licenses.
421 "A String",
422 ],
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]423 "mode": "A String", # The mode in which to attach this disk, either "READ_WRITE" or "READ_ONLY".
424 "interface": "A String",
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]425 "type": "A String", # Type of the disk, either "SCRATCH" or "PERSISTENT". Note that persistent disks must be created before you can specify them here.
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]426 "source": "A String", # Persistent disk only; the URL of the persistent disk resource.
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]427 },
428 ],
429 "scheduling": { # Scheduling options for an Instance. # Scheduling options for the instances created based on this template.
430 "automaticRestart": True or False, # Whether the Instance should be automatically restarted whenever it is terminated by Compute Engine (not terminated by user).
431 "onHostMaintenance": "A String", # How the instance should behave when the host machine undergoes maintenance that may temporarily impact instance performance.
432 },
433 "canIpForward": True or False, # Allows instances created based on this template to send packets with source IP addresses other than their own and receive packets with destination IP addresses other than their own. If these instances will be used as an IP gateway or it will be set as the next-hop in a Route resource, say true. If unsure, leave this set to false.
434 "serviceAccounts": [ # A list of service accounts each with specified scopes, for which access tokens are to be made available to the instances created based on this template, through metadata queries.
435 { # A service account.
436 "scopes": [ # The list of scopes to be made available for this service account.
437 "A String",
438 ],
439 "email": "A String", # Email address of the service account.
440 },
441 ],
442 "metadata": { # A metadata key/value entry. # Metadata key/value pairs assigned to instances created based on this template. Consists of custom metadata or predefined keys; see Instance documentation for more information.
443 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB.
444 {
445 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 32768 bytes.
446 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project.
447 },
448 ],
449 "kind": "compute#metadata", # Type of the resource.
450 "fingerprint": "A String", # Fingerprint of this resource. A hash of the metadata's contents. This field is used for optimistic locking. An up-to-date metadata fingerprint must be provided in order to modify metadata.
451 },
452 "networkInterfaces": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instances created based based on this template will have no external internet access.
453 { # A network interface resource attached to an instance.
454 "accessConfigs": [ # Array of configurations for this interface. This specifies how this interface is configured to interact with other network services, such as connecting to the internet. Currently, ONE_TO_ONE_NAT is the only access config supported. If there are no accessConfigs specified, then this instance will have no external internet access.
455 { # An access configuration attached to an instance's network interface.
456 "kind": "compute#accessConfig", # Type of the resource.
457 "type": "ONE_TO_ONE_NAT", # Type of configuration. Must be set to "ONE_TO_ONE_NAT". This configures port-for-port NAT to the internet.
458 "name": "A String", # Name of this access configuration.
459 "natIP": "A String", # An external IP address associated with this instance. Specify an unused static IP address available to the project. If not specified, the external IP will be drawn from a shared ephemeral pool.
460 },
461 ],
462 "networkIP": "A String", # An optional IPV4 internal network address assigned to the instance for this network interface (output only).
463 "name": "A String", # Name of the network interface, determined by the server; for network devices, these are e.g. eth0, eth1, etc. (output only).
464 "network": "A String", # URL of the network resource attached to this interface.
465 },
466 ],
467 },
468 "selfLink": "A String", # Server defined URL for the resource (output only).
469 "name": "A String", # Name of the instance template resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035
470 },
471 ],
472 "kind": "compute#instanceTemplateList", # Type of resource.
473 "id": "A String", # Unique identifier for the resource; defined by the server (output only).
474 "selfLink": "A String", # Server defined URL for this resource (output only).
475 }</pre>
476</div>
477
478<div class="method">
479 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
480 <pre>Retrieves the next page of results.
481
482Args:
483 previous_request: The request for the previous page. (required)
484 previous_response: The response from the request for the previous page. (required)
485
486Returns:
487 A request object that you can call 'execute()' on to request the next
488 page. Returns None if there are no more items in the collection.
489 </pre>
490</div>
491
492</body></html>