Class: OCI::Dns::Models::SteeringPolicySummary

Inherits:
Object
  • Object
show all
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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SteeringPolicySummary

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :ttl (Integer) —

    The value to assign to the #ttl property

  • :health_check_monitor_id (String) —

    The value to assign to the #health_check_monitor_id property

  • :template (String) —

    The value to assign to the #template property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :_self (String) —

    The value to assign to the #_self property

  • :id (String) —

    The value to assign to the #id property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property



197
198
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
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 197

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.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._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

The canonical absolute URL of the resource.

Returns:

  • (String) 


125
126
127
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 125

def _self
  @_self
end

#compartment_id ⇒ String

The OCID of the compartment containing the steering policy.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 33

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘{"CostCenter": "42"}`

Returns:

  • (Hash<String, Hash<String, Object>>) 


121
122
123
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 121

def defined_tags
  @defined_tags
end

#display_name ⇒ String

A user-friendly name for the steering policy. Does not have to be unique and can be changed. Avoid entering confidential information.

Returns:

  • (String) 


39
40
41
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 39

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

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](docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm).

Example: ‘"Finance"`

Returns:

  • (Hash<String, String>) 


112
113
114
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 112

def freeform_tags
  @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](docs.cloud.oracle.com/iaas/Content/HealthChecks/Tasks/managinghealthchecks.htm).

Returns:

  • (String) 


58
59
60
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 58

def health_check_monitor_id
  @health_check_monitor_id
end

#id ⇒ String

The OCID of the resource.

Returns:

  • (String) 


129
130
131
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 129

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the resource.

Returns:

  • (String) 


140
141
142
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 140

def lifecycle_state
  @lifecycle_state
end

#template ⇒ String

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.

Returns:

  • (String) 


103
104
105
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 103

def template
  @template
end

#time_created ⇒ DateTime

The date and time the resource was created, expressed in RFC 3339 timestamp format.

Example: ‘2016-07-22T17:23:59:60Z`

Returns:

  • (DateTime) 


136
137
138
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 136

def time_created
  @time_created
end

#ttl ⇒ Integer

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.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 45

def ttl
  @ttl
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 143

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.



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 162

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.

Parameters:

  • other (Object) —

    the other object to be compared



291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 291

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 &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    _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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 331

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 311

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 320

def hash
  [compartment_id, display_name, ttl, health_check_monitor_id, template, freeform_tags, defined_tags, _self, id, time_created, lifecycle_state].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



364
365
366
367
368
369
370
371
372
373
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 364

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

Returns:

  • (String) —

    String presentation of the object



358
359
360
 
# File 'lib/oci/dns/models/steering_policy_summary.rb', line 358

def to_s
  to_hash.to_s
end