Class: OCI::Dns::Models::UpdateSteeringPolicyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/dns/models/update_steering_policy_details.rb

Overview

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.

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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateSteeringPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# 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

Instance Attribute Details

#answersArray<OCI::Dns::Models::SteeringPolicyAnswer>

The set of all answers that can potentially issue from the steering policy.



115
116
117
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 115

def answers
  @answers
end

#defined_tagsHash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


110
111
112
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 110

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


28
29
30
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 28

def display_name
  @display_name
end

#freeform_tagsHash<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.

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>)


101
102
103
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 101

def freeform_tags
  @freeform_tags
end

#health_check_monitor_idString

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.

Returns:

  • (String)


47
48
49
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 47

def health_check_monitor_id
  @health_check_monitor_id
end

#rulesArray<OCI::Dns::Models::SteeringPolicyRule>

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.



126
127
128
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 126

def rules
  @rules
end

#templateString

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.

Returns:

  • (String)


92
93
94
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 92

def template
  @template
end

#ttlInteger

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)


34
35
36
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 34

def ttl
  @ttl
end

Class Method Details

.attribute_mapObject

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



129
130
131
132
133
134
135
136
137
138
139
140
141
142
# 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

.swagger_typesObject

Attribute type mapping.



145
146
147
148
149
150
151
152
153
154
155
156
157
158
# 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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object)

    the other object to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
# 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

#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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# 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

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object)

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


245
246
247
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 245

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



254
255
256
# 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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



298
299
300
301
302
303
304
305
306
307
# 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

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



292
293
294
# File 'lib/oci/dns/models/update_steering_policy_details.rb', line 292

def to_s
  to_hash.to_s
end