Advisory Notifications API (advisorynotifications:v1)

2023-01-24

2 new methods | New API

Additions

    Methods

  • ▼ ▲ advisorynotifications.organizations.locations.notifications.get

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/notifications/{notificationsId}

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

      Description: Gets a notification.

      Parameters:

        name

          Type: string

          Description: Required. A name of the notification to retrieve. Format: organizations/{organization}/locations/{location}/notifications/{notification}.

          Pattern: ^organizations/[^/]+/locations/[^/]+/notifications/[^/]+$

          Required: Yes

          Location: path

        languageCode

          Location: query

          Description: ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

          Type: string

      Path: v1/{+name}

      Parameter Order: name

      HTTP Method: GET

  • ▼ ▲ advisorynotifications.organizations.locations.notifications.list

      Path: v1/{+parent}/notifications

      Parameter Order: parent

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

      Description: Lists notifications under a given parent.

      Parameters:

        view

          Enum:

        • NOTIFICATION_VIEW_UNSPECIFIED
        • BASIC
        • FULL

          • Enum Descriptions:

        • Not specified, equivalent to BASIC.
        • Server responses only include title, creation time and Notification ID. Note: for internal use responses also include the last update time, the latest message text and whether notification has attachments.
        • Include everything.

          • Description: Specifies which parts of the notification resource should be returned in the response.

          Location: query

          Type: string

        parent

          Type: string

          Pattern: ^organizations/[^/]+/locations/[^/]+$

          Description: Required. The parent, which owns this collection of notifications. Must be of the form "organizations/{organization}/locations/{location}".

          Location: path

          Required: Yes

        languageCode

          Description: ISO code for requested localization language. If unset, will be interpereted as "en". If the requested language is valid, but not supported for this notification, English will be returned with an "Not applicable" LocalizationState. If the ISO code is invalid (i.e. not a real language), this RPC will throw an error.

          Type: string

          Location: query

        pageToken

          Location: query

          Description: A page token returned from a previous request. When paginating, all other parameters provided in the request must match the call that returned the page token.

          Type: string

        pageSize

          Description: The maximum number of notifications to return. The service may return fewer than this value. If unspecified or equal to 0, at most 50 notifications will be returned. The maximum value is 50; values above 50 will be coerced to 50.

          Format: int32

          Type: integer

          Location: query

      Flat Path: v1/organizations/{organizationsId}/locations/{locationsId}/notifications

      HTTP Method: GET