Class: Ansible::Ruby::Modules::Gcp_healthcheck

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Gcp_healthcheck

Defined in:

lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb

Overview

Create, Update or Destroy a Healthcheck. Currently only HTTP and HTTPS Healthchecks are supported. Healthchecks are used to monitor individual instances, managed instance groups and/or backend services. Healtchecks are reusable. Visit U(cloud.google.com/compute/docs/load-balancing/health-checks) for an overview of Healthchecks on GCP. See U(cloud.google.com/compute/docs/reference/latest/httpHealthChecks) for API details on HTTP Healthchecks. See U(cloud.google.com/compute/docs/reference/latest/httpsHealthChecks) for more details on the HTTPS Healtcheck API.

Instance Method Summary

• #check_interval ⇒ Integer^?

  How often (in seconds) to send a health check.

• #credentials_file ⇒ String^?

  Path to the JSON file associated with the service account email.

• #healthcheck_name ⇒ String

  Name of the Healthcheck.

• #healthcheck_type ⇒ :HTTP, :HTTPS

  Type of Healthcheck.

• #healthy_threshold ⇒ Integer^?

  A so-far unhealthy instance will be marked healthy after this many consecutive successes.

• #host_header ⇒ String

  The value of the host header in the health check request.

• #port ⇒ Object^?

  The TCP port number for the health check request.

• #project_id ⇒ String^?

  Your GCP project ID.

• #request_path ⇒ String^?

  The request path of the HTTPS health check request.

• #service_account_email ⇒ String^?

  Service account email.

• #service_account_permissions ⇒ :bigquery, ...

  Service account permissions (see U(cloud.google.com/sdk/gcloud/reference/compute/instances/create), –scopes section for detailed information).

• #state ⇒ :present, :absent

  State of the Healthcheck.

• #timeout ⇒ Integer^?

  How long (in seconds) to wait for a response before claiming failure.

• #unhealthy_threshold ⇒ Integer^?

  A so-far healthy instance will be marked unhealthy after this many consecutive failures.

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 ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 15

attribute :check_interval

#credentials_file ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 62

attribute :credentials_file

#healthcheck_name ⇒ String

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 19

attribute :healthcheck_name

#healthcheck_type ⇒ :HTTP, :HTTPS

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

attribute :healthcheck_type

#healthy_threshold ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 50

attribute :healthy_threshold

#host_header ⇒ String

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

attribute :host_header

#port ⇒ Object^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 31

attribute :port

#project_id ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 66

attribute :project_id

#request_path ⇒ String^?

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

attribute :request_path

#service_account_email ⇒ String^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 54

attribute :service_account_email

#service_account_permissions ⇒ :bigquery, ...

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 58

attribute :service_account_permissions

#state ⇒ :present, :absent

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

attribute :state

#timeout ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 42

attribute :timeout

#unhealthy_threshold ⇒ Integer^?

# File 'lib/ansible/ruby/modules/generated/cloud/google/gcp_healthcheck.rb', line 46

attribute :unhealthy_threshold