Notifications

To try out the methods for this resource, see Methods.

Resource representations

A subscription to receive Pub/Sub notifications.

{
  "id": string,
  "topic": string,
  "event_types": [
    string
  ],
  "custom_attributes": {
    (key): string
  },
  "payload_format": string,
  "object_name_prefix": string,
  "etag": string,
  "selfLink": string,
  "kind": "storage#notification"
}
Property nameValueDescriptionNotes
custom_attributesobjectAn optional list of additional attributes to attach to each Pub/Sub message published for this notification subscription.writable
custom_attributes.(key)string
etagstringHTTP 1.1 Entity tag for this subscription notification.
event_types[]listIf present, only send notifications about listed event types. If empty, send notifications for all event types.writable
idstringThe ID of the notification.
kindstringThe kind of item this is. For notifications, this is always "storage#notification".
object_name_prefixstringIf present, only apply this notification configuration to object names that begin with this prefix.writable
payload_formatstringThe desired content of the Payload.

Acceptable values are:
  • "JSON_API_V1"
  • "NONE"
writable
topicstringThe Pub/Sub topic to which this subscription publishes. Formatted as: "//pubsub.googleapis.com/projects/PROJECT-IDENTIFIER/topics/TOPIC-NAME"writable

Methods

delete
Permanently deletes a notification subscription.
get
View a notification configuration.
insert
Creates a notification subscription for a given bucket.
list
Retrieves a list of notification subscriptions for a given bucket.