GoogleApi.Gmail.V1.Model.WatchRequest (google_api_gmail v0.17.0)

View Source

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

Attributes

  • labelFilterAction (type: String.t, default: nil) - Filtering behavior of labelIds list specified. This field is deprecated because it caused incorrect behavior in some cases; use label_filter_behavior instead.
  • labelFilterBehavior (type: String.t, default: nil) - Filtering behavior of labelIds list specified. This field replaces label_filter_action; if set, label_filter_action is ignored.
  • labelIds (type: list(String.t), default: nil) - 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.
  • topicName (type: String.t, default: nil) - 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).

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Gmail.V1.Model.WatchRequest{
  labelFilterAction: String.t() | nil,
  labelFilterBehavior: String.t() | nil,
  labelIds: [String.t()] | nil,
  topicName: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.