Interface UptimeCheckConfig.HttpCheckOrBuilder (3.47.0)

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

getAcceptedResponseStatusCodes(int index)

public abstract UptimeCheckConfig.HttpCheck.ResponseStatusCode getAcceptedResponseStatusCodes(int index)

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.

repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;

Parameter
Name Description
index int
Returns
Type Description
UptimeCheckConfig.HttpCheck.ResponseStatusCode

getAcceptedResponseStatusCodesCount()

public abstract int getAcceptedResponseStatusCodesCount()

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.

repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;

Returns
Type Description
int

getAcceptedResponseStatusCodesList()

public abstract List<UptimeCheckConfig.HttpCheck.ResponseStatusCode> getAcceptedResponseStatusCodesList()

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.

repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;

Returns
Type Description
List<ResponseStatusCode>

getAcceptedResponseStatusCodesOrBuilder(int index)

public abstract UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder getAcceptedResponseStatusCodesOrBuilder(int index)

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.

repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;

Parameter
Name Description
index int
Returns
Type Description
UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder

getAcceptedResponseStatusCodesOrBuilderList()

public abstract List<? extends UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder> getAcceptedResponseStatusCodesOrBuilderList()

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.

repeated .google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode accepted_response_status_codes = 11;

Returns
Type Description
List<? extends com.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder>

getAuthInfo()

public abstract UptimeCheckConfig.HttpCheck.BasicAuthentication getAuthInfo()

The authentication information. Optional when creating an HTTP check; defaults to empty. Do not set both auth_method and auth_info.

.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. Do not set both auth_method and auth_info.

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

Returns
Type Description
UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder

getAuthMethodCase()

public abstract UptimeCheckConfig.HttpCheck.AuthMethodCase getAuthMethodCase()
Returns
Type Description
UptimeCheckConfig.HttpCheck.AuthMethodCase

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: If client libraries aren't used (which performs the conversion automatically) base64 encode your body data since the field is of bytes type.

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.

getCustomContentType()

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

string custom_content_type = 13;

Returns
Type Description
String

The customContentType.

getCustomContentTypeBytes()

public abstract ByteString getCustomContentTypeBytes()

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.

string custom_content_type = 13;

Returns
Type Description
ByteString

The bytes for customContentType.

getHeaders() (deprecated)

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.

getPingConfig()

public abstract UptimeCheckConfig.PingConfig getPingConfig()

Contains information needed to add pings to an HTTP check.

.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;

Returns
Type Description
UptimeCheckConfig.PingConfig

The pingConfig.

getPingConfigOrBuilder()

public abstract UptimeCheckConfig.PingConfigOrBuilder getPingConfigOrBuilder()

Contains information needed to add pings to an HTTP check.

.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;

Returns
Type Description
UptimeCheckConfig.PingConfigOrBuilder

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.

getServiceAgentAuthentication()

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

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication service_agent_authentication = 14;

Returns
Type Description
UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication

The serviceAgentAuthentication.

getServiceAgentAuthenticationOrBuilder()

public abstract UptimeCheckConfig.HttpCheck.ServiceAgentAuthenticationOrBuilder getServiceAgentAuthenticationOrBuilder()

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.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication service_agent_authentication = 14;

Returns
Type Description
UptimeCheckConfig.HttpCheck.ServiceAgentAuthenticationOrBuilder

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. Do not set both auth_method and auth_info.

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

Returns
Type Description
boolean

Whether the authInfo field is set.

hasPingConfig()

public abstract boolean hasPingConfig()

Contains information needed to add pings to an HTTP check.

.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;

Returns
Type Description
boolean

Whether the pingConfig field is set.

hasServiceAgentAuthentication()

public abstract boolean hasServiceAgentAuthentication()

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.

.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication service_agent_authentication = 14;

Returns
Type Description
boolean

Whether the serviceAgentAuthentication field is set.