Class: Google::Apis::ComputeV1::CompositeHealthCheck

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.rb

Overview

Represents a composite health check. A composite health check resource specifies the health source resources and the health destination resource to which the aggregated health result from the health source resources is delivered.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CompositeHealthCheck

Returns a new instance of CompositeHealthCheck.



8444
8445
8446
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8444

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

Instance Attribute Details

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


8362
8363
8364
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8362

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) 


8368
8369
8370
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8368

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 CompositeHealthCheck. An up-to-date fingerprint must be provided in order to patch the CompositeHealthCheck; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the CompositeHealthCheck. Corresponds to the JSON property fingerprint NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


8380
8381
8382
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8380

def fingerprint
  @fingerprint
end

#health_destination ⇒ String

URL to the destination resource. Must be set. Must be aForwardingRule. The ForwardingRule must have load balancing scheme INTERNAL orINTERNAL_MANAGED and must be regional and in the same region as the CompositeHealthCheck (cross-region deployment forINTERNAL_MANAGED is not supported). Can be mutated. Corresponds to the JSON property healthDestination

Returns:

  • (String) 


8390
8391
8392
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8390

def health_destination
  @health_destination
end

#health_sources ⇒ Array<String>

URLs to the HealthSource resources whose results are AND'ed. I.e. he aggregated result is is HEALTHY only if all sources are HEALTHY. Must have at least 1. Must not have more than 10. Must be regional and in the same region as theCompositeHealthCheck. Can be mutated. Corresponds to the JSON property healthSources

Returns:

  • (Array<String>) 


8399
8400
8401
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8399

def health_sources
  @health_sources
end

#id ⇒ Fixnum

Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


8406
8407
8408
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8406

def id
  @id
end

#kind ⇒ String

Output only. [Output Only] Type of the resource. Alwayscompute# compositeHealthCheck for composite health checks. Corresponds to the JSON property kind

Returns:

  • (String) 


8412
8413
8414
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8412

def kind
  @kind
end

#name ⇒ String

Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply withRFC1035. 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) 


8423
8424
8425
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8423

def name
  @name
end

#region ⇒ String

Output only. [Output Only] URL of the region where the composite health check resides. This field applies only to the regional resource. 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) 


8432
8433
8434
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8432

def region
  @region
end

#self_link ⇒ String

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

Returns:

  • (String) 


8437
8438
8439
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8437

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL with id for the resource. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


8442
8443
8444
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8442

def self_link_with_id
  @self_link_with_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
 
# File 'lib/google/apis/compute_v1/classes.rb', line 8449

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_destination = args[:health_destination] if args.key?(:health_destination)
  @health_sources = args[:health_sources] if args.key?(:health_sources)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @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