Class: OCI::Dns::Models::SteeringPolicySummary
- Inherits:
-
Object
- Object
- OCI::Dns::Models::SteeringPolicySummary
- Defined in:
- lib/oci/dns/models/steering_policy_summary.rb
Overview
A DNS steering policy.
Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.
Constant Summary collapse
- TEMPLATE_ENUM =
[ TEMPLATE_FAILOVER = 'FAILOVER'.freeze, TEMPLATE_LOAD_BALANCE = 'LOAD_BALANCE'.freeze, TEMPLATE_ROUTE_BY_GEO = 'ROUTE_BY_GEO'.freeze, TEMPLATE_ROUTE_BY_ASN = 'ROUTE_BY_ASN'.freeze, TEMPLATE_ROUTE_BY_IP = 'ROUTE_BY_IP'.freeze, TEMPLATE_CUSTOM = 'CUSTOM'.freeze, TEMPLATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_CREATING = 'CREATING'.freeze, LIFECYCLE_STATE_DELETED = 'DELETED'.freeze, LIFECYCLE_STATE_DELETING = 'DELETING'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#_self ⇒ String
[Required] The canonical absolute URL of the resource.
-
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the steering policy.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource.
-
#display_name ⇒ String
[Required] A user-friendly name for the steering policy.
-
#freeform_tags ⇒ Hash<String, String>
[Required] Free-form tags for this resource.
-
#health_check_monitor_id ⇒ String
The OCID of the health check monitor providing health data about the answers of the steering policy.
-
#id ⇒ String
[Required] The OCID of the resource.
-
#lifecycle_state ⇒ String
[Required] The current state of the resource.
-
#template ⇒ String
[Required] A set of predefined rules based on the desired purpose of the steering policy.
-
#time_created ⇒ DateTime
[Required] The date and time the resource was created, expressed in RFC 3339 timestamp format.
-
#ttl ⇒ Integer
[Required] The Time To Live (TTL) for responses from the steering policy, in seconds.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SteeringPolicySummary
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ SteeringPolicySummary
Initializes the object
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 199 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.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId'] raise 'You cannot provide both :compartmentId and :compartment_id' if attributes.key?(:'compartmentId') && attributes.key?(:'compartment_id') self.compartment_id = attributes[:'compartment_id'] if attributes[:'compartment_id'] 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. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self._self = attributes[:'self'] if attributes[:'self'] raise 'You cannot provide both :self and :_self' if attributes.key?(:'self') && attributes.key?(:'_self') self._self = attributes[:'_self'] if attributes[:'_self'] self.id = attributes[:'id'] if attributes[:'id'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] end |
Instance Attribute Details
#_self ⇒ String
[Required] The canonical absolute URL of the resource.
127 128 129 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 127 def _self @_self end |
#compartment_id ⇒ String
[Required] The OCID of the compartment containing the steering policy.
35 36 37 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 35 def compartment_id @compartment_id end |
#defined_tags ⇒ Hash<String, Hash<String, Object>>
[Required] Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: {\"Operations\": {\"CostCenter\": \"42\"}}
123 124 125 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 123 def @defined_tags end |
#display_name ⇒ String
[Required] A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.
41 42 43 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 41 def display_name @display_name end |
#freeform_tags ⇒ Hash<String, String>
[Required] 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\"}
114 115 116 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 114 def @freeform_tags end |
#health_check_monitor_id ⇒ 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.
60 61 62 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 60 def health_check_monitor_id @health_check_monitor_id end |
#id ⇒ String
[Required] The OCID of the resource.
131 132 133 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 131 def id @id end |
#lifecycle_state ⇒ String
[Required] The current state of the resource.
142 143 144 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 142 def lifecycle_state @lifecycle_state end |
#template ⇒ String
[Required] 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.
105 106 107 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 105 def template @template end |
#time_created ⇒ DateTime
[Required] The date and time the resource was created, expressed in RFC 3339 timestamp format.
Example: 2016-07-22T17:23:59:60Z
138 139 140 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 138 def time_created @time_created end |
#ttl ⇒ Integer
[Required] 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.
47 48 49 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 47 def ttl @ttl end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 145 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'compartmentId', 'display_name': :'displayName', 'ttl': :'ttl', 'health_check_monitor_id': :'healthCheckMonitorId', 'template': :'template', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', '_self': :'self', 'id': :'id', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 164 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'compartment_id': :'String', 'display_name': :'String', 'ttl': :'Integer', 'health_check_monitor_id': :'String', 'template': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', '_self': :'String', 'id': :'String', 'time_created': :'DateTime', 'lifecycle_state': :'String' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 293 def ==(other) return true if equal?(other) self.class == other.class && compartment_id == other.compartment_id && display_name == other.display_name && ttl == other.ttl && health_check_monitor_id == other.health_check_monitor_id && template == other.template && == other. && == other. && _self == other._self && id == other.id && time_created == other.time_created && lifecycle_state == other.lifecycle_state end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 333 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 |
#eql?(other) ⇒ Boolean
313 314 315 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 313 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
322 323 324 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 322 def hash [compartment_id, display_name, ttl, health_check_monitor_id, template, , , _self, id, time_created, lifecycle_state].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
366 367 368 369 370 371 372 373 374 375 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 366 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 |
#to_s ⇒ String
Returns the string representation of the object
360 361 362 |
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 360 def to_s to_hash.to_s end |