Class UptimeCheckConfig.HttpCheck (3.46.0)

See more code actions.
public static final class UptimeCheckConfig.HttpCheck extends GeneratedMessageV3 implements UptimeCheckConfig.HttpCheckOrBuilder

Information involved in an HTTP/HTTPS Uptime check request.

Protobuf type google.monitoring.v3.UptimeCheckConfig.HttpCheck

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ACCEPTED_RESPONSE_STATUS_CODES_FIELD_NUMBER

public static final int ACCEPTED_RESPONSE_STATUS_CODES_FIELD_NUMBER
Field Value
Type Description
int

AUTH_INFO_FIELD_NUMBER

public static final int AUTH_INFO_FIELD_NUMBER
Field Value
Type Description
int

BODY_FIELD_NUMBER

public static final int BODY_FIELD_NUMBER
Field Value
Type Description
int

CONTENT_TYPE_FIELD_NUMBER

public static final int CONTENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

CUSTOM_CONTENT_TYPE_FIELD_NUMBER

public static final int CUSTOM_CONTENT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

HEADERS_FIELD_NUMBER

public static final int HEADERS_FIELD_NUMBER
Field Value
Type Description
int

MASK_HEADERS_FIELD_NUMBER

public static final int MASK_HEADERS_FIELD_NUMBER
Field Value
Type Description
int

PATH_FIELD_NUMBER

public static final int PATH_FIELD_NUMBER
Field Value
Type Description
int

PING_CONFIG_FIELD_NUMBER

public static final int PING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

PORT_FIELD_NUMBER

public static final int PORT_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_METHOD_FIELD_NUMBER

public static final int REQUEST_METHOD_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_AGENT_AUTHENTICATION_FIELD_NUMBER

public static final int SERVICE_AGENT_AUTHENTICATION_FIELD_NUMBER
Field Value
Type Description
int

USE_SSL_FIELD_NUMBER

public static final int USE_SSL_FIELD_NUMBER
Field Value
Type Description
int

VALIDATE_SSL_FIELD_NUMBER

public static final int VALIDATE_SSL_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UptimeCheckConfig.HttpCheck getDefaultInstance()
Returns
Type Description
UptimeCheckConfig.HttpCheck

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static UptimeCheckConfig.HttpCheck.Builder newBuilder()
Returns
Type Description
UptimeCheckConfig.HttpCheck.Builder

newBuilder(UptimeCheckConfig.HttpCheck prototype)

public static UptimeCheckConfig.HttpCheck.Builder newBuilder(UptimeCheckConfig.HttpCheck prototype)
Parameter
Name Description
prototype UptimeCheckConfig.HttpCheck
Returns
Type Description
UptimeCheckConfig.HttpCheck.Builder

parseDelimitedFrom(InputStream input)

public static UptimeCheckConfig.HttpCheck parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UptimeCheckConfig.HttpCheck parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UptimeCheckConfig.HttpCheck parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UptimeCheckConfig.HttpCheck parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UptimeCheckConfig.HttpCheck parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UptimeCheckConfig.HttpCheck parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UptimeCheckConfig.HttpCheck parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UptimeCheckConfig.HttpCheck
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UptimeCheckConfig.HttpCheck> parser()
Returns
Type Description
Parser<HttpCheck>

Methods

containsHeaders(String key)

public 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAcceptedResponseStatusCodes(int index)

public 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

getAcceptedResponseStatusCodesCount()

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

getAcceptedResponseStatusCodesOrBuilderList()

public 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 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 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;

getAuthMethodCase()

public UptimeCheckConfig.HttpCheck.AuthMethodCase getAuthMethodCase()

getBody()

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

getDefaultInstanceForType()

public UptimeCheckConfig.HttpCheck getDefaultInstanceForType()
Returns
Type Description
UptimeCheckConfig.HttpCheck

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
Type Description
Map<String,String>

getHeadersCount()

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

getParserForType()

public Parser<UptimeCheckConfig.HttpCheck> getParserForType()
Returns
Type Description
Parser<HttpCheck>
Overrides

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.

string path = 2;

Returns
Type Description
String

The path.

getPathBytes()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceAgentAuthentication()

public 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 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;

getUseSsl()

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

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UptimeCheckConfig.HttpCheck.Builder newBuilderForType()
Returns
Type Description
UptimeCheckConfig.HttpCheck.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UptimeCheckConfig.HttpCheck.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UptimeCheckConfig.HttpCheck.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UptimeCheckConfig.HttpCheck.Builder toBuilder()
Returns
Type Description
UptimeCheckConfig.HttpCheck.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException