com.google.api.services.chat.v1

Class HangoutsChat.Spaces.Messages.Patch

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<Message>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

HangoutsChat.Spaces.Messages

public class HangoutsChat.Spaces.Messages.Patch
extends HangoutsChatRequest<Message>

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	Patch(String name, Message content) Updates a message.

Method Summary

Modifier and Type	Method and Description
Boolean	getAllowMissing() Optional.
String	getName() Identifier.
String	getUpdateMask() Required.
HangoutsChat.Spaces.Messages.Patch	set(String parameterName, Object value)
HangoutsChat.Spaces.Messages.Patch	set$Xgafv(String $Xgafv) V1 error format.
HangoutsChat.Spaces.Messages.Patch	setAccessToken(String accessToken) OAuth access token.
HangoutsChat.Spaces.Messages.Patch	setAllowMissing(Boolean allowMissing) Optional.
HangoutsChat.Spaces.Messages.Patch	setAlt(String alt) Data format for response.
HangoutsChat.Spaces.Messages.Patch	setCallback(String callback) JSONP
HangoutsChat.Spaces.Messages.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
HangoutsChat.Spaces.Messages.Patch	setKey(String key) API key.
HangoutsChat.Spaces.Messages.Patch	setName(String name) Identifier.
HangoutsChat.Spaces.Messages.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
HangoutsChat.Spaces.Messages.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
HangoutsChat.Spaces.Messages.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
HangoutsChat.Spaces.Messages.Patch	setUpdateMask(String updateMask) Required.
HangoutsChat.Spaces.Messages.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
HangoutsChat.Spaces.Messages.Patch	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

Patch

protected Patch(String name,
                Message content)

Updates a message. There's a difference between the `patch` and `update` methods. The `patch` method uses a `patch` request while the `update` method uses a `put` request. We recommend using the `patch` method. For an example, see [Update a message](https://developers.google.com/workspace/chat/update-messages). Supports the following types of [authentication](https://developers.google.com/workspace/chat/authenticate-authorize): - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize- chat-app) with the authorization scope: - `https://www.googleapis.com/auth/chat.bot` - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) with one of the following authorization scopes: - `https://www.googleapis.com/auth/chat.messages` - `https://www.googleapis.com/auth/chat.import` (import mode spaces only) When using app authentication, requests can only update messages created by the calling Chat app. Create a request for the method "messages.patch". 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:

name - Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system- assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create- messages#name_a_created_message).

content - the Message

Since:

1.13

Method Detail

set$Xgafv

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

Description copied from class: HangoutsChatRequest

V1 error format.

Overrides:

set$Xgafv in class HangoutsChatRequest<Message>

setAccessToken

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

Description copied from class: HangoutsChatRequest

OAuth access token.

Overrides:

setAccessToken in class HangoutsChatRequest<Message>

setAlt

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

Description copied from class: HangoutsChatRequest

Data format for response.

Overrides:

setAlt in class HangoutsChatRequest<Message>

setCallback

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

Description copied from class: HangoutsChatRequest

JSONP

Overrides:

setCallback in class HangoutsChatRequest<Message>

setFields

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

Description copied from class: HangoutsChatRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class HangoutsChatRequest<Message>

setKey

public HangoutsChat.Spaces.Messages.Patch 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<Message>

setOauthToken

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

Description copied from class: HangoutsChatRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class HangoutsChatRequest<Message>

setPrettyPrint

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

Description copied from class: HangoutsChatRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class HangoutsChatRequest<Message>

setQuotaUser

public HangoutsChat.Spaces.Messages.Patch 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<Message>

setUploadType

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

Description copied from class: HangoutsChatRequest

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

Overrides:

setUploadType in class HangoutsChatRequest<Message>

setUploadProtocol

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

Description copied from class: HangoutsChatRequest

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

Overrides:

setUploadProtocol in class HangoutsChatRequest<Message>

getName

public String getName()

Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create-messages#name_a_created_message).

setName

public HangoutsChat.Spaces.Messages.Patch setName(String name)

Identifier. Resource name of the message. Format: `spaces/{space}/messages/{message}` Where `{space}` is the ID of the space where the message is posted and `{message}` is a system-assigned ID for the message. For example, `spaces/AAAAAAAAAAA/messages/BBBBBBBBBBB.BBBBBBBBBBB`. If you set a custom ID when you create a message, you can use this ID to specify the message in a request by replacing `{message}` with the value from the `clientAssignedMessageId` field. For example, `spaces/AAAAAAAAAAA/messages/client-custom-name`. For details, see [Name a message](https://developers.google.com/workspace/chat/create- messages#name_a_created_message).

getAllowMissing

public Boolean getAllowMissing()

Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client- assigned](https://developers.google.com/workspace/chat/create-messages#name_a_created_message) or the request fails.

setAllowMissing

public HangoutsChat.Spaces.Messages.Patch setAllowMissing(Boolean allowMissing)

Optional. If `true` and the message isn't found, a new message is created and `updateMask` is ignored. The specified message ID must be [client- assigned](https://developers.google.com/workspace/chat/create- messages#name_a_created_message) or the request fails.

getUpdateMask

public String getUpdateMask()

Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)

setUpdateMask

public HangoutsChat.Spaces.Messages.Patch setUpdateMask(String updateMask)

Required. The field paths to update. Separate multiple values with commas or use `*` to update all field paths. Currently supported field paths: - `text` - `attachment` - `cards` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `cards_v2` (Requires [app authentication](/chat/api/guides/auth/service-accounts).) - `accessory_widgets` (Requires [app authentication](/chat/api/guides/auth/service- accounts).) - `quoted_message_metadata` (Only allows removal of the quoted message.)

set

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

Overrides:

set in class HangoutsChatRequest<Message>