Class: Google::Apis::MonitoringV3::HttpCheck

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/monitoring_v3/classes.rb,
lib/google/apis/monitoring_v3/representations.rb,
lib/google/apis/monitoring_v3/representations.rb

Overview

Information involved in an HTTP/HTTPS Uptime check request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HttpCheck

Returns a new instance of HttpCheck.



1952
1953
1954
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1952

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accepted_response_status_codes ⇒ Array<Google::Apis::MonitoringV3::ResponseStatusCode>

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. Corresponds to the JSON property acceptedResponseStatusCodes

Returns:



1841
1842
1843
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1841

def accepted_response_status_codes
  @accepted_response_status_codes
end

#auth_info ⇒ Google::Apis::MonitoringV3::BasicAuthentication

The authentication parameters to provide to the specified resource or URL that requires a username and password. Currently, only Basic HTTP authentication ( https://tools.ietf.org/html/rfc7617) is supported in Uptime checks. Corresponds to the JSON property authInfo

Returns:



1848
1849
1850
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1848

def auth_info
  @auth_info
end

#body ⇒ String

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. Corresponds to the JSON property body NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1860
1861
1862
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1860

def body
  @body
end

#content_type ⇒ String

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. Corresponds to the JSON property contentType

Returns:

  • (String) 


1870
1871
1872
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1870

def content_type
  @content_type
end

#custom_content_type ⇒ String

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. Corresponds to the JSON property customContentType

Returns:

  • (String) 


1879
1880
1881
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1879

def custom_content_type
  @custom_content_type
end

#headers ⇒ Hash<String,String>

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. Corresponds to the JSON property headers

Returns:

  • (Hash<String,String>) 


1890
1891
1892
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1890

def headers
  @headers
end

#mask_headers ⇒ Boolean Also known as: mask_headers?

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 ******. Corresponds to the JSON property maskHeaders

Returns:

  • (Boolean) 


1899
1900
1901
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1899

def mask_headers
  @mask_headers
end

#path ⇒ String

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. Corresponds to the JSON property path

Returns:

  • (String) 


1908
1909
1910
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1908

def path
  @path
end

#ping_config ⇒ Google::Apis::MonitoringV3::PingConfig

Information involved in sending ICMP pings alongside public HTTP/TCP checks. For HTTP, the pings are performed for each part of the redirect chain. Corresponds to the JSON property pingConfig

Returns:



1914
1915
1916
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1914

def ping_config
  @ping_config
end

#port ⇒ Fixnum

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. Corresponds to the JSON property port

Returns:

  • (Fixnum) 


1922
1923
1924
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1922

def port
  @port
end

#request_method ⇒ String

The HTTP request method to use for the check. If set to METHOD_UNSPECIFIED then request_method defaults to GET. Corresponds to the JSON property requestMethod

Returns:

  • (String) 


1928
1929
1930
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1928

def request_method
  @request_method
end

#service_agent_authentication ⇒ Google::Apis::MonitoringV3::ServiceAgentAuthentication

Contains information needed for generating either an OpenID Connect token ( https://developers.google.com/identity/protocols/OpenIDConnect) or OAuth token (https://developers.google.com/identity/protocols/oauth2). The token will be generated for the Monitoring service agent service account. Corresponds to the JSON property serviceAgentAuthentication

Returns:



1936
1937
1938
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1936

def service_agent_authentication
  @service_agent_authentication
end

#use_ssl ⇒ Boolean Also known as: use_ssl?

If true, use HTTPS instead of HTTP to run the check. Corresponds to the JSON property useSsl

Returns:

  • (Boolean) 


1941
1942
1943
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1941

def use_ssl
  @use_ssl
end

#validate_ssl ⇒ Boolean Also known as: validate_ssl?

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. Corresponds to the JSON property validateSsl

Returns:

  • (Boolean) 


1949
1950
1951
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1949

def validate_ssl
  @validate_ssl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1957

def update!(**args)
  @accepted_response_status_codes = args[:accepted_response_status_codes] if args.key?(:accepted_response_status_codes)
  @auth_info = args[:auth_info] if args.key?(:auth_info)
  @body = args[:body] if args.key?(:body)
  @content_type = args[:content_type] if args.key?(:content_type)
  @custom_content_type = args[:custom_content_type] if args.key?(:custom_content_type)
  @headers = args[:headers] if args.key?(:headers)
  @mask_headers = args[:mask_headers] if args.key?(:mask_headers)
  @path = args[:path] if args.key?(:path)
  @ping_config = args[:ping_config] if args.key?(:ping_config)
  @port = args[:port] if args.key?(:port)
  @request_method = args[:request_method] if args.key?(:request_method)
  @service_agent_authentication = args[:service_agent_authentication] if args.key?(:service_agent_authentication)
  @use_ssl = args[:use_ssl] if args.key?(:use_ssl)
  @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl)
end