UptimeCheckConfig (Stackdriver Monitoring API v3 (Rev. 471) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.monitoring.v3.model.UptimeCheckConfig

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.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 Stackdriver 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
  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>

Constructor Summary

Constructors
Constructor and Description

UptimeCheckConfig()

Constructors
Constructor and Description
`UptimeCheckConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UptimeCheckConfig`	`clone()`
`java.util.List<ContentMatcher>`	`getContentMatchers()` The expected content on the page the check is run against.
`java.lang.String`	`getDisplayName()` A human-friendly name for the uptime check configuration.
`HttpCheck`	`getHttpCheck()` Contains information needed to make an HTTP or HTTPS check.
`java.util.List<InternalChecker>`	`getInternalCheckers()` The internal checkers that this check will egress from.
`java.lang.Boolean`	`getIsInternal()` Denotes whether this is a check that egresses from InternalCheckers.
`MonitoredResource`	`getMonitoredResource()` The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration.
`java.lang.String`	`getName()` A unique resource name for this UptimeCheckConfig.
`java.lang.String`	`getPeriod()` How often, in seconds, the uptime check is performed.
`ResourceGroup`	`getResourceGroup()` The group resource associated with the configuration.
`java.util.List<java.lang.String>`	`getSelectedRegions()` The list of regions from which the check will be run.
`TcpCheck`	`getTcpCheck()` Contains information needed to make a TCP check.
`java.lang.String`	`getTimeout()` The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).
`UptimeCheckConfig`	`set(java.lang.String fieldName, java.lang.Object value)`
`UptimeCheckConfig`	`setContentMatchers(java.util.List<ContentMatcher> contentMatchers)` The expected content on the page the check is run against.
`UptimeCheckConfig`	`setDisplayName(java.lang.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(java.util.List<InternalChecker> internalCheckers)` The internal checkers that this check will egress from.
`UptimeCheckConfig`	`setIsInternal(java.lang.Boolean isInternal)` Denotes whether this is a check that egresses from InternalCheckers.
`UptimeCheckConfig`	`setMonitoredResource(MonitoredResource monitoredResource)` The monitored resource (https://cloud.google.com/monitoring/api/resources) associated with the configuration.
`UptimeCheckConfig`	`setName(java.lang.String name)` A unique resource name for this UptimeCheckConfig.
`UptimeCheckConfig`	`setPeriod(java.lang.String period)` How often, in seconds, the uptime check is performed.
`UptimeCheckConfig`	`setResourceGroup(ResourceGroup resourceGroup)` The group resource associated with the configuration.
`UptimeCheckConfig`	`setSelectedRegions(java.util.List<java.lang.String> selectedRegions)` The list of regions from which the check will be run.
`UptimeCheckConfig`	`setTcpCheck(TcpCheck tcpCheck)` Contains information needed to make a TCP check.
`UptimeCheckConfig`	`setTimeout(java.lang.String timeout)` The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds).

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, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, 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
  - getContentMatchers
```
public java.util.List<ContentMatcher> getContentMatchers()
```
    The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.
    
    Returns:
    
    value or null for none
  - setContentMatchers
```
public UptimeCheckConfig setContentMatchers(java.util.List<ContentMatcher> contentMatchers)
```
    The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.
    
    Parameters:
    
    contentMatchers - contentMatchers or null for none
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public UptimeCheckConfig setDisplayName(java.lang.String displayName)
```
    A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account 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 java.util.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 InternalCheckers configured for the project that owns this CheckConfig.
    
    Returns:
    
    value or null for none
  - setInternalCheckers
```
public UptimeCheckConfig setInternalCheckers(java.util.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 InternalCheckers configured for the project that owns this CheckConfig.
    
    Parameters:
    
    internalCheckers - internalCheckers or null for none
  - getIsInternal
```
public java.lang.Boolean getIsInternal()
```
    Denotes whether this is a check that egresses from InternalCheckers.
    
    Returns:
    
    value or null for none
  - setIsInternal
```
public UptimeCheckConfig setIsInternal(java.lang.Boolean isInternal)
```
    Denotes whether this is a check that egresses from InternalCheckers.
    
    Parameters:
    
    isInternal - isInternal 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 supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer
    
    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 supported for uptime checks: uptime_url gce_instance gae_app aws_ec2_instance aws_elb_load_balancer
    
    Parameters:
    
    monitoredResource - monitoredResource or null for none
  - getName
```
public java.lang.String getName()
```
    A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].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(java.lang.String name)
```
    A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].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 java.lang.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 300s.
    
    Returns:
    
    value or null for none
  - setPeriod
```
public UptimeCheckConfig setPeriod(java.lang.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 300s.
    
    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 java.util.List<java.lang.String> getSelectedRegions()
```
    The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
    
    Returns:
    
    value or null for none
  - setSelectedRegions
```
public UptimeCheckConfig setSelectedRegions(java.util.List<java.lang.String> selectedRegions)
```
    The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.
    
    Parameters:
    
    selectedRegions - selectedRegions 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 java.lang.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(java.lang.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
  - set
```
public UptimeCheckConfig set(java.lang.String fieldName,
                             java.lang.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

Stackdriver Monitoring API v3 (revision 471)

Class UptimeCheckConfig

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

Constructor Summary

Method Summary

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

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

UptimeCheckConfig

Method Detail

getContentMatchers

setContentMatchers

getDisplayName

setDisplayName

getHttpCheck

setHttpCheck

getInternalCheckers

setInternalCheckers

getIsInternal

setIsInternal

getMonitoredResource

setMonitoredResource

getName

setName

getPeriod

setPeriod

getResourceGroup

setResourceGroup

getSelectedRegions

setSelectedRegions

getTcpCheck

setTcpCheck

getTimeout

setTimeout

set

clone