Compute Engine v1 API - Class HealthCheckService (2.13.0)

public sealed class HealthCheckService : IMessage<HealthCheckService>, IEquatable<HealthCheckService>, IDeepCloneable<HealthCheckService>, IBufferMessage, IMessage

Reference documentation and code samples for the Compute Engine v1 API class HealthCheckService.

Represents a Health-Check as a Service resource.

Inheritance

object > HealthCheckService

Implements

IMessage HealthCheckService, IEquatable HealthCheckService, IDeepCloneable HealthCheckService, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

HealthCheckService()

public HealthCheckService()

HealthCheckService(HealthCheckService)

public HealthCheckService(HealthCheckService other)

Parameter
Name	Description
`other`	`HealthCheckService`

Properties

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
Type	Description
`string`

Description

public string Description { get; set; }

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

Property Value
Type	Description
`string`

Fingerprint

public string Fingerprint { get; set; }

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.

Property Value
Type	Description
`string`

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
Type	Description
`bool`

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
Type	Description
`bool`

HasFingerprint

public bool HasFingerprint { get; }

Gets whether the "fingerprint" field is set

Property Value
Type	Description
`bool`

HasHealthStatusAggregationPolicy

public bool HasHealthStatusAggregationPolicy { get; }

Gets whether the "health_status_aggregation_policy" field is set

Property Value
Type	Description
`bool`

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
Type	Description
`bool`

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
Type	Description
`bool`

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
Type	Description
`bool`

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
Type	Description
`bool`

HasSelfLink

public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
Type	Description
`bool`

HealthChecks

public RepeatedField<string> HealthChecks { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

HealthStatusAggregationPolicy

public string HealthStatusAggregationPolicy { get; set; }

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. Check the HealthStatusAggregationPolicy enum for the list of possible values.

Property Value
Type	Description
`string`

Id

public ulong Id { get; set; }

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

Property Value
Type	Description
`ulong`

Kind

public string Kind { get; set; }

[Output only] Type of the resource. Always compute#healthCheckServicefor health check services.

Property Value
Type	Description
`string`

Name

public string Name { get; set; }

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.

Property Value
Type	Description
`string`

NetworkEndpointGroups

public RepeatedField<string> NetworkEndpointGroups { get; }

A list of URLs to the NetworkEndpointGroup resources. Must not have more than 100. 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.

Property Value
Type	Description
`RepeatedFieldstring`

NotificationEndpoints

public RepeatedField<string> NotificationEndpoints { get; }

A 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.

Property Value
Type	Description
`RepeatedFieldstring`

Region

public string Region { get; set; }

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

Property Value
Type	Description
`string`

SelfLink

public string SelfLink { get; set; }

[Output Only] Server-defined URL for the resource.

Property Value
Type	Description
`string`