View Source GoogleApi.Forms.V1.Model.Watch (google_api_forms v0.2.1)
A watch for events for a form. When the designated event happens, a notification will be published to the specified target. The notification's attributes will include a formId
key that has the ID of the watched form and an eventType
key that has the string of the type. Messages are sent with at-least-once delivery and are only dropped in extraordinary circumstances. Typically all notifications should be reliably delivered within a few seconds; however, in some situations notifications may be delayed. A watch expires seven days after it is created unless it is renewed with watches.renew
Attributes
-
createTime
(type:DateTime.t
, default:nil
) - Output only. Timestamp of when this was created. -
errorType
(type:String.t
, default:nil
) - Output only. The most recent error type for an attempted delivery. To begin watching the form again a call can be made to watches.renew which also clears this error information. -
eventType
(type:String.t
, default:nil
) - Required. Which event type to watch for. -
expireTime
(type:DateTime.t
, default:nil
) - Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future. -
id
(type:String.t
, default:nil
) - Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id. -
state
(type:String.t
, default:nil
) - Output only. The current state of the watch. Additional details about suspended watches can be found by checking theerror_type
. -
target
(type:GoogleApi.Forms.V1.Model.WatchTarget.t
, default:nil
) - Required. Where to send the notification.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.Forms.V1.Model.Watch{ createTime: DateTime.t() | nil, errorType: String.t() | nil, eventType: String.t() | nil, expireTime: DateTime.t() | nil, id: String.t() | nil, state: String.t() | nil, target: GoogleApi.Forms.V1.Model.WatchTarget.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.