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