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_alpha.html">Compute Engine API</a> . <a href="compute_alpha.nodeTypes.html">nodeTypes</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 node 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, nodeType)</a></code></p> 85<p class="firstline">Returns the specified node type. Gets a list of available node 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 node 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 node 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#nodeTypeAggregatedList", # [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. 120 "items": { # A list of NodeTypesScopedList resources. 121 "a_key": { # [Output Only] Name of the scope containing this set of node types. 122 "warning": { # [Output Only] An informational warning that appears when the node types list is empty. 123 "message": "A String", # [Output Only] A human-readable description of the warning code. 124 "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. 125 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 126 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 127 { 128 "value": "A String", # [Output Only] A warning data value corresponding to the key. 129 "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). 130 }, 131 ], 132 }, 133 "nodeTypes": [ # [Output Only] A list of node types contained in this scope. 134 { # Represent a sole-tenant Node Type resource. 135 # 136 # Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) 137 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 138 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 139 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 140 "description": "A String", # [Output Only] An optional textual description of the resource. 141 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 142 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 143 "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. 144 "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. 145 "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. 146 "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. 147 "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. 148 }, 149 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 150 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 151 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 152 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 153 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 154 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 155 "name": "A String", # [Output Only] Name of the resource. 156 }, 157 ], 158 }, 159 }, 160 "warning": { # [Output Only] Informational warning message. 161 "message": "A String", # [Output Only] A human-readable description of the warning code. 162 "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. 163 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 164 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 165 { 166 "value": "A String", # [Output Only] A warning data value corresponding to the key. 167 "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). 168 }, 169 ], 170 }, 171 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 172 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 173 }</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 178 <pre>Retrieves the next page of results. 179 180Args: 181 previous_request: The request for the previous page. (required) 182 previous_response: The response from the request for the previous page. (required) 183 184Returns: 185 A request object that you can call 'execute()' on to request the next 186 page. Returns None if there are no more items in the collection. 187 </pre> 188</div> 189 190<div class="method"> 191 <code class="details" id="get">get(project, zone, nodeType)</code> 192 <pre>Returns the specified node type. Gets a list of available node types by making a list() request. 193 194Args: 195 project: string, Project ID for this request. (required) 196 zone: string, The name of the zone for this request. (required) 197 nodeType: string, Name of the node type to return. (required) 198 199Returns: 200 An object of the form: 201 202 { # Represent a sole-tenant Node Type resource. 203 # 204 # Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) 205 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 206 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 207 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 208 "description": "A String", # [Output Only] An optional textual description of the resource. 209 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 210 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 211 "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. 212 "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. 213 "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. 214 "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. 215 "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. 216 }, 217 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 218 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 219 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 220 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 221 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 222 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 223 "name": "A String", # [Output Only] Name of the resource. 224 }</pre> 225</div> 226 227<div class="method"> 228 <code class="details" id="list">list(project, zone, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 229 <pre>Retrieves a list of node types available to the specified project. 230 231Args: 232 project: string, Project ID for this request. (required) 233 zone: string, The name of the zone for this request. (required) 234 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 235 236You 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. 237 238Currently, only sorting by name or creationTimestamp desc is supported. 239 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) 240 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. 241 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 <. 242 243For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 244 245You 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. 246 247To 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). 248 249Returns: 250 An object of the form: 251 252 { # Contains a list of node types. 253 "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. 254 "kind": "compute#nodeTypeList", # [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. 255 "items": [ # A list of NodeType resources. 256 { # Represent a sole-tenant Node Type resource. 257 # 258 # Each node within a node group must have a node type. A node type specifies the total amount of cores and memory for that node. Currently, the only available node type is n1-node-96-624 node type that has 96 vCPUs and 624 GB of memory, available in multiple zones. For more information read Node types. (== resource_for beta.nodeTypes ==) (== resource_for v1.nodeTypes ==) 259 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 260 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 261 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 262 "description": "A String", # [Output Only] An optional textual description of the resource. 263 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 264 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 265 "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. 266 "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. 267 "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. 268 "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. 269 "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. 270 }, 271 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 272 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 273 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 274 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 275 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 276 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 277 "name": "A String", # [Output Only] Name of the resource. 278 }, 279 ], 280 "warning": { # [Output Only] Informational warning message. 281 "message": "A String", # [Output Only] A human-readable description of the warning code. 282 "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. 283 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 284 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 285 { 286 "value": "A String", # [Output Only] A warning data value corresponding to the key. 287 "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). 288 }, 289 ], 290 }, 291 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 292 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 293 }</pre> 294</div> 295 296<div class="method"> 297 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 298 <pre>Retrieves the next page of results. 299 300Args: 301 previous_request: The request for the previous page. (required) 302 previous_response: The response from the request for the previous page. (required) 303 304Returns: 305 A request object that you can call 'execute()' on to request the next 306 page. Returns None if there are no more items in the collection. 307 </pre> 308</div> 309 310</body></html>