Class PayloadOptions (0.4.0)

public final class PayloadOptions extends GeneratedMessageV3 implements PayloadOptionsOrBuilder

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

Protobuf type google.apps.events.subscriptions.v1.PayloadOptions

Static Fields

FIELD_MASK_FIELD_NUMBER

public static final int FIELD_MASK_FIELD_NUMBER
Field Value
TypeDescription
int

INCLUDE_RESOURCE_FIELD_NUMBER

public static final int INCLUDE_RESOURCE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static PayloadOptions getDefaultInstance()
Returns
TypeDescription
PayloadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static PayloadOptions.Builder newBuilder()
Returns
TypeDescription
PayloadOptions.Builder

newBuilder(PayloadOptions prototype)

public static PayloadOptions.Builder newBuilder(PayloadOptions prototype)
Parameter
NameDescription
prototypePayloadOptions
Returns
TypeDescription
PayloadOptions.Builder

parseDelimitedFrom(InputStream input)

public static PayloadOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static PayloadOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PayloadOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PayloadOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static PayloadOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static PayloadOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
PayloadOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<PayloadOptions> parser()
Returns
TypeDescription
Parser<PayloadOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public PayloadOptions getDefaultInstanceForType()
Returns
TypeDescription
PayloadOptions

getFieldMask()

public 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
TypeDescription
FieldMask

The fieldMask.

getFieldMaskOrBuilder()

public 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];

Returns
TypeDescription
FieldMaskOrBuilder

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 resource. If false, the event payload only includes the name of the changed resource.

bool include_resource = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
TypeDescription
boolean

The includeResource.

getParserForType()

public Parser<PayloadOptions> getParserForType()
Returns
TypeDescription
Parser<PayloadOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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];

Returns
TypeDescription
boolean

Whether the fieldMask field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public PayloadOptions.Builder newBuilderForType()
Returns
TypeDescription
PayloadOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PayloadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
PayloadOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public PayloadOptions.Builder toBuilder()
Returns
TypeDescription
PayloadOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException