- 3.54.0 (latest)
- 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 final class UptimeCheckConfig.HttpCheck.Builder extends GeneratedMessageV3.Builder<UptimeCheckConfig.HttpCheck.Builder> implements UptimeCheckConfig.HttpCheckOrBuilderInformation involved in an HTTP/HTTPS Uptime check request.
Protobuf type google.monitoring.v3.UptimeCheckConfig.HttpCheck
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UptimeCheckConfig.HttpCheck.BuilderImplements
UptimeCheckConfig.HttpCheckOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAcceptedResponseStatusCodes(UptimeCheckConfig.HttpCheck.ResponseStatusCode value)
public UptimeCheckConfig.HttpCheck.Builder addAcceptedResponseStatusCodes(UptimeCheckConfig.HttpCheck.ResponseStatusCode value)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 |
value |
UptimeCheckConfig.HttpCheck.ResponseStatusCode |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
addAcceptedResponseStatusCodes(UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder addAcceptedResponseStatusCodes(UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)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 |
builderForValue |
UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
addAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode value)
public UptimeCheckConfig.HttpCheck.Builder addAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
UptimeCheckConfig.HttpCheck.ResponseStatusCode |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
addAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder addAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
addAcceptedResponseStatusCodesBuilder()
public UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder addAcceptedResponseStatusCodesBuilder()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 |
UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder |
|
addAcceptedResponseStatusCodesBuilder(int index)
public UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder addAcceptedResponseStatusCodesBuilder(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.Builder |
|
addAllAcceptedResponseStatusCodes(Iterable<? extends UptimeCheckConfig.HttpCheck.ResponseStatusCode> values)
public UptimeCheckConfig.HttpCheck.Builder addAllAcceptedResponseStatusCodes(Iterable<? extends UptimeCheckConfig.HttpCheck.ResponseStatusCode> values)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 |
values |
Iterable<? extends com.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode> |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public UptimeCheckConfig.HttpCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
build()
public UptimeCheckConfig.HttpCheck build()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck |
|
buildPartial()
public UptimeCheckConfig.HttpCheck buildPartial()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck |
|
clear()
public UptimeCheckConfig.HttpCheck.Builder clear()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearAcceptedResponseStatusCodes()
public UptimeCheckConfig.HttpCheck.Builder clearAcceptedResponseStatusCodes()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 |
UptimeCheckConfig.HttpCheck.Builder |
|
clearAuthInfo()
public UptimeCheckConfig.HttpCheck.Builder clearAuthInfo() 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.Builder |
|
clearAuthMethod()
public UptimeCheckConfig.HttpCheck.Builder clearAuthMethod()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearBody()
public UptimeCheckConfig.HttpCheck.Builder clearBody() 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 |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearContentType()
public UptimeCheckConfig.HttpCheck.Builder clearContentType()The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headersfield and thecontent_typefield. - Request method is
GETandcontent_typeis notTYPE_UNSPECIFIED - Request method is
POSTandcontent_typeisTYPE_UNSPECIFIED. - Request method is
POSTand a "Content-Type" header is provided viaheadersfield. Thecontent_typefield should be used instead.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearCustomContentType()
public UptimeCheckConfig.HttpCheck.Builder clearCustomContentType() 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:
content_typeisURL_ENCODEDandcustom_content_typeis set.content_typeisUSER_PROVIDEDandcustom_content_typeis not set.
string custom_content_type = 13;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public UptimeCheckConfig.HttpCheck.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearHeaders()
public UptimeCheckConfig.HttpCheck.Builder clearHeaders()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearMaskHeaders()
public UptimeCheckConfig.HttpCheck.Builder clearMaskHeaders() 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 |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public UptimeCheckConfig.HttpCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearPath()
public UptimeCheckConfig.HttpCheck.Builder clearPath() 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 |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearPingConfig()
public UptimeCheckConfig.HttpCheck.Builder clearPingConfig()Contains information needed to add pings to an HTTP check.
.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
clearPort()
public UptimeCheckConfig.HttpCheck.Builder clearPort() 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 |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearRequestMethod()
public UptimeCheckConfig.HttpCheck.Builder clearRequestMethod() 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.Builder |
This builder for chaining. |
clearServiceAgentAuthentication()
public UptimeCheckConfig.HttpCheck.Builder clearServiceAgentAuthentication() 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.Builder |
|
clearUseSsl()
public UptimeCheckConfig.HttpCheck.Builder clearUseSsl() If true, use HTTPS instead of HTTP to run the check.
bool use_ssl = 1;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clearValidateSsl()
public UptimeCheckConfig.HttpCheck.Builder clearValidateSsl() 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 |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
clone()
public UptimeCheckConfig.HttpCheck.Builder clone()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
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 |
|
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 |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.ResponseStatusCode |
|
getAcceptedResponseStatusCodesBuilder(int index)
public UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder getAcceptedResponseStatusCodesBuilder(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.Builder |
|
getAcceptedResponseStatusCodesBuilderList()
public List<UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder> getAcceptedResponseStatusCodesBuilderList()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<Builder> |
|
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 |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.ResponseStatusCodeOrBuilder |
|
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. |
getAuthInfoBuilder()
public UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder getAuthInfoBuilder() 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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder |
|
getAuthMethodCase()
public UptimeCheckConfig.HttpCheck.AuthMethodCase getAuthMethodCase()| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.AuthMethodCase |
|
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:
- Content type is specified in both the
headersfield and thecontent_typefield. - Request method is
GETandcontent_typeis notTYPE_UNSPECIFIED - Request method is
POSTandcontent_typeisTYPE_UNSPECIFIED. - Request method is
POSTand a "Content-Type" header is provided viaheadersfield. Thecontent_typefield 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:
- Content type is specified in both the
headersfield and thecontent_typefield. - Request method is
GETandcontent_typeis notTYPE_UNSPECIFIED - Request method is
POSTandcontent_typeisTYPE_UNSPECIFIED. - Request method is
POSTand a "Content-Type" header is provided viaheadersfield. Thecontent_typefield 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:
content_typeisURL_ENCODEDandcustom_content_typeis set.content_typeisUSER_PROVIDEDandcustom_content_typeis 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:
content_typeisURL_ENCODEDandcustom_content_typeis set.content_typeisUSER_PROVIDEDandcustom_content_typeis 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 |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
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. |
getMutableHeaders() (deprecated)
public Map<String,String> getMutableHeaders()Use alternate mutation accessors instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
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. |
getPingConfigBuilder()
public UptimeCheckConfig.PingConfig.Builder getPingConfigBuilder()Contains information needed to add pings to an HTTP check.
.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.PingConfig.Builder |
|
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. |
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. |
getServiceAgentAuthenticationBuilder()
public UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication.Builder getServiceAgentAuthenticationBuilder() 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.Builder |
|
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;
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.ServiceAgentAuthenticationOrBuilder |
|
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. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
internalGetMutableMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)| Parameter | |
|---|---|
| Name | Description |
number |
int |
| Returns | |
|---|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication value)
public UptimeCheckConfig.HttpCheck.Builder mergeAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.BasicAuthentication |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
mergeFrom(UptimeCheckConfig.HttpCheck other)
public UptimeCheckConfig.HttpCheck.Builder mergeFrom(UptimeCheckConfig.HttpCheck other)| Parameter | |
|---|---|
| Name | Description |
other |
UptimeCheckConfig.HttpCheck |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public UptimeCheckConfig.HttpCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public UptimeCheckConfig.HttpCheck.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
mergePingConfig(UptimeCheckConfig.PingConfig value)
public UptimeCheckConfig.HttpCheck.Builder mergePingConfig(UptimeCheckConfig.PingConfig value)Contains information needed to add pings to an HTTP check.
.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.PingConfig |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
mergeServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication value)
public UptimeCheckConfig.HttpCheck.Builder mergeServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final UptimeCheckConfig.HttpCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
putAllHeaders(Map<String,String> values)
public UptimeCheckConfig.HttpCheck.Builder putAllHeaders(Map<String,String> values)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 |
values |
Map<String,String> |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
putHeaders(String key, String value)
public UptimeCheckConfig.HttpCheck.Builder putHeaders(String key, String value)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 |
value |
String |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
removeAcceptedResponseStatusCodes(int index)
public UptimeCheckConfig.HttpCheck.Builder removeAcceptedResponseStatusCodes(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.Builder |
|
removeHeaders(String key)
public UptimeCheckConfig.HttpCheck.Builder removeHeaders(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 |
UptimeCheckConfig.HttpCheck.Builder |
|
setAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode value)
public UptimeCheckConfig.HttpCheck.Builder setAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode value)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
UptimeCheckConfig.HttpCheck.ResponseStatusCode |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder setAcceptedResponseStatusCodes(int index, UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder builderForValue)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;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
UptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication value)
public UptimeCheckConfig.HttpCheck.Builder setAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.BasicAuthentication |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder setAuthInfo(UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setBody(ByteString value)
public UptimeCheckConfig.HttpCheck.Builder setBody(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe body to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setContentType(UptimeCheckConfig.HttpCheck.ContentType value)
public UptimeCheckConfig.HttpCheck.Builder setContentType(UptimeCheckConfig.HttpCheck.ContentType value)The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headersfield and thecontent_typefield. - Request method is
GETandcontent_typeis notTYPE_UNSPECIFIED - Request method is
POSTandcontent_typeisTYPE_UNSPECIFIED. - Request method is
POSTand a "Content-Type" header is provided viaheadersfield. Thecontent_typefield should be used instead.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.ContentTypeThe contentType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setContentTypeValue(int value)
public UptimeCheckConfig.HttpCheck.Builder setContentTypeValue(int value)The content type header to use for the check. The following configurations result in errors:
- Content type is specified in both the
headersfield and thecontent_typefield. - Request method is
GETandcontent_typeis notTYPE_UNSPECIFIED - Request method is
POSTandcontent_typeisTYPE_UNSPECIFIED. - Request method is
POSTand a "Content-Type" header is provided viaheadersfield. Thecontent_typefield should be used instead.
.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ContentType content_type = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for contentType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setCustomContentType(String value)
public UptimeCheckConfig.HttpCheck.Builder setCustomContentType(String value) 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:
content_typeisURL_ENCODEDandcustom_content_typeis set.content_typeisUSER_PROVIDEDandcustom_content_typeis not set.
string custom_content_type = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customContentType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setCustomContentTypeBytes(ByteString value)
public UptimeCheckConfig.HttpCheck.Builder setCustomContentTypeBytes(ByteString value) 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:
content_typeisURL_ENCODEDandcustom_content_typeis set.content_typeisUSER_PROVIDEDandcustom_content_typeis not set.
string custom_content_type = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customContentType to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public UptimeCheckConfig.HttpCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setMaskHeaders(boolean value)
public UptimeCheckConfig.HttpCheck.Builder setMaskHeaders(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe maskHeaders to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setPath(String value)
public UptimeCheckConfig.HttpCheck.Builder setPath(String value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe path to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setPathBytes(ByteString value)
public UptimeCheckConfig.HttpCheck.Builder setPathBytes(ByteString value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for path to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setPingConfig(UptimeCheckConfig.PingConfig value)
public UptimeCheckConfig.HttpCheck.Builder setPingConfig(UptimeCheckConfig.PingConfig value)Contains information needed to add pings to an HTTP check.
.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.PingConfig |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setPingConfig(UptimeCheckConfig.PingConfig.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder setPingConfig(UptimeCheckConfig.PingConfig.Builder builderForValue)Contains information needed to add pings to an HTTP check.
.google.monitoring.v3.UptimeCheckConfig.PingConfig ping_config = 12;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.PingConfig.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setPort(int value)
public UptimeCheckConfig.HttpCheck.Builder setPort(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe port to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public UptimeCheckConfig.HttpCheck.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setRequestMethod(UptimeCheckConfig.HttpCheck.RequestMethod value)
public UptimeCheckConfig.HttpCheck.Builder setRequestMethod(UptimeCheckConfig.HttpCheck.RequestMethod value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.RequestMethodThe requestMethod to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setRequestMethodValue(int value)
public UptimeCheckConfig.HttpCheck.Builder setRequestMethodValue(int value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for requestMethod to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication value)
public UptimeCheckConfig.HttpCheck.Builder setServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication.Builder builderForValue)
public UptimeCheckConfig.HttpCheck.Builder setServiceAgentAuthentication(UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication.Builder builderForValue) 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;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UptimeCheckConfig.HttpCheck.ServiceAgentAuthentication.Builder |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final UptimeCheckConfig.HttpCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
|
setUseSsl(boolean value)
public UptimeCheckConfig.HttpCheck.Builder setUseSsl(boolean value) If true, use HTTPS instead of HTTP to run the check.
bool use_ssl = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe useSsl to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |
setValidateSsl(boolean value)
public UptimeCheckConfig.HttpCheck.Builder setValidateSsl(boolean value) 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;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe validateSsl to set. |
| Returns | |
|---|---|
| Type | Description |
UptimeCheckConfig.HttpCheck.Builder |
This builder for chaining. |