Method: announcements.list

Full name: projects.locations.instances.announcements.list

List page of Announcements.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list Announcements for. Format: projects/{project}/locations/{location}/instances/{instance}/announcements

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of Announcements to return. The service may return fewer than this value.
pageToken

string

Optional. A page token, received from a previous announcements.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to announcements.list must match the call that provided the page token.
filter

string

Optional. Filter to be applied over multiple Announcement fields. Only the following filters are allowed:
orderBy

string

Optional. Configures ordering of Announcements in the response. If not specified, Announcements are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. For example: "createTime desc, updateTime" Supported fields: * order * displayName

Request body

The request body must be empty.

Response body

Response message for announcements.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
announcements[]

object (Announcement)

The list of Announcements.
nextPageToken

string

A page token, received from a previous announcements.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to announcements.list must match the call that provided the page token.
totalSize

integer

Total number of Announcements.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.