Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Retrieves the next page of results.
Close httplib2 connections.
get(project, region, commitment, x__xgafv=None)
Returns the specified commitment resource.
insert(project, region, body=None, requestId=None, x__xgafv=None)
Creates a commitment in the specified project using the data included in the request.
Retrieves a list of commitments contained within the specified region.
Retrieves the next page of results.
testIamPermissions(project, region, resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource.
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.
updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None)
Transfers GPUs or local SSDs between reservations within commitments.
aggregatedList(project, filter=None, includeAllScopes=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, serviceProjectNumber=None, x__xgafv=None)
Retrieves an aggregated list of commitments by region. To prevent failure, Google recommends that you set the `returnPartialSuccess` parameter to `true`.
Args:
project: string, Project ID for this request. (required)
filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
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.
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`)
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.
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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
serviceProjectNumber: string, The Shared VPC service project id or service project number for which aggregated list request is invoked for subnetworks list-usable api.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"items": { # A list of CommitmentsScopedList resources.
"a_key": { # [Output Only] Name of the scope containing this set of commitments.
"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.
"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
"existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
"A String",
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
"amount": "A String", # The number of licenses purchased.
"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
"license": "A String", # Any applicable license URI.
},
"mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
"A String",
],
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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).
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"reservations": [ # List of create-on-create reservations for 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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource.
"customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
},
"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
{ # Commitment for a particular resource (a Commitment is composed of one or more of these).
"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.
},
],
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"splitSourceCommitment": "A String", # Source commitment to be split into a new commitment.
"startTimestamp": "A String", # [Output Only] Commitment start 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"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. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
},
],
"warning": { # [Output Only] Informational warning which replaces the list of commitments when the list is empty.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
},
},
"kind": "compute#commitmentAggregatedList", # [Output Only] Type of resource. Always compute#commitmentAggregatedList for aggregated lists of commitments.
"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.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"unreachables": [ # [Output Only] Unreachable resources.
"A String",
],
"warning": { # [Output Only] Informational warning message.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}
aggregatedList_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
close()
Close httplib2 connections.
get(project, region, commitment, x__xgafv=None)
Returns the specified commitment resource.
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 to return. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # 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.
"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
"existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
"A String",
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
"amount": "A String", # The number of licenses purchased.
"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
"license": "A String", # Any applicable license URI.
},
"mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
"A String",
],
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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).
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"reservations": [ # List of create-on-create reservations for 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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource.
"customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
},
"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
{ # Commitment for a particular resource (a Commitment is composed of one or more of these).
"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.
},
],
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"splitSourceCommitment": "A String", # Source commitment to be split into a new commitment.
"startTimestamp": "A String", # [Output Only] Commitment start 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"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. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
}
insert(project, region, body=None, requestId=None, x__xgafv=None)
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.
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.
"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
"existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
"A String",
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
"amount": "A String", # The number of licenses purchased.
"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
"license": "A String", # Any applicable license URI.
},
"mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
"A String",
],
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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).
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"reservations": [ # List of create-on-create reservations for 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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource.
"customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
},
"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
{ # Commitment for a particular resource (a Commitment is composed of one or more of these).
"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.
},
],
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"splitSourceCommitment": "A String", # Source commitment to be split into a new commitment.
"startTimestamp": "A String", # [Output Only] Commitment start 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"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. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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 `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
"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.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"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.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `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.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"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.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"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.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"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 disk that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}
list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Retrieves a list of commitments contained within the specified region.
Args:
project: string, Project ID for this request. (required)
region: string, Name of the region for this request. (required)
filter: string, A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.
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`)
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.
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. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Contains a list of Commitment resources.
"id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
"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.
"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
"existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
"A String",
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
"amount": "A String", # The number of licenses purchased.
"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
"license": "A String", # Any applicable license URI.
},
"mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
"A String",
],
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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).
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"reservations": [ # List of create-on-create reservations for 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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource.
"customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
},
"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
{ # Commitment for a particular resource (a Commitment is composed of one or more of these).
"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.
},
],
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"splitSourceCommitment": "A String", # Source commitment to be split into a new commitment.
"startTimestamp": "A String", # [Output Only] Commitment start 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"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. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
},
],
"kind": "compute#commitmentList", # [Output Only] Type of resource. Always compute#commitmentList for lists of commitments.
"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.
"selfLink": "A String", # [Output Only] Server-defined URL for this resource.
"warning": { # [Output Only] Informational warning message.
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
}
list_next()
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
testIamPermissions(project, region, resource, body=None, x__xgafv=None)
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.
The object takes the form of:
{
"permissions": [ # The set of permissions to check for the 'resource'. Permissions with wildcards (such as '*' or 'storage.*') are not allowed.
"A String",
],
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
"A String",
],
}
update(project, region, commitment, body=None, paths=None, requestId=None, updateMask=None, x__xgafv=None)
Updates the specified commitment with the data included in the request. Update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: auto_renew.
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 for which auto renew is being updated. (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.
"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
"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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format.
"existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation
"A String",
],
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"kind": "compute#commitment", # [Output Only] Type of the resource. Always compute#commitment for commitments.
"licenseResource": { # Commitment for a particular license resource. # The license specification required as part of a license commitment.
"amount": "A String", # The number of licenses purchased.
"coresPerLicense": "A String", # Specifies the core range of the instance for which this license applies.
"license": "A String", # Any applicable license URI.
},
"mergeSourceCommitments": [ # List of source commitments to be merged into a new commitment.
"A String",
],
"name": "A String", # Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
"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).
"region": "A String", # [Output Only] URL of the region where this commitment may be used.
"reservations": [ # List of create-on-create reservations for 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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Commitment resource.
"customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
},
"resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
{ # Commitment for a particular resource (a Commitment is composed of one or more of these).
"acceleratorType": "A String", # Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
"amount": "A String", # The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU.
"type": "A String", # Type of resource for which this commitment applies. Possible values are VCPU, MEMORY, LOCAL_SSD, and ACCELERATOR.
},
],
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"splitSourceCommitment": "A String", # Source commitment to be split into a new commitment.
"startTimestamp": "A String", # [Output Only] Commitment start 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.
"statusMessage": "A String", # [Output Only] An optional, human-readable explanation of the status.
"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. Type ACCELERATOR_OPTIMIZED specifies a commitment that will only apply to accelerator optimized machines.
}
paths: string, A parameter (repeated)
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).
updateMask: string, update_mask indicates fields to be updated as part of this request.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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 `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
"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.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"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.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `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.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"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.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"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.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"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 disk that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}
updateReservations(project, region, commitment, body=None, requestId=None, x__xgafv=None)
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 for which the reservation is being updated. (required)
body: object, The request body.
The object takes the form of:
{
"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.
"aggregateReservation": { # This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. # Reservation for aggregated resources, providing shape flexibility.
"inUseResources": [ # [Output only] List of resources currently in use.
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"reservedResources": [ # List of reserved resources (CPUs, memory, accelerators).
{
"accelerator": { # Properties of accelerator resources in this reservation.
"acceleratorCount": 42, # Number of accelerators of specified type.
"acceleratorType": "A String", # Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
},
},
],
"vmFamily": "A String", # The VM family that all instances scheduled against this reservation must belong to.
"workloadType": "A String", # The workload type of the instances that will target 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.
"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
"deleteAfterDuration": { # 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. # Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
"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.
"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
},
"deleteAtTime": "A String", # Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
"deploymentType": "A String", # Specifies the deployment strategy for this reservation.
"description": "A String", # An optional description of this resource. Provide this property when you create the resource.
"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
"instanceTerminationAction": "A String", # Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
"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.
"reservationSharingPolicy": { # Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
"serviceShareType": "A String", # Sharing config for all Google Cloud services.
},
"resourcePolicies": { # Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
"a_key": "A String",
},
"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource.
"reservationBlockCount": 42, # The number of reservation blocks associated with this reservation.
"reservationMaintenance": { # Maintenance Info for ReservationBlocks. # Maintenance information for this reservation
"enableOpportunisticMaintenance": True or False, # This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
"maintenanceOngoingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
"maintenancePendingCount": 42, # Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
"schedulingType": "A String", # The type of maintenance for the reservation.
"upcomingGroupMaintenance": { # Upcoming Maintenance notification information. # Maintenance information on this group of VMs.
"canReschedule": True or False, # Indicates if the maintenance can be customer triggered.
"latestWindowStartTime": "A String", # The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
"maintenanceStatus": "A String",
"type": "A String", # Defines the type of maintenance.
"windowEndTime": "A String", # The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
"windowStartTime": "A String", # The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
},
},
"specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation.
"sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties.
"utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name.
"a_key": "A String",
},
},
},
"satisfiesPzs": True or False, # [Output Only] Reserved for future use.
"selfLink": "A String", # [Output Only] Server-defined fully-qualified URL for this resource.
"shareSettings": { # The share setting for reservations and sole tenancy node groups. # Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
"projectMap": { # A map of project id and project config. This is only valid when share_type's value is SPECIFIC_PROJECTS.
"a_key": { # Config for each project in the share settings.
"projectId": "A String", # The project ID, should be same as the key of this project config in the parent map.
},
},
"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.
"A String",
],
"shareType": "A String", # Type of sharing for this shared-reservation
},
"specificReservation": { # This reservation type allows to pre allocate specific instance configuration. # Reservation for instances with specific machine shapes.
"assuredCount": "A String", # [Output Only] Indicates how many instances are actually usable currently.
"count": "A String", # Specifies the number of resources that are allocated.
"inUseCount": "A String", # [Output Only] Indicates how many instances are in use.
"instanceProperties": { # Properties of the SKU instances being reserved. Next ID: 9 # The instance properties for the reservation.
"guestAccelerators": [ # Specifies accelerator type and count.
{ # A specification of the type and number of accelerator cards attached to the instance.
"acceleratorCount": 42, # The number of the guest accelerator cards exposed to this instance.
"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.
},
],
"localSsds": [ # Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
{
"diskSizeGb": "A String", # Specifies the size of the disk in base-2 GB.
"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.
},
],
"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.
"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.
"maintenanceFreezeDurationHours": 42, # Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
"minCpuPlatform": "A String", # Minimum cpu platform the reservation.
},
"sourceInstanceTemplate": "A String", # Specifies the instance template to create the reservation. If you use this field, you must exclude the instanceProperties field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: - https://www.googleapis.com/compute/v1/projects/project /global/instanceTemplates/instanceTemplate - projects/project/global/instanceTemplates/instanceTemplate - global/instanceTemplates/instanceTemplate
},
"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.
"status": "A String", # [Output Only] The status of the reservation. - CREATING: Reservation resources are being allocated. - READY: Reservation resources have been allocated, and the reservation is ready for use. - DELETING: Reservation deletion is in progress. - UPDATING: Reservation update is in progress.
"zone": "A String", # Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
},
],
}
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/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 `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
"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.
"description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
"endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
"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.
{
"code": "A String", # [Output Only] The error type identifier for this error.
"errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
{
"errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
"domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
"metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
"a_key": "A String",
},
"reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
},
"help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
"links": [ # URL(s) pointing to additional information on handling the current error.
{ # Describes a URL link.
"description": "A String", # Describes what the link offers.
"url": "A String", # The URL of the link.
},
],
},
"localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
"locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
"message": "A String", # The localized error message in the above locale.
},
"quotaInfo": { # Additional details for quota exceeded error for resource quota.
"dimensions": { # The map holding related quota dimensions.
"a_key": "A String",
},
"futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
"limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
"limitName": "A String", # The name of the quota limit.
"metricName": "A String", # The Compute Engine quota metric name.
"rolloutStatus": "A String", # Rollout status of the future quota limit.
},
},
],
"location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
"message": "A String", # [Output Only] An optional, human-readable error message.
},
],
},
"httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `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.
"id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
"insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
"instancesBulkInsertOperationMetadata": {
"perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
"deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
"failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
"status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
"targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
},
},
},
"kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
"name": "A String", # [Output Only] Name of the operation.
"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.
"operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
"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.
"region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
"selfLink": "A String", # [Output Only] Server-defined URL for the resource.
"setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
"clientOperationId": "A String", # [Output Only] The client operation id.
"perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
"a_key": {
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
},
},
},
"startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
"status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
"statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
"targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
"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 disk that the snapshot was created from.
"user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
"warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
{
"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.
"data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
{
"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).
"value": "A String", # [Output Only] A warning data value corresponding to the key.
},
],
"message": "A String", # [Output Only] A human-readable description of the warning code.
},
],
"zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
}