region_commitments

Overview

Name	region_commitments
Type	Resource
Id	google.compute.region_commitments

Fields

Name	Datatype	Description
id	string	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	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.
description	string	An optional description of this resource. Provide this property when you create the resource.
autoRenew	boolean	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.
type	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.
status	string	[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED.
plan	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	string	[Output Only] URL of the region where this commitment may be used.
category	string	The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified.
selfLink	string	[Output Only] Server-defined URL for the resource.
splitSourceCommitment	string	Source commitment to be split into a new commitment.
statusMessage	string	[Output Only] An optional, human-readable explanation of the status.
endTimestamp	string	[Output Only] Commitment end time in RFC3339 text format.
licenseResource	object	Commitment for a particular license resource.
kind	string	[Output Only] Type of the resource. Always compute#commitment for commitments.
startTimestamp	string	[Output Only] Commitment start time in RFC3339 text format.
reservations	array	List of reservations in this commitment.
resources	array	A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together.
mergeSourceCommitments	array	List of source commitments to be merged into a new commitment.
creationTimestamp	string	[Output Only] Creation timestamp in RFC3339 text format.

Methods

Name	Accessible by	Required Params	Description
aggregated_list	SELECT	project	Retrieves an aggregated list of commitments by region.
get	SELECT	commitment, project, region	Returns the specified commitment resource.
list	SELECT	project, region	Retrieves a list of commitments contained within the specified region.
insert	INSERT	project, region	Creates a commitment in the specified project using the data included in the request.
_aggregated_list	EXEC	project	Retrieves an aggregated list of commitments by region.
update	EXEC	commitment, project, region	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.