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

Inherits:
Base show all
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 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 ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :check_interval

#credentials_file ⇒ String?

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

Returns:

  • (String, nil) —

    Path to the JSON file associated with the service account email



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

attribute :credentials_file

#healthcheck_name ⇒ String

Returns Name of the Healthcheck.

Returns:

  • (String) —

    Name of the Healthcheck.



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

attribute :healthcheck_name

#healthcheck_type ⇒ :HTTP, :HTTPS

Returns Type of Healthcheck.

Returns:

  • (:HTTP, :HTTPS) —

    Type of Healthcheck.



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

attribute :healthcheck_type

#healthy_threshold ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :healthy_threshold

#host_header ⇒ String

Returns The value of the host header in the health check request. If left empty, the public IP on behalf of which this health check is performed will be used.

Returns:

  • (String) —

    The value of the host header in the health check request. If left empty, 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_healthcheck.rb', line 27

attribute :host_header

#port ⇒ Object?

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

Returns:

  • (Object, nil) —

    The TCP port number for the health check request. The default value is 443 for HTTPS and 80 for HTTP.



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

attribute :port

#project_id ⇒ String?

Returns Your GCP project ID.

Returns:

  • (String, nil) —

    Your GCP project ID



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

attribute :project_id

#request_path ⇒ String?

Returns The request path of the HTTPS health check request.

Returns:

  • (String, nil) —

    The request path of the HTTPS health check request.



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

attribute :request_path

#service_account_email ⇒ String?

Returns service account email.

Returns:

  • (String, nil) —

    service account email



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

attribute :service_account_email

#service_account_permissions ⇒ :bigquery, ...

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

Returns:

  • (:bigquery, :"cloud-platform", :"compute-ro", :"compute-rw", :"useraccounts-ro", :"useraccounts-rw", :datastore, :"logging-write", :monitoring, :"sql-admin", :"storage-full", :"storage-ro", :"storage-rw", :taskqueue, :"userinfo-email", nil) —

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



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

attribute :service_account_permissions

#state ⇒ :present, :absent

Returns State of the Healthcheck.

Returns:

  • (:present, :absent) —

    State of the Healthcheck.



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

attribute :state

#timeout ⇒ Integer?

Returns How long (in seconds) to wait for a response before claiming failure. It is invalid for timeout to have a greater value than check_interval.

Returns:

  • (Integer, nil) —

    How long (in seconds) to wait for a response before claiming failure. It is invalid for timeout to have a greater value than check_interval.



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

attribute :timeout

#unhealthy_threshold ⇒ Integer?

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

Returns:

  • (Integer, nil) —

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



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

attribute :unhealthy_threshold