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