1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="compute_v1.html">Compute Engine API</a> . <a href="compute_v1.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="#insert">insert(project, body, requestId=None)</a></code></p> 88<p class="firstline">Creates a network in the specified project using the data included in the request.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p> 91<p class="firstline">Retrieves the list of networks available to the specified project.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<p class="toc_element"> 96 <code><a href="#patch">patch(project, network, body, requestId=None)</a></code></p> 97<p class="firstline">Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode.</p> 98<p class="toc_element"> 99 <code><a href="#removePeering">removePeering(project, network, body, requestId=None)</a></code></p> 100<p class="firstline">Removes a peering from the specified network.</p> 101<p class="toc_element"> 102 <code><a href="#switchToCustomMode">switchToCustomMode(project, network, requestId=None)</a></code></p> 103<p class="firstline">Switches the network mode from auto subnet mode to custom subnet mode.</p> 104<h3>Method Details</h3> 105<div class="method"> 106 <code class="details" id="addPeering">addPeering(project, network, body, requestId=None)</code> 107 <pre>Adds a peering to the specified network. 108 109Args: 110 project: string, Project ID for this request. (required) 111 network: string, Name of the network resource to add peering to. (required) 112 body: object, The request body. (required) 113 The object takes the form of: 114 115{ 116 "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. 117 "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. 118 "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. 119 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 120 "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. 121 "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. 122 "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. 123 }, 124 "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. 125 "name": "A String", # Name of the peering, which should conform to RFC1035. 126 "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. 127 } 128 129 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. 130 131For 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. 132 133The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 134 135Returns: 136 An object of the form: 137 138 { # Represents an Operation resource. 139 # 140 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 141 # 142 # Operations can be global, regional or zonal. 143 # - For global operations, use the globalOperations resource. 144 # - For regional operations, use the regionOperations resource. 145 # - For zonal operations, use the zonalOperations resource. 146 # 147 # 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 ==) 148 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 149 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 150 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 151 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 152 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 153 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 154 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 155 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 156 "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. 157 "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. 158 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 159 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 160 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 161 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 162 { 163 "message": "A String", # [Output Only] A human-readable description of the warning code. 164 "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. 165 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 166 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 167 { 168 "value": "A String", # [Output Only] A warning data value corresponding to the key. 169 "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). 170 }, 171 ], 172 }, 173 ], 174 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 175 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 176 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 177 "name": "A String", # [Output Only] Name of the resource. 178 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 179 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 180 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 181 { 182 "message": "A String", # [Output Only] An optional, human-readable error message. 183 "code": "A String", # [Output Only] The error type identifier for this error. 184 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 185 }, 186 ], 187 }, 188 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 189 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 190 "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. 191 }</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="delete">delete(project, network, requestId=None)</code> 196 <pre>Deletes the specified network. 197 198Args: 199 project: string, Project ID for this request. (required) 200 network: string, Name of the network to delete. (required) 201 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. 202 203For 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. 204 205The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 206 207Returns: 208 An object of the form: 209 210 { # Represents an Operation resource. 211 # 212 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 213 # 214 # Operations can be global, regional or zonal. 215 # - For global operations, use the globalOperations resource. 216 # - For regional operations, use the regionOperations resource. 217 # - For zonal operations, use the zonalOperations resource. 218 # 219 # 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 ==) 220 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 221 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 222 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 223 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 224 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 225 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 226 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 227 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 228 "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. 229 "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. 230 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 231 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 232 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 233 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 234 { 235 "message": "A String", # [Output Only] A human-readable description of the warning code. 236 "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. 237 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 238 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 239 { 240 "value": "A String", # [Output Only] A warning data value corresponding to the key. 241 "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). 242 }, 243 ], 244 }, 245 ], 246 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 247 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 248 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 249 "name": "A String", # [Output Only] Name of the resource. 250 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 251 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 252 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 253 { 254 "message": "A String", # [Output Only] An optional, human-readable error message. 255 "code": "A String", # [Output Only] The error type identifier for this error. 256 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 257 }, 258 ], 259 }, 260 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 261 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 262 "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. 263 }</pre> 264</div> 265 266<div class="method"> 267 <code class="details" id="get">get(project, network)</code> 268 <pre>Returns the specified network. Gets a list of available networks by making a list() request. 269 270Args: 271 project: string, Project ID for this request. (required) 272 network: string, Name of the network to return. (required) 273 274Returns: 275 An object of the form: 276 277 { # Represents a VPC Network resource. 278 # 279 # 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 ==) 280 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 281 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 282 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 283 "A String", 284 ], 285 "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. 286 # 287 # 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. 288 "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. 289 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 290 "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. 291 "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. 292 }, 293 "peerings": [ # [Output Only] A list of network peerings for the resource. 294 { # 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. 295 "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. 296 "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. 297 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 298 "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. 299 "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. 300 "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. 301 }, 302 ], 303 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 304 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 305 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 306 "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. 307 }</pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="insert">insert(project, body, requestId=None)</code> 312 <pre>Creates a network in the specified project using the data included in the request. 313 314Args: 315 project: string, Project ID for this request. (required) 316 body: object, The request body. (required) 317 The object takes the form of: 318 319{ # Represents a VPC Network resource. 320 # 321 # 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 ==) 322 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 323 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 324 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 325 "A String", 326 ], 327 "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. 328 # 329 # 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. 330 "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. 331 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 332 "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. 333 "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. 334 }, 335 "peerings": [ # [Output Only] A list of network peerings for the resource. 336 { # 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. 337 "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. 338 "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. 339 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 340 "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. 341 "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. 342 "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. 343 }, 344 ], 345 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 346 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 347 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 348 "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. 349 } 350 351 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. 352 353For 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. 354 355The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 356 357Returns: 358 An object of the form: 359 360 { # Represents an Operation resource. 361 # 362 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 363 # 364 # Operations can be global, regional or zonal. 365 # - For global operations, use the globalOperations resource. 366 # - For regional operations, use the regionOperations resource. 367 # - For zonal operations, use the zonalOperations resource. 368 # 369 # 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 ==) 370 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 371 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 372 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 373 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 374 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 375 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 376 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 377 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 378 "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. 379 "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. 380 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 381 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 382 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 383 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 384 { 385 "message": "A String", # [Output Only] A human-readable description of the warning code. 386 "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. 387 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 388 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 389 { 390 "value": "A String", # [Output Only] A warning data value corresponding to the key. 391 "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). 392 }, 393 ], 394 }, 395 ], 396 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 397 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 398 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 399 "name": "A String", # [Output Only] Name of the resource. 400 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 401 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 402 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 403 { 404 "message": "A String", # [Output Only] An optional, human-readable error message. 405 "code": "A String", # [Output Only] The error type identifier for this error. 406 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 407 }, 408 ], 409 }, 410 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 411 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 412 "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. 413 }</pre> 414</div> 415 416<div class="method"> 417 <code class="details" id="list">list(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code> 418 <pre>Retrieves the list of networks available to the specified project. 419 420Args: 421 project: string, Project ID for this request. (required) 422 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. 423 424You 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. 425 426Currently, only sorting by name or creationTimestamp desc is supported. 427 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) 428 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. 429 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 <. 430 431For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. 432 433You 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. 434 435To 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). 436 437Returns: 438 An object of the form: 439 440 { # Contains a list of networks. 441 "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. 442 "kind": "compute#networkList", # [Output Only] Type of resource. Always compute#networkList for lists of networks. 443 "items": [ # A list of Network resources. 444 { # Represents a VPC Network resource. 445 # 446 # 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 ==) 447 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 448 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 449 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 450 "A String", 451 ], 452 "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. 453 # 454 # 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. 455 "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. 456 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 457 "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. 458 "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. 459 }, 460 "peerings": [ # [Output Only] A list of network peerings for the resource. 461 { # 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. 462 "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. 463 "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. 464 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 465 "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. 466 "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. 467 "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. 468 }, 469 ], 470 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 471 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 472 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 473 "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. 474 }, 475 ], 476 "warning": { # [Output Only] Informational warning message. 477 "message": "A String", # [Output Only] A human-readable description of the warning code. 478 "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. 479 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 480 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 481 { 482 "value": "A String", # [Output Only] A warning data value corresponding to the key. 483 "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). 484 }, 485 ], 486 }, 487 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 488 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 489 }</pre> 490</div> 491 492<div class="method"> 493 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 494 <pre>Retrieves the next page of results. 495 496Args: 497 previous_request: The request for the previous page. (required) 498 previous_response: The response from the request for the previous page. (required) 499 500Returns: 501 A request object that you can call 'execute()' on to request the next 502 page. Returns None if there are no more items in the collection. 503 </pre> 504</div> 505 506<div class="method"> 507 <code class="details" id="patch">patch(project, network, body, requestId=None)</code> 508 <pre>Patches the specified network with the data included in the request. Only the following fields can be modified: routingConfig.routingMode. 509 510Args: 511 project: string, Project ID for this request. (required) 512 network: string, Name of the network to update. (required) 513 body: object, The request body. (required) 514 The object takes the form of: 515 516{ # Represents a VPC Network resource. 517 # 518 # 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 ==) 519 "kind": "compute#network", # [Output Only] Type of the resource. Always compute#network for networks. 520 "description": "A String", # An optional description of this resource. Provide this field when you create the resource. 521 "subnetworks": [ # [Output Only] Server-defined fully-qualified URLs for all subnetworks in this VPC network. 522 "A String", 523 ], 524 "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. 525 # 526 # 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. 527 "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. 528 "gatewayIPv4": "A String", # [Output Only] The gateway address for default routing out of the network, selected by GCP. 529 "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. 530 "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. 531 }, 532 "peerings": [ # [Output Only] A list of network peerings for the resource. 533 { # 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. 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 "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. 536 "stateDetails": "A String", # [Output Only] Details about the current state of the peering. 537 "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. 538 "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. 539 "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. 540 }, 541 ], 542 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 543 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 544 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 545 "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. 546 } 547 548 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. 549 550For 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. 551 552The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 553 554Returns: 555 An object of the form: 556 557 { # Represents an Operation resource. 558 # 559 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 560 # 561 # Operations can be global, regional or zonal. 562 # - For global operations, use the globalOperations resource. 563 # - For regional operations, use the regionOperations resource. 564 # - For zonal operations, use the zonalOperations resource. 565 # 566 # 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 ==) 567 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 568 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 569 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 570 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 571 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 572 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 573 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 574 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 575 "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. 576 "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. 577 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 578 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 579 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 580 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 581 { 582 "message": "A String", # [Output Only] A human-readable description of the warning code. 583 "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. 584 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 585 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 586 { 587 "value": "A String", # [Output Only] A warning data value corresponding to the key. 588 "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). 589 }, 590 ], 591 }, 592 ], 593 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 594 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 595 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 596 "name": "A String", # [Output Only] Name of the resource. 597 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 598 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 599 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 600 { 601 "message": "A String", # [Output Only] An optional, human-readable error message. 602 "code": "A String", # [Output Only] The error type identifier for this error. 603 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 604 }, 605 ], 606 }, 607 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 608 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 609 "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. 610 }</pre> 611</div> 612 613<div class="method"> 614 <code class="details" id="removePeering">removePeering(project, network, body, requestId=None)</code> 615 <pre>Removes a peering from the specified network. 616 617Args: 618 project: string, Project ID for this request. (required) 619 network: string, Name of the network resource to remove peering from. (required) 620 body: object, The request body. (required) 621 The object takes the form of: 622 623{ 624 "name": "A String", # Name of the peering, which should conform to RFC1035. 625 } 626 627 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. 628 629For 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. 630 631The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 632 633Returns: 634 An object of the form: 635 636 { # Represents an Operation resource. 637 # 638 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 639 # 640 # Operations can be global, regional or zonal. 641 # - For global operations, use the globalOperations resource. 642 # - For regional operations, use the regionOperations resource. 643 # - For zonal operations, use the zonalOperations resource. 644 # 645 # 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 ==) 646 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 647 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 648 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 649 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 650 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 651 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 652 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 653 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 654 "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. 655 "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. 656 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 657 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 658 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 659 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 660 { 661 "message": "A String", # [Output Only] A human-readable description of the warning code. 662 "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. 663 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 664 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 665 { 666 "value": "A String", # [Output Only] A warning data value corresponding to the key. 667 "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). 668 }, 669 ], 670 }, 671 ], 672 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 673 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 674 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 675 "name": "A String", # [Output Only] Name of the resource. 676 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 677 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 678 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 679 { 680 "message": "A String", # [Output Only] An optional, human-readable error message. 681 "code": "A String", # [Output Only] The error type identifier for this error. 682 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 683 }, 684 ], 685 }, 686 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 687 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 688 "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. 689 }</pre> 690</div> 691 692<div class="method"> 693 <code class="details" id="switchToCustomMode">switchToCustomMode(project, network, requestId=None)</code> 694 <pre>Switches the network mode from auto subnet mode to custom subnet mode. 695 696Args: 697 project: string, Project ID for this request. (required) 698 network: string, Name of the network to be updated. (required) 699 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. 700 701For 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. 702 703The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). 704 705Returns: 706 An object of the form: 707 708 { # Represents an Operation resource. 709 # 710 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. 711 # 712 # Operations can be global, regional or zonal. 713 # - For global operations, use the globalOperations resource. 714 # - For regional operations, use the regionOperations resource. 715 # - For zonal operations, use the zonalOperations resource. 716 # 717 # 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 ==) 718 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 719 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 720 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 721 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. 722 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 723 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 724 "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on. 725 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND. 726 "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. 727 "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. 728 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 729 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE. 730 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 731 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 732 { 733 "message": "A String", # [Output Only] A human-readable description of the warning code. 734 "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. 735 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: 736 # "data": [ { "key": "scope", "value": "zones/us-east1-d" } 737 { 738 "value": "A String", # [Output Only] A warning data value corresponding to the key. 739 "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). 740 }, 741 ], 742 }, 743 ], 744 "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com. 745 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 746 "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources. 747 "name": "A String", # [Output Only] Name of the resource. 748 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 749 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 750 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 751 { 752 "message": "A String", # [Output Only] An optional, human-readable error message. 753 "code": "A String", # [Output Only] The error type identifier for this error. 754 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 755 }, 756 ], 757 }, 758 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 759 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 760 "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. 761 }</pre> 762</div> 763 764</body></html>