com.google.api.services.monitoring.v3.model

Class UptimeCheckConfig

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.monitoring.v3.model.UptimeCheckConfig

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class UptimeCheckConfig
extends com.google.api.client.json.GenericJson

This message configures which resources and services to monitor for availability.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Monitoring API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
UptimeCheckConfig()

Method Summary

Modifier and Type	Method and Description
UptimeCheckConfig	clone()
String	getCheckerType() The type of checkers to use to execute the Uptime check.
List<ContentMatcher>	getContentMatchers() The content that is expected to appear in the data returned by the target server against which the check is run.
Boolean	getDisabled() Whether the check is disabled or not.
String	getDisplayName() A human-friendly name for the Uptime check configuration.
HttpCheck	getHttpCheck() Contains information needed to make an HTTP or HTTPS check.
List<InternalChecker>	getInternalCheckers() The internal checkers that this check will egress from.
Boolean	getIsInternal() If this is true, then checks are made only from the 'internal_checkers'.
Boolean	getLogCheckFailures() To specify whether to log the results of failed probes to Cloud Logging.
MonitoredResource	getMonitoredResource() The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration.
String	getName() Identifier.
String	getPeriod() How often, in seconds, the Uptime check is performed.
ResourceGroup	getResourceGroup() The group resource associated with the configuration.
List<String>	getSelectedRegions() The list of regions from which the check will be run.
SyntheticMonitorTarget	getSyntheticMonitor() Specifies a Synthetic Monitor to invoke.
TcpCheck	getTcpCheck() Contains information needed to make a TCP check.
String	getTimeout() The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
Map<String,String>	getUserLabels() User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries.
UptimeCheckConfig	set(String fieldName, Object value)
UptimeCheckConfig	setCheckerType(String checkerType) The type of checkers to use to execute the Uptime check.
UptimeCheckConfig	setContentMatchers(List<ContentMatcher> contentMatchers) The content that is expected to appear in the data returned by the target server against which the check is run.
UptimeCheckConfig	setDisabled(Boolean disabled) Whether the check is disabled or not.
UptimeCheckConfig	setDisplayName(String displayName) A human-friendly name for the Uptime check configuration.
UptimeCheckConfig	setHttpCheck(HttpCheck httpCheck) Contains information needed to make an HTTP or HTTPS check.
UptimeCheckConfig	setInternalCheckers(List<InternalChecker> internalCheckers) The internal checkers that this check will egress from.
UptimeCheckConfig	setIsInternal(Boolean isInternal) If this is true, then checks are made only from the 'internal_checkers'.
UptimeCheckConfig	setLogCheckFailures(Boolean logCheckFailures) To specify whether to log the results of failed probes to Cloud Logging.
UptimeCheckConfig	setMonitoredResource(MonitoredResource monitoredResource) The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration.
UptimeCheckConfig	setName(String name) Identifier.
UptimeCheckConfig	setPeriod(String period) How often, in seconds, the Uptime check is performed.
UptimeCheckConfig	setResourceGroup(ResourceGroup resourceGroup) The group resource associated with the configuration.
UptimeCheckConfig	setSelectedRegions(List<String> selectedRegions) The list of regions from which the check will be run.
UptimeCheckConfig	setSyntheticMonitor(SyntheticMonitorTarget syntheticMonitor) Specifies a Synthetic Monitor to invoke.
UptimeCheckConfig	setTcpCheck(TcpCheck tcpCheck) Contains information needed to make a TCP check.
UptimeCheckConfig	setTimeout(String timeout) The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
UptimeCheckConfig	setUserLabels(Map<String,String> userLabels) User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

UptimeCheckConfig

public UptimeCheckConfig()

Method Detail

getCheckerType

public String getCheckerType()

The type of checkers to use to execute the Uptime check.

Returns:

value or null for none

setCheckerType

public UptimeCheckConfig setCheckerType(String checkerType)

The type of checkers to use to execute the Uptime check.

Parameters:

checkerType - checkerType or null for none

getContentMatchers

public List<ContentMatcher> getContentMatchers()

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

Returns:

value or null for none

setContentMatchers

public UptimeCheckConfig setContentMatchers(List<ContentMatcher> contentMatchers)

The content that is expected to appear in the data returned by the target server against which the check is run. Currently, only the first entry in the content_matchers list is supported, and additional entries will be ignored. This field is optional and should only be specified if a content match is required as part of the/ Uptime check.

Parameters:

contentMatchers - contentMatchers or null for none

getDisabled

public Boolean getDisabled()

Whether the check is disabled or not.

Returns:

value or null for none

setDisabled

public UptimeCheckConfig setDisabled(Boolean disabled)

Whether the check is disabled or not.

Parameters:

disabled - disabled or null for none

getDisplayName

public String getDisplayName()

A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

Returns:

value or null for none

setDisplayName

public UptimeCheckConfig setDisplayName(String displayName)

A human-friendly name for the Uptime check configuration. The display name should be unique within a Cloud Monitoring Workspace in order to make it easier to identify; however, uniqueness is not enforced. Required.

Parameters:

displayName - displayName or null for none

getHttpCheck

public HttpCheck getHttpCheck()

Contains information needed to make an HTTP or HTTPS check.

Returns:

value or null for none

setHttpCheck

public UptimeCheckConfig setHttpCheck(HttpCheck httpCheck)

Contains information needed to make an HTTP or HTTPS check.

Parameters:

httpCheck - httpCheck or null for none

getInternalCheckers

public List<InternalChecker> getInternalCheckers()

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Returns:

value or null for none

setInternalCheckers

public UptimeCheckConfig setInternalCheckers(List<InternalChecker> internalCheckers)

The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all the InternalCheckers configured for the project that owns this UptimeCheckConfig.

Parameters:

internalCheckers - internalCheckers or null for none

getIsInternal

public Boolean getIsInternal()

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

Returns:

value or null for none

setIsInternal

public UptimeCheckConfig setIsInternal(Boolean isInternal)

If this is true, then checks are made only from the 'internal_checkers'. If it is false, then checks are made only from the 'selected_regions'. It is an error to provide 'selected_regions' when is_internal is true, or to provide 'internal_checkers' when is_internal is false.

Parameters:

isInternal - isInternal or null for none

getLogCheckFailures

public Boolean getLogCheckFailures()

To specify whether to log the results of failed probes to Cloud Logging.

Returns:

value or null for none

setLogCheckFailures

public UptimeCheckConfig setLogCheckFailures(Boolean logCheckFailures)

To specify whether to log the results of failed probes to Cloud Logging.

Parameters:

logCheckFailures - logCheckFailures or null for none

getMonitoredResource

public MonitoredResource getMonitoredResource()

The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

Returns:

value or null for none

setMonitoredResource

public UptimeCheckConfig setMonitoredResource(MonitoredResource monitoredResource)

The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration. The following monitored resource types are valid for this field: uptime_url, gce_instance, gae_app, aws_ec2_instance, aws_elb_load_balancer k8s_service servicedirectory_service cloud_run_revision

Parameters:

monitoredResource - monitoredResource or null for none

getName

public String getName()

Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Returns:

value or null for none

setName

public UptimeCheckConfig setName(String name)

Identifier. A unique resource name for this Uptime check configuration. The format is: projects/[PROJECT_ID_OR_NUMBER]/uptimeCheckConfigs/[UPTIME_CHECK_ID] [PROJECT_ID_OR_NUMBER] is the Workspace host project associated with the Uptime check.This field should be omitted when creating the Uptime check configuration; on create, the resource name is assigned by the server and included in the response.

Parameters:

name - name or null for none

getPeriod

public String getPeriod()

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

Returns:

value or null for none

setPeriod

public UptimeCheckConfig setPeriod(String period)

How often, in seconds, the Uptime check is performed. Currently, the only supported values are 60s (1 minute), 300s (5 minutes), 600s (10 minutes), and 900s (15 minutes). Optional, defaults to 60s.

Parameters:

period - period or null for none

getResourceGroup

public ResourceGroup getResourceGroup()

The group resource associated with the configuration.

Returns:

value or null for none

setResourceGroup

public UptimeCheckConfig setResourceGroup(ResourceGroup resourceGroup)

The group resource associated with the configuration.

Parameters:

resourceGroup - resourceGroup or null for none

getSelectedRegions

public List<String> getSelectedRegions()

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

Returns:

value or null for none

setSelectedRegions

public UptimeCheckConfig setSelectedRegions(List<String> selectedRegions)

The list of regions from which the check will be run. Some regions contain one location, and others contain more than one. If this field is specified, enough regions must be provided to include a minimum of 3 locations. Not specifying this field will result in Uptime checks running from all available regions.

Parameters:

selectedRegions - selectedRegions or null for none

getSyntheticMonitor

public SyntheticMonitorTarget getSyntheticMonitor()

Specifies a Synthetic Monitor to invoke.

Returns:

value or null for none

setSyntheticMonitor

public UptimeCheckConfig setSyntheticMonitor(SyntheticMonitorTarget syntheticMonitor)

Specifies a Synthetic Monitor to invoke.

Parameters:

syntheticMonitor - syntheticMonitor or null for none

getTcpCheck

public TcpCheck getTcpCheck()

Contains information needed to make a TCP check.

Returns:

value or null for none

setTcpCheck

public UptimeCheckConfig setTcpCheck(TcpCheck tcpCheck)

Contains information needed to make a TCP check.

Parameters:

tcpCheck - tcpCheck or null for none

getTimeout

public String getTimeout()

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Returns:

value or null for none

setTimeout

public UptimeCheckConfig setTimeout(String timeout)

The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.

Parameters:

timeout - timeout or null for none

getUserLabels

public Map<String,String> getUserLabels()

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Returns:

value or null for none

setUserLabels

public UptimeCheckConfig setUserLabels(Map<String,String> userLabels)

User-supplied key/value data to be used for organizing and identifying the UptimeCheckConfig objects.The field can contain up to 64 entries. Each key and value is limited to 63 Unicode characters or 128 bytes, whichever is smaller. Labels and values can contain only lowercase letters, numerals, underscores, and dashes. Keys must begin with a letter.

Parameters:

userLabels - userLabels or null for none

set

public UptimeCheckConfig set(String fieldName,
                             Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public UptimeCheckConfig clone()

Overrides:

clone in class com.google.api.client.json.GenericJson