public static final class PayloadOptions.Builder extends GeneratedMessage.Builder<PayloadOptions.Builder> implements PayloadOptionsOrBuilderOptions about what data to include in the event payload. Only supported for Google Chat events.
Protobuf type google.apps.events.subscriptions.v1.PayloadOptions
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > PayloadOptions.BuilderImplements
PayloadOptionsOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public PayloadOptions build()| Returns | |
|---|---|
| Type | Description |
PayloadOptions |
|
buildPartial()
public PayloadOptions buildPartial()| Returns | |
|---|---|
| Type | Description |
PayloadOptions |
|
clear()
public PayloadOptions.Builder clear()| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
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];
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
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
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 |
PayloadOptions.Builder |
This builder for chaining. |
getDefaultInstanceForType()
public PayloadOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
PayloadOptions |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getFieldMaskBuilder()
public 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];
| Returns | |
|---|---|
| Type | Description |
Builder |
|
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. |
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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFieldMask(FieldMask value)
public PayloadOptions.Builder mergeFieldMask(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];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
mergeFrom(PayloadOptions other)
public PayloadOptions.Builder mergeFrom(PayloadOptions other)| Parameter | |
|---|---|
| Name | Description |
other |
PayloadOptions |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public PayloadOptions.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public PayloadOptions.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
setFieldMask(FieldMask value)
public PayloadOptions.Builder setFieldMask(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];
| Parameter | |
|---|---|
| Name | Description |
value |
FieldMask |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
setFieldMask(FieldMask.Builder builderForValue)
public PayloadOptions.Builder setFieldMask(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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
|
setIncludeResource(boolean value)
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
resource. If false, the event payload only includes the name of the changed
resource.
bool include_resource = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe includeResource to set. |
| Returns | |
|---|---|
| Type | Description |
PayloadOptions.Builder |
This builder for chaining. |