com.google.api.services.homegraph.v1.model

Class ReportStateAndNotificationRequest

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.homegraph.v1.model.ReportStateAndNotificationRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Request type for the [`ReportStateAndNotification`](#google.home.graph.v1.HomeGraphApiService.Rep ortStateAndNotification) call. It may include states, notifications, or both. States and notifications are defined per `device_id` (for example, "123" and "456" in the following example). Example: ```json { "requestId": "ff36a3cc-ec34-11e6-b1a0-64510650abcf", "agentUserId": "1234", "payload": { "devices": { "states": { "123": { "on": true }, "456": { "on": true, "brightness": 10 }, }, } } } ```

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 HomeGraph 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
ReportStateAndNotificationRequest()

Method Summary

Modifier and Type	Method and Description
ReportStateAndNotificationRequest	clone()
String	getAgentUserId() Required.
String	getEventId() Unique identifier per event (for example, a doorbell press).
String	getFollowUpToken() Deprecated.
StateAndNotificationPayload	getPayload() Required.
String	getRequestId() Request ID used for debugging.
ReportStateAndNotificationRequest	set(String fieldName, Object value)
ReportStateAndNotificationRequest	setAgentUserId(String agentUserId) Required.
ReportStateAndNotificationRequest	setEventId(String eventId) Unique identifier per event (for example, a doorbell press).
ReportStateAndNotificationRequest	setFollowUpToken(String followUpToken) Deprecated.
ReportStateAndNotificationRequest	setPayload(StateAndNotificationPayload payload) Required.
ReportStateAndNotificationRequest	setRequestId(String requestId) Request ID used for debugging.

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

ReportStateAndNotificationRequest

public ReportStateAndNotificationRequest()

Method Detail

getAgentUserId

public String getAgentUserId()

Required. Third-party user ID.

Returns:

value or null for none

setAgentUserId

public ReportStateAndNotificationRequest setAgentUserId(String agentUserId)

Required. Third-party user ID.

Parameters:

agentUserId - agentUserId or null for none

getEventId

public String getEventId()

Unique identifier per event (for example, a doorbell press).

Returns:

value or null for none

setEventId

public ReportStateAndNotificationRequest setEventId(String eventId)

Unique identifier per event (for example, a doorbell press).

Parameters:

eventId - eventId or null for none

getFollowUpToken

public String getFollowUpToken()

Deprecated.

Returns:

value or null for none

setFollowUpToken

public ReportStateAndNotificationRequest setFollowUpToken(String followUpToken)

Deprecated.

Parameters:

followUpToken - followUpToken or null for none

getPayload

public StateAndNotificationPayload getPayload()

Required. State of devices to update and notification metadata for devices.

Returns:

value or null for none

setPayload

public ReportStateAndNotificationRequest setPayload(StateAndNotificationPayload payload)

Required. State of devices to update and notification metadata for devices.

Parameters:

payload - payload or null for none

getRequestId

public String getRequestId()

Request ID used for debugging.

Returns:

value or null for none

setRequestId

public ReportStateAndNotificationRequest setRequestId(String requestId)

Request ID used for debugging.

Parameters:

requestId - requestId or null for none

set

public ReportStateAndNotificationRequest set(String fieldName,
                                             Object value)

Overrides:

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

clone

public ReportStateAndNotificationRequest clone()

Overrides:

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