Interface PayloadOptionsOrBuilder (0.1.0)

public interface PayloadOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFieldMask()

public abstract FieldMask 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.

.google.protobuf.FieldMask field_mask = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FieldMask`	The fieldMask.

getFieldMaskOrBuilder()

public abstract FieldMaskOrBuilder getFieldMaskOrBuilder()

If you specify a field that doesn't exist for the resource, the system ignores the field.

.google.protobuf.FieldMask field_mask = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`FieldMaskOrBuilder`

getIncludeResource()

public abstract boolean 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 include_resource = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	The includeResource.

hasFieldMask()

public abstract boolean hasFieldMask()

If you specify a field that doesn't exist for the resource, the system ignores the field.

.google.protobuf.FieldMask field_mask = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the fieldMask field is set.