Subscription (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.json.GenericJson
    - - com.google.api.services.workspaceevents.v1.model.Subscription

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Subscription
extends com.google.api.client.json.GenericJson
```
[Developer Preview](https://developers.google.com/workspace/preview). A subscription to receive events about a Google Workspace resource. To learn more about subscriptions, see the [Google Workspace Events API overview](https://developers.google.com/workspace/events).
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Workspace Events API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors
Constructor and Description

Subscription()

Constructors
Constructor and Description
`Subscription()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Subscription`	`clone()`
`String`	`getAuthority()` Output only.
`String`	`getCreateTime()` Output only.
`String`	`getEtag()` Optional.
`List<String>`	`getEventTypes()` Required.
`String`	`getExpireTime()` Non-empty default.
`String`	`getName()` Optional.
`NotificationEndpoint`	`getNotificationEndpoint()` Required.
`PayloadOptions`	`getPayloadOptions()` Optional.
`Boolean`	`getReconciling()` Output only.
`String`	`getState()` Output only.
`String`	`getSuspensionReason()` Output only.
`String`	`getTargetResource()` Required.
`String`	`getTtl()` Input only.
`String`	`getUid()` Output only.
`String`	`getUpdateTime()` Output only.
`Subscription`	`set(String fieldName, Object value)`
`Subscription`	`setAuthority(String authority)` Output only.
`Subscription`	`setCreateTime(String createTime)` Output only.
`Subscription`	`setEtag(String etag)` Optional.
`Subscription`	`setEventTypes(List<String> eventTypes)` Required.
`Subscription`	`setExpireTime(String expireTime)` Non-empty default.
`Subscription`	`setName(String name)` Optional.
`Subscription`	`setNotificationEndpoint(NotificationEndpoint notificationEndpoint)` Required.
`Subscription`	`setPayloadOptions(PayloadOptions payloadOptions)` Optional.
`Subscription`	`setReconciling(Boolean reconciling)` Output only.
`Subscription`	`setState(String state)` Output only.
`Subscription`	`setSuspensionReason(String suspensionReason)` Output only.
`Subscription`	`setTargetResource(String targetResource)` Required.
`Subscription`	`setTtl(String ttl)` Input only.
`Subscription`	`setUid(String uid)` Output only.
`Subscription`	`setUpdateTime(String updateTime)` Output only.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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
  - Subscription
```
public Subscription()
```
- Method Detail
  - getAuthority
```
public String getAuthority()
```
    Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com /admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
    
    Returns:
    
    value or null for none
  - setAuthority
```
public Subscription setAuthority(String authority)
```
    Output only. The user who authorized the creation of the subscription. Format: `users/{user}` For Google Workspace users, the `{user}` value is the [`user.id`](https://developers.google.com /admin-sdk/directory/reference/rest/v1/users#User.FIELDS.ids) field from the Directory API.
    
    Parameters:
    
    authority - authority or null for none
  - getCreateTime
```
public String getCreateTime()
```
    Output only. The time when the subscription is created.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Subscription setCreateTime(String createTime)
```
    Output only. The time when the subscription is created.
    
    Parameters:
    
    createTime - createTime or null for none
  - getEtag
```
public String getEtag()
```
    Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
    
    Returns:
    
    value or null for none
  - setEtag
```
public Subscription setEtag(String etag)
```
    Optional. This checksum is computed by the server based on the value of other fields, and might be sent on update requests to ensure the client has an up-to-date value before proceeding.
    
    Parameters:
    
    etag - etag or null for none
  - getEventTypes
```
public List<String> getEventTypes()
```
    Required. Immutable. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
    
    Returns:
    
    value or null for none
  - setEventTypes
```
public Subscription setEventTypes(List<String> eventTypes)
```
    Required. Immutable. Unordered list. Input for creating a subscription. Otherwise, output only. One or more types of events to receive about the target resource. Formatted according to the CloudEvents specification. The supported event types depend on the target resource of your subscription. For details, see [Supported Google Workspace events](https://developers.google.com/workspace/events/guides#supported-events). By default, you also receive events about the [lifecycle of your subscription](https://developers.google.com/workspace/events/guides/events-lifecycle). You don't need to specify lifecycle events for this field. If you specify an event type that doesn't exist for the target resource, the request returns an HTTP `400 Bad Request` status code.
    
    Parameters:
    
    eventTypes - eventTypes or null for none
  - getExpireTime
```
public String getExpireTime()
```
    Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
    
    Returns:
    
    value or null for none
  - setExpireTime
```
public Subscription setExpireTime(String expireTime)
```
    Non-empty default. The timestamp in UTC when the subscription expires. Always displayed on output, regardless of what was used on input.
    
    Parameters:
    
    expireTime - expireTime or null for none
  - getName
```
public String getName()
```
    Optional. Immutable. Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`
    
    Returns:
    
    value or null for none
  - setName
```
public Subscription setName(String name)
```
    Optional. Immutable. Identifier. Resource name of the subscription. Format: `subscriptions/{subscription}`
    
    Parameters:
    
    name - name or null for none
  - getNotificationEndpoint
```
public NotificationEndpoint getNotificationEndpoint()
```
    Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
    
    Returns:
    
    value or null for none
  - setNotificationEndpoint
```
public Subscription setNotificationEndpoint(NotificationEndpoint notificationEndpoint)
```
    Required. Immutable. The endpoint where the subscription delivers events, such as a Pub/Sub topic.
    
    Parameters:
    
    notificationEndpoint - notificationEndpoint or null for none
  - getPayloadOptions
```
public PayloadOptions getPayloadOptions()
```
    Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
    
    Returns:
    
    value or null for none
  - setPayloadOptions
```
public Subscription setPayloadOptions(PayloadOptions payloadOptions)
```
    Optional. Options about what data to include in the event payload. Only supported for Google Chat events.
    
    Parameters:
    
    payloadOptions - payloadOptions or null for none
  - getReconciling
```
public Boolean getReconciling()
```
    Output only. If `true`, the subscription is in the process of being updated.
    
    Returns:
    
    value or null for none
  - setReconciling
```
public Subscription setReconciling(Boolean reconciling)
```
    Output only. If `true`, the subscription is in the process of being updated.
    
    Parameters:
    
    reconciling - reconciling or null for none
  - getState
```
public String getState()
```
    Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
    
    Returns:
    
    value or null for none
  - setState
```
public Subscription setState(String state)
```
    Output only. The state of the subscription. Determines whether the subscription can receive events and deliver them to the notification endpoint.
    
    Parameters:
    
    state - state or null for none
  - getSuspensionReason
```
public String getSuspensionReason()
```
    Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method.
    
    Returns:
    
    value or null for none
  - setSuspensionReason
```
public Subscription setSuspensionReason(String suspensionReason)
```
    Output only. The error that suspended the subscription. To reactivate the subscription, resolve the error and call the `ReactivateSubscription` method.
    
    Parameters:
    
    suspensionReason - suspensionReason or null for none
  - getTargetResource
```
public String getTargetResource()
```
    Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
    
    Returns:
    
    value or null for none
  - setTargetResource
```
public Subscription setTargetResource(String targetResource)
```
    Required. Immutable. The Google Workspace resource that's monitored for events, formatted as the [full resource name](https://google.aip.dev/122#full-resource-names). To learn about target resources and the events that they support, see [Supported Google Workspace events](https://developers.google.com/workspace/events#supported-events). A user can only authorize your app to create one subscription for a given target resource. If your app tries to create another subscription with the same user credentials, the request returns an `ALREADY_EXISTS` error.
    
    Parameters:
    
    targetResource - targetResource or null for none
  - getTtl
```
public String getTtl()
```
    Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
    
    Returns:
    
    value or null for none
  - setTtl
```
public Subscription setTtl(String ttl)
```
    Input only. The time-to-live (TTL) or duration for the subscription. If unspecified or set to `0`, uses the maximum possible duration.
    
    Parameters:
    
    ttl - ttl or null for none
  - getUid
```
public String getUid()
```
    Output only. System-assigned unique identifier for the subscription.
    
    Returns:
    
    value or null for none
  - setUid
```
public Subscription setUid(String uid)
```
    Output only. System-assigned unique identifier for the subscription.
    
    Parameters:
    
    uid - uid or null for none
  - getUpdateTime
```
public String getUpdateTime()
```
    Output only. The last time that the subscription is updated.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Subscription setUpdateTime(String updateTime)
```
    Output only. The last time that the subscription is updated.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Subscription set(String fieldName,
                        Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Subscription clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Subscription

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

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

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

Subscription

Method Detail

getAuthority

setAuthority

getCreateTime

setCreateTime

getEtag

setEtag

getEventTypes

setEventTypes

getExpireTime

setExpireTime

getName

setName

getNotificationEndpoint

setNotificationEndpoint

getPayloadOptions

setPayloadOptions

getReconciling

setReconciling

getState

setState

getSuspensionReason

setSuspensionReason

getTargetResource

setTargetResource

getTtl

setTtl

getUid

setUid

getUpdateTime

setUpdateTime

set

clone