com.google.api.services.forms.v1.model

Class Watch

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.forms.v1.model.Watch

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Watch
extends com.google.api.client.json.GenericJson

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

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Forms API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
Watch()

Method Summary

Modifier and Type	Method and Description
Watch	clone()
String	getCreateTime() Output only.
String	getErrorType() Output only.
String	getEventType() Required.
String	getExpireTime() Output only.
String	getId() Output only.
String	getState() Output only.
WatchTarget	getTarget() Required.
Watch	set(String fieldName, Object value)
Watch	setCreateTime(String createTime) Output only.
Watch	setErrorType(String errorType) Output only.
Watch	setEventType(String eventType) Required.
Watch	setExpireTime(String expireTime) Output only.
Watch	setId(String id) Output only.
Watch	setState(String state) Output only.
Watch	setTarget(WatchTarget target) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Watch

public Watch()

Method Detail

getCreateTime

public String getCreateTime()

Output only. Timestamp of when this was created.

Returns:

value or null for none

setCreateTime

public Watch setCreateTime(String createTime)

Output only. Timestamp of when this was created.

Parameters:

createTime - createTime or null for none

getErrorType

public String getErrorType()

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.

Returns:

value or null for none

setErrorType

public Watch setErrorType(String errorType)

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.

Parameters:

errorType - errorType or null for none

getEventType

public String getEventType()

Required. Which event type to watch for.

Returns:

value or null for none

setEventType

public Watch setEventType(String eventType)

Required. Which event type to watch for.

Parameters:

eventType - eventType or null for none

getExpireTime

public String getExpireTime()

Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.

Returns:

value or null for none

setExpireTime

public Watch setExpireTime(String expireTime)

Output only. Timestamp for when this will expire. Each watches.renew call resets this to seven days in the future.

Parameters:

expireTime - expireTime or null for none

getId

public String getId()

Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.

Returns:

value or null for none

setId

public Watch setId(String id)

Output only. The ID of this watch. See notes on CreateWatchRequest.watch_id.

Parameters:

id - id or null for none

getState

public String getState()

Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.

Returns:

value or null for none

setState

public Watch setState(String state)

Output only. The current state of the watch. Additional details about suspended watches can be found by checking the `error_type`.

Parameters:

state - state or null for none

getTarget

public WatchTarget getTarget()

Required. Where to send the notification.

Returns:

value or null for none

setTarget

public Watch setTarget(WatchTarget target)

Required. Where to send the notification.

Parameters:

target - target or null for none

set

public Watch set(String fieldName,
                 Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Watch clone()

Overrides:

clone in class com.google.api.client.json.GenericJson