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.machineTypes.html">machineTypes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
79<p class="firstline">Retrieves an aggregated list of machine types.</p>
80<p class="toc_element">
81  <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
84  <code><a href="#get">get(project, zone, machineType)</a></code></p>
85<p class="firstline">Returns the specified machine type. Gets a list of available machine types by making a list() request.</p>
86<p class="toc_element">
87  <code><a href="#list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
88<p class="firstline">Retrieves a list of machine types available to 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="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
95  <pre>Retrieves an aggregated list of machine types.
96
97Args:
98  project: string, Project ID for this request. (required)
99  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
100
101You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
102
103Currently, only sorting by name or creationTimestamp desc is supported.
104  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
105  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
106  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
107
108For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
109
110You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
111
112To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
113
114Returns:
115  An object of the form:
116
117    {
118    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
119    "kind": "compute#machineTypeAggregatedList", # [Output Only] Type of resource. Always compute#machineTypeAggregatedList for aggregated lists of machine types.
120    "items": { # A list of MachineTypesScopedList resources.
121      "a_key": { # [Output Only] Name of the scope containing this set of machine types.
122        "machineTypes": [ # [Output Only] A list of machine types contained in this scope.
123          { # Represents a Machine Type resource.
124              #
125              # You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==)
126            "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
127            "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
128            "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
129            "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
130            "description": "A String", # [Output Only] An optional textual description of the resource.
131            "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
132            "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
133            "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
134              "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
135              "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
136              "state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
137              "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
138              "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
139            },
140            "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
141            "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
142            "scratchDisks": [ # [Output Only] A list of extended scratch disks assigned to the instance.
143              {
144                "diskGb": 42, # Size of the scratch disk, defined in GB.
145              },
146            ],
147            "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
148            "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
149            "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
150            "name": "A String", # [Output Only] Name of the resource.
151          },
152        ],
153        "warning": { # [Output Only] An informational warning that appears when the machine types list is empty.
154          "message": "A String", # [Output Only] A human-readable description of the warning code.
155          "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
156          "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
157              # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
158            {
159              "value": "A String", # [Output Only] A warning data value corresponding to the key.
160              "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
161            },
162          ],
163        },
164      },
165    },
166    "warning": { # [Output Only] Informational warning message.
167      "message": "A String", # [Output Only] A human-readable description of the warning code.
168      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
169      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
170          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
171        {
172          "value": "A String", # [Output Only] A warning data value corresponding to the key.
173          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
174        },
175      ],
176    },
177    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
178    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
179  }</pre>
180</div>
181
182<div class="method">
183    <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
184  <pre>Retrieves the next page of results.
185
186Args:
187  previous_request: The request for the previous page. (required)
188  previous_response: The response from the request for the previous page. (required)
189
190Returns:
191  A request object that you can call 'execute()' on to request the next
192  page. Returns None if there are no more items in the collection.
193    </pre>
194</div>
195
196<div class="method">
197    <code class="details" id="get">get(project, zone, machineType)</code>
198  <pre>Returns the specified machine type. Gets a list of available machine types by making a list() request.
199
200Args:
201  project: string, Project ID for this request. (required)
202  zone: string, The name of the zone for this request. (required)
203  machineType: string, Name of the machine type to return. (required)
204
205Returns:
206  An object of the form:
207
208    { # Represents a Machine Type resource.
209      #
210      # You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==)
211    "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
212    "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
213    "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
214    "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
215    "description": "A String", # [Output Only] An optional textual description of the resource.
216    "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
217    "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
218    "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
219      "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
220      "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
221      "state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
222      "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
223      "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
224    },
225    "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
226    "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
227    "scratchDisks": [ # [Output Only] A list of extended scratch disks assigned to the instance.
228      {
229        "diskGb": 42, # Size of the scratch disk, defined in GB.
230      },
231    ],
232    "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
233    "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
234    "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
235    "name": "A String", # [Output Only] Name of the resource.
236  }</pre>
237</div>
238
239<div class="method">
240    <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
241  <pre>Retrieves a list of machine types available to the specified project.
242
243Args:
244  project: string, Project ID for this request. (required)
245  zone: string, The name of the zone for this request. (required)
246  orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
247
248You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.
249
250Currently, only sorting by name or creationTimestamp desc is supported.
251  maxResults: integer, The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
252  pageToken: string, Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results.
253  filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.
254
255For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.
256
257You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.
258
259To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true).
260
261Returns:
262  An object of the form:
263
264    { # Contains a list of machine types.
265    "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
266    "kind": "compute#machineTypeList", # [Output Only] Type of resource. Always compute#machineTypeList for lists of machine types.
267    "items": [ # A list of MachineType resources.
268      { # Represents a Machine Type resource.
269          #
270          # You can use specific machine types for your VM instances based on performance and pricing requirements. For more information, read Machine Types. (== resource_for v1.machineTypes ==) (== resource_for beta.machineTypes ==)
271        "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the instance.
272        "imageSpaceGb": 42, # [Deprecated] This property is deprecated and will never be populated with any relevant values.
273        "kind": "compute#machineType", # [Output Only] The type of the resource. Always compute#machineType for machine types.
274        "maximumPersistentDisksSizeGb": "A String", # [Output Only] Maximum total persistent disks size (GB) allowed.
275        "description": "A String", # [Output Only] An optional textual description of the resource.
276        "zone": "A String", # [Output Only] The name of the zone where the machine type resides, such as us-central1-a.
277        "maximumPersistentDisks": 42, # [Output Only] Maximum persistent disks allowed.
278        "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this machine type.
279          "deleted": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it.
280          "deprecated": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it.
281          "state": "A String", # The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error.
282          "obsolete": "A String", # An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it.
283          "replacement": "A String", # The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource.
284        },
285        "memoryMb": 42, # [Output Only] The amount of physical memory available to the instance, defined in MB.
286        "isSharedCpu": True or False, # [Output Only] Whether this machine type has a shared CPU. See Shared-core machine types for more information.
287        "scratchDisks": [ # [Output Only] A list of extended scratch disks assigned to the instance.
288          {
289            "diskGb": 42, # Size of the scratch disk, defined in GB.
290          },
291        ],
292        "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
293        "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
294        "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
295        "name": "A String", # [Output Only] Name of the resource.
296      },
297    ],
298    "warning": { # [Output Only] Informational warning message.
299      "message": "A String", # [Output Only] A human-readable description of the warning code.
300      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
301      "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
302          # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
303        {
304          "value": "A String", # [Output Only] A warning data value corresponding to the key.
305          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
306        },
307      ],
308    },
309    "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
310    "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
311  }</pre>
312</div>
313
314<div class="method">
315    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
316  <pre>Retrieves the next page of results.
317
318Args:
319  previous_request: The request for the previous page. (required)
320  previous_response: The response from the request for the previous page. (required)
321
322Returns:
323  A request object that you can call 'execute()' on to request the next
324  page. Returns None if there are no more items in the collection.
325    </pre>
326</div>
327
328</body></html>