Class SearchMessageResult.Builder (0.63.0)

public static final class SearchMessageResult.Builder extends GeneratedMessage.Builder<SearchMessageResult.Builder> implements SearchMessageResultOrBuilder

A single result item from a message search.

Protobuf type google.chat.v1.SearchMessageResult

Static Methods

getDescriptor()

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

Methods

build()

public SearchMessageResult build()
Returns
Type Description
SearchMessageResult

buildPartial()

public SearchMessageResult buildPartial()
Returns
Type Description
SearchMessageResult

clear()

public SearchMessageResult.Builder clear()
Returns
Type Description
SearchMessageResult.Builder
Overrides

clearMessage()

public SearchMessageResult.Builder clearMessage()

The matched message.

.google.chat.v1.Message message = 1;

Returns
Type Description
SearchMessageResult.Builder

clearRead()

public SearchMessageResult.Builder clearRead()

Indicates if the matched message is read by the calling user.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

optional bool read = 3;

Returns
Type Description
SearchMessageResult.Builder

This builder for chaining.

clearSpaceMuteSetting()

public SearchMessageResult.Builder clearSpaceMuteSetting()

The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

.google.chat.v1.SpaceNotificationSetting.MuteSetting space_mute_setting = 4;

Returns
Type Description
SearchMessageResult.Builder

This builder for chaining.

getDefaultInstanceForType()

public SearchMessageResult getDefaultInstanceForType()
Returns
Type Description
SearchMessageResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMessage()

public Message getMessage()

The matched message.

.google.chat.v1.Message message = 1;

Returns
Type Description
Message

The message.

getMessageBuilder()

public Message.Builder getMessageBuilder()

The matched message.

.google.chat.v1.Message message = 1;

Returns
Type Description
Message.Builder

getMessageOrBuilder()

public MessageOrBuilder getMessageOrBuilder()

The matched message.

.google.chat.v1.Message message = 1;

Returns
Type Description
MessageOrBuilder

getRead()

public boolean getRead()

Indicates if the matched message is read by the calling user.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

optional bool read = 3;

Returns
Type Description
boolean

The read.

getSpaceMuteSetting()

public SpaceNotificationSetting.MuteSetting getSpaceMuteSetting()

The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

.google.chat.v1.SpaceNotificationSetting.MuteSetting space_mute_setting = 4;

Returns
Type Description
SpaceNotificationSetting.MuteSetting

The spaceMuteSetting.

getSpaceMuteSettingValue()

public int getSpaceMuteSettingValue()

The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

.google.chat.v1.SpaceNotificationSetting.MuteSetting space_mute_setting = 4;

Returns
Type Description
int

The enum numeric value on the wire for spaceMuteSetting.

hasMessage()

public boolean hasMessage()

The matched message.

.google.chat.v1.Message message = 1;

Returns
Type Description
boolean

Whether the message field is set.

hasRead()

public boolean hasRead()

Indicates if the matched message is read by the calling user.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

optional bool read = 3;

Returns
Type Description
boolean

Whether the read field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SearchMessageResult other)

public SearchMessageResult.Builder mergeFrom(SearchMessageResult other)
Parameter
Name Description
other SearchMessageResult
Returns
Type Description
SearchMessageResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchMessageResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchMessageResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchMessageResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchMessageResult.Builder
Overrides

mergeMessage(Message value)

public SearchMessageResult.Builder mergeMessage(Message value)

The matched message.

.google.chat.v1.Message message = 1;

Parameter
Name Description
value Message
Returns
Type Description
SearchMessageResult.Builder

setMessage(Message value)

public SearchMessageResult.Builder setMessage(Message value)

The matched message.

.google.chat.v1.Message message = 1;

Parameter
Name Description
value Message
Returns
Type Description
SearchMessageResult.Builder

setMessage(Message.Builder builderForValue)

public SearchMessageResult.Builder setMessage(Message.Builder builderForValue)

The matched message.

.google.chat.v1.Message message = 1;

Parameter
Name Description
builderForValue Message.Builder
Returns
Type Description
SearchMessageResult.Builder

setRead(boolean value)

public SearchMessageResult.Builder setRead(boolean value)

Indicates if the matched message is read by the calling user.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include one of the following authorization scopes:

optional bool read = 3;

Parameter
Name Description
value boolean

The read to set.

Returns
Type Description
SearchMessageResult.Builder

This builder for chaining.

setSpaceMuteSetting(SpaceNotificationSetting.MuteSetting value)

public SearchMessageResult.Builder setSpaceMuteSetting(SpaceNotificationSetting.MuteSetting value)

The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

.google.chat.v1.SpaceNotificationSetting.MuteSetting space_mute_setting = 4;

Parameter
Name Description
value SpaceNotificationSetting.MuteSetting

The spaceMuteSetting to set.

Returns
Type Description
SearchMessageResult.Builder

This builder for chaining.

setSpaceMuteSettingValue(int value)

public SearchMessageResult.Builder setSpaceMuteSettingValue(int value)

The mute setting of the calling user for the space where the message is posted. The caller app can use this information to decide how to process the message depending on whether the space is muted for the user or not.

Only returned if the request view is SEARCH_MESSAGES_VIEW_FULL and the calling credentials include the following authorization scope:

.google.chat.v1.SpaceNotificationSetting.MuteSetting space_mute_setting = 4;

Parameter
Name Description
value int

The enum numeric value on the wire for spaceMuteSetting to set.

Returns
Type Description
SearchMessageResult.Builder

This builder for chaining.