Google Workspace Events V1 API - Class Google::Apps::Events::Subscriptions::V1::PayloadOptions (v0.1.0)

Reference documentation and code samples for the Google Workspace Events V1 API class Google::Apps::Events::Subscriptions::V1::PayloadOptions.

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

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#field_mask

def field_mask() -> ::Google::Protobuf::FieldMask
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.

#field_mask=

def field_mask=(value) -> ::Google::Protobuf::FieldMask
Parameter
  • value (::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.

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.

#include_resource

def include_resource() -> ::Boolean
Returns
  • (::Boolean) — 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.

#include_resource=

def include_resource=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.