Class PayloadOptions (0.9.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
Type Description
int

INCLUDE_RESOURCE_FIELD_NUMBER

public static final int INCLUDE_RESOURCE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static PayloadOptions getDefaultInstance()
Returns
Type Description
PayloadOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static PayloadOptions.Builder newBuilder()
Returns
Type Description
PayloadOptions.Builder

newBuilder(PayloadOptions prototype)

public static PayloadOptions.Builder newBuilder(PayloadOptions prototype)
Parameter
Name Description
prototype PayloadOptions
Returns
Type Description
PayloadOptions.Builder

parseDelimitedFrom(InputStream input)

public static PayloadOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static PayloadOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static PayloadOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static PayloadOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static PayloadOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static PayloadOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static PayloadOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
PayloadOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<PayloadOptions> parser()
Returns
Type Description
Parser<PayloadOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public PayloadOptions getDefaultInstanceForType()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

The includeResource.

getParserForType()

public Parser<PayloadOptions> getParserForType()
Returns
Type Description
Parser<PayloadOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
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
Type Description
boolean

Whether the fieldMask field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public PayloadOptions.Builder newBuilderForType()
Returns
Type Description
PayloadOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected PayloadOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
PayloadOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public PayloadOptions.Builder toBuilder()
Returns
Type Description
PayloadOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException