Package Classes (0.3.9)

Summary of entries of Classes for advisorynotifications.

Classes

AdvisoryNotificationsServiceAsyncClient

Service to manage Security and Privacy Notifications.

AdvisoryNotificationsServiceClient

Service to manage Security and Privacy Notifications.

ListNotificationsAsyncPager

A pager for iterating through list_notifications requests.

This class thinly wraps an initial ListNotificationsResponse object, and provides an __aiter__ method to iterate through its notifications field.

If there are more pages, the __aiter__ method will make additional ListNotifications requests and continue to iterate through the notifications field on the corresponding responses.

All the usual ListNotificationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

ListNotificationsPager

A pager for iterating through list_notifications requests.

This class thinly wraps an initial ListNotificationsResponse object, and provides an __iter__ method to iterate through its notifications field.

If there are more pages, the __iter__ method will make additional ListNotifications requests and continue to iterate through the notifications field on the corresponding responses.

All the usual ListNotificationsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Attachment

Attachment with specific information about the issue.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Csv

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

CsvRow

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

GetNotificationRequest

Request for fetching a notification.

GetSettingsRequest

Request of GetSettings endpoint.

ListNotificationsRequest

Request for fetching all notifications for a given parent.

ListNotificationsResponse

Response of ListNotifications endpoint.

LocalizationState

Status of localized text.

    - 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 (2):
    Localization for requested language is in
    progress, and not ready yet.
LOCALIZATION_STATE_COMPLETED (3):
    Localization for requested language is
    completed.

Message

A message which contains notification details.

Body

A message body containing text.

Notification

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

NotificationSettings

Settings for each NotificationType.

NotificationType

Type of notification

NotificationView

Notification view.

Settings

Settings for Advisory Notifications.

NotificationSettingsEntry

The abstract base class for a message.

Subject

A subject line of a notification.

Text

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

UpdateSettingsRequest

Request of UpdateSettings endpoint.

Modules

pagers

API documentation for advisorynotifications_v1.services.advisory_notifications_service.pagers module.