Class: OCI::Dns::Models::SteeringPolicyAttachment

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

Overview

An attachment between a steering policy and a domain. An attachment constructs DNS responses using its steering policy instead of the records at its defined domain. Only records of the policy's covered rtype are blocked at the domain. A domain can have a maximum of one attachment covering any given rtype.

Warning: Oracle recommends that you avoid using any confidential information when you supply string values using the API.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.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 = {}) ⇒ SteeringPolicyAttachment

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :steering_policy_id (String) —

    The value to assign to the #steering_policy_id property

  • :zone_id (String) —

    The value to assign to the #zone_id property

  • :domain_name (String) —

    The value to assign to the #domain_name property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :rtypes (Array<String>) —

    The value to assign to the #rtypes property

  • :compartment_id (String) —

    The value to assign to the #compartment_id 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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 126

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.steering_policy_id = attributes[:'steeringPolicyId'] if attributes[:'steeringPolicyId']

  raise 'You cannot provide both :steeringPolicyId and :steering_policy_id' if attributes.key?(:'steeringPolicyId') && attributes.key?(:'steering_policy_id')

  self.steering_policy_id = attributes[:'steering_policy_id'] if attributes[:'steering_policy_id']

  self.zone_id = attributes[:'zoneId'] if attributes[:'zoneId']

  raise 'You cannot provide both :zoneId and :zone_id' if attributes.key?(:'zoneId') && attributes.key?(:'zone_id')

  self.zone_id = attributes[:'zone_id'] if attributes[:'zone_id']

  self.domain_name = attributes[:'domainName'] if attributes[:'domainName']

  raise 'You cannot provide both :domainName and :domain_name' if attributes.key?(:'domainName') && attributes.key?(:'domain_name')

  self.domain_name = attributes[:'domain_name'] if attributes[:'domain_name']

  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.rtypes = attributes[:'rtypes'] if attributes[:'rtypes']

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

Returns:

  • (String) 


57
58
59
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 57

def _self
  @_self
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


53
54
55
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 53

def compartment_id
  @compartment_id
end

#display_name ⇒ String

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

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 42

def display_name
  @display_name
end

#domain_name ⇒ String

[Required] The attached domain within the attached zone.

Returns:

  • (String) 


35
36
37
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 35

def domain_name
  @domain_name
end

#id ⇒ String

[Required] The OCID of the resource.

Returns:

  • (String) 


61
62
63
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 61

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the resource.

Returns:

  • (String) 


72
73
74
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 72

def lifecycle_state
  @lifecycle_state
end

#rtypes ⇒ Array<String>

[Required] The record types covered by the attachment at the domain. The set of record types is determined by aggregating the record types from the answers defined in the steering policy.

Returns:

  • (Array<String>) 


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

def rtypes
  @rtypes
end

#steering_policy_id ⇒ String

[Required] The OCID of the attached steering policy.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 27

def steering_policy_id
  @steering_policy_id
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

Returns:

  • (DateTime) 


68
69
70
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 68

def time_created
  @time_created
end

#zone_id ⇒ String

[Required] The OCID of the attached zone.

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 31

def zone_id
  @zone_id
end

Class Method Details

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 75

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'steering_policy_id': :'steeringPolicyId',
    'zone_id': :'zoneId',
    'domain_name': :'domainName',
    'display_name': :'displayName',
    'rtypes': :'rtypes',
    'compartment_id': :'compartmentId',
    '_self': :'self',
    'id': :'id',
    'time_created': :'timeCreated',
    'lifecycle_state': :'lifecycleState'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 93

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'steering_policy_id': :'String',
    'zone_id': :'String',
    'domain_name': :'String',
    'display_name': :'String',
    'rtypes': :'Array<String>',
    'compartment_id': :'String',
    '_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



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 205

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    steering_policy_id == other.steering_policy_id &&
    zone_id == other.zone_id &&
    domain_name == other.domain_name &&
    display_name == other.display_name &&
    rtypes == other.rtypes &&
    compartment_id == other.compartment_id &&
    _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



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 244

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


224
225
226
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 224

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



233
234
235
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 233

def hash
  [steering_policy_id, zone_id, domain_name, display_name, rtypes, compartment_id, _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



277
278
279
280
281
282
283
284
285
286
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 277

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



271
272
273
 
# File 'lib/oci/dns/models/steering_policy_attachment.rb', line 271

def to_s
  to_hash.to_s
end