get(name, x__xgafv=None)

Retrieves a `Announcement` by its resource name.

Args:
  name: string, Required. The resource name of the announcement to retrieve. 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/announcement-uuid` (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Announcement for the resources of Vmware Engine.
  "activityType": "A String", # Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
  "cluster": "A String", # A Cluster resource name.
  "code": "A 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": "A String", # Output only. Creation time of this resource. It also serves as start time of notification.
  "description": "A String", # Output only. Description of the announcement.
  "metadata": { # Output only. Additional structured details about this announcement.
    "a_key": "A String",
  },
  "name": "A 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`
  "privateCloud": "A String", # A Private Cloud resource name.
  "state": "A String", # Output only. State of the resource. New values may be added to this enum when appropriate.
  "targetResourceType": "A String", # Output only. Target Resource Type defines the type of the target for the announcement
  "updateTime": "A String", # Output only. Last update time of this resource.
}

list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

Lists `Announcements` for a given region and project

Args:
  parent: string, Required. The resource name of the location to be queried for announcements. 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` (required)
  filter: string, A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of announcement runs, you can exclude the ones named `example-announcement` by specifying `name != "example-announcement"`. You can also filter nested fields. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-announcement") (createTime > "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "announcement-1") AND (createTime > "2021-04-12T08:15:10.40Z") OR (name = "announcement-2") ```
  orderBy: string, Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported.
  pageSize: integer, The maximum number of announcements to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.
  pageToken: string, A page token, received from a previous `ListAnnouncements` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAnnouncements` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response message for VmwareEngine.ListAnnouncements
  "announcements": [ # A list of announcement runs.
    { # Announcement for the resources of Vmware Engine.
      "activityType": "A String", # Optional. Activity type of the announcement There can be only one active announcement for a given activity type and target resource.
      "cluster": "A String", # A Cluster resource name.
      "code": "A 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": "A String", # Output only. Creation time of this resource. It also serves as start time of notification.
      "description": "A String", # Output only. Description of the announcement.
      "metadata": { # Output only. Additional structured details about this announcement.
        "a_key": "A String",
      },
      "name": "A 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`
      "privateCloud": "A String", # A Private Cloud resource name.
      "state": "A String", # Output only. State of the resource. New values may be added to this enum when appropriate.
      "targetResourceType": "A String", # Output only. Target Resource Type defines the type of the target for the announcement
      "updateTime": "A String", # Output only. Last update time of this resource.
    },
  ],
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "unreachable": [ # list of unreachable locations
    "A String",
  ],
}

VMware Engine API . projects . locations . announcements

Instance Methods

Method Details