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.



1557
1558
1559
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1557

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

Instance Attribute Details

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



1476
1477
1478
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1476

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) 


1488
1489
1490
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1488

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) 


1498
1499
1500
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1498

def content_type
  @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>) 


1509
1510
1511
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1509

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) 


1518
1519
1520
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1518

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) 


1527
1528
1529
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1527

def path
  @path
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) 


1535
1536
1537
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1535

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) 


1541
1542
1543
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1541

def request_method
  @request_method
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) 


1546
1547
1548
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1546

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) 


1554
1555
1556
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1554

def validate_ssl
  @validate_ssl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
 
# File 'lib/google/apis/monitoring_v3/classes.rb', line 1562

def update!(**args)
  @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)
  @headers = args[:headers] if args.key?(:headers)
  @mask_headers = args[:mask_headers] if args.key?(:mask_headers)
  @path = args[:path] if args.key?(:path)
  @port = args[:port] if args.key?(:port)
  @request_method = args[:request_method] if args.key?(:request_method)
  @use_ssl = args[:use_ssl] if args.key?(:use_ssl)
  @validate_ssl = args[:validate_ssl] if args.key?(:validate_ssl)
end