Class: Google::Apis::ComputeAlpha::HealthCheckService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HealthCheckService
- 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
-
#creation_timestamp ⇒ String
[Output Only] Creation timestamp in RFC3339 text format.
-
#description ⇒ String
An optional description of this resource.
-
#health_checks ⇒ Array<String>
List of URLs to the HealthCheck resources.
-
#health_status_aggregation_strategy ⇒ String
Policy for how the results from multiple health checks for the same endpoint are aggregated.
-
#id ⇒ Fixnum
[Output Only] The unique identifier for the resource.
-
#kind ⇒ String
[Output only] Type of the resource.
-
#name ⇒ String
Name of the resource.
-
#network_endpoint_groups ⇒ Array<String>
List of URLs to the NetworkEndpointGroup resources.
-
#notification_endpoints ⇒ Array<String>
List of URLs to the NotificationEndpoint resources.
-
#region ⇒ String
[Output Only] URL of the region where the health check service resides.
-
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
-
#self_link_with_id ⇒ String
[Output Only] Server-defined URL with id for the resource.
Instance Method Summary collapse
-
#initialize(**args) ⇒ HealthCheckService
constructor
A new instance of HealthCheckService.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Google::Apis::Core::JsonObjectSupport
Methods included from Google::Apis::Core::Hashable
Constructor Details
#initialize(**args) ⇒ HealthCheckService
Returns a new instance of HealthCheckService
8905 8906 8907 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8905 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
8819 8820 8821 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8819 def @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
8825 8826 8827 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8825 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
8836 8837 8838 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8836 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
8847 8848 8849 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8847 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
8853 8854 8855 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8853 def id @id end |
#kind ⇒ String
[Output only] Type of the resource. Always compute#healthCheckServicefor
health check services.
Corresponds to the JSON property kind
8859 8860 8861 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8859 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
8869 8870 8871 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8869 def name @name end |
#network_endpoint_groups ⇒ Array<String>
List of URLs to the NetworkEndpointGroup resources. Must not have more than
- For regional HealthCheckService, NEGs must be in zones in the region of
the HealthCheckService.
Corresponds to the JSON property
networkEndpointGroups
8876 8877 8878 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8876 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
8885 8886 8887 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8885 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
8893 8894 8895 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8893 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
8898 8899 8900 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8898 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
8903 8904 8905 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8903 def self_link_with_id @self_link_with_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8910 8911 8912 8913 8914 8915 8916 8917 8918 8919 8920 8921 8922 8923 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 8910 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 |