chore: regens API reference docs (#889)
diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html
index ada4b5a..2f87be9 100644
--- a/docs/dyn/compute_alpha.regionCommitments.html
+++ b/docs/dyn/compute_alpha.regionCommitments.html
@@ -75,7 +75,7 @@
<h1><a href="compute_alpha.html">Compute Engine API</a> . <a href="compute_alpha.regionCommitments.html">regionCommitments</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
- <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</a></code></p>
<p class="firstline">Retrieves an aggregated list of commitments.</p>
<p class="toc_element">
<code><a href="#aggregatedList_next">aggregatedList_next(previous_request, previous_response)</a></code></p>
@@ -84,41 +84,43 @@
<code><a href="#get">get(project, region, commitment)</a></code></p>
<p class="firstline">Returns the specified commitment resource. Gets a list of available commitments by making a list() request.</p>
<p class="toc_element">
- <code><a href="#insert">insert(project, region, body, requestId=None)</a></code></p>
+ <code><a href="#insert">insert(project, region, body=None, requestId=None)</a></code></p>
<p class="firstline">Creates a commitment in the specified project using the data included in the request.</p>
<p class="toc_element">
- <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</a></code></p>
+ <code><a href="#list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</a></code></p>
<p class="firstline">Retrieves a list of commitments contained within the specified region.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
- <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body)</a></code></p>
+ <code><a href="#testIamPermissions">testIamPermissions(project, region, resource, body=None)</a></code></p>
<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
<p class="toc_element">
- <code><a href="#updateReservations">updateReservations(project, region, commitment, body, requestId=None)</a></code></p>
-<p class="firstline">Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments.</p>
+ <code><a href="#updateReservations">updateReservations(project, region, commitment, body=None, requestId=None)</a></code></p>
+<p class="firstline">Transfers GPUs or local SSDs between reservations within commitments.</p>
<h3>Method Details</h3>
<div class="method">
- <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="aggregatedList">aggregatedList(project, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None, includeAllScopes=None)</code>
<pre>Retrieves an aggregated list of commitments.
Args:
project: string, Project ID for this request. (required)
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.
+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.
- 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)
- 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.
- 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 <.
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ 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`)
+ 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.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
+ 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.
+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.
+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).
+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) ```
+ 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.
Returns:
An object of the form:
@@ -142,25 +144,29 @@
"commitments": [ # [Output Only] A list of commitments contained in this scope.
{ # Represents a regional Commitment resource.
#
- # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
- "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
+ # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
+ "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
- "reservations": [ # List of reservations for this commitment.
- { # Reservation resource NextID: 13
+ "reservations": [ # List of reservations in this commitment.
+ { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
"status": "A String", # [Output Only] The status of the reservation.
"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
"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.
- "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation.
- "commitment": "A String", # [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment.
+ "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
+ "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
- "count": "A String", # Specifies number of resources that are allocated.
- "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for this specific sku reservation.
- "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
+ "count": "A String", # Specifies the number of resources that are allocated.
+ "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
+ "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
+ #
+ # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
+ #
+ # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"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.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
@@ -168,6 +174,8 @@
"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.
},
],
+ "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.
+ "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"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.
@@ -175,9 +183,9 @@
},
],
},
- "inUseCount": "A String", # [OutputOnly] Indicates how many resource are in use.
+ "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
},
- "zone": "A String", # Zone in which the reservation resides, must be provided if reservation is created with commitment creation.
+ "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
@@ -186,8 +194,14 @@
],
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
+ "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
+ "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
+ "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
+ "amount": "A String", # The number of licenses purchased.
+ "license": "A String", # Any applicable license URI.
+ },
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
@@ -214,6 +228,9 @@
},
],
},
+ "unreachables": [ # [Output Only] Unreachable resources.
+ "A String",
+ ],
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
}</pre>
@@ -247,25 +264,29 @@
{ # Represents a regional Commitment resource.
#
- # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
- "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
+ # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
+ "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
- "reservations": [ # List of reservations for this commitment.
- { # Reservation resource NextID: 13
+ "reservations": [ # List of reservations in this commitment.
+ { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
"status": "A String", # [Output Only] The status of the reservation.
"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
"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.
- "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation.
- "commitment": "A String", # [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment.
+ "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
+ "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
- "count": "A String", # Specifies number of resources that are allocated.
- "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for this specific sku reservation.
- "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
+ "count": "A String", # Specifies the number of resources that are allocated.
+ "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
+ "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
+ #
+ # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
+ #
+ # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"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.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
@@ -273,6 +294,8 @@
"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.
},
],
+ "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.
+ "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"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.
@@ -280,9 +303,9 @@
},
],
},
- "inUseCount": "A String", # [OutputOnly] Indicates how many resource are in use.
+ "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
},
- "zone": "A String", # Zone in which the reservation resides, must be provided if reservation is created with commitment creation.
+ "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
@@ -291,8 +314,14 @@
],
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
+ "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
+ "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
+ "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
+ "amount": "A String", # The number of licenses purchased.
+ "license": "A String", # Any applicable license URI.
+ },
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
@@ -308,36 +337,40 @@
</div>
<div class="method">
- <code class="details" id="insert">insert(project, region, body, requestId=None)</code>
+ <code class="details" id="insert">insert(project, region, body=None, requestId=None)</code>
<pre>Creates a commitment in the specified project using the data included in the request.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{ # Represents a regional Commitment resource.
#
- # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
- "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
+ # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
+ "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
- "reservations": [ # List of reservations for this commitment.
- { # Reservation resource NextID: 13
+ "reservations": [ # List of reservations in this commitment.
+ { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
"status": "A String", # [Output Only] The status of the reservation.
"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
"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.
- "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation.
- "commitment": "A String", # [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment.
+ "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
+ "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
- "count": "A String", # Specifies number of resources that are allocated.
- "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for this specific sku reservation.
- "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
+ "count": "A String", # Specifies the number of resources that are allocated.
+ "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
+ "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
+ #
+ # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
+ #
+ # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"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.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
@@ -345,6 +378,8 @@
"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.
},
],
+ "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.
+ "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"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.
@@ -352,9 +387,9 @@
},
],
},
- "inUseCount": "A String", # [OutputOnly] Indicates how many resource are in use.
+ "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
},
- "zone": "A String", # Zone in which the reservation resides, must be provided if reservation is created with commitment creation.
+ "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
@@ -363,8 +398,14 @@
],
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
+ "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
+ "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
+ "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
+ "amount": "A String", # The number of licenses purchased.
+ "license": "A String", # Any applicable license URI.
+ },
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
@@ -389,26 +430,30 @@
{ # Represents an Operation resource.
#
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/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 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. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"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.
- "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.
+ "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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
@@ -424,10 +469,10 @@
},
],
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.
@@ -445,7 +490,7 @@
</div>
<div class="method">
- <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, filter=None)</code>
+ <code class="details" id="list">list(project, region, orderBy=None, maxResults=None, pageToken=None, returnPartialSuccess=None, filter=None)</code>
<pre>Retrieves a list of commitments contained within the specified region.
Args:
@@ -453,18 +498,19 @@
region: string, Name of the region for this request. (required)
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.
+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.
- 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)
- 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.
- 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 <.
+Currently, only sorting by `name` or `creationTimestamp desc` is supported.
+ 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`)
+ 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.
+ returnPartialSuccess: boolean, Opt-in for partial success behavior which provides partial results in case of failure. The default value is false and the logic is the same as today.
+ 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.
+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.
+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).
+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) ```
Returns:
An object of the form:
@@ -475,25 +521,29 @@
"items": [ # A list of Commitment resources.
{ # Represents a regional Commitment resource.
#
- # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)
- "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
+ # Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for {$api_version}.regionCommitments ==)
+ "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"startTimestamp": "A String", # [Output Only] Commitment start time in RFC3339 text format.
- "reservations": [ # List of reservations for this commitment.
- { # Reservation resource NextID: 13
+ "reservations": [ # List of reservations in this commitment.
+ { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
"status": "A String", # [Output Only] The status of the reservation.
"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
"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.
- "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation.
- "commitment": "A String", # [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment.
+ "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
+ "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
- "count": "A String", # Specifies number of resources that are allocated.
- "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for this specific sku reservation.
- "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
+ "count": "A String", # Specifies the number of resources that are allocated.
+ "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
+ "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
+ #
+ # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
+ #
+ # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"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.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
@@ -501,6 +551,8 @@
"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.
},
],
+ "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.
+ "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"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.
@@ -508,9 +560,9 @@
},
],
},
- "inUseCount": "A String", # [OutputOnly] Indicates how many resource are in use.
+ "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
},
- "zone": "A String", # Zone in which the reservation resides, must be provided if reservation is created with commitment creation.
+ "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
@@ -519,8 +571,14 @@
],
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
+ "status": "A String", # [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
"plan": "A String", # The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years).
"type": "A String", # The type of commitment, which affects the discount rate and the eligible resources. Type MEMORY_OPTIMIZED specifies a commitment that will only apply to memory optimized machines.
+ "licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
+ "coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
+ "amount": "A String", # The number of licenses purchased.
+ "license": "A String", # Any applicable license URI.
+ },
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
@@ -565,14 +623,14 @@
</div>
<div class="method">
- <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body)</code>
+ <code class="details" id="testIamPermissions">testIamPermissions(project, region, resource, body=None)</code>
<pre>Returns permissions that a caller has on the specified resource.
Args:
project: string, Project ID for this request. (required)
region: string, The name of the region for this request. (required)
resource: string, Name or id of the resource for this request. (required)
- body: object, The request body. (required)
+ body: object, The request body.
The object takes the form of:
{
@@ -593,29 +651,33 @@
</div>
<div class="method">
- <code class="details" id="updateReservations">updateReservations(project, region, commitment, body, requestId=None)</code>
- <pre>Update the shape of reservations for GPUS/Local SSDs of reservations within the commitments.
+ <code class="details" id="updateReservations">updateReservations(project, region, commitment, body=None, requestId=None)</code>
+ <pre>Transfers GPUs or local SSDs between reservations within commitments.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
- commitment: string, Name of the commitment of which the reservation's capacities are being updated. (required)
- body: object, The request body. (required)
+ commitment: string, Name of the commitment for which the reservation is being updated. (required)
+ body: object, The request body.
The object takes the form of:
{
- "reservations": [ # List of reservations for the capacity move of VMs with accelerators and local ssds.
- { # Reservation resource NextID: 13
+ "reservations": [ # A list of two reservations to transfer GPUs and local SSD between.
+ { # Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for {$api_version}.reservations ==)
"status": "A String", # [Output Only] The status of the reservation.
"kind": "compute#reservation", # [Output Only] Type of the resource. Always compute#reservations for reservations.
"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.
- "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation.
- "commitment": "A String", # [OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment.
+ "specificReservationRequired": True or False, # Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from this reservation.
+ "commitment": "A String", # [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
- "count": "A String", # Specifies number of resources that are allocated.
- "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for this specific sku reservation.
- "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
+ "count": "A String", # Specifies the number of resources that are allocated.
+ "instanceProperties": { # Properties of the SKU instances being reserved. # The instance properties for the reservation.
+ "longTermRelease": True or False, # Compute Engine Long Term Release. When specified, VMs that have this policy become long term release (internal: stable fleet) VMs.
+ #
+ # For all VM shapes, this should result in fewer disruptions due to software updates and greater predictability via 1 week extended notifications.
+ #
+ # For GPU VMs, this should also result in an 2 week uptime guarantee. See go/stable-fleet-gpus-design for more details.
"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.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
@@ -623,6 +685,8 @@
"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.
},
],
+ "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.
+ "minCpuPlatform": "A String", # Minimum cpu platform the reservation.
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"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.
@@ -630,9 +694,9 @@
},
],
},
- "inUseCount": "A String", # [OutputOnly] Indicates how many resource are in use.
+ "inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
},
- "zone": "A String", # Zone in which the reservation resides, must be provided if reservation is created with commitment creation.
+ "zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
@@ -652,26 +716,30 @@
{ # Represents an Operation resource.
#
+ # Google Compute Engine has three Operation resources:
+ #
+ # * [Global](/compute/docs/reference/rest/{$api_version}/globalOperations) * [Regional](/compute/docs/reference/rest/{$api_version}/regionOperations) * [Zonal](/compute/docs/reference/rest/{$api_version}/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 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. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)
+ # For more information, read Global, Regional, and Zonal Resources. (== resource_for {$api_version}.globalOperations ==) (== resource_for {$api_version}.regionOperations ==) (== resource_for {$api_version}.zoneOperations ==)
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
"creationTimestamp": "A String", # [Deprecated] This field is deprecated.
- "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+ "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
- "operationType": "A String", # [Output Only] The type of operation, such as insert, update, or delete, and so on.
- "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.
+ "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+ "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
"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.
- "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.
+ "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.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
- "status": "A String", # [Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.
+ "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
@@ -687,10 +755,10 @@
},
],
"selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
- "user": "A String", # [Output Only] User who requested the operation, for example: user@example.com.
+ "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com`.
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
- "kind": "compute#operation", # [Output Only] Type of the resource. Always compute#operation for Operation resources.
- "name": "A String", # [Output Only] Name of the resource.
+ "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+ "name": "A String", # [Output Only] Name of the operation.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
"errors": [ # [Output Only] The array of errors encountered while processing this operation.