Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / compute_alpha.regionCommitments.html
blob: 2f87be9fed03861cd96b2ca39978f6af8fbf1730 [file] [log] [blame]
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionCommitments.html">regionCommitments</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]79<p class="firstline">Retrieves an aggregated list of commitments.</p>
80<p class="toc_element">
81 <code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<p class="toc_element">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]84 <code><a href="#get">get(project, region, commitment)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]85<p class="firstline">Returns the specified commitment resource. Gets a list of available commitments by making a list() request.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]86<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]87 <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]88<p class="firstline">Creates a commitment in the specified project using the data included in the request.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]91<p class="firstline">Retrieves a list of commitments contained within the specified region.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]96 <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]97<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#updateReservations">updateReservations(project, region, commitment, body=None, requestId=None)</a></code></p>
100<p class="firstline">Transfers GPUs or local SSDs between reservations within commitments.</p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]103 <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]104 <pre>Retrieves an aggregated list of commitments.
105
106Args:
107 project: string, Project ID for this request. (required)
108 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
109
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]110You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]111
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112Currently, only sorting by `name` or `creationTimestamp desc` is supported.
113 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`)
114 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.
115 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
116 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]117
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]118For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]119
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]120You 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.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]121
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122To 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) ```
123 includeAllScopes: boolean, Indicates whether every visible scope for each scope type (zone, region, global) should be included in the response. For new resource types added after this field, the flag has no effect as new resource types will always include every visible scope for each scope type in response. For resource types which predate this field, if this flag is omitted or false, only scopes of the scope types where the resource type is expected to be found will be included.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]124
125Returns:
126 An object of the form:
127
128 {
129 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 "kind": "compute#commitmentAggregatedList", # [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.
131 "items": { # A list of CommitmentsScopedList resources.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]132 "a_key": { # [Output Only] Name of the scope containing this set of commitments.
133 "warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty.
134 "message": "A String", # [Output Only] A human-readable description of the warning code.
135 "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.
136 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
137 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
138 {
139 "value": "A String", # [Output Only] A warning data value corresponding to the key.
140 "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).
141 },
142 ],
143 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]144 "commitments": [ # [Output Only] A list of commitments contained in this scope.
145 { # Represents a regional Commitment resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]146 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]147 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
148 "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]149 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
150 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
151 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
152 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
153 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]154 "reservations": [ # List of reservations in this commitment.
155 { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]156 "status": "A String", # [Output Only] The status of the reservation.
157 "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
158 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]159 "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
160 "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
162 "specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]163 "count": "A String", # Specifies the number of resources that are allocated.
164 "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
165 "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
166 #
167 # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
168 #
169 # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]170 "machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
171 "guestAccelerators": [ # Specifies accelerator type and count.
172 { # A specification of the type and number of accelerator cards attached to the instance.
173 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
174 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
175 },
176 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]177 "locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
178 "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]179 "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
180 {
181 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
182 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
183 },
184 ],
185 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]186 "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]187 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
190 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
191 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
192 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
193 },
194 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]195 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
196 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]197 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]198 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]199 "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]200 "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
201 "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
202 "amount": "A String", # The number of licenses purchased.
203 "license": "A String", # Any applicable license URI.
204 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]205 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]206 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
207 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]209 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]210 "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]211 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]213 },
214 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]215 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]216 },
217 ],
218 },
219 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]220 "warning": { # [Output Only] Informational warning message.
221 "message": "A String", # [Output Only] A human-readable description of the warning code.
222 "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.
223 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
224 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
225 {
226 "value": "A String", # [Output Only] A warning data value corresponding to the key.
227 "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).
228 },
229 ],
230 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 "unreachables": [ # [Output Only] Unreachable resources.
232 "A String",
233 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]234 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]235 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
236 }</pre>
237</div>
238
239<div class="method">
240 <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code>
241 <pre>Retrieves the next page of results.
242
243Args:
244 previous_request: The request for the previous page. (required)
245 previous_response: The response from the request for the previous page. (required)
246
247Returns:
248 A request object that you can call 'execute()' on to request the next
249 page. Returns None if there are no more items in the collection.
250 </pre>
251</div>
252
253<div class="method">
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]254 <code class="details" id="get">get(project, region, commitment)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 <pre>Returns the specified commitment resource. Gets a list of available commitments by making a list() request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]256
257Args:
258 project: string, Project ID for this request. (required)
259 region: string, Name of the region for this request. (required)
260 commitment: string, Name of the commitment to return. (required)
261
262Returns:
263 An object of the form:
264
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]265 { # Represents a regional Commitment resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]266 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]267 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
268 "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]269 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
270 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
271 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
272 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
273 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]274 "reservations": [ # List of reservations in this commitment.
275 { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]276 "status": "A String", # [Output Only] The status of the reservation.
277 "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
278 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]279 "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
280 "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]281 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
282 "specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]283 "count": "A String", # Specifies the number of resources that are allocated.
284 "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
285 "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
286 #
287 # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
288 #
289 # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]290 "machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
291 "guestAccelerators": [ # Specifies accelerator type and count.
292 { # A specification of the type and number of accelerator cards attached to the instance.
293 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
294 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
295 },
296 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]297 "locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
298 "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
300 {
301 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
302 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
303 },
304 ],
305 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]307 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]308 "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]309 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
310 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
311 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
312 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
313 },
314 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]315 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
316 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]317 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]318 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]320 "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
321 "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
322 "amount": "A String", # The number of licenses purchased.
323 "license": "A String", # Any applicable license URI.
324 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]325 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]326 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
327 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]328 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]329 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]330 "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]331 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]332 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]333 },
334 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]335 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]336 }</pre>
337</div>
338
339<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]340 <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]341 <pre>Creates a commitment in the specified project using the data included in the request.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]342
343Args:
344 project: string, Project ID for this request. (required)
345 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]346 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]347 The object takes the form of:
348
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349{ # Represents a regional Commitment resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]350 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]351 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
352 "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]353 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
354 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
355 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
356 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
357 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]358 "reservations": [ # List of reservations in this commitment.
359 { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]360 "status": "A String", # [Output Only] The status of the reservation.
361 "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
362 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]363 "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
364 "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]365 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
366 "specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]367 "count": "A String", # Specifies the number of resources that are allocated.
368 "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
369 "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
370 #
371 # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
372 #
373 # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]374 "machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
375 "guestAccelerators": [ # Specifies accelerator type and count.
376 { # A specification of the type and number of accelerator cards attached to the instance.
377 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
378 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
379 },
380 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]381 "locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
382 "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]383 "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
384 {
385 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
386 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
387 },
388 ],
389 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]390 "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]391 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]392 "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]393 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
394 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
395 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
396 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
397 },
398 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]399 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
400 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]401 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]402 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]403 "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]404 "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
405 "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
406 "amount": "A String", # The number of licenses purchased.
407 "license": "A String", # Any applicable license URI.
408 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]409 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]410 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
411 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]413 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]414 "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]415 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]416 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]417 },
418 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]419 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]420 }
421
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]422 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.
423
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]424For 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.
425
426The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]427
428Returns:
429 An object of the form:
430
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 { # Represents an Operation resource.
432 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]433 # Google Compute Engine has three Operation resources:
434 #
435 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
436 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]437 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
438 #
439 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]440 # - For global operations, use the `globalOperations` resource.
441 # - For regional operations, use the `regionOperations` resource.
442 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]443 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]444 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]445 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]446 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]447 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]448 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]449 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]450 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]451 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
452 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]453 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]454 "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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]455 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]456 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]457 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
458 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
459 {
460 "message": "A String", # [Output Only] A human-readable description of the warning code.
461 "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.
462 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
463 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
464 {
465 "value": "A String", # [Output Only] A warning data value corresponding to the key.
466 "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).
467 },
468 ],
469 },
470 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]471 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]472 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]473 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]474 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
475 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]476 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]477 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
478 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
479 {
480 "message": "A String", # [Output Only] An optional, human-readable error message.
481 "code": "A String", # [Output Only] The error type identifier for this error.
482 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
483 },
484 ],
485 },
486 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
487 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
488 "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.
489 }</pre>
490</div>
491
492<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]493 <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]494 <pre>Retrieves a list of commitments contained within the specified region.
495
496Args:
497 project: string, Project ID for this request. (required)
498 region: string, Name of the region for this request. (required)
499 orderBy: string, Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.
500
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]501You 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]502
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]503Currently, only sorting by `name` or `creationTimestamp desc` is supported.
504 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`)
505 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.
506 returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
507 filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `&gt;`, or `&lt;`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]508
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]509For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]510
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]511You 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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]512
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]513To 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) ```
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]514
515Returns:
516 An object of the form:
517
518 { # Contains a list of Commitment resources.
519 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]520 "kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]521 "items": [ # A list of Commitment resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]522 { # Represents a regional Commitment resource.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]523 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]524 # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
525 "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]526 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
527 "kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
528 "statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
529 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
530 "startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]531 "reservations": [ # List of reservations in this commitment.
532 { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]533 "status": "A String", # [Output Only] The status of the reservation.
534 "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
535 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]536 "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
537 "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]538 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
539 "specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]540 "count": "A String", # Specifies the number of resources that are allocated.
541 "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
542 "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
543 #
544 # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
545 #
546 # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]547 "machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
548 "guestAccelerators": [ # Specifies accelerator type and count.
549 { # A specification of the type and number of accelerator cards attached to the instance.
550 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
551 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
552 },
553 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]554 "locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
555 "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]556 "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
557 {
558 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
559 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
560 },
561 ],
562 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]563 "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]564 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]565 "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]566 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
567 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
568 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
569 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
570 },
571 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]572 "region": "A String", # [Output Only] URL of the region where this commitment may be used.
573 "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]574 "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]575 "plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]576 "type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]577 "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
578 "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
579 "amount": "A String", # The number of licenses purchased.
580 "license": "A String", # Any applicable license URI.
581 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]583 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
584 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]585 "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]586 { # Commitment for a particular resource (a Commitment is composed of one or more of these).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 "acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]588 "type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU and MEMORY
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]589 "amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]590 },
591 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 "name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]593 },
594 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]595 "warning": { # [Output Only] Informational warning message.
596 "message": "A String", # [Output Only] A human-readable description of the warning code.
597 "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.
598 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
599 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
600 {
601 "value": "A String", # [Output Only] A warning data value corresponding to the key.
602 "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).
603 },
604 ],
605 },
606 "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]607 "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
608 }</pre>
609</div>
610
611<div class="method">
612 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
613 <pre>Retrieves the next page of results.
614
615Args:
616 previous_request: The request for the previous page. (required)
617 previous_response: The response from the request for the previous page. (required)
618
619Returns:
620 A request object that you can call 'execute()' on to request the next
621 page. Returns None if there are no more items in the collection.
622 </pre>
623</div>
624
625<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]626 <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]627 <pre>Returns permissions that a caller has on the specified resource.
628
629Args:
630 project: string, Project ID for this request. (required)
631 region: string, The name of the region for this request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]632 resource: string, Name or id of the resource for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]633 body: object, The request body.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]634 The object takes the form of:
635
636{
637 "permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
638 "A String",
639 ],
640 }
641
642
643Returns:
644 An object of the form:
645
646 {
647 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
648 "A String",
649 ],
650 }</pre>
651</div>
652
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]653<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]654 <code class="details" id="updateReservations">updateReservations(project, region, commitment, body=None, requestId=None)</code>
655 <pre>Transfers GPUs or local SSDs between reservations within commitments.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]656
657Args:
658 project: string, Project ID for this request. (required)
659 region: string, Name of the region for this request. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]660 commitment: string, Name of the commitment for which the reservation is being updated. (required)
661 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]662 The object takes the form of:
663
664{
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]665 "reservations": [ # A list of two reservations to transfer GPUs and local SSD between.
666 { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]667 "status": "A String", # [Output Only] The status of the reservation.
668 "kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
669 "name": "A String", # The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]670 "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
671 "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]672 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
673 "specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]674 "count": "A String", # Specifies the number of resources that are allocated.
675 "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
676 "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
677 #
678 # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
679 #
680 # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]681 "machineType": "A String", # Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern.
682 "guestAccelerators": [ # Specifies accelerator type and count.
683 { # A specification of the type and number of accelerator cards attached to the instance.
684 "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
685 "acceleratorType": "A String", # Full or partial URL of the accelerator type resource to attach to this instance. For example: projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100 If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
686 },
687 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]688 "locationHint": "A String", # An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
689 "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]690 "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
691 {
692 "interface": "A String", # Specifies the disk interface to use for attaching this disk, which is either SCSI or NVME. The default is SCSI. For performance characteristics of SCSI over NVMe, see Local SSD performance.
693 "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
694 },
695 ],
696 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]697 "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]698 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]699 "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]700 "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
701 "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
702 "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
703 "description": "A String", # An optional description of this resource. Provide this property when you create the resource.
704 },
705 ],
706 }
707
708 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.
709
710For 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.
711
712The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
713
714Returns:
715 An object of the form:
716
717 { # Represents an Operation resource.
718 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]719 # Google Compute Engine has three Operation resources:
720 #
721 # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/zoneOperations)
722 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]723 # You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.
724 #
725 # Operations can be global, regional or zonal.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 # - For global operations, use the `globalOperations` resource.
727 # - For regional operations, use the `regionOperations` resource.
728 # - For zonal operations, use the `zonalOperations` resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]729 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]730 # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]731 "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
732 "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
733 "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]734 "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]735 "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
736 "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]737 "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
738 "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]739 "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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]740 "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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]741 "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]742 "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]743 "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
744 "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
745 {
746 "message": "A String", # [Output Only] A human-readable description of the warning code.
747 "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.
748 "data": [ # [Output Only] Metadata about this warning in key: value format. For example:
749 # "data": [ { "key": "scope", "value": "zones/us-east1-d" }
750 {
751 "value": "A String", # [Output Only] A warning data value corresponding to the key.
752 "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).
753 },
754 ],
755 },
756 ],
757 "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]758 "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]759 "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]760 "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
761 "name": "A String", # [Output Only] Name of the operation.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]762 "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
763 "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
764 "errors": [ # [Output Only] The array of errors encountered while processing this operation.
765 {
766 "message": "A String", # [Output Only] An optional, human-readable error message.
767 "code": "A String", # [Output Only] The error type identifier for this error.
768 "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
769 },
770 ],
771 },
772 "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
773 "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
774 "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.
775 }</pre>
776</div>
777
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]778</body></html>