com.google.api.services.monitoring.v3

Class Monitoring.Projects.AlertPolicies.Patch

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.monitoring.v3.MonitoringRequest<AlertPolicy>

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Monitoring.Projects.AlertPolicies

public class Monitoring.Projects.AlertPolicies.Patch
extends MonitoringRequest<AlertPolicy>

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	Patch(String name, AlertPolicy content) Updates an alerting policy.

Method Summary

Modifier and Type	Method and Description
String	getName() Identifier.
String	getUpdateMask() Optional.
Monitoring.Projects.AlertPolicies.Patch	set(String parameterName, Object value)
Monitoring.Projects.AlertPolicies.Patch	set$Xgafv(String $Xgafv) V1 error format.
Monitoring.Projects.AlertPolicies.Patch	setAccessToken(String accessToken) OAuth access token.
Monitoring.Projects.AlertPolicies.Patch	setAlt(String alt) Data format for response.
Monitoring.Projects.AlertPolicies.Patch	setCallback(String callback) JSONP
Monitoring.Projects.AlertPolicies.Patch	setFields(String fields) Selector specifying which fields to include in a partial response.
Monitoring.Projects.AlertPolicies.Patch	setKey(String key) API key.
Monitoring.Projects.AlertPolicies.Patch	setName(String name) Identifier.
Monitoring.Projects.AlertPolicies.Patch	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Monitoring.Projects.AlertPolicies.Patch	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Monitoring.Projects.AlertPolicies.Patch	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Monitoring.Projects.AlertPolicies.Patch	setUpdateMask(String updateMask) Optional.
Monitoring.Projects.AlertPolicies.Patch	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Monitoring.Projects.AlertPolicies.Patch	setUploadType(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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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

Patch

protected Patch(String name,
                AlertPolicy content)

Updates an alerting policy. You can either replace the entire policy with a new one or replace only certain fields in the current alerting policy by specifying the fields to be updated via updateMask. Returns the updated alerting policy.Design your application to single-thread API calls that modify the state of alerting policies in a single project. This includes calls to CreateAlertPolicy, DeleteAlertPolicy and UpdateAlertPolicy. Create a request for the method "alertPolicies.patch". 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 - Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

content - the AlertPolicy

Since:

1.13

Method Detail

set$Xgafv

public Monitoring.Projects.AlertPolicies.Patch set$Xgafv(String $Xgafv)

Description copied from class: MonitoringRequest

V1 error format.

Overrides:

set$Xgafv in class MonitoringRequest<AlertPolicy>

setAccessToken

public Monitoring.Projects.AlertPolicies.Patch setAccessToken(String accessToken)

Description copied from class: MonitoringRequest

OAuth access token.

Overrides:

setAccessToken in class MonitoringRequest<AlertPolicy>

setAlt

public Monitoring.Projects.AlertPolicies.Patch setAlt(String alt)

Description copied from class: MonitoringRequest

Data format for response.

Overrides:

setAlt in class MonitoringRequest<AlertPolicy>

setCallback

public Monitoring.Projects.AlertPolicies.Patch setCallback(String callback)

Description copied from class: MonitoringRequest

JSONP

Overrides:

setCallback in class MonitoringRequest<AlertPolicy>

setFields

public Monitoring.Projects.AlertPolicies.Patch setFields(String fields)

Description copied from class: MonitoringRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class MonitoringRequest<AlertPolicy>

setKey

public Monitoring.Projects.AlertPolicies.Patch setKey(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<AlertPolicy>

setOauthToken

public Monitoring.Projects.AlertPolicies.Patch setOauthToken(String oauthToken)

Description copied from class: MonitoringRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class MonitoringRequest<AlertPolicy>

setPrettyPrint

public Monitoring.Projects.AlertPolicies.Patch setPrettyPrint(Boolean prettyPrint)

Description copied from class: MonitoringRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class MonitoringRequest<AlertPolicy>

setQuotaUser

public Monitoring.Projects.AlertPolicies.Patch setQuotaUser(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<AlertPolicy>

setUploadType

public Monitoring.Projects.AlertPolicies.Patch setUploadType(String uploadType)

Description copied from class: MonitoringRequest

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

Overrides:

setUploadType in class MonitoringRequest<AlertPolicy>

setUploadProtocol

public Monitoring.Projects.AlertPolicies.Patch setUploadProtocol(String uploadProtocol)

Description copied from class: MonitoringRequest

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

Overrides:

setUploadProtocol in class MonitoringRequest<AlertPolicy>

getName

public String getName()

Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

setName

public Monitoring.Projects.AlertPolicies.Patch setName(String name)

Identifier. Required if the policy exists. The resource name for this policy. The format is: projects/[PROJECT_ID_OR_NUMBER]/alertPolicies/[ALERT_POLICY_ID] [ALERT_POLICY_ID] is assigned by Cloud Monitoring when the policy is created. When calling the alertPolicies.create method, do not include the name field in the alerting policy passed as part of the request.

getUpdateMask

public String getUpdateMask()

Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.

setUpdateMask

public Monitoring.Projects.AlertPolicies.Patch setUpdateMask(String updateMask)

Optional. A list of alerting policy field names. If this field is not empty, each listed field in the existing alerting policy is set to the value of the corresponding field in the supplied policy (alert_policy), or to the field's default value if the field is not in the supplied alerting policy. Fields not listed retain their previous value.Examples of valid field masks include display_name, documentation, documentation.content, documentation.mime_type, user_labels, user_label.nameofkey, enabled, conditions, combiner, etc.If this field is empty, then the supplied alerting policy replaces the existing policy. It is the same as deleting the existing policy and adding the supplied policy, except for the following: The new policy will have the same [ALERT_POLICY_ID] as the former policy. This gives you continuity with the former policy in your notifications and incidents. Conditions in the new policy will keep their former [CONDITION_ID] if the supplied condition includes the name field with that [CONDITION_ID]. If the supplied condition omits the name field, then a new [CONDITION_ID] is created.

set

public Monitoring.Projects.AlertPolicies.Patch set(String parameterName,
                                                   Object value)

Overrides:

set in class MonitoringRequest<AlertPolicy>