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.subnetworks.html">subnetworks</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 subnetworks.</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="#delete">delete(project, region, subnetwork)</a></code></p> 85<p class="firstline">Deletes the specified subnetwork.</p> 86<p class="toc_element"> 87 <code><a href="#expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</a></code></p> 88<p class="firstline">Expands the IP CIDR range of the subnetwork to a specified value.</p> 89<p class="toc_element"> 90 <code><a href="#get">get(project, region, subnetwork)</a></code></p> 91<p class="firstline">Returns the specified subnetwork. Get a list of available subnetworks list() request.</p> 92<p class="toc_element"> 93 <code><a href="#insert">insert(project, region, body)</a></code></p> 94<p class="firstline">Creates a subnetwork in the specified project using the data included in the request.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 97<p class="firstline">Retrieves a list of subnetworks available to the specified project.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<p class="toc_element"> 102 <code><a href="#setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</a></code></p> 103<p class="firstline">Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 107 <pre>Retrieves an aggregated list of subnetworks. 108 109Args: 110 project: string, Project ID for this request. (required) 111 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 112 113You 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. 114 115Currently, only sorting by name or creationTimestamp desc is supported. 116 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) 117 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. 118 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 119 120The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 121 122For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 123 124You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 125 126To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 127 128Returns: 129 An object of the form: 130 131 { 132 "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. 133 "items": { # [Output] A map of scoped Subnetwork lists. 134 "a_key": { # Name of the scope containing this set of Subnetworks. 135 "subnetworks": [ # List of subnetworks contained in this scope. 136 { # A Subnetwork resource. 137 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 138 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 139 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 140 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 141 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 142 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 143 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 144 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 145 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 146 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 147 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 148 }, 149 ], 150 "warning": { # An informational warning that appears when the list of addresses is empty. 151 "message": "A String", # [Output Only] A human-readable description of the warning code. 152 "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. 153 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 154 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 155 { 156 "value": "A String", # [Output Only] A warning data value corresponding to the key. 157 "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). 158 }, 159 ], 160 }, 161 }, 162 }, 163 "kind": "compute#subnetworkAggregatedList", # [Output Only] Type of resource. Always compute#subnetworkAggregatedList for aggregated lists of subnetworks. 164 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 165 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 166 }</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> 171 <pre>Retrieves the next page of results. 172 173Args: 174 previous_request: The request for the previous page. (required) 175 previous_response: The response from the request for the previous page. (required) 176 177Returns: 178 A request object that you can call 'execute()' on to request the next 179 page. Returns None if there are no more items in the collection. 180 </pre> 181</div> 182 183<div class="method"> 184 <code class="details" id="delete">delete(project, region, subnetwork)</code> 185 <pre>Deletes the specified subnetwork. 186 187Args: 188 project: string, Project ID for this request. (required) 189 region: string, Name of the region scoping this request. (required) 190 subnetwork: string, Name of the Subnetwork resource to delete. (required) 191 192Returns: 193 An object of the form: 194 195 { # An Operation resource, used to manage asynchronous API requests. 196 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 197 "clientOperationId": "A String", # [Output Only] Reserved for future use. 198 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 199 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 200 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 201 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 202 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 203 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 204 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 205 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 206 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 207 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 208 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 209 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 210 { 211 "message": "A String", # [Output Only] A human-readable description of the warning code. 212 "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. 213 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 214 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 215 { 216 "value": "A String", # [Output Only] A warning data value corresponding to the key. 217 "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). 218 }, 219 ], 220 }, 221 ], 222 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 223 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 224 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 225 "name": "A String", # [Output Only] Name of the resource. 226 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 227 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 228 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 229 { 230 "message": "A String", # [Output Only] An optional, human-readable error message. 231 "code": "A String", # [Output Only] The error type identifier for this error. 232 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 233 }, 234 ], 235 }, 236 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 237 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 238 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 239 }</pre> 240</div> 241 242<div class="method"> 243 <code class="details" id="expandIpCidrRange">expandIpCidrRange(project, region, subnetwork, body)</code> 244 <pre>Expands the IP CIDR range of the subnetwork to a specified value. 245 246Args: 247 project: string, Project ID for this request. (required) 248 region: string, Name of the region scoping this request. (required) 249 subnetwork: string, Name of the Subnetwork resource to update. (required) 250 body: object, The request body. (required) 251 The object takes the form of: 252 253{ 254 "ipCidrRange": "A String", # The IP (in CIDR format or netmask) of internal addresses that are legal on this Subnetwork. This range should be disjoint from other subnetworks within this network. This range can only be larger than (i.e. a superset of) the range previously defined before the update. 255 } 256 257 258Returns: 259 An object of the form: 260 261 { # An Operation resource, used to manage asynchronous API requests. 262 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 263 "clientOperationId": "A String", # [Output Only] Reserved for future use. 264 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 265 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 266 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 267 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 268 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 269 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 270 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 271 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 272 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 273 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 274 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 275 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 276 { 277 "message": "A String", # [Output Only] A human-readable description of the warning code. 278 "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. 279 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 280 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 281 { 282 "value": "A String", # [Output Only] A warning data value corresponding to the key. 283 "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). 284 }, 285 ], 286 }, 287 ], 288 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 289 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 290 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 291 "name": "A String", # [Output Only] Name of the resource. 292 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 293 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 294 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 295 { 296 "message": "A String", # [Output Only] An optional, human-readable error message. 297 "code": "A String", # [Output Only] The error type identifier for this error. 298 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 299 }, 300 ], 301 }, 302 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 303 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 304 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 305 }</pre> 306</div> 307 308<div class="method"> 309 <code class="details" id="get">get(project, region, subnetwork)</code> 310 <pre>Returns the specified subnetwork. Get a list of available subnetworks list() request. 311 312Args: 313 project: string, Project ID for this request. (required) 314 region: string, Name of the region scoping this request. (required) 315 subnetwork: string, Name of the Subnetwork resource to return. (required) 316 317Returns: 318 An object of the form: 319 320 { # A Subnetwork resource. 321 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 322 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 323 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 324 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 325 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 326 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 327 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 328 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 329 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 330 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 331 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 332 }</pre> 333</div> 334 335<div class="method"> 336 <code class="details" id="insert">insert(project, region, body)</code> 337 <pre>Creates a subnetwork in the specified project using the data included in the request. 338 339Args: 340 project: string, Project ID for this request. (required) 341 region: string, Name of the region scoping this request. (required) 342 body: object, The request body. (required) 343 The object takes the form of: 344 345{ # A Subnetwork resource. 346 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 347 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 348 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 349 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 350 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 351 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 352 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 353 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 354 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 355 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 356 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 357 } 358 359 360Returns: 361 An object of the form: 362 363 { # An Operation resource, used to manage asynchronous API requests. 364 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 365 "clientOperationId": "A String", # [Output Only] Reserved for future use. 366 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 367 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 368 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 369 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 370 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 371 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 372 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 373 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 374 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 375 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 376 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 377 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 378 { 379 "message": "A String", # [Output Only] A human-readable description of the warning code. 380 "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. 381 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 382 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 383 { 384 "value": "A String", # [Output Only] A warning data value corresponding to the key. 385 "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). 386 }, 387 ], 388 }, 389 ], 390 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 391 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 392 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 393 "name": "A String", # [Output Only] Name of the resource. 394 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 395 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 396 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 397 { 398 "message": "A String", # [Output Only] An optional, human-readable error message. 399 "code": "A String", # [Output Only] The error type identifier for this error. 400 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 401 }, 402 ], 403 }, 404 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 405 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 406 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 407 }</pre> 408</div> 409 410<div class="method"> 411 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 412 <pre>Retrieves a list of subnetworks available to the specified project. 413 414Args: 415 project: string, Project ID for this request. (required) 416 region: string, Name of the region scoping this request. (required) 417 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 418 419You 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. 420 421Currently, only sorting by name or creationTimestamp desc is supported. 422 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) 423 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. 424 filter: string, Sets a filter expression for filtering listed resources, in the form filter={expression}. Your {expression} must be in the format: field_name comparison_string literal_string. 425 426The field_name is the name of the field you want to compare. Only atomic field types are supported (string, number, boolean). The comparison_string must be either eq (equals) or ne (not equals). The literal_string is the string value to filter to. The literal value must be valid for the type of field you are filtering by (string, number, boolean). For string fields, the literal value is interpreted as a regular expression using RE2 syntax. The literal value must match the entire field. 427 428For example, to filter for instances that do not have a name of example-instance, you would use filter=name ne example-instance. 429 430You can filter on nested fields. For example, you could filter on instances that have set the scheduling.automaticRestart field to true. Use filtering on nested fields to take advantage of labels to organize and search for results based on label values. 431 432To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart eq true) (zone eq us-central1-f). Multiple expressions are treated as AND expressions, meaning that resources must match all expressions to pass the filters. 433 434Returns: 435 An object of the form: 436 437 { # Contains a list of Subnetwork resources. 438 "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. 439 "items": [ # The Subnetwork resources. 440 { # A Subnetwork resource. 441 "kind": "compute#subnetwork", # [Output Only] Type of the resource. Always compute#subnetwork for Subnetwork resources. 442 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. This field can be set only at resource creation time. 443 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 444 "region": "A String", # URL of the region where the Subnetwork resides. This field can be set only at resource creation time. 445 "network": "A String", # The URL of the network to which this subnetwork belongs, provided by the client when initially creating the subnetwork. Only networks that are in the distributed mode can have subnetworks. This field can be set only at resource creation time. 446 "privateIpGoogleAccess": True or False, # Whether the VMs in this subnet can access Google services without assigned external IP addresses. This field can be both set at resource creation time and updated using setPrivateIpGoogleAccess. 447 "ipCidrRange": "A String", # The range of internal addresses that are owned by this subnetwork. Provide this property when you create the subnetwork. For example, 10.0.0.0/8 or 192.168.0.0/16. Ranges must be unique and non-overlapping within a network. Only IPv4 is supported. This field can be set only at resource creation time. 448 "gatewayAddress": "A String", # [Output Only] The gateway address for default routes to reach destination addresses outside this subnetwork. This field can be set only at resource creation time. 449 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 450 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 451 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 452 }, 453 ], 454 "kind": "compute#subnetworkList", # [Output Only] Type of resource. Always compute#subnetworkList for lists of subnetworks. 455 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 456 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 457 }</pre> 458</div> 459 460<div class="method"> 461 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 462 <pre>Retrieves the next page of results. 463 464Args: 465 previous_request: The request for the previous page. (required) 466 previous_response: The response from the request for the previous page. (required) 467 468Returns: 469 A request object that you can call 'execute()' on to request the next 470 page. Returns None if there are no more items in the collection. 471 </pre> 472</div> 473 474<div class="method"> 475 <code class="details" id="setPrivateIpGoogleAccess">setPrivateIpGoogleAccess(project, region, subnetwork, body)</code> 476 <pre>Set whether VMs in this subnet can access Google services without assigning external IP addresses through Private Google Access. 477 478Args: 479 project: string, Project ID for this request. (required) 480 region: string, Name of the region scoping this request. (required) 481 subnetwork: string, Name of the Subnetwork resource. (required) 482 body: object, The request body. (required) 483 The object takes the form of: 484 485{ 486 "privateIpGoogleAccess": True or False, 487 } 488 489 490Returns: 491 An object of the form: 492 493 { # An Operation resource, used to manage asynchronous API requests. 494 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 495 "clientOperationId": "A String", # [Output Only] Reserved for future use. 496 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 497 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 498 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only available when performing per-zone operations. 499 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 500 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 501 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 502 "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. 503 "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found. 504 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 505 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 506 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 507 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 508 { 509 "message": "A String", # [Output Only] A human-readable description of the warning code. 510 "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. 511 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 512 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 513 { 514 "value": "A String", # [Output Only] A warning data value corresponding to the key. 515 "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). 516 }, 517 ], 518 }, 519 ], 520 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 521 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 522 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 523 "name": "A String", # [Output Only] Name of the resource. 524 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only available when performing regional operations. 525 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 526 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 527 { 528 "message": "A String", # [Output Only] An optional, human-readable error message. 529 "code": "A String", # [Output Only] The error type identifier for this error. 530 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 531 }, 532 ], 533 }, 534 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 535 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 536 "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. 537 }</pre> 538</div> 539 540</body></html>