com.google.api.services.workspaceevents.v1.model

Class PayloadOptions

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.workspaceevents.v1.model.PayloadOptions

All Implemented Interfaces:

Cloneable, Map<String,Object>

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

Options about what data to include in the event payload. Only supported for Google Chat events.

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 Workspace Events 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
PayloadOptions()

Method Summary

Modifier and Type	Method and Description
PayloadOptions	clone()
String	getFieldMask() Optional.
Boolean	getIncludeResource() Optional.
PayloadOptions	set(String fieldName, Object value)
PayloadOptions	setFieldMask(String fieldMask) Optional.
PayloadOptions	setIncludeResource(Boolean includeResource) Optional.

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

PayloadOptions

public PayloadOptions()

Method Detail

getFieldMask

public String getFieldMask()

Optional. If `include_resource` is set to `true`, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, enter `message.sender,message.createTime`. If omitted, the payload includes all fields for the resource. If you specify a field that doesn't exist for the resource, the system ignores the field.

Returns:

value or null for none

setFieldMask

public PayloadOptions setFieldMask(String fieldMask)

Optional. If `include_resource` is set to `true`, the list of fields to include in the event payload. Separate fields with a comma. For example, to include a Google Chat message's sender and create time, enter `message.sender,message.createTime`. If omitted, the payload includes all fields for the resource. If you specify a field that doesn't exist for the resource, the system ignores the field.

Parameters:

fieldMask - fieldMask or null for none

getIncludeResource

public Boolean getIncludeResource()

Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource.

Returns:

value or null for none

setIncludeResource

public PayloadOptions setIncludeResource(Boolean includeResource)

Optional. Whether the event payload includes data about the resource that changed. For example, for an event where a Google Chat message was created, whether the payload contains data about the [`Message`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages) resource. If false, the event payload only includes the name of the changed resource.

Parameters:

includeResource - includeResource or null for none

set

public PayloadOptions set(String fieldName,
                          Object value)

Overrides:

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

clone

public PayloadOptions clone()

Overrides:

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