Class: OCI::Dns::Models::CreateSteeringPolicyAttachmentDetails

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

Overview

The body for defining an attachment between a steering policy and a domain.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateSteeringPolicyAttachmentDetails

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



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 68

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']
end

Instance Attribute Details

#display_name ⇒ String

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) 


32
33
34
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 32

def display_name
  @display_name
end

#domain_name ⇒ String

[Required] The attached domain within the attached zone.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 25

def domain_name
  @domain_name
end

#steering_policy_id ⇒ String

[Required] The OCID of the attached steering policy.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 17

def steering_policy_id
  @steering_policy_id
end

#zone_id ⇒ String

[Required] The OCID of the attached zone.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 21

def zone_id
  @zone_id
end

Class Method Details

.attribute_map ⇒ Object

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



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 35

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'steering_policy_id': :'steeringPolicyId',
    'zone_id': :'zoneId',
    'domain_name': :'domainName',
    'display_name': :'displayName'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 47

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



106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 106

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 139

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


119
120
121
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [steering_policy_id, zone_id, domain_name, display_name].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 172

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



166
167
168
 
# File 'lib/oci/dns/models/create_steering_policy_attachment_details.rb', line 166

def to_s
  to_hash.to_s
end