Class PayloadOptions.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder>
com.google.apps.events.subscriptions.v1beta.PayloadOptions.Builder
All Implemented Interfaces:
PayloadOptionsOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
PayloadOptions

public static final class PayloadOptions.Builder extends com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder> implements PayloadOptionsOrBuilder
 Options about what data to include in the event payload. Only supported for
 Google Chat events.
 
Protobuf type google.apps.events.subscriptions.v1beta.PayloadOptions
  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder>
    • clear

      public PayloadOptions.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder>
    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder>
    • getDefaultInstanceForType

      public PayloadOptions getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
    • build

      public PayloadOptions build()
      Specified by:
      build in interface com.google.protobuf.Message.Builder
      Specified by:
      build in interface com.google.protobuf.MessageLite.Builder
    • buildPartial

      public PayloadOptions buildPartial()
      Specified by:
      buildPartial in interface com.google.protobuf.Message.Builder
      Specified by:
      buildPartial in interface com.google.protobuf.MessageLite.Builder
    • mergeFrom

      public PayloadOptions.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PayloadOptions.Builder>
    • mergeFrom

      public PayloadOptions.Builder mergeFrom(PayloadOptions other)
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<PayloadOptions.Builder>
    • mergeFrom

      public PayloadOptions.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<PayloadOptions.Builder>
      Throws:
      IOException
    • getIncludeResource

      public 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];
      Specified by:
      getIncludeResource in interface PayloadOptionsOrBuilder
      Returns:
      The includeResource.
    • setIncludeResource

      public PayloadOptions.Builder setIncludeResource(boolean value)
       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];
      Parameters:
      value - The includeResource to set.
      Returns:
      This builder for chaining.
    • clearIncludeResource

      public PayloadOptions.Builder clearIncludeResource()
       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:
      This builder for chaining.
    • hasFieldMask

      public 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];
      Specified by:
      hasFieldMask in interface PayloadOptionsOrBuilder
      Returns:
      Whether the fieldMask field is set.
    • getFieldMask

      public 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];
      Specified by:
      getFieldMask in interface PayloadOptionsOrBuilder
      Returns:
      The fieldMask.
    • setFieldMask

      public PayloadOptions.Builder setFieldMask(com.google.protobuf.FieldMask value)
       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];
    • setFieldMask

      public PayloadOptions.Builder setFieldMask(com.google.protobuf.FieldMask.Builder builderForValue)
       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];
    • mergeFieldMask

      public PayloadOptions.Builder mergeFieldMask(com.google.protobuf.FieldMask value)
       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];
    • clearFieldMask

      public PayloadOptions.Builder clearFieldMask()
       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];
    • getFieldMaskBuilder

      public com.google.protobuf.FieldMask.Builder getFieldMaskBuilder()
       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];
    • getFieldMaskOrBuilder

      public 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];
      Specified by:
      getFieldMaskOrBuilder in interface PayloadOptionsOrBuilder