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.
-
#fingerprint ⇒ String
Fingerprint of this resource.
-
#health_checks ⇒ Array<String>
List of URLs to the HealthCheck resources.
-
#health_status_aggregation_policy ⇒ String
Optional.
-
#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.
9205 9206 9207 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9205 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
9097 9098 9099 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9097 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
9103 9104 9105 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9103 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.
9114 9115 9116 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9114 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
9125 9126 9127 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9125 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
9136 9137 9138 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9136 def health_status_aggregation_policy @health_status_aggregation_policy 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
9147 9148 9149 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9147 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
9153 9154 9155 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9153 def id @id end |
#kind ⇒ String
[Output only] Type of the resource. Always compute#healthCheckServicefor
health check services.
Corresponds to the JSON property kind
9159 9160 9161 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9159 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
9169 9170 9171 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9169 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
9176 9177 9178 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9176 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
9185 9186 9187 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9185 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
9193 9194 9195 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9193 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
9198 9199 9200 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9198 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
9203 9204 9205 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9203 def self_link_with_id @self_link_with_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 |
# File 'generated/google/apis/compute_alpha/classes.rb', line 9210 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 |