upgrades

Creates, updates, deletes, gets or lists a upgrades resource.

Overview

Name	upgrades
Type	Resource
Id	google.vmwareengine.upgrades

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the private cloud Upgrade. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade
componentUpgrades	array	Output only. Output Only. The list of component upgrades.
createTime	string (google-datetime)	Output only. Output Only. Creation time of this resource.
description	string	Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
endTime	string (google-datetime)	Output only. Output Only. End time of the upgrade.
estimatedDuration	string (google-duration)	Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
etag	string	The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
schedule	object	Schedule details for the upgrade. (id: Schedule)
startVersion	string	Output only. Output Only. The start version
state	string	Output only. The current state of the upgrade. (STATE_UNSPECIFIED, SCHEDULED, ONGOING, SUCCEEDED, PAUSED, FAILED, CANCELLING, CANCELLED, RESCHEDULING)
targetVersion	string	Output only. Output Only. The target version
type	string	Output only. Output Only. The type of upgrade. (TYPE_UNSPECIFIED, VSPHERE_UPGRADE, VSPHERE_PATCH, WORKAROUND, FIRMWARE_UPGRADE, SWITCH_UPGRADE, OTHER, INFRASTRUCTURE_UPGRADE)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Output Only. Last update time of this resource.
version	string	Output only.

list

Name	Datatype	Description
name	string	Output only. Identifier. The resource name of the private cloud Upgrade. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: projects/my-project/locations/us-west1-a/privateClouds/my-cloud/upgrades/my-upgrade
componentUpgrades	array	Output only. Output Only. The list of component upgrades.
createTime	string (google-datetime)	Output only. Output Only. Creation time of this resource.
description	string	Output only. Output Only. The description of the upgrade. This is used to provide additional information about the private cloud upgrade, such as the upgrade's purpose, the changes included in the upgrade, or any other relevant information about the upgrade.
endTime	string (google-datetime)	Output only. Output Only. End time of the upgrade.
estimatedDuration	string (google-duration)	Output only. Output Only. The estimated total duration of the upgrade. This information can be used to plan or schedule upgrades to minimize disruptions. Please note that the estimated duration is only an estimate. The actual upgrade duration may vary.
etag	string	The etag for the upgrade resource. If this is provided on update, it must match the server's etag.
schedule	object	Schedule details for the upgrade. (id: Schedule)
startVersion	string	Output only. Output Only. The start version
state	string	Output only. The current state of the upgrade. (STATE_UNSPECIFIED, SCHEDULED, ONGOING, SUCCEEDED, PAUSED, FAILED, CANCELLING, CANCELLED, RESCHEDULING)
targetVersion	string	Output only. Output Only. The target version
type	string	Output only. Output Only. The type of upgrade. (TYPE_UNSPECIFIED, VSPHERE_UPGRADE, VSPHERE_PATCH, WORKAROUND, FIRMWARE_UPGRADE, SWITCH_UPGRADE, OTHER, INFRASTRUCTURE_UPGRADE)
uid	string	Output only. System-generated unique identifier for the resource.
updateTime	string (google-datetime)	Output only. Output Only. Last update time of this resource.
version	string	Output only.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, privateCloudsId, upgradesId		Retrieves a private cloud Upgrade resource by its resource name.
list	select	projectsId, locationsId, privateCloudsId	filter, orderBy, pageSize, pageToken	Lists past, ongoing and upcoming Upgrades for the given private cloud.
patch	update	projectsId, locationsId, privateCloudsId, upgradesId	requestId, updateMask	Update the private cloud Upgrade resource. Only schedule field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in update_mask are considered.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
privateCloudsId	string
projectsId	string
upgradesId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string
requestId	string
updateMask	string (google-fieldmask)

SELECT examples

get

Retrieves a private cloud Upgrade resource by its resource name.

SELECT
name,
componentUpgrades,
createTime,
description,
endTime,
estimatedDuration,
etag,
schedule,
startVersion,
state,
targetVersion,
type,
uid,
updateTime,
version
FROM google.vmwareengine.upgrades
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND upgradesId = '{{ upgradesId }}' -- required
;

list

Lists past, ongoing and upcoming Upgrades for the given private cloud.

SELECT
name,
componentUpgrades,
createTime,
description,
endTime,
estimatedDuration,
etag,
schedule,
startVersion,
state,
targetVersion,
type,
uid,
updateTime,
version
FROM google.vmwareengine.upgrades
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND privateCloudsId = '{{ privateCloudsId }}' -- required
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;

UPDATE examples

patch

Update the private cloud Upgrade resource. Only schedule field can updated. The schedule can only be updated when the upgrade has not started and schedule edit window is open. Only fields specified in update_mask are considered.

UPDATE google.vmwareengine.upgrades
SET 
data__etag = '{{ etag }}',
data__schedule = '{{ schedule }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND privateCloudsId = '{{ privateCloudsId }}' --required
AND upgradesId = '{{ upgradesId }}' --required
AND requestId = '{{ requestId}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;