AlertCenter.Alerts.List (Google Workspace Alert Center API v1beta1-rev20241028-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.alertcenter.v1beta1.AlertCenterRequest<ListAlertsResponse>
        
        com.google.api.services.alertcenter.v1beta1.AlertCenter.Alerts.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AlertCenter.Alerts
```
public class AlertCenter.Alerts.List
extends AlertCenterRequest<ListAlertsResponse>
```

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 List()
Lists the alerts.

Constructors
Modifier	Constructor and Description
`protected`	`List()` Lists the alerts.

Method Summary

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

Methods inherited from class com.google.api.services.alertcenter.v1beta1.AlertCenterRequest
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()
```
    Lists the alerts. Create a request for the method "alerts.list". This request holds the parameters needed by the the alertcenter server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    AlertCenter.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<ListAlertsResponse>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListAlertsResponse>
    
    Throws:
    
    IOException
  - set$Xgafv
```
public AlertCenter.Alerts.List set$Xgafv(String $Xgafv)
```
    Description copied from class: AlertCenterRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class AlertCenterRequest<ListAlertsResponse>
  - setAccessToken
```
public AlertCenter.Alerts.List setAccessToken(String accessToken)
```
    Description copied from class: AlertCenterRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class AlertCenterRequest<ListAlertsResponse>
  - setAlt
```
public AlertCenter.Alerts.List setAlt(String alt)
```
    Description copied from class: AlertCenterRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class AlertCenterRequest<ListAlertsResponse>
  - setCallback
```
public AlertCenter.Alerts.List setCallback(String callback)
```
    Description copied from class: AlertCenterRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class AlertCenterRequest<ListAlertsResponse>
  - setFields
```
public AlertCenter.Alerts.List setFields(String fields)
```
    Description copied from class: AlertCenterRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class AlertCenterRequest<ListAlertsResponse>
  - setKey
```
public AlertCenter.Alerts.List setKey(String key)
```
    Description copied from class: AlertCenterRequest
    
    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 AlertCenterRequest<ListAlertsResponse>
  - setOauthToken
```
public AlertCenter.Alerts.List setOauthToken(String oauthToken)
```
    Description copied from class: AlertCenterRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class AlertCenterRequest<ListAlertsResponse>
  - setPrettyPrint
```
public AlertCenter.Alerts.List setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: AlertCenterRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class AlertCenterRequest<ListAlertsResponse>
  - setQuotaUser
```
public AlertCenter.Alerts.List setQuotaUser(String quotaUser)
```
    Description copied from class: AlertCenterRequest
    
    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 AlertCenterRequest<ListAlertsResponse>
  - setUploadType
```
public AlertCenter.Alerts.List setUploadType(String uploadType)
```
    Description copied from class: AlertCenterRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class AlertCenterRequest<ListAlertsResponse>
  - setUploadProtocol
```
public AlertCenter.Alerts.List setUploadProtocol(String uploadProtocol)
```
    Description copied from class: AlertCenterRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class AlertCenterRequest<ListAlertsResponse>
  - getCustomerId
```
public String getCustomerId()
```
    Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
  - setCustomerId
```
public AlertCenter.Alerts.List setCustomerId(String customerId)
```
    Optional. The unique identifier of the Google Workspace account of the customer the alerts are associated with. The `customer_id` must have the initial "C" stripped (for example, `046psxkn`). Inferred from the caller identity if not provided. [Find your customer ID](https://support.google.com/cloudidentity/answer/10070793).
  - getFilter
```
public String getFilter()
```
    Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin-sdk/alertcenter/reference/filter- fields#alerts.list).
  - setFilter
```
public AlertCenter.Alerts.List setFilter(String filter)
```
    Optional. A query string for filtering alert results. For more details, see [Query filters](https://developers.google.com/admin-sdk/alertcenter/guides/query-filters) and [Supported query filter fields](https://developers.google.com/admin- sdk/alertcenter/reference/filter-fields#alerts.list).
  - getOrderBy
```
public String getOrderBy()
```
    Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
  - setOrderBy
```
public AlertCenter.Alerts.List setOrderBy(String orderBy)
```
    Optional. The sort order of the list results. If not specified results may be returned in arbitrary order. You can sort the results in descending order based on the creation timestamp using `order_by="create_time desc"`. Currently, supported sorting are `create_time asc`, `create_time desc`, `update_time desc`
  - getPageSize
```
public Integer getPageSize()
```
    Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
  - setPageSize
```
public AlertCenter.Alerts.List setPageSize(Integer pageSize)
```
    Optional. The requested page size. Server may return fewer items than requested. If unspecified, server picks an appropriate default.
  - getPageToken
```
public String getPageToken()
```
    Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
  - setPageToken
```
public AlertCenter.Alerts.List setPageToken(String pageToken)
```
    Optional. A token identifying a page of results the server should return. If empty, a new iteration is started. To continue an iteration, pass in the value from the previous ListAlertsResponse's next_page_token field.
  - set
```
public AlertCenter.Alerts.List set(String parameterName,
                                   Object value)
```
    Overrides:
    
    set in class AlertCenterRequest<ListAlertsResponse>

Class AlertCenter.Alerts.List

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.alertcenter.v1beta1.AlertCenterRequest

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

getCustomerId

setCustomerId

getFilter

setFilter

getOrderBy

setOrderBy

getPageSize

setPageSize

getPageToken

setPageToken

set