Package com.ibm.cloud.networking.dns_svcs.v1.model

Class UpdatePoolOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.networking.dns_svcs.v1.model.UpdatePoolOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class UpdatePoolOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The updatePool options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UpdatePoolOptions.Builder	Builder.
static interface	UpdatePoolOptions.HealthcheckRegion	Health check region of VSIs.

Method Summary

Modifier and Type	Method	Description
String	description()	Gets the description.
Boolean	enabled()	Gets the enabled.
String	healthcheckRegion()	Gets the healthcheckRegion.
List<String>	healthcheckSubnets()	Gets the healthcheckSubnets.
Long	healthyOriginsThreshold()	Gets the healthyOriginsThreshold.
String	instanceId()	Gets the instanceId.
String	monitor()	Gets the monitor.
String	name()	Gets the name.
UpdatePoolOptions.Builder	newBuilder()	New builder.
String	notificationChannel()	Gets the notificationChannel.
List<OriginInput>	origins()	Gets the origins.
String	poolId()	Gets the poolId.
String	xCorrelationId()	Gets the xCorrelationId.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public UpdatePoolOptions.Builder newBuilder()

New builder.

Returns:

a UpdatePoolOptions builder

instanceId

public String instanceId()

Gets the instanceId. The unique identifier of a service instance.

Returns:

the instanceId

poolId

public String poolId()

Gets the poolId. The unique identifier of a load balancer pool.

Returns:

the poolId

name

public String name()

Gets the name. Name of the load balancer pool.

Returns:

the name

description

public String description()

Gets the description. Descriptive text of the load balancer pool.

Returns:

the description

enabled

public Boolean enabled()

Gets the enabled. Whether the load balancer pool is enabled.

Returns:

the enabled

healthyOriginsThreshold

public Long healthyOriginsThreshold()

Gets the healthyOriginsThreshold. The minimum number of origins that must be healthy for this pool to serve traffic. If the number of healthy origins falls below this number, the pool will be marked unhealthy and we will failover to the next available pool.

Returns:

the healthyOriginsThreshold

origins

public List<OriginInput> origins()

Gets the origins. The list of origins within this pool. Traffic directed at this pool is balanced across all currently healthy origins, provided the pool itself is healthy.

Returns:

the origins

monitor

public String monitor()

Gets the monitor. The ID of the load balancer monitor to be associated to this pool.

Returns:

the monitor

notificationChannel

public String notificationChannel()

Gets the notificationChannel. The notification channel.

Returns:

the notificationChannel

healthcheckRegion

public String healthcheckRegion()

Gets the healthcheckRegion. Health check region of VSIs.

Returns:

the healthcheckRegion

healthcheckSubnets

public List<String> healthcheckSubnets()

Gets the healthcheckSubnets. Health check subnet CRNs.

Returns:

the healthcheckSubnets

xCorrelationId

public String xCorrelationId()

Gets the xCorrelationId. Uniquely identifying a request.

Returns:

the xCorrelationId