PATCH /projects/{project}/regions/{region}/commitments/{commitment}

Specifies whether to automatically renew the commitment at the end of its current term. The default value is false. If you set the field to true, each time your commitment reaches the end of its term, Compute Engine automatically renews it for another term. You can update this field anytime before the commitment expires. For example, if the commitment is set to expire at 12 AM UTC-8 on January 3, 2027, you can update this field until 11:59 PM UTC-8 on January 2, 2027.

The category of the commitment; specifies whether the commitment is for hardware or software resources. Category MACHINE specifies that you are committing to hardware machine resources such asVCPU or MEMORY, listed in resources. Category LICENSE specifies that you are committing to software licenses, listed in licenseResources. Note that if you specify MACHINE commitments, then you must also specify a type to indicate the machine series of the hardware resource that you are committing to.

Output only. [Output Only] Creation timestamp inRFC3339 text format.

[Input Only] Optional, specifies the requested commitment end time inRFC3339 text format. Use this option when the desired commitment's end date is later than the start date + term duration.

An optional description of the commitment. You can provide this property when you create the resource.

Output only. [Output Only] Commitment end time inRFC3339 text format.

Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

Output only. [Output Only] Type of the resource. Always compute#commitment for commitments.

Name of the commitment. You must specify a name when you purchase the commitment. The name must be 1-63 characters long, and comply withRFC1035. 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.

The minimum time duration that you commit to purchasing resources. The plan that you choose determines the preset term length of the commitment (which is 1 year or 3 years) and affects the discount rate that you receive for your resources. Committing to a longer time duration typically gives you a higher discount rate. The supported values for this field are TWELVE_MONTH (1 year), andTHIRTY_SIX_MONTH (3 years).

Output only. [Output Only] URL of the region where the commitment and committed resources are located.

Output only. [Output Only] Server-defined URL for the resource.

The source commitment from which you are transferring resources to create the new split commitment. For more information, see Split commitments.

Output only. [Output Only] Commitment start time inRFC3339 text format.

Output only. [Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). Status can be one of the following values: NOT_YET_ACTIVE, ACTIVE, orEXPIRED.

Output only. [Output Only] An optional, human-readable explanation of the status.

The type of commitment; specifies the machine series for which you want to commit to purchasing resources. The choice of machine series affects the discount rate and the eligible resource types.

The type must be one of the following:ACCELERATOR_OPTIMIZED, ACCELERATOR_OPTIMIZED_A3,ACCELERATOR_OPTIMIZED_A3_MEGA,COMPUTE_OPTIMIZED, COMPUTE_OPTIMIZED_C2D, COMPUTE_OPTIMIZED_C3, COMPUTE_OPTIMIZED_C3D,COMPUTE_OPTIMIZED_H3, GENERAL_PURPOSE,GENERAL_PURPOSE_C4, GENERAL_PURPOSE_E2,GENERAL_PURPOSE_N2, GENERAL_PURPOSE_N2D,GENERAL_PURPOSE_N4, GENERAL_PURPOSE_T2D,GRAPHICS_OPTIMIZED, GRAPHICS_OPTIMIZED_G4,GRAPHICS_OPTIMIZED_G4_VGPU,MEMORY_OPTIMIZED, MEMORY_OPTIMIZED_M3,MEMORY_OPTIMIZED_X4, STORAGE_OPTIMIZED_Z3,STORAGE_OPTIMIZED_Z4DS, STORAGE_OPTIMIZED_Z4DH,STORAGE_OPTIMIZED_Z4D4T,STORAGE_OPTIMIZED_Z4M. For example, type MEMORY_OPTIMIZED specifies a commitment that applies only to eligible resources of memory optimized M1 and M2 machine series. Type GENERAL_PURPOSE specifies a commitment that applies only to eligible resources of general purpose N1 machine series.

[Output Only] The value of requestId if you provided it in the request. Not present otherwise.

[Deprecated] This field is deprecated.

[Output Only] A textual description of the operation, which is set when the operation is created.

[Output Only] The time that this operation was completed. This value is inRFC3339 text format.

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND.

[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.

[Output Only] The unique identifier for the operation. This identifier is defined by the server.

[Output Only] The time that this operation was requested. This value is inRFC3339 text format.

Output only. [Output Only] Type of the resource. Always compute#operation for Operation resources.

[Output Only] Name of the operation.

Output only. [Output Only] An ID that represents a group of operations, such as when a group of operations results from a bulkInsert API request.

[Output Only] The type of operation, such as insert, update, or delete, and so on.

[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.

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.

[Output Only] Server-defined URL for the resource.

[Output Only] The time that this operation was started by the server. This value is inRFC3339 text format.

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE.

[Output Only] An optional textual description of the current status of the operation.

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource.

[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.

[Output Only] User who requested the operation, for example: user@example.com or alice_smith_identifier (global/workforcePools/example-com-us-employees).

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.