com.google.monitoring.v3

Interface UptimeCheckConfig.HttpCheckOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UptimeCheckConfig.HttpCheck, UptimeCheckConfig.HttpCheck.Builder

Enclosing class:

UptimeCheckConfig

public static interface UptimeCheckConfig.HttpCheckOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsHeaders(String key) The list of headers to send as part of the Uptime check request.
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.
int	getAcceptedResponseStatusCodesCount() If present, the check will only pass if the HTTP response status code is in this set of status codes.
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.
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.
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.
UptimeCheckConfig.HttpCheck.BasicAuthentication	getAuthInfo() The authentication information.
UptimeCheckConfig.HttpCheck.BasicAuthenticationOrBuilder	getAuthInfoOrBuilder() The authentication information.
com.google.protobuf.ByteString	getBody() The request body associated with the HTTP POST request.
UptimeCheckConfig.HttpCheck.ContentType	getContentType() The content type header to use for the check.
int	getContentTypeValue() The content type header to use for the check.
String	getCustomContentType() A user provided content type header to use for the check.
com.google.protobuf.ByteString	getCustomContentTypeBytes() A user provided content type header to use for the check.
Map<String,String>	getHeaders() Deprecated.
int	getHeadersCount() The list of headers to send as part of the Uptime check request.
Map<String,String>	getHeadersMap() The list of headers to send as part of the Uptime check request.
String	getHeadersOrDefault(String key, String defaultValue) The list of headers to send as part of the Uptime check request.
String	getHeadersOrThrow(String key) The list of headers to send as part of the Uptime check request.
boolean	getMaskHeaders() Boolean specifying whether to encrypt the header information.
String	getPath() Optional (defaults to "/").
com.google.protobuf.ByteString	getPathBytes() Optional (defaults to "/").
UptimeCheckConfig.PingConfig	getPingConfig() Contains information needed to add pings to an HTTP check.
UptimeCheckConfig.PingConfigOrBuilder	getPingConfigOrBuilder() Contains information needed to add pings to an HTTP check.
int	getPort() Optional (defaults to 80 when `use_ssl` is `false`, and 443 when `use_ssl` is `true`).
UptimeCheckConfig.HttpCheck.RequestMethod	getRequestMethod() The HTTP request method to use for the check.
int	getRequestMethodValue() The HTTP request method to use for the check.
boolean	getUseSsl() If `true`, use HTTPS instead of HTTP to run the check.
boolean	getValidateSsl() Boolean specifying whether to include SSL certificate validation as a part of the Uptime check.
boolean	hasAuthInfo() The authentication information.
boolean	hasPingConfig() Contains information needed to add pings to an HTTP check.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getRequestMethodValue

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:

The enum numeric value on the wire for requestMethod.

getRequestMethod

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:

The requestMethod.

getUseSsl

boolean getUseSsl()

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

bool use_ssl = 1;

Returns:

The useSsl.

getPath

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:

The path.

getPathBytes

com.google.protobuf.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:

The bytes for path.

getPort

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:

The port.

hasAuthInfo

boolean hasAuthInfo()

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

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

Returns:

Whether the authInfo field is set.

getAuthInfo

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:

The authInfo.

getAuthInfoOrBuilder

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;

getMaskHeaders

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:

The maskHeaders.

getHeadersCount

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;

containsHeaders

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;

getHeaders

@Deprecated
Map<String,String> getHeaders()

Deprecated.

Use getHeadersMap() instead.

getHeadersMap

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;

getHeadersOrDefault

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;

getHeadersOrThrow

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;

getContentTypeValue

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:

The enum numeric value on the wire for contentType.

getContentType

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:

The contentType.

getCustomContentType

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:

The customContentType.

getCustomContentTypeBytes

com.google.protobuf.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:

The bytes for customContentType.

getValidateSsl

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:

The validateSsl.

getBody

com.google.protobuf.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:

The body.

getAcceptedResponseStatusCodesList

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;

getAcceptedResponseStatusCodes

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;

getAcceptedResponseStatusCodesCount

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;

getAcceptedResponseStatusCodesOrBuilderList

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;

getAcceptedResponseStatusCodesOrBuilder

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;

hasPingConfig

boolean hasPingConfig()

 Contains information needed to add pings to an HTTP check.
 

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

Returns:

Whether the pingConfig field is set.

getPingConfig

UptimeCheckConfig.PingConfig getPingConfig()

 Contains information needed to add pings to an HTTP check.
 

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

Returns:

The pingConfig.

getPingConfigOrBuilder

UptimeCheckConfig.PingConfigOrBuilder getPingConfigOrBuilder()

 Contains information needed to add pings to an HTTP check.
 

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