com.google.api.services.alertcenter.v1beta1

Class AlertCenter.Alerts.GetMetadata

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

com.google.api.services.alertcenter.v1beta1.AlertCenter.Alerts.GetMetadata

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

AlertCenter.Alerts

public class AlertCenter.Alerts.GetMetadata
extends AlertCenterRequest<AlertMetadata>

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	GetMetadata(String alertId) Returns the metadata of an alert.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getAlertId() Required.
String	getCustomerId() Optional.
AlertCenter.Alerts.GetMetadata	set(String parameterName, Object value)
AlertCenter.Alerts.GetMetadata	set$Xgafv(String $Xgafv) V1 error format.
AlertCenter.Alerts.GetMetadata	setAccessToken(String accessToken) OAuth access token.
AlertCenter.Alerts.GetMetadata	setAlertId(String alertId) Required.
AlertCenter.Alerts.GetMetadata	setAlt(String alt) Data format for response.
AlertCenter.Alerts.GetMetadata	setCallback(String callback) JSONP
AlertCenter.Alerts.GetMetadata	setCustomerId(String customerId) Optional.
AlertCenter.Alerts.GetMetadata	setFields(String fields) Selector specifying which fields to include in a partial response.
AlertCenter.Alerts.GetMetadata	setKey(String key) API key.
AlertCenter.Alerts.GetMetadata	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
AlertCenter.Alerts.GetMetadata	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
AlertCenter.Alerts.GetMetadata	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
AlertCenter.Alerts.GetMetadata	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
AlertCenter.Alerts.GetMetadata	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

GetMetadata

protected GetMetadata(String alertId)

Returns the metadata of an alert. Attempting to get metadata for a non-existent alert returns `NOT_FOUND` error. Create a request for the method "alerts.getMetadata". 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.

Parameters:

alertId - Required. The identifier of the alert this metadata belongs to.

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

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public AlertCenter.Alerts.GetMetadata set$Xgafv(String $Xgafv)

Description copied from class: AlertCenterRequest

V1 error format.

Overrides:

set$Xgafv in class AlertCenterRequest<AlertMetadata>

setAccessToken

public AlertCenter.Alerts.GetMetadata setAccessToken(String accessToken)

Description copied from class: AlertCenterRequest

OAuth access token.

Overrides:

setAccessToken in class AlertCenterRequest<AlertMetadata>

setAlt

public AlertCenter.Alerts.GetMetadata setAlt(String alt)

Description copied from class: AlertCenterRequest

Data format for response.

Overrides:

setAlt in class AlertCenterRequest<AlertMetadata>

setCallback

public AlertCenter.Alerts.GetMetadata setCallback(String callback)

Description copied from class: AlertCenterRequest

JSONP

Overrides:

setCallback in class AlertCenterRequest<AlertMetadata>

setFields

public AlertCenter.Alerts.GetMetadata setFields(String fields)

Description copied from class: AlertCenterRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AlertCenterRequest<AlertMetadata>

setKey

public AlertCenter.Alerts.GetMetadata 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<AlertMetadata>

setOauthToken

public AlertCenter.Alerts.GetMetadata setOauthToken(String oauthToken)

Description copied from class: AlertCenterRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AlertCenterRequest<AlertMetadata>

setPrettyPrint

public AlertCenter.Alerts.GetMetadata setPrettyPrint(Boolean prettyPrint)

Description copied from class: AlertCenterRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AlertCenterRequest<AlertMetadata>

setQuotaUser

public AlertCenter.Alerts.GetMetadata 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<AlertMetadata>

setUploadType

public AlertCenter.Alerts.GetMetadata setUploadType(String uploadType)

Description copied from class: AlertCenterRequest

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

Overrides:

setUploadType in class AlertCenterRequest<AlertMetadata>

setUploadProtocol

public AlertCenter.Alerts.GetMetadata setUploadProtocol(String uploadProtocol)

Description copied from class: AlertCenterRequest

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

Overrides:

setUploadProtocol in class AlertCenterRequest<AlertMetadata>

getAlertId

public String getAlertId()

Required. The identifier of the alert this metadata belongs to.

setAlertId

public AlertCenter.Alerts.GetMetadata setAlertId(String alertId)

Required. The identifier of the alert this metadata belongs to.

getCustomerId

public String getCustomerId()

Optional. The unique identifier of the Google Workspace account of the customer the alert metadata is 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.GetMetadata setCustomerId(String customerId)

Optional. The unique identifier of the Google Workspace account of the customer the alert metadata is 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).

set

public AlertCenter.Alerts.GetMetadata set(String parameterName,
                                          Object value)

Overrides:

set in class AlertCenterRequest<AlertMetadata>