com.google.api.services.chat.v1

Class HangoutsChat.Spaces.Messages.Search

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.chat.v1.HangoutsChatRequest<SearchMessagesResponse>

com.google.api.services.chat.v1.HangoutsChat.Spaces.Messages.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

HangoutsChat.Spaces.Messages

public class HangoutsChat.Spaces.Messages.Search
extends HangoutsChatRequest<SearchMessagesResponse>

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Search(String parent, SearchMessagesRequest content) Searches for messages in Google Chat that the calling user has access to.

Method Summary

Modifier and Type	Method and Description
String	getParent() Required.
HangoutsChat.Spaces.Messages.Search	set(String parameterName, Object value)
HangoutsChat.Spaces.Messages.Search	set$Xgafv(String $Xgafv) V1 error format.
HangoutsChat.Spaces.Messages.Search	setAccessToken(String accessToken) OAuth access token.
HangoutsChat.Spaces.Messages.Search	setAlt(String alt) Data format for response.
HangoutsChat.Spaces.Messages.Search	setCallback(String callback) JSONP
HangoutsChat.Spaces.Messages.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
HangoutsChat.Spaces.Messages.Search	setKey(String key) API key.
HangoutsChat.Spaces.Messages.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
HangoutsChat.Spaces.Messages.Search	setParent(String parent) Required.
HangoutsChat.Spaces.Messages.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
HangoutsChat.Spaces.Messages.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
HangoutsChat.Spaces.Messages.Search	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
HangoutsChat.Spaces.Messages.Search	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.chat.v1.HangoutsChatRequest

get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

Search

protected Search(String parent,
                 SearchMessagesRequest content)

Searches for messages in Google Chat that the calling user has access to. Returns a list of messages matching the search criteria. To search across all spaces the user has access to, set `parent` to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. The returned messages have their `name` field populated with the full resource name, which includes the specific `space` in which the message resides. This API doesn't return all message types. The types of messages listed below aren't included in the response. Use ListMessages to list all messages. - Private Messages that are visible to the authenticated user. - Messages posted by Chat apps in spaces or group chats. - Messages in a Chat app DM. - Messages from blocked users. - Messages in spaces that the caller has muted. Requires [user authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following [authorization scopes](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-scopes): - `https://www.googleapis.com/auth/chat.messages.readonly` - `https://www.googleapis.com/auth/chat.messages` Create a request for the method "messages.search". This request holds the parameters needed by the the chat server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

HangoutsChat.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

parent - Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.

content - the SearchMessagesRequest

Since:

1.13

Method Detail

set$Xgafv

public HangoutsChat.Spaces.Messages.Search set$Xgafv(String $Xgafv)

Description copied from class: HangoutsChatRequest

V1 error format.

Overrides:

set$Xgafv in class HangoutsChatRequest<SearchMessagesResponse>

setAccessToken

public HangoutsChat.Spaces.Messages.Search setAccessToken(String accessToken)

Description copied from class: HangoutsChatRequest

OAuth access token.

Overrides:

setAccessToken in class HangoutsChatRequest<SearchMessagesResponse>

setAlt

public HangoutsChat.Spaces.Messages.Search setAlt(String alt)

Description copied from class: HangoutsChatRequest

Data format for response.

Overrides:

setAlt in class HangoutsChatRequest<SearchMessagesResponse>

setCallback

public HangoutsChat.Spaces.Messages.Search setCallback(String callback)

Description copied from class: HangoutsChatRequest

JSONP

Overrides:

setCallback in class HangoutsChatRequest<SearchMessagesResponse>

setFields

public HangoutsChat.Spaces.Messages.Search setFields(String fields)

Description copied from class: HangoutsChatRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class HangoutsChatRequest<SearchMessagesResponse>

setKey

public HangoutsChat.Spaces.Messages.Search setKey(String key)

Description copied from class: HangoutsChatRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class HangoutsChatRequest<SearchMessagesResponse>

setOauthToken

public HangoutsChat.Spaces.Messages.Search setOauthToken(String oauthToken)

Description copied from class: HangoutsChatRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class HangoutsChatRequest<SearchMessagesResponse>

setPrettyPrint

public HangoutsChat.Spaces.Messages.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: HangoutsChatRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class HangoutsChatRequest<SearchMessagesResponse>

setQuotaUser

public HangoutsChat.Spaces.Messages.Search setQuotaUser(String quotaUser)

Description copied from class: HangoutsChatRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Overrides:

setQuotaUser in class HangoutsChatRequest<SearchMessagesResponse>

setUploadType

public HangoutsChat.Spaces.Messages.Search setUploadType(String uploadType)

Description copied from class: HangoutsChatRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class HangoutsChatRequest<SearchMessagesResponse>

setUploadProtocol

public HangoutsChat.Spaces.Messages.Search setUploadProtocol(String uploadProtocol)

Description copied from class: HangoutsChatRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class HangoutsChatRequest<SearchMessagesResponse>

getParent

public String getParent()

Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.

setParent

public HangoutsChat.Spaces.Messages.Search setParent(String parent)

Required. The resource name of the space to search within. To search across all spaces the user has access to, set this field to `spaces/-`. Using any other value for `parent` results in an `INVALID_ARGUMENT` error. To limit the search to one or more spaces, use `space.name` or `space.display_name` in the `filter`.

set

public HangoutsChat.Spaces.Messages.Search set(String parameterName,
                                               Object value)

Overrides:

set in class HangoutsChatRequest<SearchMessagesResponse>