Class PayloadOptions
Options about what data to include in the event payload. Only supported for Google Chat events.
Implements
Namespace: Google.Apps.Events.Subscriptions.V1
Assembly: Google.Apps.Events.Subscriptions.V1.dll
Syntax
public sealed class PayloadOptions : IMessage<PayloadOptions>, IEquatable<PayloadOptions>, IDeepCloneable<PayloadOptions>, IBufferMessage, IMessage
Constructors
PayloadOptions()
Declaration
public PayloadOptions()
PayloadOptions(PayloadOptions)
Declaration
public PayloadOptions(PayloadOptions other)
Parameters
| Type | Name | Description |
|---|---|---|
| PayloadOptions | other |
Properties
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.
Declaration
public FieldMask FieldMask { get; set; }
Property Value
| Type | Description |
|---|---|
| FieldMask |
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
resource. If false, the event payload only includes the name of the changed
resource.
Declaration
public bool IncludeResource { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |