Class: Google::Apis::ComputeAlpha::HealthCheckService
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::HealthCheckService
- 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.
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>
A list of URLs to the HealthCheck resources.
-
#health_status_aggregation_policy ⇒ String
Optional.
-
#health_status_aggregation_strategy ⇒ String
This field is deprecated.
-
#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>
A list of URLs to the NetworkEndpointGroup resources.
-
#notification_endpoints ⇒ Array<String>
A 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.
Constructor Details
#initialize(**args) ⇒ HealthCheckService
Returns a new instance of HealthCheckService.
13259 13260 13261 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13259 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
13144 13145 13146 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13144 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
13150 13151 13152 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13150 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.
13161 13162 13163 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13161 def fingerprint @fingerprint end |
#health_checks ⇒ Array<String>
A list of URLs to the HealthCheck resources. Must have at least one
HealthCheck, and not more than 10 for regional HealthCheckService, and not
more than 1 for global HealthCheckService. HealthCheck resources must have
portSpecification=USE_SERVING_PORT or portSpecification=USE_FIXED_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 must belong
to the same region as zones of NetworkEndpointGroups. For global
HealthCheckService using global INTERNET_IP_PORT NetworkEndpointGroups, the
global HealthChecks must specify sourceRegions, and HealthChecks that specify
sourceRegions can only be used with global INTERNET_IP_PORT
NetworkEndpointGroups.
Corresponds to the JSON property healthChecks
13178 13179 13180 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13178 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 pair in the
health check service. - AND. If any health check of an endpoint reports
UNHEALTHY, then UNHEALTHY is the HealthState of the endpoint. If all health
checks report HEALTHY, the HealthState of the endpoint is HEALTHY. . This is
only allowed with regional HealthCheckService.
Corresponds to the JSON property healthStatusAggregationPolicy
13189 13190 13191 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13189 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
13200 13201 13202 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13200 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
13206 13207 13208 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13206 def id @id end |
#kind ⇒ String
[Output only] Type of the resource. Always compute#healthCheckServicefor
health check services.
Corresponds to the JSON property kind
13212 13213 13214 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13212 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
13222 13223 13224 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13222 def name @name end |
#network_endpoint_groups ⇒ Array<String>
A 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. For global HealthCheckServices, the
NetworkEndpointGroups must be global INTERNET_IP_PORT.
Corresponds to the JSON property
networkEndpointGroups
13230 13231 13232 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13230 def network_endpoint_groups @network_endpoint_groups end |
#notification_endpoints ⇒ Array<String>
A list of URLs to the NotificationEndpoint resources. Must not have more than
- 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
13239 13240 13241 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13239 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
13247 13248 13249 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13247 def region @region end |
#self_link ⇒ String
[Output Only] Server-defined URL for the resource.
Corresponds to the JSON property selfLink
13252 13253 13254 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13252 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
13257 13258 13259 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13257 def self_link_with_id @self_link_with_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
13264 13265 13266 13267 13268 13269 13270 13271 13272 13273 13274 13275 13276 13277 13278 13279 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 13264 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 |