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.projects.html">projects</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#disableXpnHost">disableXpnHost(project, requestId=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Disable this project as a shared VPC host project.</p> 83<p class="toc_element"> 84 <code><a href="#disableXpnResource">disableXpnResource(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Disable a service resource (also known as service project) associated with this host project.</p> 86<p class="toc_element"> 87 <code><a href="#enableXpnHost">enableXpnHost(project, requestId=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Enable this project as a shared VPC host project.</p> 89<p class="toc_element"> 90 <code><a href="#enableXpnResource">enableXpnResource(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(project, x__xgafv=None)</a></code></p> 94<p class="firstline">Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.</p> 95<p class="toc_element"> 96 <code><a href="#getXpnHost">getXpnHost(project, x__xgafv=None)</a></code></p> 97<p class="firstline">Gets the shared VPC host project that this project links to. May be empty if no link exists.</p> 98<p class="toc_element"> 99 <code><a href="#getXpnResources">getXpnResources(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 100<p class="firstline">Gets service resources (a.k.a service project) associated with this host project.</p> 101<p class="toc_element"> 102 <code><a href="#getXpnResources_next">getXpnResources_next(previous_request, previous_response)</a></code></p> 103<p class="firstline">Retrieves the next page of results.</p> 104<p class="toc_element"> 105 <code><a href="#listXpnHosts">listXpnHosts(project, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> 106<p class="firstline">Lists all shared VPC host projects visible to the user in an organization.</p> 107<p class="toc_element"> 108 <code><a href="#listXpnHosts_next">listXpnHosts_next(previous_request, previous_response)</a></code></p> 109<p class="firstline">Retrieves the next page of results.</p> 110<p class="toc_element"> 111 <code><a href="#moveDisk">moveDisk(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 112<p class="firstline">Moves a persistent disk from one zone to another.</p> 113<p class="toc_element"> 114 <code><a href="#moveInstance">moveInstance(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 115<p class="firstline">Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior).</p> 116<p class="toc_element"> 117 <code><a href="#setCommonInstanceMetadata">setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 118<p class="firstline">Sets metadata common to all instances within the specified project using the data included in the request.</p> 119<p class="toc_element"> 120 <code><a href="#setDefaultNetworkTier">setDefaultNetworkTier(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 121<p class="firstline">Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field.</p> 122<p class="toc_element"> 123 <code><a href="#setDefaultServiceAccount">setDefaultServiceAccount(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 124<p class="firstline">Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default".</p> 125<p class="toc_element"> 126 <code><a href="#setUsageExportBucket">setUsageExportBucket(project, body=None, requestId=None, x__xgafv=None)</a></code></p> 127<p class="firstline">Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled.</p> 128<h3>Method Details</h3> 129<div class="method"> 130 <code class="details" id="close">close()</code> 131 <pre>Close httplib2 connections.</pre> 132</div> 133 134<div class="method"> 135 <code class="details" id="disableXpnHost">disableXpnHost(project, requestId=None, x__xgafv=None)</code> 136 <pre>Disable this project as a shared VPC host project. 137 138Args: 139 project: string, Project ID for this request. (required) 140 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 141 x__xgafv: string, V1 error format. 142 Allowed values 143 1 - v1 error format 144 2 - v2 error format 145 146Returns: 147 An object of the form: 148 149 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 150 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 151 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 152 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 153 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 154 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 155 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 156 { 157 "code": "A String", # [Output Only] The error type identifier for this error. 158 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 159 "message": "A String", # [Output Only] An optional, human-readable error message. 160 }, 161 ], 162 }, 163 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 164 "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. 165 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 166 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 167 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 168 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 169 "a_key": "", # Properties of the object. Contains field @type with type URL. 170 }, 171 "name": "A String", # [Output Only] Name of the operation. 172 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 173 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 174 "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. 175 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 176 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 177 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 178 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 179 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 180 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 181 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 182 "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. 183 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 184 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 185 { 186 "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. 187 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 188 { 189 "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). 190 "value": "A String", # [Output Only] A warning data value corresponding to the key. 191 }, 192 ], 193 "message": "A String", # [Output Only] A human-readable description of the warning code. 194 }, 195 ], 196 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 197}</pre> 198</div> 199 200<div class="method"> 201 <code class="details" id="disableXpnResource">disableXpnResource(project, body=None, requestId=None, x__xgafv=None)</code> 202 <pre>Disable a service resource (also known as service project) associated with this host project. 203 204Args: 205 project: string, Project ID for this request. (required) 206 body: object, The request body. 207 The object takes the form of: 208 209{ 210 "xpnResource": { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID. 211 "id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). 212 "type": "A String", # The type of the service resource. 213 }, 214} 215 216 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 217 x__xgafv: string, V1 error format. 218 Allowed values 219 1 - v1 error format 220 2 - v2 error format 221 222Returns: 223 An object of the form: 224 225 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 226 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 227 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 228 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 229 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 230 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 231 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 232 { 233 "code": "A String", # [Output Only] The error type identifier for this error. 234 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 235 "message": "A String", # [Output Only] An optional, human-readable error message. 236 }, 237 ], 238 }, 239 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 240 "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. 241 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 242 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 243 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 244 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 245 "a_key": "", # Properties of the object. Contains field @type with type URL. 246 }, 247 "name": "A String", # [Output Only] Name of the operation. 248 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 249 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 250 "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. 251 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 252 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 253 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 254 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 255 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 256 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 257 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 258 "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. 259 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 260 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 261 { 262 "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. 263 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 264 { 265 "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). 266 "value": "A String", # [Output Only] A warning data value corresponding to the key. 267 }, 268 ], 269 "message": "A String", # [Output Only] A human-readable description of the warning code. 270 }, 271 ], 272 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 273}</pre> 274</div> 275 276<div class="method"> 277 <code class="details" id="enableXpnHost">enableXpnHost(project, requestId=None, x__xgafv=None)</code> 278 <pre>Enable this project as a shared VPC host project. 279 280Args: 281 project: string, Project ID for this request. (required) 282 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 283 x__xgafv: string, V1 error format. 284 Allowed values 285 1 - v1 error format 286 2 - v2 error format 287 288Returns: 289 An object of the form: 290 291 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 292 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 293 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 294 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 295 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 296 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 297 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 298 { 299 "code": "A String", # [Output Only] The error type identifier for this error. 300 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 301 "message": "A String", # [Output Only] An optional, human-readable error message. 302 }, 303 ], 304 }, 305 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 306 "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. 307 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 308 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 309 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 310 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 311 "a_key": "", # Properties of the object. Contains field @type with type URL. 312 }, 313 "name": "A String", # [Output Only] Name of the operation. 314 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 315 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 316 "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. 317 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 318 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 319 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 320 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 321 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 322 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 323 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 324 "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. 325 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 326 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 327 { 328 "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. 329 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 330 { 331 "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). 332 "value": "A String", # [Output Only] A warning data value corresponding to the key. 333 }, 334 ], 335 "message": "A String", # [Output Only] A human-readable description of the warning code. 336 }, 337 ], 338 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 339}</pre> 340</div> 341 342<div class="method"> 343 <code class="details" id="enableXpnResource">enableXpnResource(project, body=None, requestId=None, x__xgafv=None)</code> 344 <pre>Enable service resource (a.k.a service project) for a host project, so that subnets in the host project can be used by instances in the service project. 345 346Args: 347 project: string, Project ID for this request. (required) 348 body: object, The request body. 349 The object takes the form of: 350 351{ 352 "xpnResource": { # Service resource (a.k.a service project) ID. # Service resource (a.k.a service project) ID. 353 "id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). 354 "type": "A String", # The type of the service resource. 355 }, 356} 357 358 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 359 x__xgafv: string, V1 error format. 360 Allowed values 361 1 - v1 error format 362 2 - v2 error format 363 364Returns: 365 An object of the form: 366 367 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 368 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 369 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 370 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 371 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 372 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 373 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 374 { 375 "code": "A String", # [Output Only] The error type identifier for this error. 376 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 377 "message": "A String", # [Output Only] An optional, human-readable error message. 378 }, 379 ], 380 }, 381 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 382 "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. 383 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 384 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 385 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 386 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 387 "a_key": "", # Properties of the object. Contains field @type with type URL. 388 }, 389 "name": "A String", # [Output Only] Name of the operation. 390 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 391 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 392 "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. 393 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 394 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 395 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 396 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 397 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 398 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 399 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 400 "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. 401 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 402 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 403 { 404 "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. 405 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 406 { 407 "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). 408 "value": "A String", # [Output Only] A warning data value corresponding to the key. 409 }, 410 ], 411 "message": "A String", # [Output Only] A human-readable description of the warning code. 412 }, 413 ], 414 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 415}</pre> 416</div> 417 418<div class="method"> 419 <code class="details" id="get">get(project, x__xgafv=None)</code> 420 <pre>Returns the specified Project resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. 421 422Args: 423 project: string, Project ID for this request. (required) 424 x__xgafv: string, V1 error format. 425 Allowed values 426 1 - v1 error format 427 2 - v2 error format 428 429Returns: 430 An object of the form: 431 432 { # Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. 433 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. 434 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. 435 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 436 { # Metadata 437 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. 438 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). 439 }, 440 ], 441 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 442 }, 443 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 444 "defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. 445 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project. 446 "description": "A String", # An optional textual description of the resource. 447 "enabledFeatures": [ # Restricted features enabled for use on this project. 448 "A String", 449 ], 450 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. 451 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects. 452 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. 453 "quotas": [ # [Output Only] Quotas assigned to this project. 454 { # A quotas entry. 455 "limit": 3.14, # [Output Only] Quota limit for this metric. 456 "metric": "A String", # [Output Only] Name of the quota metric. 457 "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied. 458 "usage": 3.14, # [Output Only] Current usage of this metric. 459 }, 460 ], 461 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 462 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. 463 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. 464 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. 465 }, 466 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. 467}</pre> 468</div> 469 470<div class="method"> 471 <code class="details" id="getXpnHost">getXpnHost(project, x__xgafv=None)</code> 472 <pre>Gets the shared VPC host project that this project links to. May be empty if no link exists. 473 474Args: 475 project: string, Project ID for this request. (required) 476 x__xgafv: string, V1 error format. 477 Allowed values 478 1 - v1 error format 479 2 - v2 error format 480 481Returns: 482 An object of the form: 483 484 { # Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. 485 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. 486 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. 487 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 488 { # Metadata 489 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. 490 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). 491 }, 492 ], 493 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 494 }, 495 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 496 "defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. 497 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project. 498 "description": "A String", # An optional textual description of the resource. 499 "enabledFeatures": [ # Restricted features enabled for use on this project. 500 "A String", 501 ], 502 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. 503 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects. 504 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. 505 "quotas": [ # [Output Only] Quotas assigned to this project. 506 { # A quotas entry. 507 "limit": 3.14, # [Output Only] Quota limit for this metric. 508 "metric": "A String", # [Output Only] Name of the quota metric. 509 "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied. 510 "usage": 3.14, # [Output Only] Current usage of this metric. 511 }, 512 ], 513 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 514 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. 515 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. 516 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. 517 }, 518 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. 519}</pre> 520</div> 521 522<div class="method"> 523 <code class="details" id="getXpnResources">getXpnResources(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 524 <pre>Gets service resources (a.k.a service project) associated with this host project. 525 526Args: 527 project: string, Project ID for this request. (required) 528 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 529 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`) 530 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 531 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. 532 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 533 x__xgafv: string, V1 error format. 534 Allowed values 535 1 - v1 error format 536 2 - v2 error format 537 538Returns: 539 An object of the form: 540 541 { 542 "kind": "compute#projectsGetXpnResources", # [Output Only] Type of resource. Always compute#projectsGetXpnResources for lists of service resources (a.k.a service projects) 543 "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. 544 "resources": [ # Service resources (a.k.a service projects) attached to this project as their shared VPC host. 545 { # Service resource (a.k.a service project) ID. 546 "id": "A String", # The ID of the service resource. In the case of projects, this field supports project id (e.g., my-project-123) and project number (e.g. 12345678). 547 "type": "A String", # The type of the service resource. 548 }, 549 ], 550}</pre> 551</div> 552 553<div class="method"> 554 <code class="details" id="getXpnResources_next">getXpnResources_next(previous_request, previous_response)</code> 555 <pre>Retrieves the next page of results. 556 557Args: 558 previous_request: The request for the previous page. (required) 559 previous_response: The response from the request for the previous page. (required) 560 561Returns: 562 A request object that you can call 'execute()' on to request the next 563 page. Returns None if there are no more items in the collection. 564 </pre> 565</div> 566 567<div class="method"> 568 <code class="details" id="listXpnHosts">listXpnHosts(project, body=None, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> 569 <pre>Lists all shared VPC host projects visible to the user in an organization. 570 571Args: 572 project: string, Project ID for this request. (required) 573 body: object, The request body. 574 The object takes the form of: 575 576{ 577 "organization": "A String", # Optional organization ID managed by Cloud Resource Manager, for which to list shared VPC host projects. If not specified, the organization will be inferred from the project. 578 "returnPartialPage": True or False, # Opt-in for partial page behavior which provides a partial filled page (number of items on which may be smaller than maxResults) within the API deadline. If opt-in, then the user should rely on if nextPageToken is empty in the response to determine if there is a next page. Empty page is also valid and possible. The default value is false. 579} 580 581 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` 582 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`) 583 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. 584 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. 585 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. 586 x__xgafv: string, V1 error format. 587 Allowed values 588 1 - v1 error format 589 2 - v2 error format 590 591Returns: 592 An object of the form: 593 594 { 595 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. 596 "items": [ # [Output Only] A list of shared VPC host project URLs. 597 { # Represents a Project resource. A project is used to organize resources in a Google Cloud Platform environment. For more information, read about the Resource Hierarchy. 598 "commonInstanceMetadata": { # A metadata key/value entry. # Metadata key/value pairs available to all instances contained in this project. See Custom metadata for more information. 599 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. 600 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 601 { # Metadata 602 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. 603 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). 604 }, 605 ], 606 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 607 }, 608 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. 609 "defaultNetworkTier": "A String", # This signifies the default network tier used for configuring resources of the project and can only take the following values: PREMIUM, STANDARD. Initially the default network tier is PREMIUM. 610 "defaultServiceAccount": "A String", # [Output Only] Default service account used by VMs running in this project. 611 "description": "A String", # An optional textual description of the resource. 612 "enabledFeatures": [ # Restricted features enabled for use on this project. 613 "A String", 614 ], 615 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. This is *not* the project ID, and is just a unique ID used by Compute Engine to identify resources. 616 "kind": "compute#project", # [Output Only] Type of the resource. Always compute#project for projects. 617 "name": "A String", # The project ID. For example: my-example-project. Use the project ID to make requests to Compute Engine. 618 "quotas": [ # [Output Only] Quotas assigned to this project. 619 { # A quotas entry. 620 "limit": 3.14, # [Output Only] Quota limit for this metric. 621 "metric": "A String", # [Output Only] Name of the quota metric. 622 "owner": "A String", # [Output Only] Owning resource. This is the resource on which this quota is applied. 623 "usage": 3.14, # [Output Only] Current usage of this metric. 624 }, 625 ], 626 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 627 "usageExportLocation": { # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. # The naming prefix for daily usage reports and the Google Cloud Storage bucket where they are stored. 628 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. 629 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. 630 }, 631 "xpnProjectStatus": "A String", # [Output Only] The role this project has in a shared VPC configuration. Currently, only projects with the host role, which is specified by the value HOST, are differentiated. 632 }, 633 ], 634 "kind": "compute#xpnHostList", # [Output Only] Type of resource. Always compute#xpnHostList for lists of shared VPC hosts. 635 "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. 636 "selfLink": "A String", # [Output Only] Server-defined URL for this resource. 637 "warning": { # [Output Only] Informational warning message. 638 "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. 639 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 640 { 641 "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). 642 "value": "A String", # [Output Only] A warning data value corresponding to the key. 643 }, 644 ], 645 "message": "A String", # [Output Only] A human-readable description of the warning code. 646 }, 647}</pre> 648</div> 649 650<div class="method"> 651 <code class="details" id="listXpnHosts_next">listXpnHosts_next(previous_request, previous_response)</code> 652 <pre>Retrieves the next page of results. 653 654Args: 655 previous_request: The request for the previous page. (required) 656 previous_response: The response from the request for the previous page. (required) 657 658Returns: 659 A request object that you can call 'execute()' on to request the next 660 page. Returns None if there are no more items in the collection. 661 </pre> 662</div> 663 664<div class="method"> 665 <code class="details" id="moveDisk">moveDisk(project, body=None, requestId=None, x__xgafv=None)</code> 666 <pre>Moves a persistent disk from one zone to another. 667 668Args: 669 project: string, Project ID for this request. (required) 670 body: object, The request body. 671 The object takes the form of: 672 673{ 674 "destinationZone": "A String", # The URL of the destination zone to move the disk. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone 675 "targetDisk": "A String", # The URL of the target disk to move. This can be a full or partial URL. For example, the following are all valid URLs to a disk: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /disks/disk - projects/project/zones/zone/disks/disk - zones/zone/disks/disk 676} 677 678 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 679 x__xgafv: string, V1 error format. 680 Allowed values 681 1 - v1 error format 682 2 - v2 error format 683 684Returns: 685 An object of the form: 686 687 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 688 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 689 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 690 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 691 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 692 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 693 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 694 { 695 "code": "A String", # [Output Only] The error type identifier for this error. 696 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 697 "message": "A String", # [Output Only] An optional, human-readable error message. 698 }, 699 ], 700 }, 701 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 702 "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. 703 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 704 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 705 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 706 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 707 "a_key": "", # Properties of the object. Contains field @type with type URL. 708 }, 709 "name": "A String", # [Output Only] Name of the operation. 710 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 711 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 712 "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. 713 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 714 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 715 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 716 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 717 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 718 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 719 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 720 "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. 721 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 722 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 723 { 724 "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. 725 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 726 { 727 "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). 728 "value": "A String", # [Output Only] A warning data value corresponding to the key. 729 }, 730 ], 731 "message": "A String", # [Output Only] A human-readable description of the warning code. 732 }, 733 ], 734 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 735}</pre> 736</div> 737 738<div class="method"> 739 <code class="details" id="moveInstance">moveInstance(project, body=None, requestId=None, x__xgafv=None)</code> 740 <pre>Moves an instance and its attached persistent disks from one zone to another. *Note*: Moving VMs or disks by using this method might cause unexpected behavior. For more information, see the [known issue](/compute/docs/troubleshooting/known-issues#moving_vms_or_disks_using_the_moveinstance_api_or_the_causes_unexpected_behavior). 741 742Args: 743 project: string, Project ID for this request. (required) 744 body: object, The request body. 745 The object takes the form of: 746 747{ 748 "destinationZone": "A String", # The URL of the destination zone to move the instance. This can be a full or partial URL. For example, the following are all valid URLs to a zone: - https://www.googleapis.com/compute/v1/projects/project/zones/zone - projects/project/zones/zone - zones/zone 749 "targetInstance": "A String", # The URL of the target instance to move. This can be a full or partial URL. For example, the following are all valid URLs to an instance: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /instances/instance - projects/project/zones/zone/instances/instance - zones/zone/instances/instance 750} 751 752 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 753 x__xgafv: string, V1 error format. 754 Allowed values 755 1 - v1 error format 756 2 - v2 error format 757 758Returns: 759 An object of the form: 760 761 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 762 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 763 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 764 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 765 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 766 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 767 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 768 { 769 "code": "A String", # [Output Only] The error type identifier for this error. 770 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 771 "message": "A String", # [Output Only] An optional, human-readable error message. 772 }, 773 ], 774 }, 775 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 776 "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. 777 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 778 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 779 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 780 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 781 "a_key": "", # Properties of the object. Contains field @type with type URL. 782 }, 783 "name": "A String", # [Output Only] Name of the operation. 784 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 785 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 786 "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. 787 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 788 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 789 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 790 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 791 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 792 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 793 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 794 "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. 795 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 796 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 797 { 798 "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. 799 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 800 { 801 "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). 802 "value": "A String", # [Output Only] A warning data value corresponding to the key. 803 }, 804 ], 805 "message": "A String", # [Output Only] A human-readable description of the warning code. 806 }, 807 ], 808 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 809}</pre> 810</div> 811 812<div class="method"> 813 <code class="details" id="setCommonInstanceMetadata">setCommonInstanceMetadata(project, body=None, requestId=None, x__xgafv=None)</code> 814 <pre>Sets metadata common to all instances within the specified project using the data included in the request. 815 816Args: 817 project: string, Project ID for this request. (required) 818 body: object, The request body. 819 The object takes the form of: 820 821{ # A metadata key/value entry. 822 "fingerprint": "A String", # Specifies a fingerprint for this request, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the resource. 823 "items": [ # Array of key/value pairs. The total size of all keys and values must be less than 512 KB. 824 { # Metadata 825 "key": "A String", # Key for the metadata entry. Keys must conform to the following regexp: [a-zA-Z0-9-_]+, and be less than 128 bytes in length. This is reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project. 826 "value": "A String", # Value for the metadata entry. These are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on values is that their size must be less than or equal to 262144 bytes (256 KiB). 827 }, 828 ], 829 "kind": "compute#metadata", # [Output Only] Type of the resource. Always compute#metadata for metadata. 830} 831 832 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 833 x__xgafv: string, V1 error format. 834 Allowed values 835 1 - v1 error format 836 2 - v2 error format 837 838Returns: 839 An object of the form: 840 841 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 842 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 843 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 844 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 845 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 846 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 847 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 848 { 849 "code": "A String", # [Output Only] The error type identifier for this error. 850 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 851 "message": "A String", # [Output Only] An optional, human-readable error message. 852 }, 853 ], 854 }, 855 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 856 "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. 857 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 858 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 859 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 860 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 861 "a_key": "", # Properties of the object. Contains field @type with type URL. 862 }, 863 "name": "A String", # [Output Only] Name of the operation. 864 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 865 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 866 "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. 867 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 868 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 869 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 870 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 871 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 872 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 873 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 874 "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. 875 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 876 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 877 { 878 "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. 879 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 880 { 881 "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). 882 "value": "A String", # [Output Only] A warning data value corresponding to the key. 883 }, 884 ], 885 "message": "A String", # [Output Only] A human-readable description of the warning code. 886 }, 887 ], 888 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 889}</pre> 890</div> 891 892<div class="method"> 893 <code class="details" id="setDefaultNetworkTier">setDefaultNetworkTier(project, body=None, requestId=None, x__xgafv=None)</code> 894 <pre>Sets the default network tier of the project. The default network tier is used when an address/forwardingRule/instance is created without specifying the network tier field. 895 896Args: 897 project: string, Project ID for this request. (required) 898 body: object, The request body. 899 The object takes the form of: 900 901{ 902 "networkTier": "A String", # Default network tier to be set. 903} 904 905 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 906 x__xgafv: string, V1 error format. 907 Allowed values 908 1 - v1 error format 909 2 - v2 error format 910 911Returns: 912 An object of the form: 913 914 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 915 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 916 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 917 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 918 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 919 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 920 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 921 { 922 "code": "A String", # [Output Only] The error type identifier for this error. 923 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 924 "message": "A String", # [Output Only] An optional, human-readable error message. 925 }, 926 ], 927 }, 928 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 929 "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. 930 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 931 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 932 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 933 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 934 "a_key": "", # Properties of the object. Contains field @type with type URL. 935 }, 936 "name": "A String", # [Output Only] Name of the operation. 937 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 938 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 939 "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. 940 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 941 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 942 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 943 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 944 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 945 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 946 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 947 "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. 948 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 949 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 950 { 951 "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. 952 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 953 { 954 "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). 955 "value": "A String", # [Output Only] A warning data value corresponding to the key. 956 }, 957 ], 958 "message": "A String", # [Output Only] A human-readable description of the warning code. 959 }, 960 ], 961 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 962}</pre> 963</div> 964 965<div class="method"> 966 <code class="details" id="setDefaultServiceAccount">setDefaultServiceAccount(project, body=None, requestId=None, x__xgafv=None)</code> 967 <pre>Sets the default service account of the project. The default service account is used when a VM instance is created with the service account email address set to "default". 968 969Args: 970 project: string, Project ID for this request. (required) 971 body: object, The request body. 972 The object takes the form of: 973 974{ 975 "email": "A String", # Email address of the service account. 976} 977 978 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 979 x__xgafv: string, V1 error format. 980 Allowed values 981 1 - v1 error format 982 2 - v2 error format 983 984Returns: 985 An object of the form: 986 987 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 988 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 989 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 990 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 991 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 992 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 993 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 994 { 995 "code": "A String", # [Output Only] The error type identifier for this error. 996 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 997 "message": "A String", # [Output Only] An optional, human-readable error message. 998 }, 999 ], 1000 }, 1001 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1002 "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. 1003 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1004 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1005 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1006 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1007 "a_key": "", # Properties of the object. Contains field @type with type URL. 1008 }, 1009 "name": "A String", # [Output Only] Name of the operation. 1010 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1011 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1012 "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. 1013 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1014 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1015 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1016 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1017 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1018 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1019 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1020 "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. 1021 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1022 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1023 { 1024 "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. 1025 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1026 { 1027 "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). 1028 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1029 }, 1030 ], 1031 "message": "A String", # [Output Only] A human-readable description of the warning code. 1032 }, 1033 ], 1034 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1035}</pre> 1036</div> 1037 1038<div class="method"> 1039 <code class="details" id="setUsageExportBucket">setUsageExportBucket(project, body=None, requestId=None, x__xgafv=None)</code> 1040 <pre>Enables the usage export feature and sets the usage export bucket where reports are stored. If you provide an empty request body using this method, the usage export feature will be disabled. 1041 1042Args: 1043 project: string, Project ID for this request. (required) 1044 body: object, The request body. 1045 The object takes the form of: 1046 1047{ # The location in Cloud Storage and naming method of the daily usage report. Contains bucket_name and report_name prefix. 1048 "bucketName": "A String", # The name of an existing bucket in Cloud Storage where the usage report object is stored. The Google Service Account is granted write access to this bucket. This can either be the bucket name by itself, such as example-bucket, or the bucket name with gs:// or https://storage.googleapis.com/ in front of it, such as gs://example-bucket. 1049 "reportNamePrefix": "A String", # An optional prefix for the name of the usage report object stored in bucketName. If not supplied, defaults to usage_gce. The report is stored as a CSV file named report_name_prefix_gce_YYYYMMDD.csv where YYYYMMDD is the day of the usage according to Pacific Time. If you supply a prefix, it should conform to Cloud Storage object naming conventions. 1050} 1051 1052 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. For 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. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). 1053 x__xgafv: string, V1 error format. 1054 Allowed values 1055 1 - v1 error format 1056 2 - v2 error format 1057 1058Returns: 1059 An object of the form: 1060 1061 { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. 1062 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. 1063 "creationTimestamp": "A String", # [Deprecated] This field is deprecated. 1064 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. 1065 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. 1066 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. 1067 "errors": [ # [Output Only] The array of errors encountered while processing this operation. 1068 { 1069 "code": "A String", # [Output Only] The error type identifier for this error. 1070 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. 1071 "message": "A String", # [Output Only] An optional, human-readable error message. 1072 }, 1073 ], 1074 }, 1075 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. 1076 "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. 1077 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. 1078 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. 1079 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. 1080 "metadata": { # [Output Only] Service-specific metadata attached to this operation. 1081 "a_key": "", # Properties of the object. Contains field @type with type URL. 1082 }, 1083 "name": "A String", # [Output Only] Name of the operation. 1084 "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. 1085 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. 1086 "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. 1087 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. 1088 "selfLink": "A String", # [Output Only] Server-defined URL for the resource. 1089 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. 1090 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. 1091 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. 1092 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. 1093 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. 1094 "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. 1095 "user": "A String", # [Output Only] User who requested the operation, for example: `[email protected]`. 1096 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. 1097 { 1098 "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. 1099 "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } 1100 { 1101 "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). 1102 "value": "A String", # [Output Only] A warning data value corresponding to the key. 1103 }, 1104 ], 1105 "message": "A String", # [Output Only] A human-readable description of the warning code. 1106 }, 1107 ], 1108 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. 1109}</pre> 1110</div> 1111 1112</body></html>