HttpCheck (Cloud Monitoring API v3-rev20251006-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,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 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

HttpCheck()

Constructors
Constructor and Description
`HttpCheck()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`HttpCheck`	`clone()`
`byte[]`	`decodeBody()` The request body associated with the HTTP POST request.
`HttpCheck`	`encodeBody(byte[] body)` The request body associated with the HTTP POST request.
`List<ResponseStatusCode>`	`getAcceptedResponseStatusCodes()` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`BasicAuthentication`	`getAuthInfo()` The authentication information.
`String`	`getBody()` The request body associated with the HTTP POST request.
`String`	`getContentType()` The content type header to use for the check.
`String`	`getCustomContentType()` A user provided content type header to use for the check.
`Map<String,String>`	`getHeaders()` The list of headers to send as part of the Uptime check request.
`Boolean`	`getMaskHeaders()` Boolean specifying whether to encrypt the header information.
`String`	`getPath()` Optional (defaults to "/").
`PingConfig`	`getPingConfig()` Contains information needed to add pings to an HTTP check.
`Integer`	`getPort()` Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
`String`	`getRequestMethod()` The HTTP request method to use for the check.
`ServiceAgentAuthentication`	`getServiceAgentAuthentication()` If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an Authorization header in the HTTP request when probing.
`Boolean`	`getUseSsl()` If true, use HTTPS instead of HTTP to run the check.
`Boolean`	`getValidateSsl()` Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.
`HttpCheck`	`set(String fieldName, Object value)`
`HttpCheck`	`setAcceptedResponseStatusCodes(List<ResponseStatusCode> acceptedResponseStatusCodes)` If present, the check will only pass if the HTTP response status code is in this set of status codes.
`HttpCheck`	`setAuthInfo(BasicAuthentication authInfo)` The authentication information.
`HttpCheck`	`setBody(String body)` The request body associated with the HTTP POST request.
`HttpCheck`	`setContentType(String contentType)` The content type header to use for the check.
`HttpCheck`	`setCustomContentType(String customContentType)` A user provided content type header to use for the check.
`HttpCheck`	`setHeaders(Map<String,String> headers)` The list of headers to send as part of the Uptime check request.
`HttpCheck`	`setMaskHeaders(Boolean maskHeaders)` Boolean specifying whether to encrypt the header information.
`HttpCheck`	`setPath(String path)` Optional (defaults to "/").
`HttpCheck`	`setPingConfig(PingConfig pingConfig)` Contains information needed to add pings to an HTTP check.
`HttpCheck`	`setPort(Integer port)` Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true).
`HttpCheck`	`setRequestMethod(String requestMethod)` The HTTP request method to use for the check.
`HttpCheck`	`setServiceAgentAuthentication(ServiceAgentAuthentication serviceAgentAuthentication)` If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an Authorization header in the HTTP request when probing.
`HttpCheck`	`setUseSsl(Boolean useSsl)` If true, use HTTPS instead of HTTP to run the check.
`HttpCheck`	`setValidateSsl(Boolean validateSsl)` Boolean specifying whether to include SSL certificate validation as a part of the Uptime 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, 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
  - HttpCheck
```
public HttpCheck()
```
- Method Detail
  - getAcceptedResponseStatusCodes
```
public List<ResponseStatusCode> getAcceptedResponseStatusCodes()
```
    If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299.
    
    Returns:
    
    value or null for none
  - setAcceptedResponseStatusCodes
```
public HttpCheck setAcceptedResponseStatusCodes(List<ResponseStatusCode> acceptedResponseStatusCodes)
```
    If present, the check will only pass if the HTTP response status code is in this set of status codes. If empty, the HTTP status code will only pass if the HTTP status code is 200-299.
    
    Parameters:
    
    acceptedResponseStatusCodes - acceptedResponseStatusCodes or null for none
  - getAuthInfo
```
public BasicAuthentication getAuthInfo()
```
    The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.
    
    Returns:
    
    value or null for none
  - setAuthInfo
```
public HttpCheck setAuthInfo(BasicAuthentication authInfo)
```
    The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.
    
    Parameters:
    
    authInfo - authInfo or null for none
  - getBody
```
public String getBody()
```
    The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeBody()
  - decodeBody
```
public byte[] decodeBody()
```
    The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getBody()
  - setBody
```
public HttpCheck setBody(String body)
```
    The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.
    
    Parameters:
    
    body - body or null for none
    
    See Also:
    
    #encodeBody()
  - encodeBody
```
public HttpCheck encodeBody(byte[] body)
```
    The request body associated with the HTTP POST request. If content_type is URL_ENCODED, the body passed in must be URL-encoded. Users can provide a Content-Length header via the headers field or the API will do so. If the request_method is GET and body is not empty, the API will return an error. The maximum byte size is 1 megabyte.Note: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getContentType
```
public String getContentType()
```
    The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
    
    Returns:
    
    value or null for none
  - setContentType
```
public HttpCheck setContentType(String contentType)
```
    The content type header to use for the check. The following configurations result in errors: 1. Content type is specified in both the headers field and the content_type field. 2. Request method is GET and content_type is not TYPE_UNSPECIFIED 3. Request method is POST and content_type is TYPE_UNSPECIFIED. 4. Request method is POST and a "Content-Type" header is provided via headers field. The content_type field should be used instead.
    
    Parameters:
    
    contentType - contentType or null for none
  - getCustomContentType
```
public String getCustomContentType()
```
    A user provided content type header to use for the check. The invalid configurations outlined in the content_type field apply to custom_content_type, as well as the following: 1. content_type is URL_ENCODED and custom_content_type is set. 2. content_type is USER_PROVIDED and custom_content_type is not set.
    
    Returns:
    
    value or null for none
  - setCustomContentType
```
public HttpCheck setCustomContentType(String customContentType)
```
    A user provided content type header to use for the check. The invalid configurations outlined in the content_type field apply to custom_content_type, as well as the following: 1. content_type is URL_ENCODED and custom_content_type is set. 2. content_type is USER_PROVIDED and custom_content_type is not set.
    
    Parameters:
    
    customContentType - customContentType or null for none
  - getHeaders
```
public Map<String,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(Map<String,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 Boolean getMaskHeaders()
```
    Boolean specifying 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(Boolean maskHeaders)
```
    Boolean specifying 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 String getPath()
```
    Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
    
    Returns:
    
    value or null for none
  - setPath
```
public HttpCheck setPath(String path)
```
    Optional (defaults to "/"). The path to the page against which to run the check. Will be combined with the host (specified within the monitored_resource) and port to construct the full URL. If the provided path does not begin with "/", a "/" will be prepended automatically.
    
    Parameters:
    
    path - path or null for none
  - getPingConfig
```
public PingConfig getPingConfig()
```
    Contains information needed to add pings to an HTTP check.
    
    Returns:
    
    value or null for none
  - setPingConfig
```
public HttpCheck setPingConfig(PingConfig pingConfig)
```
    Contains information needed to add pings to an HTTP check.
    
    Parameters:
    
    pingConfig - pingConfig or null for none
  - getPort
```
public Integer getPort()
```
    Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
    
    Returns:
    
    value or null for none
  - setPort
```
public HttpCheck setPort(Integer port)
```
    Optional (defaults to 80 when use_ssl is false, and 443 when use_ssl is true). The TCP port on the HTTP server against which to run the check. Will be combined with host (specified within the monitored_resource) and path to construct the full URL.
    
    Parameters:
    
    port - port or null for none
  - getRequestMethod
```
public String getRequestMethod()
```
    The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
    
    Returns:
    
    value or null for none
  - setRequestMethod
```
public HttpCheck setRequestMethod(String requestMethod)
```
    The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.
    
    Parameters:
    
    requestMethod - requestMethod or null for none
  - getServiceAgentAuthentication
```
public ServiceAgentAuthentication getServiceAgentAuthentication()
```
    If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an Authorization header in the HTTP request when probing.
    
    Returns:
    
    value or null for none
  - setServiceAgentAuthentication
```
public HttpCheck setServiceAgentAuthentication(ServiceAgentAuthentication serviceAgentAuthentication)
```
    If specified, Uptime will generate and attach an OIDC JWT token for the Monitoring service agent service account as an Authorization header in the HTTP request when probing.
    
    Parameters:
    
    serviceAgentAuthentication - serviceAgentAuthentication or null for none
  - getUseSsl
```
public Boolean getUseSsl()
```
    If true, use HTTPS instead of HTTP to run the check.
    
    Returns:
    
    value or null for none
  - setUseSsl
```
public HttpCheck setUseSsl(Boolean useSsl)
```
    If true, use HTTPS instead of HTTP to run the check.
    
    Parameters:
    
    useSsl - useSsl or null for none
  - getValidateSsl
```
public Boolean getValidateSsl()
```
    Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is false, setting validate_ssl to true has no effect.
    
    Returns:
    
    value or null for none
  - setValidateSsl
```
public HttpCheck setValidateSsl(Boolean validateSsl)
```
    Boolean specifying whether to include SSL certificate validation as a part of the Uptime check. Only applies to checks where monitored_resource is set to uptime_url. If use_ssl is false, setting validate_ssl to true has no effect.
    
    Parameters:
    
    validateSsl - validateSsl or null for none
  - set
```
public HttpCheck set(String fieldName,
                     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

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

getAcceptedResponseStatusCodes

setAcceptedResponseStatusCodes

getAuthInfo

setAuthInfo

getBody

decodeBody

setBody

encodeBody

getContentType

setContentType

getCustomContentType

setCustomContentType

getHeaders

setHeaders

getMaskHeaders

setMaskHeaders

getPath

setPath

getPingConfig

setPingConfig

getPort

setPort

getRequestMethod

setRequestMethod

getServiceAgentAuthentication

setServiceAgentAuthentication

getUseSsl

setUseSsl

getValidateSsl

setValidateSsl

set

clone