Package google.cloud.advisorynotifications.v1

Stay organized with collections Save and categorize content based on your preferences.

Index

AdvisoryNotificationsService

Service to manage Security and Privacy Notifications.

GetNotification

rpc GetNotification(GetNotificationRequest) returns (Notification)

Gets a notification.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • advisorynotifications.notifications.get

For more information, see the IAM documentation.

ListNotifications

rpc ListNotifications(ListNotificationsRequest) returns (ListNotificationsResponse)

Lists notifications under a given parent.

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • advisorynotifications.notifications.list

For more information, see the IAM documentation.

Attachment

Attachment with specific information about the issue.

Fields
display_name

string

The title of the attachment.

Union field data. Data type of the attachment. data can be only one of the following:
csv

Csv

A CSV file attachment. Max size is 10 MB.

Csv

A representation of a CSV file attachment, as a list of column headers and a list of data rows.

Fields
headers[]

string

The list of headers for data columns in a CSV file.

data_rows[]

CsvRow

The list of data rows in a CSV file, as string arrays rather than as a single comma-separated string.

CsvRow

A representation of a single data row in a CSV file.

Fields
entries[]

string

The data entries in a CSV file row, as a string array rather than a single comma-separated string.

GetNotificationRequest

Request for fetching a notification.

Fields
name

string

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

language_code

string

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.

ListNotificationsRequest

Request for fetching all notifications for a given parent.

Fields
parent

string

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

page_size

int32

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.

page_token

string

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.

view

NotificationView

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

language_code

string

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.

ListNotificationsResponse

Response of ListNotifications endpoint.

Fields
notifications[]

Notification

List of notifications under a given parent.

next_page_token

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.

total_size

int32

Estimation of a total number of notifications.

LocalizationState

Status of localized text.

Enums
LOCALIZATION_STATE_UNSPECIFIED Not used.
LOCALIZATION_STATE_NOT_APPLICABLE Localization is not applicable for requested language. This can happen when:
- The requested language was not supported by Advisory Notifications at the time of localization (including notifications created before the localization feature was launched).
- The requested language is English, so only the English text is returned.
LOCALIZATION_STATE_PENDING Localization for requested language is in progress, and not ready yet.
LOCALIZATION_STATE_COMPLETED Localization for requested language is completed.

Message

A message which contains notification details.

Fields
body

Body

The message content.

attachments[]

Attachment

The attachments to download.

create_time

Timestamp

The Message creation timestamp.

localization_time

Timestamp

Time when Message was localized

Body

A message body containing text.

Fields
text

Text

The text content of the message body.

Notification

A notification object for notifying customers about security and privacy issues.

Fields
name

string

The resource name of the notification. Format: organizations/{organization}/locations/{location}/notifications/{notification}.

subject

Subject

The subject line of the notification.

messages[]

Message

A list of messages in the notification.

create_time

Timestamp

Output only. Time the notification was created.

NotificationView

Notification view.

Enums
NOTIFICATION_VIEW_UNSPECIFIED Not specified, equivalent to BASIC.
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.
FULL Include everything.

Subject

A subject line of a notification.

Fields
text

Text

The text content.

Text

A text object containing the English text and its localized copies.

Fields
en_text

string

The English copy.

localized_text

string

The requested localized copy (if applicable).

localization_state

LocalizationState

Status of the localization.