Class: OCI::Dns::Models::CreateSteeringPolicyDetails

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

Overview

The body for defining a new 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
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSteeringPolicyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
212
213
214
215
216
217
218
219
220
221
222
223
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 179

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.ttl = 30 if ttl.nil? && !attributes.key?(:'ttl') # rubocop:disable Style/StringLiterals

  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.



117
118
119
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 117

def answers
  @answers
end

#compartment_idString

[Required] The OCID of the compartment containing the steering policy.

Returns:

  • (String)


24
25
26
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 24

def compartment_id
  @compartment_id
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>>)


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

def defined_tags
  @defined_tags
end

#display_nameString

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

Returns:

  • (String)


30
31
32
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 30

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>)


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

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)


49
50
51
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 49

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.



128
129
130
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 128

def rules
  @rules
end

#templateString

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

Returns:

  • (String)


94
95
96
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 94

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)


36
37
38
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 36

def ttl
  @ttl
end

Class Method Details

.attribute_mapObject

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 131

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',
    'answers': :'answers',
    'rules': :'rules'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 148

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>>',
    '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



240
241
242
243
244
245
246
247
248
249
250
251
252
253
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 240

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 &&
    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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 278

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


258
259
260
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 258

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



267
268
269
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 267

def hash
  [compartment_id, 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



311
312
313
314
315
316
317
318
319
320
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 311

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



305
306
307
# File 'lib/oci/dns/models/create_steering_policy_details.rb', line 305

def to_s
  to_hash.to_s
end