google_api_gmail v0.1.0 GoogleApi.Gmail.V1.Model.WatchRequest View Source

Set up or update a new push notification watch on this user's mailbox.

Attributes

  • labelFilterAction (String.t): Filtering behavior of labelIds list specified. Defaults to: null.

    • Enum - one of [exclude, include]
  • labelIds ([String.t]): List of label_ids to restrict notifications about. By default, if unspecified, all changes are pushed out. If specified then dictates which labels are required for a push notification to be generated. Defaults to: null.
  • topicName (String.t): A fully qualified Google Cloud Pub/Sub API topic name to publish the events to. This topic name must already exist in Cloud Pub/Sub and you must have already granted gmail "publish" permission on it. For example, "projects/my-project-identifier/topics/my-topic-name" (using the Cloud Pub/Sub "v1" topic naming format). Note that the "my-project-identifier" portion must exactly match your Google developer project id (the one executing this watch request). Defaults to: null.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source
t() :: %GoogleApi.Gmail.V1.Model.WatchRequest{
  labelFilterAction: any(),
  labelIds: [any()],
  topicName: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.