Class: Ansible::Ruby::Modules::Gcp_compute_http_health_check

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb

Overview

An HttpHealthCheck resource. This resource defines a template for how individual VMs should be checked for health, via HTTP.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#check_interval_sec ⇒ Integer?

Returns How often (in seconds) to send a health check. The default value is 5 seconds.

Returns:

  • (Integer, nil) —

    How often (in seconds) to send a health check. The default value is 5 seconds.



16
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 16

attribute :check_interval_sec

#description ⇒ Object?

Returns An optional description of this resource. Provide this property when you create the resource.

Returns:

  • (Object, nil) —

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



20
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 20

attribute :description

#healthy_threshold ⇒ Integer?

Returns A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

Returns:

  • (Integer, nil) —

    A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.



23
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 23

attribute :healthy_threshold

#host ⇒ Object?

Returns 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.

Returns:

  • (Object, nil) —

    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.



27
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 27

attribute :host

#name ⇒ String

Returns 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])?` 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.

Returns:

  • (String) —

    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])?` 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.



30
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 30

attribute :name

#port ⇒ Integer?

Returns The TCP port number for the HTTP health check request.,The default value is 80.

Returns:

  • (Integer, nil) —

    The TCP port number for the HTTP health check request.,The default value is 80.



34
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 34

attribute :port

#request_path ⇒ Object?

Returns The request path of the HTTP health check request.,The default value is /.

Returns:

  • (Object, nil) —

    The request path of the HTTP health check request.,The default value is /.



38
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 38

attribute :request_path

#state ⇒ :present, ...

Returns Whether the given object should exist in GCP.

Returns:

  • (:present, :absent, nil) —

    Whether the given object should exist in GCP



12
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 12

attribute :state

#timeout_sec ⇒ Integer?

Returns 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.

Returns:

  • (Integer, nil) —

    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.



41
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 41

attribute :timeout_sec

#unhealthy_threshold ⇒ Integer?

Returns A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Returns:

  • (Integer, nil) —

    A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.



45
 
# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_compute_http_health_check.rb', line 45

attribute :unhealthy_threshold