Package org.jclouds.googlecomputeengine.domain

Class TargetPool

java.lang.Object

org.jclouds.googlecomputeengine.domain.TargetPool

public abstract class TargetPool
extends Object

Method Summary

Modifier and Type	Method	Description
abstract URI	backupPool()	This field is applicable only when the target pool is serving a forwarding rule as the primary pool.
static TargetPool	create(String id, URI selfLink, Date creationTimestamp, String name, String description, URI region, List<URI> healthChecks, List<URI> instances, TargetPoolCreationOptions.SessionAffinityValue sessionAffinity, Float failoverRatio, URI backupPool)
abstract Date	creationTimestamp()
abstract String	description()
abstract Float	failoverRatio()	This field is applicable only when the target pool is serving a forwarding rule as the primary pool.
abstract List<URI>	healthChecks()	URL to HttpHealthCheck resources.
abstract String	id()
abstract List<URI>	instances()	A list of resource URLs to the member VMs serving this pool.
abstract String	name()
abstract URI	region()
abstract URI	selfLink()
abstract TargetPoolCreationOptions.SessionAffinityValue	sessionAffinity()	The session affinity option, determines the hash method that Google Compute Engine uses to distribute traffic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

id

public abstract String id()

selfLink

public abstract URI selfLink()

creationTimestamp

public abstract Date creationTimestamp()

name

public abstract String name()

description

@Nullable
public abstract String description()

region

public abstract URI region()

healthChecks

public abstract List<URI> healthChecks()

URL to HttpHealthCheck resources. A member VM in this pool is considered healthy if and only if the specified health checks pass. An empty list means all member virtual machines will be considered healthy at all times but the health status of this target pool will be marked as unhealthy to indicate that no health checks are being performed.

instances

public abstract List<URI> instances()

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

sessionAffinity

@Nullable
public abstract TargetPoolCreationOptions.SessionAffinityValue sessionAffinity()

The session affinity option, determines the hash method that Google Compute Engine uses to distribute traffic.

failoverRatio

@Nullable
public abstract Float failoverRatio()

This field is applicable only when the target pool is serving a forwarding rule as the primary pool. The value of the a float between [0, 1]. If set, backupPool must also be set. Together, they define the fallback behavior of the primary target pool. If the ratio of the healthy VMs 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 VMs 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 VMs with the best effort, or to all VMs when no VM is healthy.

backupPool

@Nullable
public abstract URI backupPool()

This field is applicable only when the target pool is serving a forwarding rule as the primary pool. Must be a fully-qualified URL to a target pool that is in the same region as the primary target pool. If set, failoverRatio must also be set. Together, they define the fallback behavior of the primary target pool. If the ratio of the healthy VMs 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 VMs 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 VMs with the best effort, or to all VMs when no VM is healthy.

create

public static TargetPool create(String id,
                                URI selfLink,
                                Date creationTimestamp,
                                String name,
                                String description,
                                URI region,
                                List<URI> healthChecks,
                                List<URI> instances,
                                TargetPoolCreationOptions.SessionAffinityValue sessionAffinity,
                                Float failoverRatio,
                                URI backupPool)