WorkspaceEvents.Subscriptions.Patch (Google Workspace Events API v1-rev20240305-2.0.0)

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.workspaceevents.v1.WorkspaceEventsRequest<Operation>
        
        com.google.api.services.workspaceevents.v1.WorkspaceEvents.Subscriptions.Patch

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

WorkspaceEvents.Subscriptions
```
public class WorkspaceEvents.Subscriptions.Patch
extends WorkspaceEventsRequest<Operation>
```

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
  USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Patch(String name, Subscription content)` [Developer Preview](https://developers.google.com/workspace/preview): Updates or renews a Google Workspace subscription.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getName()` Optional.
`String`	`getUpdateMask()` Optional.
`Boolean`	`getValidateOnly()` Optional.
`WorkspaceEvents.Subscriptions.Patch`	`set(String parameterName, Object value)`
`WorkspaceEvents.Subscriptions.Patch`	`set$Xgafv(String $Xgafv)` V1 error format.
`WorkspaceEvents.Subscriptions.Patch`	`setAccessToken(String accessToken)` OAuth access token.
`WorkspaceEvents.Subscriptions.Patch`	`setAlt(String alt)` Data format for response.
`WorkspaceEvents.Subscriptions.Patch`	`setCallback(String callback)` JSONP
`WorkspaceEvents.Subscriptions.Patch`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`WorkspaceEvents.Subscriptions.Patch`	`setKey(String key)` API key.
`WorkspaceEvents.Subscriptions.Patch`	`setName(String name)` Optional.
`WorkspaceEvents.Subscriptions.Patch`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`WorkspaceEvents.Subscriptions.Patch`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`WorkspaceEvents.Subscriptions.Patch`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`WorkspaceEvents.Subscriptions.Patch`	`setUpdateMask(String updateMask)` Optional.
`WorkspaceEvents.Subscriptions.Patch`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`WorkspaceEvents.Subscriptions.Patch`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.
`WorkspaceEvents.Subscriptions.Patch`	`setValidateOnly(Boolean validateOnly)` Optional.

Methods inherited from class com.google.api.services.workspaceevents.v1.WorkspaceEventsRequest
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,
                Subscription content)
```
    [Developer Preview](https://developers.google.com/workspace/preview): Updates or renews a Google Workspace subscription. To learn how to use this method, see [Update or renew a Google Workspace subscription](https://developers.google.com/workspace/events/guides/update- subscription). Create a request for the method "subscriptions.patch". This request holds the parameters needed by the the workspaceevents server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    WorkspaceEvents.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    name - Optional. Immutable. Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`
    
    content - the Subscription
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public WorkspaceEvents.Subscriptions.Patch set$Xgafv(String $Xgafv)
```
    Description copied from class: WorkspaceEventsRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class WorkspaceEventsRequest<Operation>
  - setAccessToken
```
public WorkspaceEvents.Subscriptions.Patch setAccessToken(String accessToken)
```
    Description copied from class: WorkspaceEventsRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class WorkspaceEventsRequest<Operation>
  - setAlt
```
public WorkspaceEvents.Subscriptions.Patch setAlt(String alt)
```
    Description copied from class: WorkspaceEventsRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class WorkspaceEventsRequest<Operation>
  - setCallback
```
public WorkspaceEvents.Subscriptions.Patch setCallback(String callback)
```
    Description copied from class: WorkspaceEventsRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class WorkspaceEventsRequest<Operation>
  - setFields
```
public WorkspaceEvents.Subscriptions.Patch setFields(String fields)
```
    Description copied from class: WorkspaceEventsRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class WorkspaceEventsRequest<Operation>
  - setKey
```
public WorkspaceEvents.Subscriptions.Patch setKey(String key)
```
    Description copied from class: WorkspaceEventsRequest
    
    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 WorkspaceEventsRequest<Operation>
  - setOauthToken
```
public WorkspaceEvents.Subscriptions.Patch setOauthToken(String oauthToken)
```
    Description copied from class: WorkspaceEventsRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class WorkspaceEventsRequest<Operation>
  - setPrettyPrint
```
public WorkspaceEvents.Subscriptions.Patch setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: WorkspaceEventsRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class WorkspaceEventsRequest<Operation>
  - setQuotaUser
```
public WorkspaceEvents.Subscriptions.Patch setQuotaUser(String quotaUser)
```
    Description copied from class: WorkspaceEventsRequest
    
    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 WorkspaceEventsRequest<Operation>
  - setUploadType
```
public WorkspaceEvents.Subscriptions.Patch setUploadType(String uploadType)
```
    Description copied from class: WorkspaceEventsRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class WorkspaceEventsRequest<Operation>
  - setUploadProtocol
```
public WorkspaceEvents.Subscriptions.Patch setUploadProtocol(String uploadProtocol)
```
    Description copied from class: WorkspaceEventsRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class WorkspaceEventsRequest<Operation>
  - getName
```
public String getName()
```
    Optional. Immutable. Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`
  - setName
```
public WorkspaceEvents.Subscriptions.Patch setName(String name)
```
    Optional. Immutable. Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`
  - getUpdateMask
```
public String getUpdateMask()
```
    Optional. Required. The field to update. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to- live (TTL) or duration of the subscription.
  - setUpdateMask
```
public WorkspaceEvents.Subscriptions.Patch setUpdateMask(String updateMask)
```
    Optional. Required. The field to update. You can update one of the following fields in a subscription: * `expire_time`: The timestamp when the subscription expires. * `ttl`: The time-to-live (TTL) or duration of the subscription.
  - getValidateOnly
```
public Boolean getValidateOnly()
```
    Optional. If set to `true`, validates and previews the request, but doesn't update the subscription.
  - setValidateOnly
```
public WorkspaceEvents.Subscriptions.Patch setValidateOnly(Boolean validateOnly)
```
    Optional. If set to `true`, validates and previews the request, but doesn't update the subscription.
  - set
```
public WorkspaceEvents.Subscriptions.Patch set(String parameterName,
                                               Object value)
```
    Overrides:
    
    set in class WorkspaceEventsRequest<Operation>

Class WorkspaceEvents.Subscriptions.Patch

Nested Class Summary

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

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

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

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.workspaceevents.v1.WorkspaceEventsRequest

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

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

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Patch

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getName

setName

getUpdateMask

setUpdateMask

getValidateOnly

setValidateOnly

set