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

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

Overview

Information involved in an HTTP/HTTPS Uptime check request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HttpCheck

Returns a new instance of HttpCheck



1160
1161
1162
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1160

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:



1107
1108
1109
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1107

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


1118
1119
1120
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1118

def headers
  @headers
end

#mask_headers ⇒ Boolean Also known as: mask_headers?

Boolean specifiying 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) 


1127
1128
1129
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1127

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) 


1136
1137
1138
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1136

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) 


1144
1145
1146
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1144

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


1149
1150
1151
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1149

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) 


1157
1158
1159
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1157

def validate_ssl
  @validate_ssl
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1165
1166
1167
1168
1169
1170
1171
1172
1173
 
# File 'generated/google/apis/monitoring_v3/classes.rb', line 1165

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