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

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/representations.rb,
generated/google/apis/compute_alpha/representations.rb

Overview

A HealthCheckService defines a set of backends on which to perform periodic health checks and an endpoint to which to send notification of changes in the health status of the backends.

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) ⇒ HealthCheckService

Returns a new instance of HealthCheckService



8419
8420
8421
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8419

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) 


8333
8334
8335
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8333

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) 


8339
8340
8341
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8339

def description
  @description
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>) 


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

def health_checks
  @health_checks
end

#health_status_aggregation_strategy ⇒ String

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) 


8361
8362
8363
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8361

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) 


8367
8368
8369
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8367

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) 


8373
8374
8375
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8373

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) 


8383
8384
8385
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8383

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>) 


8390
8391
8392
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8390

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>) 


8399
8400
8401
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8399

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) 


8407
8408
8409
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8407

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


8412
8413
8414
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8412

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) 


8417
8418
8419
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8417

def self_link_with_id
  @self_link_with_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
 
# File 'generated/google/apis/compute_alpha/classes.rb', line 8424

def update!(**args)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @health_checks = args[:health_checks] if args.key?(:health_checks)
  @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