Class: Google::Apps::Events::Subscriptions::V1::PayloadOptions

Inherits:

Object

Object
Google::Apps::Events::Subscriptions::V1::PayloadOptions

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/apps/events/subscriptions/v1/subscription_resource.rb

Overview

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

Instance Attribute Summary collapse

#field_mask ⇒ ::Google::Protobuf::FieldMask
Optional.
#include_resource ⇒ ::Boolean
Optional.

Instance Attribute Details

#field_mask ⇒ `::Google::Protobuf::FieldMask`

Returns 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:

(::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.

# File 'proto_docs/google/apps/events/subscriptions/v1/subscription_resource.rb', line 196

class PayloadOptions
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_resource ⇒ `::Boolean`

Returns 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.