HttpCheck (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.HttpCheck

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class HttpCheck
extends com.google.api.client.json.GenericJson
```
Information involved in an HTTP/HTTPS uptime check request.
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

HttpCheck()

Constructors
Constructor and Description
`HttpCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpCheck`	`clone()`
`BasicAuthentication`	`getAuthInfo()` The authentication information.
`java.util.Map<java.lang.String,java.lang.String>`	`getHeaders()` The list of headers to send as part of the uptime check request.
`java.lang.Boolean`	`getMaskHeaders()` Boolean specifiying whether to encrypt the header information.
`java.lang.String`	`getPath()` The path to the page to run the check against.
`java.lang.Integer`	`getPort()` The port to the page to run the check against.
`java.lang.Boolean`	`getUseSsl()` If true, use HTTPS instead of HTTP to run the check.
`HttpCheck`	`set(java.lang.String fieldName, java.lang.Object value)`
`HttpCheck`	`setAuthInfo(BasicAuthentication authInfo)` The authentication information.
`HttpCheck`	`setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)` The list of headers to send as part of the uptime check request.
`HttpCheck`	`setMaskHeaders(java.lang.Boolean maskHeaders)` Boolean specifiying whether to encrypt the header information.
`HttpCheck`	`setPath(java.lang.String path)` The path to the page to run the check against.
`HttpCheck`	`setPort(java.lang.Integer port)` The port to the page to run the check against.
`HttpCheck`	`setUseSsl(java.lang.Boolean useSsl)` If true, use HTTPS instead of HTTP to run the check.

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
  - HttpCheck
```
public HttpCheck()
```
- Method Detail
  - getAuthInfo
```
public BasicAuthentication getAuthInfo()
```
    The authentication information. Optional when creating an HTTP check; defaults to empty.
    
    Returns:
    
    value or null for none
  - setAuthInfo
```
public HttpCheck setAuthInfo(BasicAuthentication authInfo)
```
    The authentication information. Optional when creating an HTTP check; defaults to empty.
    
    Parameters:
    
    authInfo - authInfo or null for none
  - getHeaders
```
public java.util.Map<java.lang.String,java.lang.String> getHeaders()
```
    The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
    
    Returns:
    
    value or null for none
  - setHeaders
```
public HttpCheck setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
```
    The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second. The maximum number of headers allowed is 100.
    
    Parameters:
    
    headers - headers or null for none
  - getMaskHeaders
```
public java.lang.Boolean getMaskHeaders()
```
    Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
    
    Returns:
    
    value or null for none
  - setMaskHeaders
```
public HttpCheck setMaskHeaders(java.lang.Boolean maskHeaders)
```
    Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.
    
    Parameters:
    
    maskHeaders - maskHeaders or null for none
  - getPath
```
public java.lang.String getPath()
```
    The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").
    
    Returns:
    
    value or null for none
  - setPath
```
public HttpCheck setPath(java.lang.String path)
```
    The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to "/").
    
    Parameters:
    
    path - path or null for none
  - getPort
```
public java.lang.Integer getPort()
```
    The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).
    
    Returns:
    
    value or null for none
  - setPort
```
public HttpCheck setPort(java.lang.Integer port)
```
    The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).
    
    Parameters:
    
    port - port or null for none
  - getUseSsl
```
public java.lang.Boolean getUseSsl()
```
    If true, use HTTPS instead of HTTP to run the check.
    
    Returns:
    
    value or null for none
  - setUseSsl
```
public HttpCheck setUseSsl(java.lang.Boolean useSsl)
```
    If true, use HTTPS instead of HTTP to run the check.
    
    Parameters:
    
    useSsl - useSsl or null for none
  - set
```
public HttpCheck set(java.lang.String fieldName,
                     java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public HttpCheck clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Stackdriver Monitoring API v3 (revision 471)

Class HttpCheck

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

HttpCheck

Method Detail

getAuthInfo

setAuthInfo

getHeaders

setHeaders

getMaskHeaders

setMaskHeaders

getPath

setPath

getPort

setPort

getUseSsl

setUseSsl

set

clone