Class: Google::Apis::ComputeAlpha::HealthCheckService

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

Overview

Represents a Health-Check as a Service resource. (== resource_for $api_version.regionHealthCheckServices ==)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ HealthCheckService

Returns a new instance of HealthCheckService.



10858
10859
10860
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10858

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

Instance Attribute Details

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


10749
10750
10751
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10749

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

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

Returns:

  • (String) 


10755
10756
10757
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10755

def description
  @description
end

#fingerprint ⇒ String

Fingerprint of this resource. A hash of the contents stored in this object. This field is used in optimistic locking. This field will be ignored when inserting a HealthCheckService. An up-to-date fingerprint must be provided in order to patch/update the HealthCheckService; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthCheckService. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


10766
10767
10768
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10766

def fingerprint
  @fingerprint
end

#health_checks ⇒ Array<String>

List of URLs to the HealthCheck resources. Must have at least one HealthCheck, and not more than 10. HealthCheck resources must have portSpecification= USE_SERVING_PORT. For regional HealthCheckService, the HealthCheck must be regional and in the same region. For global HealthCheckService, HealthCheck must be global. Mix of regional and global HealthChecks is not supported. Multiple regional HealthChecks must belong to the same region. Regional HealthChecks</code? must belong to the same region as zones of NEGs. Corresponds to the JSON property healthChecks

Returns:

  • (Array<String>) 


10777
10778
10779
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10777

def health_checks
  @health_checks
end

#health_status_aggregation_policy ⇒ String

Optional. Policy for how the results from multiple health checks for the same endpoint are aggregated. Defaults to NO_AGGREGATION if unspecified.

  • NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
  • AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . Corresponds to the JSON property healthStatusAggregationPolicy

Returns:

  • (String) 


10788
10789
10790
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10788

def health_status_aggregation_policy
  @health_status_aggregation_policy
end

#health_status_aggregation_strategy ⇒ String

This field is deprecated. Use health_status_aggregation_policy instead. Policy for how the results from multiple health checks for the same endpoint are aggregated.

  • NO_AGGREGATION. An EndpointHealth message is returned for each backend in the health check service.
  • AND. If any backend's health check reports UNHEALTHY, then UNHEALTHY is the HealthState of the entire health check service. If all backend's are healthy, the HealthState of the health check service is HEALTHY. . Corresponds to the JSON property healthStatusAggregationStrategy

Returns:

  • (String) 


10800
10801
10802
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10800

def health_status_aggregation_strategy
  @health_status_aggregation_strategy
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


10806
10807
10808
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10806

def id
  @id
end

#kind ⇒ String

[Output only] Type of the resource. Always compute#healthCheckServicefor health check services. Corresponds to the JSON property kind

Returns:

  • (String) 


10812
10813
10814
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10812

def kind
  @kind
end

#name ⇒ String

Name of the resource. 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) 


10822
10823
10824
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10822

def name
  @name
end

#network_endpoint_groups ⇒ Array<String>

List of URLs to the NetworkEndpointGroup resources. Must not have more than

  1. For regional HealthCheckService, NEGs must be in zones in the region of the HealthCheckService. Corresponds to the JSON property networkEndpointGroups

Returns:

  • (Array<String>) 


10829
10830
10831
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10829

def network_endpoint_groups
  @network_endpoint_groups
end

#notification_endpoints ⇒ Array<String>

List of URLs to the NotificationEndpoint resources. Must not have more than 10. A list of endpoints for receiving notifications of change in health status. For regional HealthCheckService, NotificationEndpoint must be regional and in the same region. For global HealthCheckService, NotificationEndpoint must be global. Corresponds to the JSON property notificationEndpoints

Returns:

  • (Array<String>) 


10838
10839
10840
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10838

def notification_endpoints
  @notification_endpoints
end

#region ⇒ String

[Output Only] URL of the region where the health check service resides. This field is not applicable to global health check services. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. Corresponds to the JSON property region

Returns:

  • (String) 


10846
10847
10848
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10846

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


10851
10852
10853
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10851

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


10856
10857
10858
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10856

def self_link_with_id
  @self_link_with_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 10863

def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @fingerprint = args[:fingerprint] if args.key?(:fingerprint)
  @health_checks = args[:health_checks] if args.key?(:health_checks)
  @health_status_aggregation_policy = args[:health_status_aggregation_policy] if args.key?(:health_status_aggregation_policy)
  @health_status_aggregation_strategy = args[:health_status_aggregation_strategy] if args.key?(:health_status_aggregation_strategy)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @network_endpoint_groups = args[:network_endpoint_groups] if args.key?(:network_endpoint_groups)
  @notification_endpoints = args[:notification_endpoints] if args.key?(:notification_endpoints)
  @region = args[:region] if args.key?(:region)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
end