Class: OCI::Identity::Models::CreateNetworkSourceDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/identity/models/create_network_source_details.rb

Overview

Properties for creating a network source object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateNetworkSourceDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
# File 'lib/oci/identity/models/create_network_source_details.rb', line 102

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

  self.public_source_list = attributes[:'publicSourceList'] if attributes[:'publicSourceList']

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

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

  self.virtual_source_list = attributes[:'virtualSourceList'] if attributes[:'virtualSourceList']

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

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

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

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

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

Instance Attribute Details

#compartment_idString

[Required] The OCID of the tenancy (root compartment) containing the network source object.

Returns:

  • (String)


12
13
14
# File 'lib/oci/identity/models/create_network_source_details.rb', line 12

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


54
55
56
# File 'lib/oci/identity/models/create_network_source_details.rb', line 54

def defined_tags
  @defined_tags
end

#descriptionString

[Required] The description you assign to the network source during creation. Does not have to be unique, and it's changeable.

Returns:

  • (String)


40
41
42
# File 'lib/oci/identity/models/create_network_source_details.rb', line 40

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


47
48
49
# File 'lib/oci/identity/models/create_network_source_details.rb', line 47

def freeform_tags
  @freeform_tags
end

#nameString

[Required] The name you assign to the network source during creation. The name must be unique across all groups in the tenancy and cannot be changed.

Returns:

  • (String)


18
19
20
# File 'lib/oci/identity/models/create_network_source_details.rb', line 18

def name
  @name
end

#public_source_listArray<String>

A list of allowed public IP addresses and CIDR ranges.

Returns:

  • (Array<String>)


23
24
25
# File 'lib/oci/identity/models/create_network_source_details.rb', line 23

def public_source_list
  @public_source_list
end

#servicesArray<String>

A list of services allowed to make on-behalf-of requests. These requests can have different source IP addresses than those listed in the network source. Currently, only all and none are supported. The default is all.

Returns:

  • (Array<String>)


36
37
38
# File 'lib/oci/identity/models/create_network_source_details.rb', line 36

def services
  @services
end

#virtual_source_listArray<OCI::Identity::Models::NetworkSourcesVirtualSourceList>

A list of allowed VCN OCID and IP range pairs. Example:\"vcnId\": \"ocid1.vcn.oc1.iad.aaaaaaaaexampleuniqueID\", \"ipRanges\": [ \"129.213.39.0/24\" ]



29
30
31
# File 'lib/oci/identity/models/create_network_source_details.rb', line 29

def virtual_source_list
  @virtual_source_list
end

Class Method Details

.attribute_mapObject

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/oci/identity/models/create_network_source_details.rb', line 57

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'name': :'name',
    'public_source_list': :'publicSourceList',
    'virtual_source_list': :'virtualSourceList',
    'services': :'services',
    'description': :'description',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
# File 'lib/oci/identity/models/create_network_source_details.rb', line 73

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'name': :'String',
    'public_source_list': :'Array<String>',
    'virtual_source_list': :'Array<OCI::Identity::Models::NetworkSourcesVirtualSourceList>',
    'services': :'Array<String>',
    'description': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>'
    # 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



152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/oci/identity/models/create_network_source_details.rb', line 152

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    name == other.name &&
    public_source_list == other.public_source_list &&
    virtual_source_list == other.virtual_source_list &&
    services == other.services &&
    description == other.description &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags
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



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/identity/models/create_network_source_details.rb', line 189

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


169
170
171
# File 'lib/oci/identity/models/create_network_source_details.rb', line 169

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



178
179
180
# File 'lib/oci/identity/models/create_network_source_details.rb', line 178

def hash
  [compartment_id, name, public_source_list, virtual_source_list, services, description, freeform_tags, defined_tags].hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



222
223
224
225
226
227
228
229
230
231
# File 'lib/oci/identity/models/create_network_source_details.rb', line 222

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



216
217
218
# File 'lib/oci/identity/models/create_network_source_details.rb', line 216

def to_s
  to_hash.to_s
end