com.google.api.services.monitoring.v3

Class Monitoring.Projects.AlertPolicies.List

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.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.monitoring.v3.MonitoringRequest<ListAlertPoliciesResponse>

com.google.api.services.monitoring.v3.Monitoring.Projects.AlertPolicies.List

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

Enclosing class:

Monitoring.Projects.AlertPolicies

public class Monitoring.Projects.AlertPolicies.List
extends MonitoringRequest<ListAlertPoliciesResponse>

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

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

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

java.util.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(java.lang.String name) Lists the existing alerting policies for the project.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
java.lang.String	getFilter() If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering.
java.lang.String	getName() The project whose alert policies are to be listed.
java.lang.String	getOrderBy() A comma-separated list of fields by which to sort the result.
java.lang.Integer	getPageSize() The maximum number of results to return in a single response.
java.lang.String	getPageToken() If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method.
Monitoring.Projects.AlertPolicies.List	set(java.lang.String parameterName, java.lang.Object value)
Monitoring.Projects.AlertPolicies.List	set$Xgafv(java.lang.String $Xgafv) V1 error format.
Monitoring.Projects.AlertPolicies.List	setAccessToken(java.lang.String accessToken) OAuth access token.
Monitoring.Projects.AlertPolicies.List	setAlt(java.lang.String alt) Data format for response.
Monitoring.Projects.AlertPolicies.List	setCallback(java.lang.String callback) JSONP
Monitoring.Projects.AlertPolicies.List	setFields(java.lang.String fields) Selector specifying which fields to include in a partial response.
Monitoring.Projects.AlertPolicies.List	setFilter(java.lang.String filter) If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering.
Monitoring.Projects.AlertPolicies.List	setKey(java.lang.String key) API key.
Monitoring.Projects.AlertPolicies.List	setName(java.lang.String name) The project whose alert policies are to be listed.
Monitoring.Projects.AlertPolicies.List	setOauthToken(java.lang.String oauthToken) OAuth 2.0 token for the current user.
Monitoring.Projects.AlertPolicies.List	setOrderBy(java.lang.String orderBy) A comma-separated list of fields by which to sort the result.
Monitoring.Projects.AlertPolicies.List	setPageSize(java.lang.Integer pageSize) The maximum number of results to return in a single response.
Monitoring.Projects.AlertPolicies.List	setPageToken(java.lang.String pageToken) If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method.
Monitoring.Projects.AlertPolicies.List	setPrettyPrint(java.lang.Boolean prettyPrint) Returns response with indentations and line breaks.
Monitoring.Projects.AlertPolicies.List	setQuotaUser(java.lang.String quotaUser) Available to use for quota purposes for server-side applications.
Monitoring.Projects.AlertPolicies.List	setUploadProtocol(java.lang.String uploadProtocol) Upload protocol for media (e.g.
Monitoring.Projects.AlertPolicies.List	setUploadType(java.lang.String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.monitoring.v3.MonitoringRequest

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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, 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(java.lang.String name)

Lists the existing alerting policies for the project. Create a request for the method "alertPolicies.list". This request holds the parameters needed by the the monitoring server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Monitoring.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

name - The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

Since:

1.13

Method Detail

executeUsingHead

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

Overrides:

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

Throws:

java.io.IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

java.io.IOException

set$Xgafv

public Monitoring.Projects.AlertPolicies.List set$Xgafv(java.lang.String $Xgafv)

Description copied from class: MonitoringRequest

V1 error format.

Overrides:

set$Xgafv in class MonitoringRequest<ListAlertPoliciesResponse>

setAccessToken

public Monitoring.Projects.AlertPolicies.List setAccessToken(java.lang.String accessToken)

Description copied from class: MonitoringRequest

OAuth access token.

Overrides:

setAccessToken in class MonitoringRequest<ListAlertPoliciesResponse>

setAlt

public Monitoring.Projects.AlertPolicies.List setAlt(java.lang.String alt)

Description copied from class: MonitoringRequest

Data format for response.

Overrides:

setAlt in class MonitoringRequest<ListAlertPoliciesResponse>

setCallback

public Monitoring.Projects.AlertPolicies.List setCallback(java.lang.String callback)

Description copied from class: MonitoringRequest

JSONP

Overrides:

setCallback in class MonitoringRequest<ListAlertPoliciesResponse>

setFields

public Monitoring.Projects.AlertPolicies.List setFields(java.lang.String fields)

Description copied from class: MonitoringRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class MonitoringRequest<ListAlertPoliciesResponse>

setKey

public Monitoring.Projects.AlertPolicies.List setKey(java.lang.String key)

Description copied from class: MonitoringRequest

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 MonitoringRequest<ListAlertPoliciesResponse>

setOauthToken

public Monitoring.Projects.AlertPolicies.List setOauthToken(java.lang.String oauthToken)

Description copied from class: MonitoringRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class MonitoringRequest<ListAlertPoliciesResponse>

setPrettyPrint

public Monitoring.Projects.AlertPolicies.List setPrettyPrint(java.lang.Boolean prettyPrint)

Description copied from class: MonitoringRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class MonitoringRequest<ListAlertPoliciesResponse>

setQuotaUser

public Monitoring.Projects.AlertPolicies.List setQuotaUser(java.lang.String quotaUser)

Description copied from class: MonitoringRequest

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 MonitoringRequest<ListAlertPoliciesResponse>

setUploadType

public Monitoring.Projects.AlertPolicies.List setUploadType(java.lang.String uploadType)

Description copied from class: MonitoringRequest

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

Overrides:

setUploadType in class MonitoringRequest<ListAlertPoliciesResponse>

setUploadProtocol

public Monitoring.Projects.AlertPolicies.List setUploadProtocol(java.lang.String uploadProtocol)

Description copied from class: MonitoringRequest

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

Overrides:

setUploadProtocol in class MonitoringRequest<ListAlertPoliciesResponse>

getName

public java.lang.String getName()

The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

setName

public Monitoring.Projects.AlertPolicies.List setName(java.lang.String name)

The project whose alert policies are to be listed. The format is projects/[PROJECT_ID] Note that this field names the parent container in which the alerting policies to be listed are stored. To retrieve a single alerting policy by name, use the GetAlertPolicy operation, instead.

getFilter

public java.lang.String getFilter()

If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering.

setFilter

public Monitoring.Projects.AlertPolicies.List setFilter(java.lang.String filter)

If provided, this field specifies the criteria that must be met by alert policies to be included in the response.For more details, see sorting and filtering.

getOrderBy

public java.lang.String getOrderBy()

A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering.

setOrderBy

public Monitoring.Projects.AlertPolicies.List setOrderBy(java.lang.String orderBy)

A comma-separated list of fields by which to sort the result. Supports the same set of field references as the filter field. Entries can be prefixed with a minus sign to sort by the field in descending order.For more details, see sorting and filtering.

getPageToken

public java.lang.String getPageToken()

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

setPageToken

public Monitoring.Projects.AlertPolicies.List setPageToken(java.lang.String pageToken)

If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.

getPageSize

public java.lang.Integer getPageSize()

The maximum number of results to return in a single response.

setPageSize

public Monitoring.Projects.AlertPolicies.List setPageSize(java.lang.Integer pageSize)

The maximum number of results to return in a single response.

set

public Monitoring.Projects.AlertPolicies.List set(java.lang.String parameterName,
                                                  java.lang.Object value)

Overrides:

set in class MonitoringRequest<ListAlertPoliciesResponse>