Compute Engine v1 API - Class TargetPool (2.11.0) 

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

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

Represents a Target Pool resource. Target pools are used for network TCP/UDP load balancing. A target pool references member instances, an associated legacy HttpHealthCheck resource, and, optionally, a backup target pool. For more information, read Using target pools.

Inheritance

object > TargetPool

Namespace

Google.Cloud.Compute.V1

Assembly

Google.Cloud.Compute.V1.dll

Constructors

TargetPool()

public TargetPool()

TargetPool(TargetPool)

public TargetPool(TargetPool other)
Parameter
NameDescription
otherTargetPool

Properties

BackupPool

public string BackupPool { get; set; }

The server-defined URL for the resource. This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool, and its failoverRatio field is properly set to a value between [0, 1]. backupPool and failoverRatio together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below failoverRatio, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio and backupPool are not set, or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Property Value
TypeDescription
string

CreationTimestamp

public string CreationTimestamp { get; set; }

[Output Only] Creation timestamp in RFC3339 text format.

Property Value
TypeDescription
string

Description

public string Description { get; set; }

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

Property Value
TypeDescription
string

FailoverRatio

public float FailoverRatio { get; set; }

This field is applicable only when the containing target pool is serving a forwarding rule as the primary pool (i.e., not as a backup pool to some other target pool). The value of the field must be in [0, 1]. If set, backupPool must also be set. They together define the fallback behavior of the primary target pool: if the ratio of the healthy instances in the primary pool is at or below this number, traffic arriving at the load-balanced IP will be directed to the backup pool. In case where failoverRatio is not set or all the instances in the backup pool are unhealthy, the traffic will be directed back to the primary pool in the "force" mode, where traffic will be spread to the healthy instances with the best effort, or to all instances when no instance is healthy.

Property Value
TypeDescription
float

HasBackupPool

public bool HasBackupPool { get; }

Gets whether the "backup_pool" field is set

Property Value
TypeDescription
bool

HasCreationTimestamp

public bool HasCreationTimestamp { get; }

Gets whether the "creation_timestamp" field is set

Property Value
TypeDescription
bool

HasDescription

public bool HasDescription { get; }

Gets whether the "description" field is set

Property Value
TypeDescription
bool

HasFailoverRatio

public bool HasFailoverRatio { get; }

Gets whether the "failover_ratio" field is set

Property Value
TypeDescription
bool

HasId

public bool HasId { get; }

Gets whether the "id" field is set

Property Value
TypeDescription
bool

HasKind

public bool HasKind { get; }

Gets whether the "kind" field is set

Property Value
TypeDescription
bool

HasName

public bool HasName { get; }

Gets whether the "name" field is set

Property Value
TypeDescription
bool

HasRegion

public bool HasRegion { get; }

Gets whether the "region" field is set

Property Value
TypeDescription
bool
public bool HasSelfLink { get; }

Gets whether the "self_link" field is set

Property Value
TypeDescription
bool

HasSessionAffinity

public bool HasSessionAffinity { get; }

Gets whether the "session_affinity" field is set

Property Value
TypeDescription
bool

HealthChecks

public RepeatedField<string> HealthChecks { get; }

The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. Only legacy HttpHealthChecks are supported. Only one health check may be specified.

Property Value
TypeDescription
RepeatedFieldstring

Id

public ulong Id { get; set; }

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

Property Value
TypeDescription
ulong

Instances

public RepeatedField<string> Instances { get; }

A list of resource URLs to the virtual machine instances serving this pool. They must live in zones contained in the same region as this pool.

Property Value
TypeDescription
RepeatedFieldstring

Kind

public string Kind { get; set; }

[Output Only] Type of the resource. Always compute#targetPool for target pools.

Property Value
TypeDescription
string

Name

public string Name { get; set; }

Name of the resource. Provided by the client when the resource is created. 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
TypeDescription
string

Region

public string Region { get; set; }

[Output Only] URL of the region where the target pool resides.

Property Value
TypeDescription
string
public string SelfLink { get; set; }

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

Property Value
TypeDescription
string

SessionAffinity

public string SessionAffinity { get; set; }

Session affinity option, must be one of the following values: NONE: Connections from the same client IP may go to any instance in the pool. CLIENT_IP: Connections from the same client IP will go to the same instance in the pool while that instance remains healthy. CLIENT_IP_PROTO: Connections from the same client IP with the same IP protocol will go to the same instance in the pool while that instance remains healthy. Check the SessionAffinity enum for the list of possible values.

Property Value
TypeDescription
string