target.apidocs.com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.Patch.html Maven / Gradle / Ivy
HangoutsChat.Spaces.Members.Patch (Google Chat API v1-rev20240829-2.0.0)
com.google.api.services.chat.v1
Class HangoutsChat.Spaces.Members.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<Membership>
-
- com.google.api.services.chat.v1.HangoutsChat.Spaces.Members.Patch
-
- Enclosing class:
- HangoutsChat.Spaces.Members
public class HangoutsChat.Spaces.Members.Patch
extends HangoutsChatRequest<Membership>
-
-
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>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Patch(String name,
Membership content)
Updates a membership.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
String
getName()
Resource name of the membership, assigned by the server.
String
getUpdateMask()
Required.
Boolean
getUseAdminAccess()
[ Developer Preview](https://developers.google.com/workspace/preview).
HangoutsChat.Spaces.Members.Patch
set(String parameterName,
Object value)
HangoutsChat.Spaces.Members.Patch
set$Xgafv(String $Xgafv)
V1 error format.
HangoutsChat.Spaces.Members.Patch
setAccessToken(String accessToken)
OAuth access token.
HangoutsChat.Spaces.Members.Patch
setAlt(String alt)
Data format for response.
HangoutsChat.Spaces.Members.Patch
setCallback(String callback)
JSONP
HangoutsChat.Spaces.Members.Patch
setFields(String fields)
Selector specifying which fields to include in a partial response.
HangoutsChat.Spaces.Members.Patch
setKey(String key)
API key.
HangoutsChat.Spaces.Members.Patch
setName(String name)
Resource name of the membership, assigned by the server.
HangoutsChat.Spaces.Members.Patch
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
HangoutsChat.Spaces.Members.Patch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
HangoutsChat.Spaces.Members.Patch
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.
HangoutsChat.Spaces.Members.Patch
setUpdateMask(String updateMask)
Required.
HangoutsChat.Spaces.Members.Patch
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.
HangoutsChat.Spaces.Members.Patch
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.
HangoutsChat.Spaces.Members.Patch
setUseAdminAccess(Boolean useAdminAccess)
[Developer Preview](https://developers.google.com/workspace/preview).
-
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,
Membership content)
Updates a membership. For an example, see [Update a user's membership in a
space](https://developers.google.com/workspace/chat/update-members). Requires [user
authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user).
Create a request for the method "members.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
- Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
content
- the Membership
- Since:
- 1.13
-
Method Detail
-
set$Xgafv
public HangoutsChat.Spaces.Members.Patch set$Xgafv(String $Xgafv)
Description copied from class: HangoutsChatRequest
V1 error format.
- Overrides:
set$Xgafv
in class HangoutsChatRequest<Membership>
-
setAccessToken
public HangoutsChat.Spaces.Members.Patch setAccessToken(String accessToken)
Description copied from class: HangoutsChatRequest
OAuth access token.
- Overrides:
setAccessToken
in class HangoutsChatRequest<Membership>
-
setAlt
public HangoutsChat.Spaces.Members.Patch setAlt(String alt)
Description copied from class: HangoutsChatRequest
Data format for response.
- Overrides:
setAlt
in class HangoutsChatRequest<Membership>
-
setCallback
public HangoutsChat.Spaces.Members.Patch setCallback(String callback)
Description copied from class: HangoutsChatRequest
JSONP
- Overrides:
setCallback
in class HangoutsChatRequest<Membership>
-
setFields
public HangoutsChat.Spaces.Members.Patch setFields(String fields)
Description copied from class: HangoutsChatRequest
Selector specifying which fields to include in a partial response.
- Overrides:
setFields
in class HangoutsChatRequest<Membership>
-
setKey
public HangoutsChat.Spaces.Members.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<Membership>
-
setOauthToken
public HangoutsChat.Spaces.Members.Patch setOauthToken(String oauthToken)
Description copied from class: HangoutsChatRequest
OAuth 2.0 token for the current user.
- Overrides:
setOauthToken
in class HangoutsChatRequest<Membership>
-
setPrettyPrint
public HangoutsChat.Spaces.Members.Patch setPrettyPrint(Boolean prettyPrint)
Description copied from class: HangoutsChatRequest
Returns response with indentations and line breaks.
- Overrides:
setPrettyPrint
in class HangoutsChatRequest<Membership>
-
setQuotaUser
public HangoutsChat.Spaces.Members.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<Membership>
-
setUploadType
public HangoutsChat.Spaces.Members.Patch setUploadType(String uploadType)
Description copied from class: HangoutsChatRequest
Legacy upload protocol for media (e.g. "media", "multipart").
- Overrides:
setUploadType
in class HangoutsChatRequest<Membership>
-
setUploadProtocol
public HangoutsChat.Spaces.Members.Patch setUploadProtocol(String uploadProtocol)
Description copied from class: HangoutsChatRequest
Upload protocol for media (e.g. "raw", "multipart").
- Overrides:
setUploadProtocol
in class HangoutsChatRequest<Membership>
-
getName
public String getName()
Resource name of the membership, assigned by the server. Format: `spaces/{space}/members/{member}`
-
setName
public HangoutsChat.Spaces.Members.Patch setName(String name)
Resource name of the membership, assigned by the server. Format:
`spaces/{space}/members/{member}`
-
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: - `role`
-
setUpdateMask
public HangoutsChat.Spaces.Members.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: - `role`
-
getUseAdminAccess
public Boolean getUseAdminAccess()
[ Developer Preview](https://developers.google.com/workspace/preview). When `true`, the method runs
[ using the user's Google Workspace administrator privileges. The calling user must be a Google
[ Workspace administrator with the [manage chat and spaces conversations
[ privilege](https://support.google.com/a/answer/13369245). Requires the `chat.admin.memberships`
[ [OAuth 2.0 scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
[ scopes).
[
-
setUseAdminAccess
public HangoutsChat.Spaces.Members.Patch setUseAdminAccess(Boolean useAdminAccess)
[Developer Preview](https://developers.google.com/workspace/preview). When `true`, the
method runs using the user's Google Workspace administrator privileges. The calling user
must be a Google Workspace administrator with the [manage chat and spaces conversations
privilege](https://support.google.com/a/answer/13369245). Requires the
`chat.admin.memberships` [OAuth 2.0
scope](https://developers.google.com/workspace/chat/authenticate-authorize#chat-api-
scopes).
-
set
public HangoutsChat.Spaces.Members.Patch set(String parameterName,
Object value)
- Overrides:
set
in class HangoutsChatRequest<Membership>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy