Interface UptimeCheckConfig.HttpCheckOrBuilder (3.13.0)

Version 3.13.0

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.6
• 3.3.6
• 3.2.10

public static interface UptimeCheckConfig.HttpCheckOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsHeaders(String key)

public abstract boolean containsHeaders(String key)

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.

map<string, string> headers = 6;

Parameter

Name	Description
key	String

Returns

Type	Description
boolean

getAuthInfo()

public abstract UptimeCheckConfig.HttpCheck.BasicAuthentication getAuthInfo()

The authentication information. Optional when creating an HTTP check; defaults to empty.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Returns

Type	Description
UptimeCheckConfig.HttpCheck.BasicAuthentication	The authInfo.

getAuthInfoOrBuilder()

public abstract UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder getAuthInfoOrBuilder()

The authentication information. Optional when creating an HTTP check; defaults to empty.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Returns

Type	Description
UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder

getBody()

public abstract ByteString 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: As with all bytes fields, JSON representations are base64 encoded. e.g.: "foo=bar" in URL-encoded form is "foo%3Dbar" and in base64 encoding is "Zm9vJTI1M0RiYXI=".

bytes body = 10;

Returns

Type	Description
ByteString	The body.

getContentType()

public abstract UptimeCheckConfig.HttpCheck.ContentType 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.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;

Returns

Type	Description
UptimeCheckConfig.HttpCheck.ContentType	The contentType.

getContentTypeValue()

public abstract int getContentTypeValue()

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.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;

Returns

Type	Description
int	The enum numeric value on the wire for contentType.

getHeaders()

public abstract Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns

Type	Description
Map<String,String>

getHeadersCount()

public abstract int getHeadersCount()

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.

map<string, string> headers = 6;

Returns

Type	Description
int

getHeadersMap()

public abstract Map<String,String> getHeadersMap()

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.

map<string, string> headers = 6;

Returns

Type	Description
Map<String,String>

getHeadersOrDefault(String key, String defaultValue)

public abstract String getHeadersOrDefault(String key, String defaultValue)

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.

map<string, string> headers = 6;

Parameters

Name	Description
key	String
defaultValue	String

Returns

Type	Description
String

getHeadersOrThrow(String key)

public abstract String getHeadersOrThrow(String key)

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.

map<string, string> headers = 6;

Parameter

Name	Description
key	String

Returns

Type	Description
String

getMaskHeaders()

public abstract 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 ******.

bool mask_headers = 5;

Returns

Type	Description
boolean	The maskHeaders.

getPath()

public abstract 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.

string path = 2;

Returns

Type	Description
String	The path.

getPathBytes()

public abstract ByteString getPathBytes()

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.

string path = 2;

Returns

Type	Description
ByteString	The bytes for path.

getPort()

public abstract int 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.

int32 port = 3;

Returns

Type	Description
int	The port.

getRequestMethod()

public abstract UptimeCheckConfig.HttpCheck.RequestMethod getRequestMethod()

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;

Returns

Type	Description
UptimeCheckConfig.HttpCheck.RequestMethod	The requestMethod.

getRequestMethodValue()

public abstract int getRequestMethodValue()

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.RequestMethod request_method = 8;

Returns

Type	Description
int	The enum numeric value on the wire for requestMethod.

getUseSsl()

public abstract boolean getUseSsl()

If true, use HTTPS instead of HTTP to run the check.

bool use_ssl = 1;

Returns

Type	Description
boolean	The useSsl.

getValidateSsl()

public abstract 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.

bool validate_ssl = 7;

Returns

Type	Description
boolean	The validateSsl.

hasAuthInfo()

public abstract boolean hasAuthInfo()

The authentication information. Optional when creating an HTTP check; defaults to empty.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.BasicAuthentication auth_info = 4;

Returns

Type	Description
boolean	Whether the authInfo field is set.