com.google.api.services.workspaceevents.v1

Class WorkspaceEvents.Subscriptions.List

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

com.google.api.services.workspaceevents.v1.WorkspaceEvents.Subscriptions.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

WorkspaceEvents.Subscriptions

public class WorkspaceEvents.Subscriptions.List
extends WorkspaceEventsRequest<ListSubscriptionsResponse>

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	List() [Developer Preview](https://developers.google.com/workspace/preview): Lists Google Workspace subscriptions.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() Required.
Integer	getPageSize() Optional.
String	getPageToken() Optional.
WorkspaceEvents.Subscriptions.List	set(String parameterName, Object value)
WorkspaceEvents.Subscriptions.List	set$Xgafv(String $Xgafv) V1 error format.
WorkspaceEvents.Subscriptions.List	setAccessToken(String accessToken) OAuth access token.
WorkspaceEvents.Subscriptions.List	setAlt(String alt) Data format for response.
WorkspaceEvents.Subscriptions.List	setCallback(String callback) JSONP
WorkspaceEvents.Subscriptions.List	setFields(String fields) Selector specifying which fields to include in a partial response.
WorkspaceEvents.Subscriptions.List	setFilter(String filter) Required.
WorkspaceEvents.Subscriptions.List	setKey(String key) API key.
WorkspaceEvents.Subscriptions.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
WorkspaceEvents.Subscriptions.List	setPageSize(Integer pageSize) Optional.
WorkspaceEvents.Subscriptions.List	setPageToken(String pageToken) Optional.
WorkspaceEvents.Subscriptions.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
WorkspaceEvents.Subscriptions.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
WorkspaceEvents.Subscriptions.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
WorkspaceEvents.Subscriptions.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

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, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, 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

List

protected List()

[Developer Preview](https://developers.google.com/workspace/preview): Lists Google Workspace subscriptions. To learn how to use this method, see [List Google Workspace subscriptions](https://developers.google.com/workspace/events/guides/list-subscriptions). Create a request for the method "subscriptions.list". 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.

Since:

1.13

Method Detail

executeUsingHead

public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListSubscriptionsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListSubscriptionsResponse>

Throws:

IOException

set$Xgafv

public WorkspaceEvents.Subscriptions.List set$Xgafv(String $Xgafv)

Description copied from class: WorkspaceEventsRequest

V1 error format.

Overrides:

set$Xgafv in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setAccessToken

public WorkspaceEvents.Subscriptions.List setAccessToken(String accessToken)

Description copied from class: WorkspaceEventsRequest

OAuth access token.

Overrides:

setAccessToken in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setAlt

public WorkspaceEvents.Subscriptions.List setAlt(String alt)

Description copied from class: WorkspaceEventsRequest

Data format for response.

Overrides:

setAlt in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setCallback

public WorkspaceEvents.Subscriptions.List setCallback(String callback)

Description copied from class: WorkspaceEventsRequest

JSONP

Overrides:

setCallback in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setFields

public WorkspaceEvents.Subscriptions.List setFields(String fields)

Description copied from class: WorkspaceEventsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setKey

public WorkspaceEvents.Subscriptions.List 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<ListSubscriptionsResponse>

setOauthToken

public WorkspaceEvents.Subscriptions.List setOauthToken(String oauthToken)

Description copied from class: WorkspaceEventsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setPrettyPrint

public WorkspaceEvents.Subscriptions.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: WorkspaceEventsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setQuotaUser

public WorkspaceEvents.Subscriptions.List 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<ListSubscriptionsResponse>

setUploadType

public WorkspaceEvents.Subscriptions.List setUploadType(String uploadType)

Description copied from class: WorkspaceEventsRequest

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

Overrides:

setUploadType in class WorkspaceEventsRequest<ListSubscriptionsResponse>

setUploadProtocol

public WorkspaceEvents.Subscriptions.List setUploadProtocol(String uploadProtocol)

Description copied from class: WorkspaceEventsRequest

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

Overrides:

setUploadProtocol in class WorkspaceEventsRequest<ListSubscriptionsResponse>

getFilter

public String getFilter()

Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.message.v1.created" AND target_resource="//chat.googleapis.com/spaces/{space}" ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" ) AND target_resource="//chat.googleapis.com/spaces/{space}" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.

setFilter

public WorkspaceEvents.Subscriptions.List setFilter(String filter)

Required. A query filter. You can filter subscriptions by event type (`event_types`) and target resource (`target_resource`). You must specify at least one event type in your query. To filter for multiple event types, use the `OR` operator. To filter by both event type and target resource, use the `AND` operator and specify the full resource name, such as `//chat.googleapis.com/spaces/{space}`. For example, the following queries are valid: ``` event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" event_types:"google.workspace.chat.message.v1.created" AND target_resource="//chat.googleapis.com/spaces/{space}" ( event_types:"google.workspace.chat.membership.v1.updated" OR event_types:"google.workspace.chat.message.v1.created" ) AND target_resource="//chat.googleapis.com/spaces/{space}" ``` The server rejects invalid queries with an `INVALID_ARGUMENT` error.

getPageSize

public Integer getPageSize()

Optional. The maximum number of subscriptions to return. The service might return fewer than this value. If unspecified or set to `0`, up to 50 subscriptions are returned. The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.

setPageSize

public WorkspaceEvents.Subscriptions.List setPageSize(Integer pageSize)

Optional. The maximum number of subscriptions to return. The service might return fewer than this value. If unspecified or set to `0`, up to 50 subscriptions are returned. The maximum value is 100. If you specify a value more than 100, the system only returns 100 subscriptions.

getPageToken

public String getPageToken()

Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

setPageToken

public WorkspaceEvents.Subscriptions.List setPageToken(String pageToken)

Optional. A page token, received from a previous list subscriptions call. Provide this parameter to retrieve the subsequent page. When paginating, the filter value should match the call that provided the page token. Passing a different value might lead to unexpected results.

set

public WorkspaceEvents.Subscriptions.List set(String parameterName,
                                              Object value)

Overrides:

set in class WorkspaceEventsRequest<ListSubscriptionsResponse>