Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::HealthSource (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::HealthSource.

Represents a health source.

A health source resource specifies the source resources and the health aggregation policy applied to the source resources to determine the aggregated health status.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#creation_timestamp

def creation_timestamp() -> ::String

Returns

(::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

Returns

(::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#description

def description() -> ::String

Returns

(::String) — An optional description of this resource. Provide this property when you create the resource.

#description=

def description=(value) -> ::String

Parameter

value (::String) — An optional description of this resource. Provide this property when you create the resource.

Returns

(::String) — An optional description of this resource. Provide this property when you create the resource.

#fingerprint

def fingerprint() -> ::String

Returns

(::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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.

#fingerprint=

def fingerprint=(value) -> ::String

Parameter

value (::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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.

Returns

(::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 HealthSource. An up-to-date fingerprint must be provided in order to patch the HealthSource; Otherwise, the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make a get() request to retrieve the HealthSource.

#health_aggregation_policy

def health_aggregation_policy() -> ::String

Returns

(::String) — URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.

#health_aggregation_policy=

def health_aggregation_policy=(value) -> ::String

Parameter

value (::String) — URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.

Returns

(::String) — URL to the HealthAggregationPolicy resource. Must be set. Must be regional and in the same region as the HealthSource. Can be mutated.

#id

def id() -> ::Integer

Returns

(::Integer) — Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.

#id=

def id=(value) -> ::Integer

Parameter

value (::Integer) — Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.

Returns

(::Integer) — Output only. [Output Only] A unique identifier for this resource type. The server generates this identifier.

#kind

def kind() -> ::String

Returns

(::String) — Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.

#kind=

def kind=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.

Returns

(::String) — Output only. [Output Only] Type of the resource. Alwayscompute#healthSource for health sources.

#name

def name() -> ::String

Returns

(::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.

#name=

def name=(value) -> ::String

Parameter

value (::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.

Returns

(::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.

#region

def region() -> ::String

Returns

(::String) — Output only. [Output Only] URL of the region where the health source 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.

#region=

def region=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] URL of the region where the health source 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.

Returns

(::String) — Output only. [Output Only] URL of the region where the health source 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.

#self_link

def self_link() -> ::String

Returns

(::String) — Output only. [Output Only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] Server-defined URL for the resource.

Returns

(::String) — Output only. [Output Only] Server-defined URL for the resource.

#self_link_with_id

def self_link_with_id() -> ::String

Returns

(::String) — Output only. [Output Only] Server-defined URL with id for the resource.

#self_link_with_id=

def self_link_with_id=(value) -> ::String

Parameter

value (::String) — Output only. [Output Only] Server-defined URL with id for the resource.

Returns

(::String) — Output only. [Output Only] Server-defined URL with id for the resource.

#source_type

def source_type() -> ::String

Returns

(::String) — Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated. Check the SourceType enum for the list of possible values.

#source_type=

def source_type=(value) -> ::String

Parameter

value (::String) — Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated. Check the SourceType enum for the list of possible values.

Returns

(::String) — Specifies the type of the HealthSource. The only allowed value is BACKEND_SERVICE. Must be specified when theHealthSource is created, and cannot be mutated. Check the SourceType enum for the list of possible values.

#sources

def sources() -> ::Array<::String>

Returns

(::Array<::String>) — URLs to the source resources. Must be size 1. Must be aBackendService if the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be mutated.

#sources=

def sources=(value) -> ::Array<::String>

Parameter

value (::Array<::String>) — URLs to the source resources. Must be size 1. Must be aBackendService if the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be mutated.

Returns

(::Array<::String>) — URLs to the source resources. Must be size 1. Must be aBackendService if the sourceType is BACKEND_SERVICE. TheBackendService must have load balancing schemeINTERNAL or INTERNAL_MANAGED and must be regional and in the same region as the HealthSource (cross-region deployment for INTERNAL_MANAGED is not supported). TheBackendService may use only IGs, MIGs, or NEGs of typeGCE_VM_IP or GCE_VM_IP_PORT. TheBackendService may not use haPolicy. Can be mutated.