Class: OCI::Identity::Models::NetworkSourcesSummary

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

Overview

A network source specifies a list of source IP addresses that are allowed to make authorization requests. Use the network source in policy statements to restrict access to only requests that come from the specified IPs. For more information, see Managing Network Sources.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NetworkSourcesSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
184
185
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 130

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

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

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

  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.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_id ⇒ String

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

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 20

def compartment_id
  @compartment_id
end

#defined_tags ⇒ Hash<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>>) 


73
74
75
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 73

def defined_tags
  @defined_tags
end

#description ⇒ String

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

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 30

def description
  @description
end

#freeform_tags ⇒ Hash<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>) 


66
67
68
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 66

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the network source.

Returns:

  • (String) 


16
17
18
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 16

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The network source object's current state. After creating a network source, make sure its lifecycleState changes from CREATING to ACTIVE before using it.

Returns:

  • (String) 


52
53
54
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 52

def lifecycle_state
  @lifecycle_state
end

#name ⇒ String

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

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 26

def name
  @name
end

#public_source_list ⇒ Array<String>

A list of allowed public IP addresses and CIDR ranges.

Returns:

  • (Array<String>) 


35
36
37
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 35

def public_source_list
  @public_source_list
end

#services ⇒ Array<String>

– The services attribute has no effect and is reserved for use by Oracle. –

Returns:

  • (Array<String>) 


46
47
48
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 46

def services
  @services
end

#time_created ⇒ DateTime

[Required] Date and time the network source was created, in the format defined by RFC3339.

Example: 2016-08-25T21:10:29.600Z

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 59

def time_created
  @time_created
end

#virtual_source_list ⇒ Array<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\" ]

Returns:



41
42
43
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 41

def virtual_source_list
  @virtual_source_list
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 76

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

.swagger_types ⇒ Object

Attribute type mapping.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 95

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 194

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

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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 234

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


214
215
216
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 214

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



223
224
225
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 223

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 267

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



261
262
263
 
# File 'lib/oci/identity/models/network_sources_summary.rb', line 261

def to_s
  to_hash.to_s
end