announcements

Creates, updates, deletes, gets or lists an announcements resource.

Overview

Name	announcements
Type	Resource
Id	google.vmwareengine.announcements

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the announcement. 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/announcements/my-announcement-id
activityType	string	Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
cluster	string	A Cluster resource name.
code	string	Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the description field.
createTime	string (google-datetime)	Output only. Creation time of this resource. It also serves as start time of notification.
description	string	Output only. Description of the announcement.
metadata	object	Output only. Additional structured details about this announcement.
privateCloud	string	A Private Cloud resource name.
state	string	Output only. State of the resource. New values may be added to this enum when appropriate.
targetResourceType	string	Output only. Target Resource Type defines the type of the target for the announcement
updateTime	string (google-datetime)	Output only. Last update time of this resource.

list

Successful response

Name	Datatype	Description
name	string	Output only. The resource name of the announcement. 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/announcements/my-announcement-id
activityType	string	Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
cluster	string	A Cluster resource name.
code	string	Required. Code of the announcement. Indicates the presence of a VMware Engine related announcement and corresponds to a related message in the description field.
createTime	string (google-datetime)	Output only. Creation time of this resource. It also serves as start time of notification.
description	string	Output only. Description of the announcement.
metadata	object	Output only. Additional structured details about this announcement.
privateCloud	string	A Private Cloud resource name.
state	string	Output only. State of the resource. New values may be added to this enum when appropriate.
targetResourceType	string	Output only. Target Resource Type defines the type of the target for the announcement
updateTime	string (google-datetime)	Output only. Last update time of this resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, announcementsId		Retrieves a Announcement by its resource name.
list	select	projectsId, locationsId	pageSize, pageToken, filter, orderBy	Lists Announcements for a given region and project

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
announcementsId	string
locationsId	string
projectsId	string
filter	string
orderBy	string
pageSize	integer (int32)
pageToken	string

SELECT examples

get

Retrieves a Announcement by its resource name.

SELECT
name,
activityType,
cluster,
code,
createTime,
description,
metadata,
privateCloud,
state,
targetResourceType,
updateTime
FROM google.vmwareengine.announcements
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND announcementsId = '{{ announcementsId }}' -- required;

list

Lists Announcements for a given region and project

SELECT
name,
activityType,
cluster,
code,
createTime,
description,
metadata,
privateCloud,
state,
targetResourceType,
updateTime
FROM google.vmwareengine.announcements
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND orderBy = '{{ orderBy }}';