Class: Google::Apis::WorkspaceeventsV1::PayloadOptions

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/workspaceevents_v1/classes.rb,
lib/google/apis/workspaceevents_v1/representations.rb,
lib/google/apis/workspaceevents_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ PayloadOptions

Returns a new instance of PayloadOptions.



162
163
164
 
# File 'lib/google/apis/workspaceevents_v1/classes.rb', line 162

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#field_mask ⇒ String

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. Corresponds to the JSON property fieldMask

Returns:

  • (String) 


150
151
152
 
# File 'lib/google/apis/workspaceevents_v1/classes.rb', line 150

def field_mask
  @field_mask
end

#include_resource ⇒ Boolean Also known as: include_resource?

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. Corresponds to the JSON property includeResource

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/google/apis/workspaceevents_v1/classes.rb', line 159

def include_resource
  @include_resource
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



167
168
169
170
 
# File 'lib/google/apis/workspaceevents_v1/classes.rb', line 167

def update!(**args)
  @field_mask = args[:field_mask] if args.key?(:field_mask)
  @include_resource = args[:include_resource] if args.key?(:include_resource)
end