Class: Google::Apis::ComputeAlpha::HttpHealthCheck

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

Overview

Represents a legacy HTTP Health Check resource. Legacy health checks are required by network load balancers. For more information, read Health Check Concepts.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ HttpHealthCheck

Returns a new instance of HttpHealthCheck



8395
8396
8397
# File 'generated/google/apis/compute_alpha/classes.rb', line 8395

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

Instance Attribute Details

#check_interval_secFixnum

How often (in seconds) to send a health check. The default value is 5 seconds. Corresponds to the JSON property checkIntervalSec

Returns:

  • (Fixnum)


9674
9675
9676
# File 'generated/google/apis/compute_alpha/classes.rb', line 9674

def check_interval_sec
  @check_interval_sec
end

#creation_timestampString

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String)


9679
9680
9681
# File 'generated/google/apis/compute_alpha/classes.rb', line 9679

def creation_timestamp
  @creation_timestamp
end

#descriptionString

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String)


9685
9686
9687
# File 'generated/google/apis/compute_alpha/classes.rb', line 9685

def description
  @description
end

#healthy_thresholdFixnum

A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. Corresponds to the JSON property healthyThreshold

Returns:

  • (Fixnum)


9691
9692
9693
# File 'generated/google/apis/compute_alpha/classes.rb', line 9691

def healthy_threshold
  @healthy_threshold
end

#hostString

The value of the host header in the HTTP health check request. If left empty ( default value), the public IP on behalf of which this health check is performed will be used. Corresponds to the JSON property host

Returns:

  • (String)


8343
8344
8345
# File 'generated/google/apis/compute_alpha/classes.rb', line 8343

def host
  @host
end

#idFixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum)


9704
9705
9706
# File 'generated/google/apis/compute_alpha/classes.rb', line 9704

def id
  @id
end

#kindString

[Output Only] Type of the resource. Always compute#httpHealthCheck for HTTP health checks. Corresponds to the JSON property kind

Returns:

  • (String)


9710
9711
9712
# File 'generated/google/apis/compute_alpha/classes.rb', line 9710

def kind
  @kind
end

#nameString

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a- z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Corresponds to the JSON property name

Returns:

  • (String)


9720
9721
9722
# File 'generated/google/apis/compute_alpha/classes.rb', line 9720

def name
  @name
end

#portFixnum

The TCP port number for the HTTP health check request. The default value is 80. Corresponds to the JSON property port

Returns:

  • (Fixnum)


8349
8350
8351
# File 'generated/google/apis/compute_alpha/classes.rb', line 8349

def port
  @port
end

#port_nameString

Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence. Corresponds to the JSON property portName

Returns:

  • (String)


8355
8356
8357
# File 'generated/google/apis/compute_alpha/classes.rb', line 8355

def port_name
  @port_name
end

#port_specificationString

Specifies how port is selected for health checking, can be one of following values: USE_FIXED_PORT: The port number in port is used for health checking. USE_NAMED_PORT: The portName is used for health checking. USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP health check follows behavior specified in port and portName fields. Corresponds to the JSON property portSpecification

Returns:

  • (String)


8375
8376
8377
# File 'generated/google/apis/compute_alpha/classes.rb', line 8375

def port_specification
  @port_specification
end

#proxy_headerString

Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Corresponds to the JSON property proxyHeader

Returns:

  • (String)


8381
8382
8383
# File 'generated/google/apis/compute_alpha/classes.rb', line 8381

def proxy_header
  @proxy_header
end

#request_pathString

The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Corresponds to the JSON property requestPath

Returns:

  • (String)


8386
8387
8388
# File 'generated/google/apis/compute_alpha/classes.rb', line 8386

def request_path
  @request_path
end

#responseString

The string to match anywhere in the first 1024 bytes of the response body. If left empty (the default value), the status code determines health. The response data can only be ASCII. Corresponds to the JSON property response

Returns:

  • (String)


8393
8394
8395
# File 'generated/google/apis/compute_alpha/classes.rb', line 8393

def response
  @response
end

[Output Only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String)


9736
9737
9738
# File 'generated/google/apis/compute_alpha/classes.rb', line 9736

def self_link
  @self_link
end

[Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String)


9741
9742
9743
# File 'generated/google/apis/compute_alpha/classes.rb', line 9741

def self_link_with_id
  @self_link_with_id
end

#timeout_secFixnum

How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec. Corresponds to the JSON property timeoutSec

Returns:

  • (Fixnum)


9748
9749
9750
# File 'generated/google/apis/compute_alpha/classes.rb', line 9748

def timeout_sec
  @timeout_sec
end

#unhealthy_thresholdFixnum

A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. Corresponds to the JSON property unhealthyThreshold

Returns:

  • (Fixnum)


9754
9755
9756
# File 'generated/google/apis/compute_alpha/classes.rb', line 9754

def unhealthy_threshold
  @unhealthy_threshold
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8400
8401
8402
8403
8404
8405
8406
8407
8408
# File 'generated/google/apis/compute_alpha/classes.rb', line 8400

def update!(**args)
  @host = args[:host] if args.key?(:host)
  @port = args[:port] if args.key?(:port)
  @port_name = args[:port_name] if args.key?(:port_name)
  @port_specification = args[:port_specification] if args.key?(:port_specification)
  @proxy_header = args[:proxy_header] if args.key?(:proxy_header)
  @request_path = args[:request_path] if args.key?(:request_path)
  @response = args[:response] if args.key?(:response)
end