public static class CreateSteeringPolicyDetails.Builder extends Object
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
CreateSteeringPolicyDetails.Builder |
answers(List<SteeringPolicyAnswer> answers)
The set of all answers that can potentially issue from the steering policy.
|
CreateSteeringPolicyDetails |
build() |
CreateSteeringPolicyDetails.Builder |
compartmentId(String compartmentId)
The OCID of the compartment containing the steering policy.
|
CreateSteeringPolicyDetails.Builder |
copy(CreateSteeringPolicyDetails model) |
CreateSteeringPolicyDetails.Builder |
definedTags(Map<String,Map<String,Object>> definedTags)
Defined tags for this resource.
|
CreateSteeringPolicyDetails.Builder |
displayName(String displayName)
A user-friendly name for the steering policy.
|
CreateSteeringPolicyDetails.Builder |
freeformTags(Map<String,String> freeformTags)
Free-form tags for this resource.
|
CreateSteeringPolicyDetails.Builder |
healthCheckMonitorId(String healthCheckMonitorId)
The OCID of the health check monitor providing health data about the answers of the
steering policy.
|
CreateSteeringPolicyDetails.Builder |
rules(List<SteeringPolicyRule> rules)
The series of rules that will be processed in sequence to reduce the pool of answers
to a response for any given request.
|
CreateSteeringPolicyDetails.Builder |
template(CreateSteeringPolicyDetails.Template template)
A set of predefined rules based on the desired purpose of the steering policy.
|
CreateSteeringPolicyDetails.Builder |
ttl(Integer ttl)
The Time To Live (TTL) for responses from the steering policy, in seconds.
|
public CreateSteeringPolicyDetails.Builder compartmentId(String compartmentId)
The OCID of the compartment containing the steering policy.
compartmentId
- the value to setpublic CreateSteeringPolicyDetails.Builder displayName(String displayName)
A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
displayName
- the value to setpublic CreateSteeringPolicyDetails.Builder ttl(Integer ttl)
The Time To Live (TTL) for responses from the steering policy, in seconds. If not specified during creation, a value of 30 seconds will be used.
ttl
- the value to setpublic CreateSteeringPolicyDetails.Builder healthCheckMonitorId(String healthCheckMonitorId)
The OCID of the health check monitor providing health data about the answers of the
steering policy. A steering policy answer with rdata
matching a monitored endpoint
will use the health data of that endpoint. A steering policy answer with rdata
not
matching any monitored endpoint will be assumed healthy.
Note: To use the Health Check monitoring feature in a steering policy, a monitor must be created using the Health Checks service first. For more information on how to create a monitor, please see Managing Health Checks.
healthCheckMonitorId
- the value to setpublic CreateSteeringPolicyDetails.Builder template(CreateSteeringPolicyDetails.Template template)
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.
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.
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.template
- the value to setpublic CreateSteeringPolicyDetails.Builder freeformTags(Map<String,String> freeformTags)
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: {"Department": "Finance"}
freeformTags
- the value to setpublic CreateSteeringPolicyDetails.Builder definedTags(Map<String,Map<String,Object>> definedTags)
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {"Operations": {"CostCenter": "42"}}
definedTags
- the value to setpublic CreateSteeringPolicyDetails.Builder answers(List<SteeringPolicyAnswer> answers)
The set of all answers that can potentially issue from the steering policy.
answers
- the value to setpublic CreateSteeringPolicyDetails.Builder rules(List<SteeringPolicyRule> rules)
The series of rules that will be processed in sequence to reduce the pool of answers to a response for any given request.
The first rule receives a shuffled list of all answers, and every other rule receives the list of answers emitted by the one preceding it. The last rule populates the response.
rules
- the value to setpublic CreateSteeringPolicyDetails build()
public CreateSteeringPolicyDetails.Builder copy(CreateSteeringPolicyDetails model)
Copyright © 2016–2022. All rights reserved.