com.oracle.bmc.dns.model

Enum SteeringPolicy.Template

java.lang.Object

java.lang.Enum<SteeringPolicy.Template>

com.oracle.bmc.dns.model.SteeringPolicy.Template

All Implemented Interfaces:

BmcEnum, Serializable, Comparable<SteeringPolicy.Template>

Enclosing class:

SteeringPolicy

public static enum SteeringPolicy.Template
extends Enum<SteeringPolicy.Template>
implements BmcEnum

A set of predefined rules based on the desired purpose of the steering policy. Each template utilizes Traffic Management’s rules in a different order to produce the desired results when answering DNS queries.

**Example:** The FAILOVER template determines answers by filtering the policy's answers using the FILTER rule first, then the following rules in succession: HEALTH, PRIORITY, and LIMIT. This gives the domain dynamic failover capability.

It is **strongly recommended** to use a template other than CUSTOM when creating a steering policy.

All templates require the rule order to begin with an unconditional FILTER rule that keeps answers contingent upon answer.isDisabled != true, except for CUSTOM. A defined HEALTH rule must follow the FILTER rule if the policy references a healthCheckMonitorId. The last rule of a template must must be a LIMIT rule. For more information about templates and code examples, see [Traffic Management API Guide](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Concepts/trafficmanagementapi.htm).

*Template Types**

FAILOVER - Uses health check information on your endpoints to determine which DNS answers to serve. If an endpoint fails a health check, the answer for that endpoint will be removed from the list of available answers until the endpoint is detected as healthy.

* LOAD_BALANCE - Distributes web traffic to specified endpoints based on defined weights.

* ROUTE_BY_GEO - Answers DNS queries based on the query's geographic location. For a list of geographic locations to route by, see [Traffic Management Geographic Locations](https://docs.cloud.oracle.com/iaas/Content/TrafficManagement/Reference/trafficmanagementgeo.htm).

* ROUTE_BY_ASN - Answers DNS queries based on the query's originating ASN.

* ROUTE_BY_IP - Answers DNS queries based on the query's IP address.

* CUSTOM - Allows a customized configuration of rules.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Custom
Failover
LoadBalance
RouteByAsn
RouteByGeo
RouteByIp
UnknownEnumValue This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Summary

Modifier and Type	Method and Description
static SteeringPolicy.Template	create(String key)
String	getValue()
static SteeringPolicy.Template	valueOf(String name) Returns the enum constant of this type with the specified name.
static SteeringPolicy.Template[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Failover

public static final SteeringPolicy.Template Failover

LoadBalance

public static final SteeringPolicy.Template LoadBalance

RouteByGeo

public static final SteeringPolicy.Template RouteByGeo

RouteByAsn

public static final SteeringPolicy.Template RouteByAsn

RouteByIp

public static final SteeringPolicy.Template RouteByIp

Custom

public static final SteeringPolicy.Template Custom

UnknownEnumValue

public static final SteeringPolicy.Template UnknownEnumValue

This value is used if a service returns a value for this enum that is not recognized by this version of the SDK.

Method Detail

values

public static SteeringPolicy.Template[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SteeringPolicy.Template c : SteeringPolicy.Template.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SteeringPolicy.Template valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

Specified by:

getValue in interface BmcEnum

create

public static SteeringPolicy.Template create(String key)