Class SearchMessageResult (0.63.0)

public final class SearchMessageResult extends GeneratedMessage implements SearchMessageResultOrBuilder

A single result item from a message search.

Protobuf type google.chat.v1.SearchMessageResult

Static Fields

MESSAGE_FIELD_NUMBER

public static final int MESSAGE_FIELD_NUMBER
Field Value
Type Description
int

READ_FIELD_NUMBER

public static final int READ_FIELD_NUMBER
Field Value
Type Description
int

SPACE_MUTE_SETTING_FIELD_NUMBER

public static final int SPACE_MUTE_SETTING_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchMessageResult getDefaultInstance()
Returns
Type Description
SearchMessageResult

getDescriptor()

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

newBuilder()

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

newBuilder(SearchMessageResult prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchMessageResult getDefaultInstanceForType()
Returns
Type Description
SearchMessageResult

getMessage()

public Message getMessage()

The matched message.

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

Returns
Type Description
Message

The message.

getMessageOrBuilder()

public MessageOrBuilder getMessageOrBuilder()

The matched message.

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

Returns
Type Description
MessageOrBuilder

getParserForType()

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

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchMessageResult.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchMessageResult.Builder
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

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