Reference documentation and code samples for the Google Apps Events Subscriptions V1beta Client class PayloadOptions.
Options about what data to include in the event payload. Only supported for Google Chat events.
Generated from protobuf message google.apps.events.subscriptions.v1beta.PayloadOptions
Namespace
Google \ Apps \ Events \ Subscriptions \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ include_resource
bool
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
resource. If false, the event payload only includes the name of the changed resource.
↳ field_mask
Google\Protobuf\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.
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
resource. If false, the event payload only includes the name of the changed
resource.
bool
setIncludeResource
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
resource. If false, the event payload only includes the name of the changed
resource.
var
bool
$this
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.
hasFieldMask
clearFieldMask
setFieldMask
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.
$this
