Package com.google.apps.events.subscriptions.v1beta

Interface PayloadOptionsOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
PayloadOptions, PayloadOptions.Builder
@Generated public interface PayloadOptionsOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.FieldMask
    getFieldMask()
    Optional.
    com.google.protobuf.FieldMaskOrBuilder
    getFieldMaskOrBuilder()
    Optional.
    boolean
    getIncludeResource()
    Optional.
    boolean
    hasFieldMask()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getIncludeResource

      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`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages)
 resource. If false, the event payload only includes the name of the changed
 resource.
      bool include_resource = 1 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The includeResource.

    • hasFieldMask

      boolean hasFieldMask()
       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:
      Whether the fieldMask field is set.

    • getFieldMask

      com.google.protobuf.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:
      The fieldMask.

    • getFieldMaskOrBuilder

      com.google.protobuf.FieldMaskOrBuilder getFieldMaskOrBuilder()
       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];