class OCI::Dns::Models::UpdateSteeringPolicyDetails
The body for updating a steering policy. New rules and answers provided in the request will replace the existing rules and answers in the policy.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constants
- TEMPLATE_ENUM
Attributes
The set of all answers that can potentially issue from the steering policy.
@return [Array<OCI::Dns::Models::SteeringPolicyAnswer>]
A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
@return [String]
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](docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm).
@return [String]
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.
@return [Array<OCI::Dns::Models::SteeringPolicyRule>]
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](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](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.
@return [String]
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.
@return [Integer]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/dns/models/update_steering_policy_details.rb, line 129 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'ttl': :'ttl', 'health_check_monitor_id': :'healthCheckMonitorId', 'template': :'template', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'answers': :'answers', 'rules': :'rules' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :display_name The value to assign to the {#display_name} property @option attributes [Integer] :ttl The value to assign to the {#ttl} property @option attributes [String] :health_check_monitor_id The value to assign to the {#health_check_monitor_id} property @option attributes [String] :template The value to assign to the {#template} property @option attributes [Hash<String, String>] :freeform_tags The value to assign to the {#freeform_tags} property @option attributes [Hash<String, Hash<String, Object>>] :defined_tags The value to assign to the {#defined_tags} property @option attributes [Array<OCI::Dns::Models::SteeringPolicyAnswer>] :answers The value to assign to the {#answers} property @option attributes [Array<OCI::Dns::Models::SteeringPolicyRule>] :rules The value to assign to the {#rules} property
# File lib/oci/dns/models/update_steering_policy_details.rb, line 174 def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.display_name = attributes[:'displayName'] if attributes[:'displayName'] raise 'You cannot provide both :displayName and :display_name' if attributes.key?(:'displayName') && attributes.key?(:'display_name') self.display_name = attributes[:'display_name'] if attributes[:'display_name'] self.ttl = attributes[:'ttl'] if attributes[:'ttl'] self.health_check_monitor_id = attributes[:'healthCheckMonitorId'] if attributes[:'healthCheckMonitorId'] raise 'You cannot provide both :healthCheckMonitorId and :health_check_monitor_id' if attributes.key?(:'healthCheckMonitorId') && attributes.key?(:'health_check_monitor_id') self.health_check_monitor_id = attributes[:'health_check_monitor_id'] if attributes[:'health_check_monitor_id'] self.template = attributes[:'template'] if attributes[:'template'] self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self.freeform_tags = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self.defined_tags = attributes[:'defined_tags'] if attributes[:'defined_tags'] self.answers = attributes[:'answers'] if attributes[:'answers'] self.rules = attributes[:'rules'] if attributes[:'rules'] end
Attribute type mapping.
# File lib/oci/dns/models/update_steering_policy_details.rb, line 145 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'display_name': :'String', 'ttl': :'Integer', 'health_check_monitor_id': :'String', 'template': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'answers': :'Array<OCI::Dns::Models::SteeringPolicyAnswer>', 'rules': :'Array<OCI::Dns::Models::SteeringPolicyRule>' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/dns/models/update_steering_policy_details.rb, line 228 def ==(other) return true if equal?(other) self.class == other.class && display_name == other.display_name && ttl == other.ttl && health_check_monitor_id == other.health_check_monitor_id && template == other.template && freeform_tags == other.freeform_tags && defined_tags == other.defined_tags && answers == other.answers && rules == other.rules end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/dns/models/update_steering_policy_details.rb, line 265 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.swagger_types.each_pair do |key, type| if type =~ /^Array<(.*)>/i # check to ensure the input is an array given that the the attribute # is documented as an array but the input is not if attributes[self.class.attribute_map[key]].is_a?(Array) public_method("#{key}=").call( attributes[self.class.attribute_map[key]] .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) } ) end elsif !attributes[self.class.attribute_map[key]].nil? public_method("#{key}=").call( OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]]) ) end # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/dns/models/update_steering_policy_details.rb, line 245 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/dns/models/update_steering_policy_details.rb, line 254 def hash [display_name, ttl, health_check_monitor_id, template, freeform_tags, defined_tags, answers, rules].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] template Object
to be assigned
# File lib/oci/dns/models/update_steering_policy_details.rb, line 217 def template=(template) raise "Invalid value for 'template': this must be one of the values in TEMPLATE_ENUM." if template && !TEMPLATE_ENUM.include?(template) @template = template end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/dns/models/update_steering_policy_details.rb, line 298 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = public_method(attr).call next if value.nil? && !instance_variable_defined?("@#{attr}") hash[param] = _to_hash(value) end hash end
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/dns/models/update_steering_policy_details.rb, line 292 def to_s to_hash.to_s end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/dns/models/update_steering_policy_details.rb, line 315 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end