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.networks.html">networks</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#addPeering">addPeering(project, network, body, requestId=None)</a></code></p> 79<p class="firstline">Adds a peering to the specified network.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(project, network, requestId=None)</a></code></p> 82<p class="firstline">Deletes the specified network.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(project, network)</a></code></p> 85<p class="firstline">Returns the specified network. Gets a list of available networks by making a list() request.</p> 86<p class="toc_element"> 87 <code><a href="#getEffectiveFirewalls">getEffectiveFirewalls(project, network)</a></code></p> 88<p class="firstline">Returns the effective firewalls on a given network.</p> 89<p class="toc_element"> 90 <code><a href="#insert">insert(project, body, requestId=None)</a></code></p> 91<p class="firstline">Creates a network in the specified project using the data included in the request.</p> 92<p class="toc_element"> 93 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 94<p class="firstline">Retrieves the list of networks available to the specified project.</p> 95<p class="toc_element"> 96 <code><a href="#listIpAddresses">listIpAddresses(project, network, orderBy=None, maxResults=None, pageToken=None, filter=None, types=None)</a></code></p> 97<p class="firstline">Lists the internal IP addresses in the specified network.</p> 98<p class="toc_element"> 99 <code><a href="#listIpAddresses_next">listIpAddresses_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="#listIpOwners">listIpOwners(project, network, orderBy=None, pageToken=None, ownerTypes=None, ipCidrRange=None, maxResults=None, subnetName=None, subnetRegion=None, ownerProjects=None, filter=None)</a></code></p> 103<p class="firstline">Lists the internal IP owners in the specified network.</p> 104<p class="toc_element"> 105 <code><a href="#listIpOwners_next">listIpOwners_next(previous_request, previous_response)</a></code></p> 106<p class="firstline">Retrieves the next page of results.</p> 107<p class="toc_element"> 108 <code><a href="#listPeeringRoutes">listPeeringRoutes(project, network, orderBy=None, direction=None, region=None, maxResults=None, pageToken=None, filter=None, peeringName=None)</a></code></p> 109<p class="firstline">Lists the peering routes exchanged over peering connection.</p> 110<p class="toc_element"> 111 <code><a href="#listPeeringRoutes_next">listPeeringRoutes_next(previous_request, previous_response)</a></code></p> 112<p class="firstline">Retrieves the next page of results.</p> 113<p class="toc_element"> 114 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 115<p class="firstline">Retrieves the next page of results.</p> 116<p class="toc_element"> 117 <code><a href="#patch">patch(project, network, body, requestId=None)</a></code></p> 118<p class="firstline">Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.</p> 119<p class="toc_element"> 120 <code><a href="#removePeering">removePeering(project, network, body, requestId=None)</a></code></p> 121<p class="firstline">Removes a peering from the specified network.</p> 122<p class="toc_element"> 123 <code><a href="#switchToCustomMode">switchToCustomMode(project, network, requestId=None)</a></code></p> 124<p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p> 125<p class="toc_element"> 126 <code><a href="#testIamPermissions">testIamPermissions(project, resource, body)</a></code></p> 127<p class="firstline">Returns permissions that a caller has on the specified resource.</p> 128<p class="toc_element"> 129 <code><a href="#updatePeering">updatePeering(project, network, body, requestId=None)</a></code></p> 130<p class="firstline">Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes</p> 131<h3>Method Details</h3> 132<div class="method"> 133 <code class="details" id="addPeering">addPeering(project, network, body, requestId=None)</code> 134 <pre>Adds a peering to the specified network. 135 136Args: 137 project: string, Project ID for this request. (required) 138 network: string, Name of the network resource to add peering to. (required) 139 body: object, The request body. (required) 140 The object takes the form of: 141 142{ 143 "networkPeering": { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. # Network peering parameters. In order to specify route policies for peering using import and export custom routes, you must specify all peering related parameters (name, peer network, exchange_subnet_routes) in the network_peering field. The corresponding fields in NetworksAddPeeringRequest will be deprecated soon. 144 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 145 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 146 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 147 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 148 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 149 "peerMtu": 42, # Maximum Transmission Unit in bytes. 150 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 151 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 152 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 153 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 154 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 155 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 156 }, 157 "peerNetwork": "A String", # URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 158 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use exchange_subnet_routes in network_peering instead. Whether Google Compute Engine manages the routes automatically. 159 "exportCustomRoutes": True or False, # This field will be deprecated soon. Use export_custom_routes in network_peering instead. Whether to export the custom routes to peer network. 160 "importCustomRoutes": True or False, # This field will be deprecated soon. Use import_custom_routes in network_peering instead. Whether to import the custom routes from peer network. 161 "name": "A String", # Name of the peering, which should conform to RFC1035. 162 } 163 164 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 165 166For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 167 168The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 169 170Returns: 171 An object of the form: 172 173 { # Represents an Operation resource. 174 # 175 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 176 # 177 # Operations can be global, regional or zonal. 178 # - For global operations, use the globalOperations resource. 179 # - For regional operations, use the regionOperations resource. 180 # - For zonal operations, use the zonalOperations resource. 181 # 182 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 183 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 184 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 185 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 186 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 187 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 188 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 189 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 190 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 191 "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. 192 "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. 193 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 194 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 195 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 196 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 197 { 198 "message": "A String", # [Output Only] A human-readable description of the warning code. 199 "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. 200 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 201 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 202 { 203 "value": "A String", # [Output Only] A warning data value corresponding to the key. 204 "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). 205 }, 206 ], 207 }, 208 ], 209 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 210 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 211 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 212 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 213 "name": "A String", # [Output Only] Name of the resource. 214 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 215 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 216 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 217 { 218 "message": "A String", # [Output Only] An optional, human-readable error message. 219 "code": "A String", # [Output Only] The error type identifier for this error. 220 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 221 }, 222 ], 223 }, 224 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 225 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 226 "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. 227 }</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="delete">delete(project, network, requestId=None)</code> 232 <pre>Deletes the specified network. 233 234Args: 235 project: string, Project ID for this request. (required) 236 network: string, Name of the network to delete. (required) 237 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 238 239For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 240 241The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 242 243Returns: 244 An object of the form: 245 246 { # Represents an Operation resource. 247 # 248 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 249 # 250 # Operations can be global, regional or zonal. 251 # - For global operations, use the globalOperations resource. 252 # - For regional operations, use the regionOperations resource. 253 # - For zonal operations, use the zonalOperations resource. 254 # 255 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 256 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 257 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 258 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 259 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 260 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 261 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 262 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 263 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 264 "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. 265 "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. 266 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 267 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 268 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 269 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 270 { 271 "message": "A String", # [Output Only] A human-readable description of the warning code. 272 "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. 273 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 274 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 275 { 276 "value": "A String", # [Output Only] A warning data value corresponding to the key. 277 "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). 278 }, 279 ], 280 }, 281 ], 282 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 283 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 284 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 285 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 286 "name": "A String", # [Output Only] Name of the resource. 287 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 288 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 289 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 290 { 291 "message": "A String", # [Output Only] An optional, human-readable error message. 292 "code": "A String", # [Output Only] The error type identifier for this error. 293 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 294 }, 295 ], 296 }, 297 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 298 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 299 "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. 300 }</pre> 301</div> 302 303<div class="method"> 304 <code class="details" id="get">get(project, network)</code> 305 <pre>Returns the specified network. Gets a list of available networks by making a list() request. 306 307Args: 308 project: string, Project ID for this request. (required) 309 network: string, Name of the network to return. (required) 310 311Returns: 312 An object of the form: 313 314 { # Represents a VPC Network resource. 315 # 316 # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) 317 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 318 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 319 "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network. 320 "peerings": [ # [Output Only] A list of network peerings for the resource. 321 { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. 322 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 323 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 324 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 325 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 326 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 327 "peerMtu": 42, # Maximum Transmission Unit in bytes. 328 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 329 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 330 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 331 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 332 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 333 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 334 }, 335 ], 336 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 337 "A String", 338 ], 339 "name": "A String", # Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. 340 "multicastMode": "A String", # The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. 341 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 342 "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. 343 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 344 "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. 345 "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. 346 }, 347 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 348 "mtu": 42, # Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. 349 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 350 "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. 351 # 352 # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. 353 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 354 "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network. 355 }</pre> 356</div> 357 358<div class="method"> 359 <code class="details" id="getEffectiveFirewalls">getEffectiveFirewalls(project, network)</code> 360 <pre>Returns the effective firewalls on a given network. 361 362Args: 363 project: string, Project ID for this request. (required) 364 network: string, Name of the network for this request. (required) 365 366Returns: 367 An object of the form: 368 369 { 370 "organizationFirewalls": [ # Effective firewalls from organization policies. 371 { # A pruned SecurityPolicy containing ID and any applicable firewall rules. 372 "rules": [ # The rules that apply to the network. 373 { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). 374 "direction": "A String", # The direction in which this rule applies. This field may only be specified when versioned_expr is set to FIREWALL. 375 "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall security policy rule. 376 "description": "A String", # An optional description of this resource. Provide this property when you create the resource. 377 "kind": "compute#securityPolicyRule", # [Output only] Type of the resource. Always compute#securityPolicyRule for security policy rules 378 "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. 379 # 380 # This field may only be specified when the versioned_expr is set to FIREWALL. 381 "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. 382 "rateLimitOptions": { # Must be specified if the action is "rate_based_blacklist" or "throttle". Cannot be specified for any other actions. 383 "enforceOnKey": "A String", # Determines the key to enforce the threshold_rps limit on. If key is "IP", each IP has this limit enforced separately, whereas "ALL_IPs" means a single limit is applied to all requests matching this rule. 384 "thresholdRps": 42, # Rate in requests per second at which to begin ratelimiting. 385 "conformAction": "A String", # Action to take when requests are under the given threshold. When requests are throttled, this is also the action for all requests which are not dropped. Valid options are "allow", "fairshare", and "drop_overload". 386 "blockDuration": 42, # Can only be specifed if the action for the rule is "rate_based_blacklist" If specified, determines the time (in seconds) the traffic will continue to be blocked by the rate limit after the rate falls below the threshold. The default value is 0 seconds. 387 "exceedAction": "A String", # When a request is denied, returns the HTTP response code specified. Valid options are "deny()" where valid values for status are 403, 404, 429, and 502. 388 }, 389 "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network?s VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. 390 # 391 # This field may only be specified when versioned_expr is set to FIREWALL. 392 "A String", 393 ], 394 "action": "A String", # The Action to preform when the client connection triggers the rule. Can currently be either "allow" or "deny()" where valid values for status are 403, 404, and 502. 395 "preview": True or False, # If set to true, the specified action is not enforced. 396 "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding ?action? is enforced. 397 "expr": { # Represents an expression text. Example: # User defined CEVAL expression. A CEVAL expression is used to specify match criteria such as origin.ip, source.region_code and contents in the request header. 398 # 399 # title: "User account presence" description: "Determines whether the request has a user account" expression: "size(request.user) > 0" 400 "title": "A String", # An optional title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression. 401 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 402 # 403 # The application context of the containing message determines which well-known feature set of CEL is supported. 404 "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 405 "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 406 }, 407 "config": { # The configuration options available when specifying versioned_expr. This field must be specified if versioned_expr is specified and cannot be specified if versioned_expr is not specified. 408 "srcIpRanges": [ # CIDR IP address range. 409 "A String", 410 ], 411 "destIpRanges": [ # CIDR IP address range. 412 # 413 # This field may only be specified when versioned_expr is set to FIREWALL. 414 "A String", 415 ], 416 "destPorts": [ # Pairs of IP protocols and ports that the rule should match. 417 # 418 # This field may only be specified when versioned_expr is set to FIREWALL. 419 { 420 "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. 421 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. 422 # 423 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 424 # 425 # This field may only be specified when versioned_expr is set to FIREWALL. 426 "A String", 427 ], 428 }, 429 ], 430 }, 431 "versionedExpr": "A String", # Preconfigured versioned expression. If this field is specified, config must also be specified. Available preconfigured expressions along with their requirements are: SRC_IPS_V1 - must specify the corresponding src_ip_range field in config. 432 }, 433 }, 434 ], 435 "id": "A String", # [Output Only] The unique identifier for the security policy. This identifier is defined by the server. 436 }, 437 ], 438 "firewalls": [ # Effective firewalls on the network. 439 { # Represents a Firewall Rule resource. 440 # 441 # Firewall rules allow or deny ingress traffic to, and egress traffic from your instances. For more information, read Firewall rules. 442 "priority": 42, # Priority for this rule. This is an integer between `0` and `65535`, both inclusive. The default value is `1000`. Relative priorities determine which rule takes effect if multiple rules apply. Lower values indicate higher priority. For example, a rule with priority `0` has higher precedence than a rule with priority `1`. DENY rules take precedence over ALLOW rules if they have equal priority. Note that VPC networks have implied rules with a priority of `65535`. To avoid conflicts with the implied rules, use a priority number less than `65535`. 443 "direction": "A String", # Direction of traffic to which this firewall applies, either `INGRESS` or `EGRESS`. The default is `INGRESS`. For `INGRESS` traffic, you cannot specify the destinationRanges field, and for `EGRESS` traffic, you cannot specify the sourceRanges or sourceTags fields. 444 "sourceRanges": [ # If source ranges are specified, the firewall rule applies only to traffic that has a source IP address in these ranges. These ranges must be expressed in CIDR format. One or both of sourceRanges and sourceTags may be set. If both fields are set, the rule applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the rule to apply. Only IPv4 is supported. 445 "A String", 446 ], 447 "sourceServiceAccounts": [ # If source service accounts are specified, the firewall rules apply only to traffic originating from an instance with a service account in this list. Source service accounts cannot be used to control traffic to an instance's external IP address because service accounts are associated with an instance, not an IP address. sourceRanges can be set at the same time as sourceServiceAccounts. If both are set, the firewall applies to traffic that has a source IP address within the sourceRanges OR a source IP that belongs to an instance with service account listed in sourceServiceAccount. The connection does not need to match both fields for the firewall to apply. sourceServiceAccounts cannot be used at the same time as sourceTags or targetTags. 448 "A String", 449 ], 450 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 451 "destinationRanges": [ # If destination ranges are specified, the firewall rule applies only to traffic that has destination IP address in these ranges. These ranges must be expressed in CIDR format. Only IPv4 is supported. 452 "A String", 453 ], 454 "sourceTags": [ # If source tags are specified, the firewall rule applies only to traffic with source IPs that match the primary network interfaces of VM instances that have the tag and are in the same VPC network. Source tags cannot be used to control traffic to an instance's external IP address, it only applies to traffic between instances in the same virtual network. Because tags are associated with instances, not IP addresses. One or both of sourceRanges and sourceTags may be set. If both fields are set, the firewall applies to traffic that has a source IP address within sourceRanges OR a source IP from a resource with a matching tag listed in the sourceTags field. The connection does not need to match both fields for the firewall to apply. 455 "A String", 456 ], 457 "allowed": [ # The list of ALLOW rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a permitted connection. 458 { 459 "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number. 460 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. 461 # 462 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 463 "A String", 464 ], 465 }, 466 ], 467 "enableLogging": True or False, # Deprecated in favor of enable in LogConfig. This field denotes whether to enable logging for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. 468 "kind": "compute#firewall", # [Output Only] Type of the resource. Always compute#firewall for firewall rules. 469 "logConfig": { # The available logging options for a firewall rule. # This field denotes the logging options for a particular firewall rule. If logging is enabled, logs will be exported to Stackdriver. 470 "enable": True or False, # This field denotes whether to enable logging for a particular firewall rule. 471 "metadata": "A String", # This field can only be specified for a particular firewall rule if logging is enabled for that rule. This field denotes whether to include or exclude metadata for firewall logs. 472 }, 473 "disabled": True or False, # Denotes whether the firewall rule is disabled. When set to true, the firewall rule is not enforced and the network behaves as if it did not exist. If this is unspecified, the firewall rule will be enabled. 474 "network": "A String", # URL of the network resource for this firewall rule. If not specified when creating a firewall rule, the default network is used: 475 # global/networks/default 476 # If you choose to specify this field, you can specify the network as a full or partial URL. For example, the following are all valid URLs: 477 # - https://www.googleapis.com/compute/v1/projects/myproject/global/networks/my-network 478 # - projects/myproject/global/networks/my-network 479 # - global/networks/default 480 "targetServiceAccounts": [ # A list of service accounts indicating sets of instances located in the network that may make network connections as specified in allowed[]. targetServiceAccounts cannot be used at the same time as targetTags or sourceTags. If neither targetServiceAccounts nor targetTags are specified, the firewall rule applies to all instances on the specified network. 481 "A String", 482 ], 483 "targetTags": [ # A list of tags that controls which instances the firewall rule applies to. If targetTags are specified, then the firewall rule applies only to instances in the VPC network that have one of those tags. If no targetTags are specified, the firewall rule applies to all instances on the specified network. 484 "A String", 485 ], 486 "denied": [ # The list of DENY rules specified by this firewall. Each rule specifies a protocol and port-range tuple that describes a denied connection. 487 { 488 "IPProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp) or the IP protocol number. 489 "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for the UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. 490 # 491 # Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. 492 "A String", 493 ], 494 }, 495 ], 496 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 497 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 498 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 499 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 500 "name": "A String", # Name of the resource; provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. 501 }, 502 ], 503 }</pre> 504</div> 505 506<div class="method"> 507 <code class="details" id="insert">insert(project, body, requestId=None)</code> 508 <pre>Creates a network in the specified project using the data included in the request. 509 510Args: 511 project: string, Project ID for this request. (required) 512 body: object, The request body. (required) 513 The object takes the form of: 514 515{ # Represents a VPC Network resource. 516 # 517 # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) 518 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 519 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 520 "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network. 521 "peerings": [ # [Output Only] A list of network peerings for the resource. 522 { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. 523 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 524 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 525 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 526 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 527 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 528 "peerMtu": 42, # Maximum Transmission Unit in bytes. 529 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 530 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 531 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 532 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 533 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 534 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 535 }, 536 ], 537 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 538 "A String", 539 ], 540 "name": "A String", # Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. 541 "multicastMode": "A String", # The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. 542 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 543 "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. 544 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 545 "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. 546 "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. 547 }, 548 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 549 "mtu": 42, # Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. 550 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 551 "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. 552 # 553 # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. 554 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 555 "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network. 556 } 557 558 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 559 560For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 561 562The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 563 564Returns: 565 An object of the form: 566 567 { # Represents an Operation resource. 568 # 569 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 570 # 571 # Operations can be global, regional or zonal. 572 # - For global operations, use the globalOperations resource. 573 # - For regional operations, use the regionOperations resource. 574 # - For zonal operations, use the zonalOperations resource. 575 # 576 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 577 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 578 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 579 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 580 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 581 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 582 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 583 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 584 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 585 "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. 586 "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. 587 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 588 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 589 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 590 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 591 { 592 "message": "A String", # [Output Only] A human-readable description of the warning code. 593 "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. 594 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 595 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 596 { 597 "value": "A String", # [Output Only] A warning data value corresponding to the key. 598 "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). 599 }, 600 ], 601 }, 602 ], 603 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 604 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 605 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 606 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 607 "name": "A String", # [Output Only] Name of the resource. 608 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 609 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 610 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 611 { 612 "message": "A String", # [Output Only] An optional, human-readable error message. 613 "code": "A String", # [Output Only] The error type identifier for this error. 614 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 615 }, 616 ], 617 }, 618 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 619 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 620 "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. 621 }</pre> 622</div> 623 624<div class="method"> 625 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 626 <pre>Retrieves the list of networks available to the specified project. 627 628Args: 629 project: string, Project ID for this request. (required) 630 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 631 632You 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. 633 634Currently, only sorting by name or creationTimestamp desc is supported. 635 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) 636 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. 637 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 <. 638 639For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 640 641You 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. 642 643To 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). 644 645Returns: 646 An object of the form: 647 648 { # Contains a list of networks. 649 "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. 650 "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks. 651 "items": [ # A list of Network resources. 652 { # Represents a VPC Network resource. 653 # 654 # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) 655 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 656 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 657 "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network. 658 "peerings": [ # [Output Only] A list of network peerings for the resource. 659 { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. 660 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 661 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 662 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 663 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 664 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 665 "peerMtu": 42, # Maximum Transmission Unit in bytes. 666 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 667 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 668 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 669 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 670 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 671 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 672 }, 673 ], 674 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 675 "A String", 676 ], 677 "name": "A String", # Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. 678 "multicastMode": "A String", # The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. 679 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 680 "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. 681 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 682 "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. 683 "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. 684 }, 685 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 686 "mtu": 42, # Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. 687 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 688 "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. 689 # 690 # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. 691 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 692 "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network. 693 }, 694 ], 695 "warning": { # [Output Only] Informational warning message. 696 "message": "A String", # [Output Only] A human-readable description of the warning code. 697 "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. 698 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 699 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 700 { 701 "value": "A String", # [Output Only] A warning data value corresponding to the key. 702 "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). 703 }, 704 ], 705 }, 706 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 707 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 708 }</pre> 709</div> 710 711<div class="method"> 712 <code class="details" id="listIpAddresses">listIpAddresses(project, network, orderBy=None, maxResults=None, pageToken=None, filter=None, types=None)</code> 713 <pre>Lists the internal IP addresses in the specified network. 714 715Args: 716 project: string, Project ID for this request. (required) 717 network: string, Name of the network for this request. (required) 718 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 719 720You 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. 721 722Currently, only sorting by name or creationTimestamp desc is supported. 723 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) 724 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. 725 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 <. 726 727For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 728 729You 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. 730 731To 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). 732 types: string, (Optional) types filter separate by comma, valid values are: SUBNETWORK, RESERVED, PEER_USED, PEER_RESERVED, REMOTE_USED, REMOTE_RESERVED. 733 734Returns: 735 An object of the form: 736 737 { 738 "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. 739 "kind": "compute#ipAddressesList", # [Output Only] Type of resource. Always compute#ipAddressesList for IP addresses lists. 740 "items": [ # A list of InternalIpAddress resources. 741 { 742 "owner": "A String", # The owner of the internal IP address. 743 "region": "A String", # The region of the internal IP address if applicable. 744 "cidr": "A String", # IP CIDR address or range. 745 "type": "A String", # The type of the internal IP address. 746 "purpose": "A String", # The purpose of the internal IP address if applicable. 747 }, 748 ], 749 "warning": { # [Output Only] Informational warning message. 750 "message": "A String", # [Output Only] A human-readable description of the warning code. 751 "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. 752 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 753 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 754 { 755 "value": "A String", # [Output Only] A warning data value corresponding to the key. 756 "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). 757 }, 758 ], 759 }, 760 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 761 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 762 }</pre> 763</div> 764 765<div class="method"> 766 <code class="details" id="listIpAddresses_next">listIpAddresses_next(previous_request, previous_response)</code> 767 <pre>Retrieves the next page of results. 768 769Args: 770 previous_request: The request for the previous page. (required) 771 previous_response: The response from the request for the previous page. (required) 772 773Returns: 774 A request object that you can call 'execute()' on to request the next 775 page. Returns None if there are no more items in the collection. 776 </pre> 777</div> 778 779<div class="method"> 780 <code class="details" id="listIpOwners">listIpOwners(project, network, orderBy=None, pageToken=None, ownerTypes=None, ipCidrRange=None, maxResults=None, subnetName=None, subnetRegion=None, ownerProjects=None, filter=None)</code> 781 <pre>Lists the internal IP owners in the specified network. 782 783Args: 784 project: string, Project ID for this request. (required) 785 network: string, Name of the network to return. (required) 786 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 787 788You 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. 789 790Currently, only sorting by name or creationTimestamp desc is supported. 791 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. 792 ownerTypes: string, (Optional) Owner types filter, example: "instance,forwardingRule". 793 ipCidrRange: string, (Optional) IP CIDR range filter, example: "10.128.10.0/30". 794 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) 795 subnetName: string, (Optional) Subnetwork name filter. 796 subnetRegion: string, (Optional) Subnetwork region filter. 797 ownerProjects: string, (Optional) Project IDs filter, example: "project-1,project-2". 798 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 <. 799 800For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 801 802You 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. 803 804To 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). 805 806Returns: 807 An object of the form: 808 809 { # Contains a list of IP owners. 810 "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. 811 "kind": "compute#ipOwnerList", # [Output Only] Type of resource. Always compute#ipOwnerList for lists of IP owners. 812 "items": [ # A list of InternalIpOwner resources. 813 { 814 "owners": [ # URLs of the IP owners of the IP CIDR range. 815 "A String", 816 ], 817 "ipCidrRange": "A String", # IP CIDR range being owned. 818 "systemOwned": True or False, # Whether this IP CIDR range is reserved for system use. 819 }, 820 ], 821 "warning": { # [Output Only] Informational warning message. 822 "message": "A String", # [Output Only] A human-readable description of the warning code. 823 "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. 824 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 825 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 826 { 827 "value": "A String", # [Output Only] A warning data value corresponding to the key. 828 "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). 829 }, 830 ], 831 }, 832 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 833 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 834 }</pre> 835</div> 836 837<div class="method"> 838 <code class="details" id="listIpOwners_next">listIpOwners_next(previous_request, previous_response)</code> 839 <pre>Retrieves the next page of results. 840 841Args: 842 previous_request: The request for the previous page. (required) 843 previous_response: The response from the request for the previous page. (required) 844 845Returns: 846 A request object that you can call 'execute()' on to request the next 847 page. Returns None if there are no more items in the collection. 848 </pre> 849</div> 850 851<div class="method"> 852 <code class="details" id="listPeeringRoutes">listPeeringRoutes(project, network, orderBy=None, direction=None, region=None, maxResults=None, pageToken=None, filter=None, peeringName=None)</code> 853 <pre>Lists the peering routes exchanged over peering connection. 854 855Args: 856 project: string, Project ID for this request. (required) 857 network: string, Name of the network for this request. (required) 858 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 859 860You 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. 861 862Currently, only sorting by name or creationTimestamp desc is supported. 863 direction: string, The direction of the exchanged routes. 864 Allowed values 865 INCOMING - 866 OUTGOING - 867 region: string, The region of the request. The response will include all subnet routes, static routes and dynamic routes in the region. 868 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) 869 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. 870 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 <. 871 872For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 873 874You 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. 875 876To 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). 877 peeringName: string, The response will show routes exchanged over the given peering connection. 878 879Returns: 880 An object of the form: 881 882 { 883 "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. 884 "kind": "compute#exchangedPeeringRoutesList", # [Output Only] Type of resource. Always compute#exchangedPeeringRoutesList for exchanged peering routes lists. 885 "items": [ # A list of ExchangedPeeringRoute resources. 886 { 887 "priority": 42, # The priority of the peering route. 888 "type": "A String", # The type of the peering route. 889 "destRange": "A String", # The destination range of the route. 890 "imported": True or False, # True if the peering route has been imported from a peer. The actual import happens if the field networkPeering.importCustomRoutes is true for this network, and networkPeering.exportCustomRoutes is true for the peer network, and the import does not result in a route conflict. 891 "nextHopRegion": "A String", # The region of peering route next hop, only applies to dynamic routes. 892 }, 893 ], 894 "warning": { # [Output Only] Informational warning message. 895 "message": "A String", # [Output Only] A human-readable description of the warning code. 896 "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. 897 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 898 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 899 { 900 "value": "A String", # [Output Only] A warning data value corresponding to the key. 901 "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). 902 }, 903 ], 904 }, 905 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 906 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 907 }</pre> 908</div> 909 910<div class="method"> 911 <code class="details" id="listPeeringRoutes_next">listPeeringRoutes_next(previous_request, previous_response)</code> 912 <pre>Retrieves the next page of results. 913 914Args: 915 previous_request: The request for the previous page. (required) 916 previous_response: The response from the request for the previous page. (required) 917 918Returns: 919 A request object that you can call 'execute()' on to request the next 920 page. Returns None if there are no more items in the collection. 921 </pre> 922</div> 923 924<div class="method"> 925 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 926 <pre>Retrieves the next page of results. 927 928Args: 929 previous_request: The request for the previous page. (required) 930 previous_response: The response from the request for the previous page. (required) 931 932Returns: 933 A request object that you can call 'execute()' on to request the next 934 page. Returns None if there are no more items in the collection. 935 </pre> 936</div> 937 938<div class="method"> 939 <code class="details" id="patch">patch(project, network, body, requestId=None)</code> 940 <pre>Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. 941 942Args: 943 project: string, Project ID for this request. (required) 944 network: string, Name of the network to update. (required) 945 body: object, The request body. (required) 946 The object takes the form of: 947 948{ # Represents a VPC Network resource. 949 # 950 # Networks connect resources to each other and to the internet. For more information, read Virtual Private Cloud (VPC) Network. (== resource_for v1.networks ==) (== resource_for beta.networks ==) 951 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 952 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 953 "loadBalancerVmEncryption": "A String", # [Output Only] Type of LB-to-VM traffic encryption for this network. 954 "peerings": [ # [Output Only] A list of network peerings for the resource. 955 { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. 956 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 957 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 958 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 959 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 960 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 961 "peerMtu": 42, # Maximum Transmission Unit in bytes. 962 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 963 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 964 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 965 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 966 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 967 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 968 }, 969 ], 970 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 971 "A String", 972 ], 973 "name": "A String", # Name of the resource. Provided by the client when the resource is created. 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])?. The first character must be a lowercase letter, and all following characters (except for the last character) must be a dash, lowercase letter, or digit. The last character must be a lowercase letter or digit. 974 "multicastMode": "A String", # The multicast mode for this network. If set to ZONAL, multicast is allowed within a zone. If set to DISABLED, multicast is disabled for this network. The default is DISABLED. 975 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 976 "IPv4Range": "A String", # Deprecated in favor of subnet mode networks. The range of internal addresses that are legal on this network. This range is a CIDR specification, for example: 192.168.0.0/16. Provided by the client when the network is created. 977 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 978 "routingConfig": { # A routing configuration attached to a network resource. The message includes the list of routers associated with the network, and a flag indicating the type of routing behavior to enforce network-wide. # The network-level routing configuration for this network. Used by Cloud Router to determine what type of network-wide routing behavior to enforce. 979 "routingMode": "A String", # The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. 980 }, 981 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 982 "mtu": 42, # Maximum Transmission Unit in bytes. The minimum value for this field is 1460 and the maximum value is 1600 bytes. 983 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 984 "autoCreateSubnetworks": True or False, # When set to true, the VPC network is created in "auto" mode. When set to false, the VPC network is created in "custom" mode. 985 # 986 # An auto mode VPC network starts with one subnet per region. Each subnet has a predetermined range as described in Auto mode VPC network IP ranges. 987 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 988 "crossVmEncryption": "A String", # [Output Only] Type of VM-to-VM traffic encryption for this network. 989 } 990 991 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 992 993For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 994 995The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 996 997Returns: 998 An object of the form: 999 1000 { # Represents an Operation resource. 1001 # 1002 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1003 # 1004 # Operations can be global, regional or zonal. 1005 # - For global operations, use the globalOperations resource. 1006 # - For regional operations, use the regionOperations resource. 1007 # - For zonal operations, use the zonalOperations resource. 1008 # 1009 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1010 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1011 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1012 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1013 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1014 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1015 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1016 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1017 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1018 "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. 1019 "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. 1020 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1021 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1022 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1023 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1024 { 1025 "message": "A String", # [Output Only] A human-readable description of the warning code. 1026 "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. 1027 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1028 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1029 { 1030 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1031 "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). 1032 }, 1033 ], 1034 }, 1035 ], 1036 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1037 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1038 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1039 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1040 "name": "A String", # [Output Only] Name of the resource. 1041 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1042 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1043 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1044 { 1045 "message": "A String", # [Output Only] An optional, human-readable error message. 1046 "code": "A String", # [Output Only] The error type identifier for this error. 1047 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1048 }, 1049 ], 1050 }, 1051 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1052 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1053 "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. 1054 }</pre> 1055</div> 1056 1057<div class="method"> 1058 <code class="details" id="removePeering">removePeering(project, network, body, requestId=None)</code> 1059 <pre>Removes a peering from the specified network. 1060 1061Args: 1062 project: string, Project ID for this request. (required) 1063 network: string, Name of the network resource to remove peering from. (required) 1064 body: object, The request body. (required) 1065 The object takes the form of: 1066 1067{ 1068 "name": "A String", # Name of the peering, which should conform to RFC1035. 1069 } 1070 1071 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 1072 1073For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 1074 1075The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1076 1077Returns: 1078 An object of the form: 1079 1080 { # Represents an Operation resource. 1081 # 1082 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1083 # 1084 # Operations can be global, regional or zonal. 1085 # - For global operations, use the globalOperations resource. 1086 # - For regional operations, use the regionOperations resource. 1087 # - For zonal operations, use the zonalOperations resource. 1088 # 1089 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1090 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1091 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1092 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1093 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1094 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1095 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1096 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1097 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1098 "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. 1099 "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. 1100 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1101 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1102 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1103 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1104 { 1105 "message": "A String", # [Output Only] A human-readable description of the warning code. 1106 "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. 1107 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1108 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1109 { 1110 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1111 "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). 1112 }, 1113 ], 1114 }, 1115 ], 1116 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1117 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1118 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1119 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1120 "name": "A String", # [Output Only] Name of the resource. 1121 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1122 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1123 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1124 { 1125 "message": "A String", # [Output Only] An optional, human-readable error message. 1126 "code": "A String", # [Output Only] The error type identifier for this error. 1127 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1128 }, 1129 ], 1130 }, 1131 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1132 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1133 "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. 1134 }</pre> 1135</div> 1136 1137<div class="method"> 1138 <code class="details" id="switchToCustomMode">switchToCustomMode(project, network, requestId=None)</code> 1139 <pre>Switches the network mode from auto subnet mode to custom subnet mode. 1140 1141Args: 1142 project: string, Project ID for this request. (required) 1143 network: string, Name of the network to be updated. (required) 1144 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 1145 1146For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 1147 1148The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1149 1150Returns: 1151 An object of the form: 1152 1153 { # Represents an Operation resource. 1154 # 1155 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1156 # 1157 # Operations can be global, regional or zonal. 1158 # - For global operations, use the globalOperations resource. 1159 # - For regional operations, use the regionOperations resource. 1160 # - For zonal operations, use the zonalOperations resource. 1161 # 1162 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1163 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1164 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1165 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1166 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1167 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1168 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1169 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1170 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1171 "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. 1172 "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. 1173 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1174 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1175 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1176 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1177 { 1178 "message": "A String", # [Output Only] A human-readable description of the warning code. 1179 "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. 1180 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1181 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1182 { 1183 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1184 "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). 1185 }, 1186 ], 1187 }, 1188 ], 1189 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1190 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1191 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1192 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1193 "name": "A String", # [Output Only] Name of the resource. 1194 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1195 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1196 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1197 { 1198 "message": "A String", # [Output Only] An optional, human-readable error message. 1199 "code": "A String", # [Output Only] The error type identifier for this error. 1200 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1201 }, 1202 ], 1203 }, 1204 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1205 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1206 "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. 1207 }</pre> 1208</div> 1209 1210<div class="method"> 1211 <code class="details" id="testIamPermissions">testIamPermissions(project, resource, body)</code> 1212 <pre>Returns permissions that a caller has on the specified resource. 1213 1214Args: 1215 project: string, Project ID for this request. (required) 1216 resource: string, Name or id of the resource for this request. (required) 1217 body: object, The request body. (required) 1218 The object takes the form of: 1219 1220{ 1221 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. 1222 "A String", 1223 ], 1224 } 1225 1226 1227Returns: 1228 An object of the form: 1229 1230 { 1231 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed. 1232 "A String", 1233 ], 1234 }</pre> 1235</div> 1236 1237<div class="method"> 1238 <code class="details" id="updatePeering">updatePeering(project, network, body, requestId=None)</code> 1239 <pre>Updates the specified network peering with the data included in the request Only the following fields can be modified: NetworkPeering.export_custom_routes, and NetworkPeering.import_custom_routes 1240 1241Args: 1242 project: string, Project ID for this request. (required) 1243 network: string, Name of the network resource which the updated peering is belonging to. (required) 1244 body: object, The request body. (required) 1245 The object takes the form of: 1246 1247{ 1248 "networkPeering": { # A network peering attached to a network resource. The message includes the peering name, peer network, peering state, and a flag indicating whether Google Compute Engine should automatically create routes for the peering. 1249 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 1250 "name": "A String", # Name of this peering. Provided by the client when the peering is created. The name must comply with RFC1035. Specifically, the name must be 1-63 characters long and match regular expression `[a-z]([-a-z0-9]*[a-z0-9])?`. The first character must be a lowercase letter, and all the following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. 1251 "autoCreateRoutes": True or False, # This field will be deprecated soon. Use the exchange_subnet_routes field instead. Indicates whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 1252 "advertisePeerSubnetsViaRouters": True or False, # Whether Cloud Routers in this network can automatically advertise subnets from the peer network. 1253 "importSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are imported. The default value is false. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always imported from peers and are not controlled by this field. 1254 "peerMtu": 42, # Maximum Transmission Unit in bytes. 1255 "state": "A String", # [Output Only] State for the peering, either `ACTIVE` or `INACTIVE`. The peering is `ACTIVE` when there's a matching configuration in the peer network. 1256 "exportCustomRoutes": True or False, # Whether to export the custom routes to peer network. 1257 "exportSubnetRoutesWithPublicIp": True or False, # Whether subnet routes with public IP range are exported. The default value is true, all subnet routes are exported. The IPv4 special-use ranges (https://en.wikipedia.org/wiki/IPv4#Special_addresses) are always exported to peers and are not controlled by this field. 1258 "exchangeSubnetRoutes": True or False, # Whether full mesh connectivity is created and managed automatically. When it is set to true, Google Compute Engine will automatically create and manage the routes between two networks when the peering state is ACTIVE. Otherwise, user needs to create routes manually to route packets to peer network. 1259 "importCustomRoutes": True or False, # Whether to import the custom routes from peer network. 1260 "network": "A String", # The URL of the peer network. It can be either full URL or partial URL. The peer network may belong to a different project. If the partial URL does not contain project, it is assumed that the peer network is in the same project as the current network. 1261 }, 1262 } 1263 1264 requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. 1265 1266For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. 1267 1268The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 1269 1270Returns: 1271 An object of the form: 1272 1273 { # Represents an Operation resource. 1274 # 1275 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 1276 # 1277 # Operations can be global, regional or zonal. 1278 # - For global operations, use the globalOperations resource. 1279 # - For regional operations, use the regionOperations resource. 1280 # - For zonal operations, use the zonalOperations resource. 1281 # 1282 # For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==) 1283 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1284 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1285 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1286 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 1287 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1288 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1289 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 1290 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 1291 "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. 1292 "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. 1293 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1294 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 1295 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1296 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1297 { 1298 "message": "A String", # [Output Only] A human-readable description of the warning code. 1299 "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. 1300 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 1301 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1302 { 1303 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1304 "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). 1305 }, 1306 ], 1307 }, 1308 ], 1309 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1310 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 1311 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1312 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 1313 "name": "A String", # [Output Only] Name of the resource. 1314 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1315 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1316 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1317 { 1318 "message": "A String", # [Output Only] An optional, human-readable error message. 1319 "code": "A String", # [Output Only] The error type identifier for this error. 1320 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1321 }, 1322 ], 1323 }, 1324 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1325 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1326 "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. 1327 }</pre> 1328</div> 1329 1330</body></html>