Class: Google::Apis::ComputeV1::HealthCheckService

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/compute_v1/classes.rb,
generated/google/apis/compute_v1/representations.rb,
generated/google/apis/compute_v1/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.



8593
8594
8595
# File 'generated/google/apis/compute_v1/classes.rb', line 8593

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

Instance Attribute Details

#creation_timestampString

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

Returns:

  • (String)


8501
8502
8503
# File 'generated/google/apis/compute_v1/classes.rb', line 8501

def creation_timestamp
  @creation_timestamp
end

#descriptionString

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

Returns:

  • (String)


8507
8508
8509
# File 'generated/google/apis/compute_v1/classes.rb', line 8507

def description
  @description
end

#fingerprintString

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)


8518
8519
8520
# File 'generated/google/apis/compute_v1/classes.rb', line 8518

def fingerprint
  @fingerprint
end

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


8529
8530
8531
# File 'generated/google/apis/compute_v1/classes.rb', line 8529

def health_checks
  @health_checks
end

#health_status_aggregation_policyString

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)


8540
8541
8542
# File 'generated/google/apis/compute_v1/classes.rb', line 8540

def health_status_aggregation_policy
  @health_status_aggregation_policy
end

#idFixnum

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

Returns:

  • (Fixnum)


8546
8547
8548
# File 'generated/google/apis/compute_v1/classes.rb', line 8546

def id
  @id
end

#kindString

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

Returns:

  • (String)


8552
8553
8554
# File 'generated/google/apis/compute_v1/classes.rb', line 8552

def kind
  @kind
end

#nameString

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)


8562
8563
8564
# File 'generated/google/apis/compute_v1/classes.rb', line 8562

def name
  @name
end

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


8569
8570
8571
# File 'generated/google/apis/compute_v1/classes.rb', line 8569

def network_endpoint_groups
  @network_endpoint_groups
end

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


8578
8579
8580
# File 'generated/google/apis/compute_v1/classes.rb', line 8578

def notification_endpoints
  @notification_endpoints
end

#regionString

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


8586
8587
8588
# File 'generated/google/apis/compute_v1/classes.rb', line 8586

def region
  @region
end

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

Returns:

  • (String)


8591
8592
8593
# File 'generated/google/apis/compute_v1/classes.rb', line 8591

def self_link
  @self_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
# File 'generated/google/apis/compute_v1/classes.rb', line 8598

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