TargetPool.Builder (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.cloud.compute.v1.TargetPool.Builder

Enclosing class:: TargetPool

public static class TargetPool.Builder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TargetPool.Builder`	`addAllHealthChecks(List<String> healthChecks)` The URL of the HttpHealthCheck resource.
`TargetPool.Builder`	`addAllInstances(List<String> instances)` A list of resource URLs to the virtual machine instances serving this pool.
`TargetPool.Builder`	`addHealthChecks(String healthChecks)` The URL of the HttpHealthCheck resource.
`TargetPool.Builder`	`addInstances(String instances)` A list of resource URLs to the virtual machine instances serving this pool.
`TargetPool`	`build()`
`TargetPool.Builder`	`clone()`
`String`	`getBackupPool()` 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].
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`Float`	`getFailoverRatio()` 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).
`List<String>`	`getHealthChecksList()` The URL of the HttpHealthCheck resource.
`String`	`getId()` [Output Only] The unique identifier for the resource.
`List<String>`	`getInstancesList()` A list of resource URLs to the virtual machine instances serving this pool.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` Name of the resource.
`String`	`getRegion()` [Output Only] URL of the region where the target pool resides.
`String`	`getSelfLink()` [Output Only] Server-defined URL for the resource.
`String`	`getSessionAffinity()` 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.
`TargetPool.Builder`	`mergeFrom(TargetPool other)`
`TargetPool.Builder`	`setBackupPool(String backupPool)` 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].
`TargetPool.Builder`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`TargetPool.Builder`	`setDescription(String description)` An optional description of this resource.
`TargetPool.Builder`	`setFailoverRatio(Float failoverRatio)` 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).
`TargetPool.Builder`	`setId(String id)` [Output Only] The unique identifier for the resource.
`TargetPool.Builder`	`setKind(String kind)` [Output Only] Type of the resource.
`TargetPool.Builder`	`setName(String name)` Name of the resource.
`TargetPool.Builder`	`setRegion(String region)` [Output Only] URL of the region where the target pool resides.
`TargetPool.Builder`	`setSelfLink(String selfLink)` [Output Only] Server-defined URL for the resource.
`TargetPool.Builder`	`setSessionAffinity(String sessionAffinity)` 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.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - mergeFrom
```
public TargetPool.Builder mergeFrom(TargetPool other)
```
  - getBackupPool
```
public String getBackupPool()
```
    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.
  - setBackupPool
```
public TargetPool.Builder setBackupPool(String backupPool)
```
    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.
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - setCreationTimestamp
```
public TargetPool.Builder setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
  - setDescription
```
public TargetPool.Builder setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
  - getFailoverRatio
```
public Float getFailoverRatio()
```
    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.
  - setFailoverRatio
```
public TargetPool.Builder setFailoverRatio(Float failoverRatio)
```
    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.
  - getHealthChecksList
```
public List<String> getHealthChecksList()
```
    The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
  - addAllHealthChecks
```
public TargetPool.Builder addAllHealthChecks(List<String> healthChecks)
```
    The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
  - addHealthChecks
```
public TargetPool.Builder addHealthChecks(String healthChecks)
```
    The URL of the HttpHealthCheck resource. A member instance in this pool is considered healthy if and only if the health checks pass. An empty list means all member instances will be considered healthy at all times. Only HttpHealthChecks are supported. Only one health check may be specified.
  - getId
```
public String getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - setId
```
public TargetPool.Builder setId(String id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
  - getInstancesList
```
public List<String> getInstancesList()
```
    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.
  - addAllInstances
```
public TargetPool.Builder addAllInstances(List<String> instances)
```
    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.
  - addInstances
```
public TargetPool.Builder addInstances(String instances)
```
    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.
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#targetPool for target pools.
  - setKind
```
public TargetPool.Builder setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#targetPool for target pools.
  - getName
```
public String getName()
```
    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.
  - setName
```
public TargetPool.Builder setName(String name)
```
    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.
  - getRegion
```
public String getRegion()
```
    [Output Only] URL of the region where the target pool resides.
  - setRegion
```
public TargetPool.Builder setRegion(String region)
```
    [Output Only] URL of the region where the target pool resides.
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined URL for the resource.
  - setSelfLink
```
public TargetPool.Builder setSelfLink(String selfLink)
```
    [Output Only] Server-defined URL for the resource.
  - getSessionAffinity
```
public String getSessionAffinity()
```
    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.
  - setSessionAffinity
```
public TargetPool.Builder setSessionAffinity(String sessionAffinity)
```
    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.
  - build
```
public TargetPool build()
```
  - clone
```
public TargetPool.Builder clone()
```
    Overrides:
    
    clone in class Object

Class TargetPool.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

mergeFrom

getBackupPool

setBackupPool

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getFailoverRatio

setFailoverRatio

getHealthChecksList

addAllHealthChecks

addHealthChecks

getId

setId

getInstancesList

addAllInstances

addInstances

getKind

setKind

getName

setName

getRegion

setRegion

getSelfLink

setSelfLink

getSessionAffinity

setSessionAffinity

build

clone