Class UptimeCheckConfig.HttpCheck.Builder (3.40.0)

public static final class UptimeCheckConfig.HttpCheck.Builder extends GeneratedMessageV3.Builder<UptimeCheckConfig.HttpCheck.Builder> implements UptimeCheckConfig.HttpCheckOrBuilder

Information involved in an HTTP/HTTPS Uptime check request.

Protobuf type google.monitoring.v3.UptimeCheckConfig.HttpCheck

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
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
NameDescription
valueUptimeCheckConfig.HttpCheck.ResponseStatusCode
Returns
TypeDescription
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
NameDescription
builderForValueUptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder
Returns
TypeDescription
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
NameDescription
indexint
valueUptimeCheckConfig.HttpCheck.ResponseStatusCode
Returns
TypeDescription
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
NameDescription
indexint
builderForValueUptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder
Returns
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
valuesIterable<? extends com.google.monitoring.v3.UptimeCheckConfig.HttpCheck.ResponseStatusCode>
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UptimeCheckConfig.HttpCheck.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

build()

public UptimeCheckConfig.HttpCheck build()
Returns
TypeDescription
UptimeCheckConfig.HttpCheck

buildPartial()

public UptimeCheckConfig.HttpCheck buildPartial()
Returns
TypeDescription
UptimeCheckConfig.HttpCheck

clear()

public UptimeCheckConfig.HttpCheck.Builder clear()
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

clearAuthInfo()

public UptimeCheckConfig.HttpCheck.Builder clearAuthInfo()

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

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

Returns
TypeDescription
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
TypeDescription
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:

  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
TypeDescription
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:

  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
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public UptimeCheckConfig.HttpCheck.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

clearHeaders()

public UptimeCheckConfig.HttpCheck.Builder clearHeaders()
Returns
TypeDescription
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
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public UptimeCheckConfig.HttpCheck.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

clearUseSsl()

public UptimeCheckConfig.HttpCheck.Builder clearUseSsl()

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

bool use_ssl = 1;

Returns
TypeDescription
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
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

clone()

public UptimeCheckConfig.HttpCheck.Builder clone()
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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.

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

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.BasicAuthentication

The authInfo.

getAuthInfoBuilder()

public UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder getAuthInfoBuilder()

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

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

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.BasicAuthentication.Builder

getAuthInfoOrBuilder()

public UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder getAuthInfoOrBuilder()

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

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

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder

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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for customContentType.

getDefaultInstanceForType()

public UptimeCheckConfig.HttpCheck getDefaultInstanceForType()
Returns
TypeDescription
UptimeCheckConfig.HttpCheck

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getHeaders() (deprecated)

public Map<String,String> getHeaders()

Use #getHeadersMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
boolean

The maskHeaders.

getMutableHeaders() (deprecated)

public Map<String,String> getMutableHeaders()

Use alternate mutation accessors instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for requestMethod.

getUseSsl()

public boolean getUseSsl()

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

bool use_ssl = 1;

Returns
TypeDescription
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
TypeDescription
boolean

The validateSsl.

hasAuthInfo()

public boolean hasAuthInfo()

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

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

Returns
TypeDescription
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
TypeDescription
boolean

Whether the pingConfig field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

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.

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

Parameter
NameDescription
valueUptimeCheckConfig.HttpCheck.BasicAuthentication
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

mergeFrom(UptimeCheckConfig.HttpCheck other)

public UptimeCheckConfig.HttpCheck.Builder mergeFrom(UptimeCheckConfig.HttpCheck other)
Parameter
NameDescription
otherUptimeCheckConfig.HttpCheck
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UptimeCheckConfig.HttpCheck.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public UptimeCheckConfig.HttpCheck.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
valueUptimeCheckConfig.PingConfig
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UptimeCheckConfig.HttpCheck.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
indexint
valueUptimeCheckConfig.HttpCheck.ResponseStatusCode
Returns
TypeDescription
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
NameDescription
indexint
builderForValueUptimeCheckConfig.HttpCheck.ResponseStatusCode.Builder
Returns
TypeDescription
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.

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

Parameter
NameDescription
valueUptimeCheckConfig.HttpCheck.BasicAuthentication
Returns
TypeDescription
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.

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

Parameter
NameDescription
builderForValueUptimeCheckConfig.HttpCheck.BasicAuthentication.Builder
Returns
TypeDescription
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
NameDescription
valueByteString

The body to set.

Returns
TypeDescription
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:

  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;

Parameter
NameDescription
valueUptimeCheckConfig.HttpCheck.ContentType

The contentType to set.

Returns
TypeDescription
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:

  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;

Parameter
NameDescription
valueint

The enum numeric value on the wire for contentType to set.

Returns
TypeDescription
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:

  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;

Parameter
NameDescription
valueString

The customContentType to set.

Returns
TypeDescription
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:

  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;

Parameter
NameDescription
valueByteString

The bytes for customContentType to set.

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public UptimeCheckConfig.HttpCheck.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
valueboolean

The maskHeaders to set.

Returns
TypeDescription
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
NameDescription
valueString

The path to set.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes for path to set.

Returns
TypeDescription
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
NameDescription
valueUptimeCheckConfig.PingConfig
Returns
TypeDescription
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
NameDescription
builderForValueUptimeCheckConfig.PingConfig.Builder
Returns
TypeDescription
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
NameDescription
valueint

The port to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
valueUptimeCheckConfig.HttpCheck.RequestMethod

The requestMethod to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for requestMethod to set.

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UptimeCheckConfig.HttpCheck.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder
Overrides

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
NameDescription
valueboolean

The useSsl to set.

Returns
TypeDescription
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
NameDescription
valueboolean

The validateSsl to set.

Returns
TypeDescription
UptimeCheckConfig.HttpCheck.Builder

This builder for chaining.