| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.futureReservations.html">futureReservations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 78 | <code><a href="#aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 79 | <p class="firstline">Retrieves an aggregated list of future reservations.</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"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 84 | <code><a href="#cancel">cancel(project, zone, futureReservation, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 85 | <p class="firstline">Cancel the specified future reservation.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#close">close()</a></code></p> |
| 88 | <p class="firstline">Close httplib2 connections.</p> |
| 89 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 90 | <code><a href="#delete">delete(project, zone, futureReservation, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 91 | <p class="firstline">Deletes the specified future reservation.</p> |
| 92 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 93 | <code><a href="#get">get(project, zone, futureReservation, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 94 | <p class="firstline">Retrieves information about the specified future reservation.</p> |
| 95 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 96 | <code><a href="#insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 97 | <p class="firstline">Creates a new Future Reservation.</p> |
| 98 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 99 | <code><a href="#list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 100 | <p class="firstline">A list of all the future reservations that have been configured for the specified project in specified zone.</p> |
| 101 | <p class="toc_element"> |
| 102 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 103 | <p class="firstline">Retrieves the next page of results.</p> |
| 104 | <p class="toc_element"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 105 | <code><a href="#update">update(project, zone, futureReservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</a></code></p> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 106 | <p class="firstline">Updates the specified future reservation.</p> |
| 107 | <h3>Method Details</h3> |
| 108 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 109 | <code class="details" id="aggregatedList">aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 110 | <pre>Retrieves an aggregated list of future reservations. |
| 111 | |
| 112 | Args: |
| 113 | project: string, Project ID for this request. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 114 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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) ``` |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 115 | 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. |
| 116 | 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`) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 117 | 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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 118 | 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. |
| 119 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 120 | x__xgafv: string, V1 error format. |
| 121 | Allowed values |
| 122 | 1 - v1 error format |
| 123 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 124 | |
| 125 | Returns: |
| 126 | An object of the form: |
| 127 | |
| 128 | { # Contains a list of future reservations. |
| 129 | "etag": "A String", |
| 130 | "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server. |
| 131 | "items": { # A list of Future reservation resources. |
| 132 | "a_key": { # Name of the scope containing this set of future reservations. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 133 | "futureReservations": [ # A list of future reservations contained in this scope. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 134 | { |
| 135 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
| 136 | "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. |
| 137 | "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 138 | "kind": "compute#futureReservation", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 139 | "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. |
| 140 | "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. |
| 141 | "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| 142 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 143 | "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 144 | "folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. |
| 145 | "a_key": { # Config for each folder in the share settings. |
| 146 | "folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map. |
| 147 | }, |
| 148 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 149 | "projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one. |
| 150 | "a_key": { # Config for each project in the share settings. |
| 151 | "projectId": "A String", # The project ID, should be same as the key of this project config in the parent map. |
| 152 | }, |
| 153 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 154 | "projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS. |
| 155 | "A String", |
| 156 | ], |
| 157 | "shareType": "A String", # Type of sharing for this shared-reservation |
| 158 | }, |
| 159 | "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. |
| 160 | "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. |
| 161 | "guestAccelerators": [ # Specifies accelerator type and count. |
| 162 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 163 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 164 | "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. |
| 165 | }, |
| 166 | ], |
| 167 | "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
| 168 | { |
| 169 | "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| 170 | "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. |
| 171 | }, |
| 172 | ], |
| 173 | "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. |
| 174 | "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. |
| 175 | "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
| 176 | "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. |
| 177 | "minCpuPlatform": "A String", # Minimum cpu platform the reservation. |
| 178 | }, |
| 179 | "totalCount": "A String", # Total number of instances for which capacity assurance is requested at a future time period. |
| 180 | }, |
| 181 | "status": { # [Output only] Represents status related to the future reservation. # [Output only] Status of the Future Reservation |
| 182 | "autoCreatedReservations": [ # Fully qualified urls of the automatically created reservations at start_time. |
| 183 | "A String", |
| 184 | ], |
| 185 | "fulfilledCount": "A String", # This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 186 | "lockTime": "A String", # Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 187 | "procurementStatus": "A String", # Current state of this Future Reservation |
| 188 | }, |
| 189 | "timeWindow": { # Time window for this Future Reservation. |
| 190 | "duration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. |
| 191 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 192 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 193 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 194 | "endTime": "A String", |
| 195 | "startTime": "A String", # Start time of the Future Reservation. The start_time is an RFC3339 string. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 196 | }, |
| 197 | "zone": "A String", # [Output Only] URL of the Zone where this future reservation resides. |
| 198 | }, |
| 199 | ], |
| 200 | "warning": { # Informational warning which replaces the list of future reservations when the list is empty. |
| 201 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 202 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 203 | { |
| 204 | "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). |
| 205 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 206 | }, |
| 207 | ], |
| 208 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 209 | }, |
| 210 | }, |
| 211 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 212 | "kind": "compute#futureReservationsAggregatedListResponse", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 213 | "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. |
| 214 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 215 | "unreachables": [ # [Output Only] Unreachable resources. |
| 216 | "A String", |
| 217 | ], |
| 218 | "warning": { # [Output Only] Informational warning message. |
| 219 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 220 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 221 | { |
| 222 | "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). |
| 223 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 224 | }, |
| 225 | ], |
| 226 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 227 | }, |
| 228 | }</pre> |
| 229 | </div> |
| 230 | |
| 231 | <div class="method"> |
| 232 | <code class="details" id="aggregatedList_next">aggregatedList_next(previous_request, previous_response)</code> |
| 233 | <pre>Retrieves the next page of results. |
| 234 | |
| 235 | Args: |
| 236 | previous_request: The request for the previous page. (required) |
| 237 | previous_response: The response from the request for the previous page. (required) |
| 238 | |
| 239 | Returns: |
| 240 | A request object that you can call 'execute()' on to request the next |
| 241 | page. Returns None if there are no more items in the collection. |
| 242 | </pre> |
| 243 | </div> |
| 244 | |
| 245 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 246 | <code class="details" id="cancel">cancel(project, zone, futureReservation, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 247 | <pre>Cancel the specified future reservation. |
| 248 | |
| 249 | Args: |
| 250 | project: string, Project ID for this request. (required) |
| 251 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| 252 | futureReservation: string, Name of the future reservation to retrieve. Name should conform to RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 253 | 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). |
| 254 | x__xgafv: string, V1 error format. |
| 255 | Allowed values |
| 256 | 1 - v1 error format |
| 257 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 258 | |
| 259 | Returns: |
| 260 | An object of the form: |
| 261 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 262 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 263 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 264 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 265 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 266 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 267 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 268 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 269 | { |
| 270 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 271 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 272 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 273 | }, |
| 274 | ], |
| 275 | }, |
| 276 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 277 | "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. |
| 278 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 279 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 280 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 281 | "name": "A String", # [Output Only] Name of the operation. |
| 282 | "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. |
| 283 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 284 | "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. |
| 285 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 286 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 287 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 288 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 289 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 290 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 291 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 292 | "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. |
| 293 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 294 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 295 | { |
| 296 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 297 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 298 | { |
| 299 | "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). |
| 300 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 301 | }, |
| 302 | ], |
| 303 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 304 | }, |
| 305 | ], |
| 306 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 307 | }</pre> |
| 308 | </div> |
| 309 | |
| 310 | <div class="method"> |
| 311 | <code class="details" id="close">close()</code> |
| 312 | <pre>Close httplib2 connections.</pre> |
| 313 | </div> |
| 314 | |
| 315 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 316 | <code class="details" id="delete">delete(project, zone, futureReservation, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 317 | <pre>Deletes the specified future reservation. |
| 318 | |
| 319 | Args: |
| 320 | project: string, Project ID for this request. (required) |
| 321 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| 322 | futureReservation: string, Name of the future reservation to retrieve. Name should conform to RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 323 | 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). |
| 324 | x__xgafv: string, V1 error format. |
| 325 | Allowed values |
| 326 | 1 - v1 error format |
| 327 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 328 | |
| 329 | Returns: |
| 330 | An object of the form: |
| 331 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 332 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 333 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 334 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 335 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 336 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 337 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 338 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 339 | { |
| 340 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 341 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 342 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 343 | }, |
| 344 | ], |
| 345 | }, |
| 346 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 347 | "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. |
| 348 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 349 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 350 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 351 | "name": "A String", # [Output Only] Name of the operation. |
| 352 | "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. |
| 353 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 354 | "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. |
| 355 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 356 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 357 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 358 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 359 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 360 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 361 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 362 | "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. |
| 363 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 364 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 365 | { |
| 366 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 367 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 368 | { |
| 369 | "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). |
| 370 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 371 | }, |
| 372 | ], |
| 373 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 374 | }, |
| 375 | ], |
| 376 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 377 | }</pre> |
| 378 | </div> |
| 379 | |
| 380 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 381 | <code class="details" id="get">get(project, zone, futureReservation, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 382 | <pre>Retrieves information about the specified future reservation. |
| 383 | |
| 384 | Args: |
| 385 | project: string, Project ID for this request. (required) |
| 386 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| 387 | futureReservation: string, Name of the future reservation to retrieve. Name should conform to RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 388 | x__xgafv: string, V1 error format. |
| 389 | Allowed values |
| 390 | 1 - v1 error format |
| 391 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 392 | |
| 393 | Returns: |
| 394 | An object of the form: |
| 395 | |
| 396 | { |
| 397 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
| 398 | "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. |
| 399 | "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 400 | "kind": "compute#futureReservation", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 401 | "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. |
| 402 | "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. |
| 403 | "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| 404 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 405 | "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 406 | "folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. |
| 407 | "a_key": { # Config for each folder in the share settings. |
| 408 | "folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map. |
| 409 | }, |
| 410 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 411 | "projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one. |
| 412 | "a_key": { # Config for each project in the share settings. |
| 413 | "projectId": "A String", # The project ID, should be same as the key of this project config in the parent map. |
| 414 | }, |
| 415 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 416 | "projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS. |
| 417 | "A String", |
| 418 | ], |
| 419 | "shareType": "A String", # Type of sharing for this shared-reservation |
| 420 | }, |
| 421 | "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. |
| 422 | "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. |
| 423 | "guestAccelerators": [ # Specifies accelerator type and count. |
| 424 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 425 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 426 | "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. |
| 427 | }, |
| 428 | ], |
| 429 | "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
| 430 | { |
| 431 | "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| 432 | "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. |
| 433 | }, |
| 434 | ], |
| 435 | "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. |
| 436 | "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. |
| 437 | "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
| 438 | "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. |
| 439 | "minCpuPlatform": "A String", # Minimum cpu platform the reservation. |
| 440 | }, |
| 441 | "totalCount": "A String", # Total number of instances for which capacity assurance is requested at a future time period. |
| 442 | }, |
| 443 | "status": { # [Output only] Represents status related to the future reservation. # [Output only] Status of the Future Reservation |
| 444 | "autoCreatedReservations": [ # Fully qualified urls of the automatically created reservations at start_time. |
| 445 | "A String", |
| 446 | ], |
| 447 | "fulfilledCount": "A String", # This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 448 | "lockTime": "A String", # Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 449 | "procurementStatus": "A String", # Current state of this Future Reservation |
| 450 | }, |
| 451 | "timeWindow": { # Time window for this Future Reservation. |
| 452 | "duration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. |
| 453 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 454 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 455 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 456 | "endTime": "A String", |
| 457 | "startTime": "A String", # Start time of the Future Reservation. The start_time is an RFC3339 string. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 458 | }, |
| 459 | "zone": "A String", # [Output Only] URL of the Zone where this future reservation resides. |
| 460 | }</pre> |
| 461 | </div> |
| 462 | |
| 463 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 464 | <code class="details" id="insert">insert(project, zone, body=None, requestId=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 465 | <pre>Creates a new Future Reservation. |
| 466 | |
| 467 | Args: |
| 468 | project: string, Project ID for this request. (required) |
| 469 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| 470 | body: object, The request body. |
| 471 | The object takes the form of: |
| 472 | |
| 473 | { |
| 474 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
| 475 | "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. |
| 476 | "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 477 | "kind": "compute#futureReservation", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 478 | "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. |
| 479 | "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. |
| 480 | "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| 481 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 482 | "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 483 | "folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. |
| 484 | "a_key": { # Config for each folder in the share settings. |
| 485 | "folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map. |
| 486 | }, |
| 487 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 488 | "projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one. |
| 489 | "a_key": { # Config for each project in the share settings. |
| 490 | "projectId": "A String", # The project ID, should be same as the key of this project config in the parent map. |
| 491 | }, |
| 492 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 493 | "projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS. |
| 494 | "A String", |
| 495 | ], |
| 496 | "shareType": "A String", # Type of sharing for this shared-reservation |
| 497 | }, |
| 498 | "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. |
| 499 | "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. |
| 500 | "guestAccelerators": [ # Specifies accelerator type and count. |
| 501 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 502 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 503 | "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. |
| 504 | }, |
| 505 | ], |
| 506 | "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
| 507 | { |
| 508 | "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| 509 | "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. |
| 510 | }, |
| 511 | ], |
| 512 | "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. |
| 513 | "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. |
| 514 | "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
| 515 | "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. |
| 516 | "minCpuPlatform": "A String", # Minimum cpu platform the reservation. |
| 517 | }, |
| 518 | "totalCount": "A String", # Total number of instances for which capacity assurance is requested at a future time period. |
| 519 | }, |
| 520 | "status": { # [Output only] Represents status related to the future reservation. # [Output only] Status of the Future Reservation |
| 521 | "autoCreatedReservations": [ # Fully qualified urls of the automatically created reservations at start_time. |
| 522 | "A String", |
| 523 | ], |
| 524 | "fulfilledCount": "A String", # This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 525 | "lockTime": "A String", # Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 526 | "procurementStatus": "A String", # Current state of this Future Reservation |
| 527 | }, |
| 528 | "timeWindow": { # Time window for this Future Reservation. |
| 529 | "duration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. |
| 530 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 531 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 532 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 533 | "endTime": "A String", |
| 534 | "startTime": "A String", # Start time of the Future Reservation. The start_time is an RFC3339 string. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 535 | }, |
| 536 | "zone": "A String", # [Output Only] URL of the Zone where this future reservation resides. |
| 537 | } |
| 538 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 539 | 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). |
| 540 | x__xgafv: string, V1 error format. |
| 541 | Allowed values |
| 542 | 1 - v1 error format |
| 543 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 544 | |
| 545 | Returns: |
| 546 | An object of the form: |
| 547 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 548 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 549 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 550 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 551 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 552 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 553 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 554 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 555 | { |
| 556 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 557 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 558 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 559 | }, |
| 560 | ], |
| 561 | }, |
| 562 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 563 | "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. |
| 564 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 565 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 566 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 567 | "name": "A String", # [Output Only] Name of the operation. |
| 568 | "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. |
| 569 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 570 | "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. |
| 571 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 572 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 573 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 574 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 575 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 576 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 577 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 578 | "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. |
| 579 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 580 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 581 | { |
| 582 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 583 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 584 | { |
| 585 | "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). |
| 586 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 587 | }, |
| 588 | ], |
| 589 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 590 | }, |
| 591 | ], |
| 592 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 593 | }</pre> |
| 594 | </div> |
| 595 | |
| 596 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 597 | <code class="details" id="list">list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 598 | <pre>A list of all the future reservations that have been configured for the specified project in specified zone. |
| 599 | |
| 600 | Args: |
| 601 | project: string, Project ID for this request. (required) |
| 602 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 603 | filter: string, A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either `=`, `!=`, `>`, or `<`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. 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) ``` |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 604 | 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`) |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 605 | 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. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 606 | 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. |
| 607 | returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 608 | x__xgafv: string, V1 error format. |
| 609 | Allowed values |
| 610 | 1 - v1 error format |
| 611 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 612 | |
| 613 | Returns: |
| 614 | An object of the form: |
| 615 | |
| 616 | { |
| 617 | "etag": "A String", |
| 618 | "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. |
| 619 | "items": [ # [Output Only] A list of future reservation resources. |
| 620 | { |
| 621 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
| 622 | "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. |
| 623 | "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 624 | "kind": "compute#futureReservation", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 625 | "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. |
| 626 | "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. |
| 627 | "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| 628 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 629 | "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 630 | "folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. |
| 631 | "a_key": { # Config for each folder in the share settings. |
| 632 | "folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map. |
| 633 | }, |
| 634 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 635 | "projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one. |
| 636 | "a_key": { # Config for each project in the share settings. |
| 637 | "projectId": "A String", # The project ID, should be same as the key of this project config in the parent map. |
| 638 | }, |
| 639 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 640 | "projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS. |
| 641 | "A String", |
| 642 | ], |
| 643 | "shareType": "A String", # Type of sharing for this shared-reservation |
| 644 | }, |
| 645 | "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. |
| 646 | "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. |
| 647 | "guestAccelerators": [ # Specifies accelerator type and count. |
| 648 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 649 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 650 | "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. |
| 651 | }, |
| 652 | ], |
| 653 | "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
| 654 | { |
| 655 | "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| 656 | "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. |
| 657 | }, |
| 658 | ], |
| 659 | "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. |
| 660 | "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. |
| 661 | "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
| 662 | "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. |
| 663 | "minCpuPlatform": "A String", # Minimum cpu platform the reservation. |
| 664 | }, |
| 665 | "totalCount": "A String", # Total number of instances for which capacity assurance is requested at a future time period. |
| 666 | }, |
| 667 | "status": { # [Output only] Represents status related to the future reservation. # [Output only] Status of the Future Reservation |
| 668 | "autoCreatedReservations": [ # Fully qualified urls of the automatically created reservations at start_time. |
| 669 | "A String", |
| 670 | ], |
| 671 | "fulfilledCount": "A String", # This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 672 | "lockTime": "A String", # Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 673 | "procurementStatus": "A String", # Current state of this Future Reservation |
| 674 | }, |
| 675 | "timeWindow": { # Time window for this Future Reservation. |
| 676 | "duration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. |
| 677 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 678 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 679 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 680 | "endTime": "A String", |
| 681 | "startTime": "A String", # Start time of the Future Reservation. The start_time is an RFC3339 string. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 682 | }, |
| 683 | "zone": "A String", # [Output Only] URL of the Zone where this future reservation resides. |
| 684 | }, |
| 685 | ], |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 686 | "kind": "compute#futureReservationsListResponse", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 687 | "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. |
| 688 | "selfLink": "A String", # [Output Only] Server-defined URL for this resource. |
| 689 | "unreachables": [ # [Output Only] Unreachable resources. |
| 690 | "A String", |
| 691 | ], |
| 692 | "warning": { # [Output Only] Informational warning message. |
| 693 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 694 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 695 | { |
| 696 | "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). |
| 697 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 698 | }, |
| 699 | ], |
| 700 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 701 | }, |
| 702 | }</pre> |
| 703 | </div> |
| 704 | |
| 705 | <div class="method"> |
| 706 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 707 | <pre>Retrieves the next page of results. |
| 708 | |
| 709 | Args: |
| 710 | previous_request: The request for the previous page. (required) |
| 711 | previous_response: The response from the request for the previous page. (required) |
| 712 | |
| 713 | Returns: |
| 714 | A request object that you can call 'execute()' on to request the next |
| 715 | page. Returns None if there are no more items in the collection. |
| 716 | </pre> |
| 717 | </div> |
| 718 | |
| 719 | <div class="method"> |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 720 | <code class="details" id="update">update(project, zone, futureReservation, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)</code> |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 721 | <pre>Updates the specified future reservation. |
| 722 | |
| 723 | Args: |
| 724 | project: string, Project ID for this request. (required) |
| 725 | zone: string, Name of the zone for this request. Name should conform to RFC1035. (required) |
| 726 | futureReservation: string, Name of the reservation to update. Name should conform to RFC1035. (required) |
| 727 | body: object, The request body. |
| 728 | The object takes the form of: |
| 729 | |
| 730 | { |
| 731 | "creationTimestamp": "A String", # [Output Only] The creation timestamp for this future reservation in RFC3339 text format. |
| 732 | "description": "A String", # An optional description of this resource. Provide this property when you create the future reservation. |
| 733 | "id": "A String", # [Output Only] A unique identifier for this future reservation. The server defines this identifier. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 734 | "kind": "compute#futureReservation", |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 735 | "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. |
| 736 | "namePrefix": "A String", # Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. |
| 737 | "selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource. |
| 738 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 739 | "shareSettings": { # The share setting for reservations and sole tenancy node groups. # List of Projects/Folders to share with. |
| yoshi-code-bot | 96afc04 | 2021-08-24 00:22:31 -0700 | [diff] [blame] | 740 | "folderMap": { # A map of folder id and folder config to specify consumer projects for this shared-reservation. This is only valid when share_type's value is DIRECT_PROJECTS_UNDER_SPECIFIC_FOLDERS. |
| 741 | "a_key": { # Config for each folder in the share settings. |
| 742 | "folderId": "A String", # The folder ID, should be same as the key of this folder config in the parent map. |
| 743 | }, |
| 744 | }, |
| yoshi-code-bot | 312da31 | 2021-09-21 00:22:28 -0700 | [diff] [blame^] | 745 | "projectMap": { # A map of project id and project config. Using map format to ease add-to/remove-from the Project list in PATCH command. In future we will deprecate (And later remove) the array one. |
| 746 | "a_key": { # Config for each project in the share settings. |
| 747 | "projectId": "A String", # The project ID, should be same as the key of this project config in the parent map. |
| 748 | }, |
| 749 | }, |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 750 | "projects": [ # A List of Project names to specify consumer projects for this shared-reservation. This is only valid when share_type's value is SPECIFIC_PROJECTS. |
| 751 | "A String", |
| 752 | ], |
| 753 | "shareType": "A String", # Type of sharing for this shared-reservation |
| 754 | }, |
| 755 | "specificSkuProperties": { # Future Reservation configuration to indicate instance properties and total count. |
| 756 | "instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # Properties of the SKU instances being reserved. |
| 757 | "guestAccelerators": [ # Specifies accelerator type and count. |
| 758 | { # A specification of the type and number of accelerator cards attached to the instance. |
| 759 | "acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance. |
| 760 | "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. |
| 761 | }, |
| 762 | ], |
| 763 | "localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd. |
| 764 | { |
| 765 | "diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB. |
| 766 | "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. |
| 767 | }, |
| 768 | ], |
| 769 | "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. |
| 770 | "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. |
| 771 | "maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance. |
| 772 | "maintenanceInterval": "A String", # For more information about maintenance intervals, see Setting maintenance intervals. |
| 773 | "minCpuPlatform": "A String", # Minimum cpu platform the reservation. |
| 774 | }, |
| 775 | "totalCount": "A String", # Total number of instances for which capacity assurance is requested at a future time period. |
| 776 | }, |
| 777 | "status": { # [Output only] Represents status related to the future reservation. # [Output only] Status of the Future Reservation |
| 778 | "autoCreatedReservations": [ # Fully qualified urls of the automatically created reservations at start_time. |
| 779 | "A String", |
| 780 | ], |
| 781 | "fulfilledCount": "A String", # This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 782 | "lockTime": "A String", # Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lock_time is an RFC3339 string. The procurement_status will transition to PROCURING state at this time. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 783 | "procurementStatus": "A String", # Current state of this Future Reservation |
| 784 | }, |
| 785 | "timeWindow": { # Time window for this Future Reservation. |
| 786 | "duration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. |
| 787 | "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. |
| 788 | "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years |
| 789 | }, |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 790 | "endTime": "A String", |
| 791 | "startTime": "A String", # Start time of the Future Reservation. The start_time is an RFC3339 string. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 792 | }, |
| 793 | "zone": "A String", # [Output Only] URL of the Zone where this future reservation resides. |
| 794 | } |
| 795 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 796 | paths: string, A parameter (repeated) |
| 797 | 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). |
| 798 | updateMask: string, update_mask indicates fields to be updated as part of this request. |
| 799 | x__xgafv: string, V1 error format. |
| 800 | Allowed values |
| 801 | 1 - v1 error format |
| 802 | 2 - v2 error format |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 803 | |
| 804 | Returns: |
| 805 | An object of the form: |
| 806 | |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 807 | { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zonalOperations` resource. For more information, read Global, Regional, and Zonal Resources. |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 808 | "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. |
| 809 | "creationTimestamp": "A String", # [Deprecated] This field is deprecated. |
| 810 | "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. |
| 811 | "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. |
| 812 | "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. |
| 813 | "errors": [ # [Output Only] The array of errors encountered while processing this operation. |
| 814 | { |
| 815 | "code": "A String", # [Output Only] The error type identifier for this error. |
| 816 | "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. |
| 817 | "message": "A String", # [Output Only] An optional, human-readable error message. |
| 818 | }, |
| 819 | ], |
| 820 | }, |
| 821 | "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. |
| 822 | "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. |
| 823 | "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. |
| 824 | "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. |
| 825 | "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. |
| 826 | "name": "A String", # [Output Only] Name of the operation. |
| 827 | "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. |
| 828 | "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. |
| 829 | "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. |
| 830 | "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. |
| 831 | "selfLink": "A String", # [Output Only] Server-defined URL for the resource. |
| 832 | "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. |
| 833 | "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. |
| 834 | "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. |
| 835 | "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. |
| 836 | "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. |
| 837 | "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. |
| 838 | "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`. |
| 839 | "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. |
| 840 | { |
| 841 | "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. |
| yoshi-code-bot | 3659137 | 2021-06-16 00:22:06 -0700 | [diff] [blame] | 842 | "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
| yoshi-code-bot | c2cd326 | 2021-05-16 02:16:04 -0700 | [diff] [blame] | 843 | { |
| 844 | "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). |
| 845 | "value": "A String", # [Output Only] A warning data value corresponding to the key. |
| 846 | }, |
| 847 | ], |
| 848 | "message": "A String", # [Output Only] A human-readable description of the warning code. |
| 849 | }, |
| 850 | ], |
| 851 | "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
| 852 | }</pre> |
| 853 | </div> |
| 854 | |
| 855 | </body></html> |