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_beta.html">Compute Engine API</a> . <a href="compute_beta.nodeTypes.html">nodeTypes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=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="#close">close()</a></code></p> 85<p class="firstline">Close httplib2 connections.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(project, zone, nodeType, x__xgafv=None)</a></code></p> 88<p class="firstline">Returns the specified node type. Gets a list of available node types by making a list() request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Retrieves a list of node types available to the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 98 <pre>Retrieves an aggregated list of node types. 99 100Args: 101 project: string, Project ID for this request. (required) 102 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 103 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included. 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 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 106 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. 107 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 108 x__xgafv: string, V1 error format. 109 Allowed values 110 1 - v1 error format 111 2 - v2 error format 112 113Returns: 114 An object of the form: 115 116 { 117 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 118 "items": { # A list of NodeTypesScopedList resources. 119 "a_key": { # [Output Only] Name of the scope containing this set of node types. 120 "nodeTypes": [ # [Output Only] A list of node types contained in this scope. 121 { # Represent a sole-tenant Node Type resource. 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. 122 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 123 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 124 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 125 "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. 126 "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. 127 "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. 128 "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. 129 "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. 130 "stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method. 131 "defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. 132 "locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. 133 "a_key": "A String", 134 }, 135 }, 136 }, 137 "description": "A String", # [Output Only] An optional textual description of the resource. 138 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 139 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 140 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 141 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 142 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 143 "name": "A String", # [Output Only] Name of the resource. 144 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 145 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 146 }, 147 ], 148 "warning": { # [Output Only] An informational warning that appears when the node types list is empty. 149 "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. 150 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 151 { 152 "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). 153 "value": "A String", # [Output Only] A warning data value corresponding to the key. 154 }, 155 ], 156 "message": "A String", # [Output Only] A human-readable description of the warning code. 157 }, 158 }, 159 }, 160 "kind": "compute#nodeTypeAggregatedList", # [Output Only] Type of resource.Always compute#nodeTypeAggregatedList for aggregated lists of node types. 161 "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. 162 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 163 "unreachables": [ # [Output Only] Unreachable resources. 164 "A String", 165 ], 166 "warning": { # [Output Only] Informational warning message. 167 "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. 168 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 169 { 170 "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). 171 "value": "A String", # [Output Only] A warning data value corresponding to the key. 172 }, 173 ], 174 "message": "A String", # [Output Only] A human-readable description of the warning code. 175 }, 176}</pre> 177</div> 178 179<div class="method"> 180 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 181 <pre>Retrieves the next page of results. 182 183Args: 184 previous_request: The request for the previous page. (required) 185 previous_response: The response from the request for the previous page. (required) 186 187Returns: 188 A request object that you can call 'execute()' on to request the next 189 page. Returns None if there are no more items in the collection. 190 </pre> 191</div> 192 193<div class="method"> 194 <code class="details" id="close">close()</code> 195 <pre>Close httplib2 connections.</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="get">get(project, zone, nodeType, x__xgafv=None)</code> 200 <pre>Returns the specified node type. Gets a list of available node types by making a list() request. 201 202Args: 203 project: string, Project ID for this request. (required) 204 zone: string, The name of the zone for this request. (required) 205 nodeType: string, Name of the node type to return. (required) 206 x__xgafv: string, V1 error format. 207 Allowed values 208 1 - v1 error format 209 2 - v2 error format 210 211Returns: 212 An object of the form: 213 214 { # Represent a sole-tenant Node Type resource. 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. 215 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 216 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 217 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 218 "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. 219 "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. 220 "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. 221 "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. 222 "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. 223 "stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method. 224 "defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. 225 "locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. 226 "a_key": "A String", 227 }, 228 }, 229 }, 230 "description": "A String", # [Output Only] An optional textual description of the resource. 231 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 232 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 233 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 234 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 235 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 236 "name": "A String", # [Output Only] Name of the resource. 237 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 238 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 239}</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 244 <pre>Retrieves a list of node types available to the specified project. 245 246Args: 247 project: string, Project ID for this request. (required) 248 zone: string, The name of the zone for this request. (required) 249 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You 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. To 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) ``` 250 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`) 251 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You 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. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 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 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 254 x__xgafv: string, V1 error format. 255 Allowed values 256 1 - v1 error format 257 2 - v2 error format 258 259Returns: 260 An object of the form: 261 262 { # Contains a list of node types. 263 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 264 "items": [ # A list of NodeType resources. 265 { # Represent a sole-tenant Node Type resource. 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. 266 "cpuPlatform": "A String", # [Output Only] The CPU platform used by this node type. 267 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 268 "deprecated": { # Deprecation status for a public resource. # [Output Only] The deprecation status associated with this node type. 269 "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. 270 "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. 271 "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. 272 "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. 273 "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. 274 "stateOverride": { # A rollout policy configuration. # The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the imageFamilyViews.get method. 275 "defaultRolloutTime": "A String", # An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. 276 "locationRolloutPolicies": { # Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. 277 "a_key": "A String", 278 }, 279 }, 280 }, 281 "description": "A String", # [Output Only] An optional textual description of the resource. 282 "guestCpus": 42, # [Output Only] The number of virtual CPUs that are available to the node type. 283 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 284 "kind": "compute#nodeType", # [Output Only] The type of the resource. Always compute#nodeType for node types. 285 "localSsdGb": 42, # [Output Only] Local SSD available to the node type, defined in GB. 286 "memoryMb": 42, # [Output Only] The amount of physical memory available to the node type, defined in MB. 287 "name": "A String", # [Output Only] Name of the resource. 288 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 289 "zone": "A String", # [Output Only] The name of the zone where the node type resides, such as us-central1-a. 290 }, 291 ], 292 "kind": "compute#nodeTypeList", # [Output Only] Type of resource.Always compute#nodeTypeList for lists of node types. 293 "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. 294 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 295 "warning": { # [Output Only] Informational warning message. 296 "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. 297 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 298 { 299 "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). 300 "value": "A String", # [Output Only] A warning data value corresponding to the key. 301 }, 302 ], 303 "message": "A String", # [Output Only] A human-readable description of the warning code. 304 }, 305}</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 310 <pre>Retrieves the next page of results. 311 312Args: 313 previous_request: The request for the previous page. (required) 314 previous_response: The response from the request for the previous page. (required) 315 316Returns: 317 A request object that you can call 'execute()' on to request the next 318 page. Returns None if there are no more items in the collection. 319 </pre> 320</div> 321 322</body></html>