Class: OracleBMC::Core::Models::Vnic

Inherits:
Object
  • Object
show all
Defined in:
lib/oraclebmc/core/models/vnic.rb

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[LIFECYCLE_STATE_PROVISIONING = 'PROVISIONING',
LIFECYCLE_STATE_AVAILABLE = 'AVAILABLE',
LIFECYCLE_STATE_TERMINATING = 'TERMINATING',
LIFECYCLE_STATE_TERMINATED = 'TERMINATED']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Vnic

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
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
98
99
100
101
102
103
104
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 61

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}

  
  if attributes[:'availabilityDomain']
    self.availability_domain = attributes[:'availabilityDomain']
  end
  
  if attributes[:'compartmentId']
    self.compartment_id = attributes[:'compartmentId']
  end
  
  if attributes[:'displayName']
    self.display_name = attributes[:'displayName']
  end
  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'lifecycleState']
    self.lifecycle_state = attributes[:'lifecycleState']
  end
  
  if attributes[:'privateIp']
    self.private_ip = attributes[:'privateIp']
  end
  
  if attributes[:'publicIp']
    self.public_ip = attributes[:'publicIp']
  end
  
  if attributes[:'subnetId']
    self.subnet_id = attributes[:'subnetId']
  end
  
  if attributes[:'timeCreated']
    self.time_created = attributes[:'timeCreated']
  end
  
end

Instance Attribute Details

#availability_domain ⇒ String

The VNIC’s Availability Domain.

Example: ‘Uocm:PHX-AD-1`

Returns:

  • (String) 


18
19
20
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 18

def availability_domain
  @availability_domain
end

#compartment_id ⇒ String

The OCID of the compartment containing the VNIC.

Returns:

  • (String) 


22
23
24
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 22

def compartment_id
  @compartment_id
end

#display_name ⇒ String

A user-friendly name. Does not have to be unique.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 26

def display_name
  @display_name
end

#id ⇒ String

The VNIC’s Oracle ID (OCID).

Returns:

  • (String) 


30
31
32
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 30

def id
  @id
end

#lifecycle_state ⇒ String

The current state of the VNIC.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 34

def lifecycle_state
  @lifecycle_state
end

#private_ip ⇒ String

The private IP addresses of the VNIC, which is within the VNIC subnet and is accessible within the VCN.

Returns:

  • (String) 


40
41
42
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 40

def private_ip
  @private_ip
end

#public_ip ⇒ String

The public IP address of the VNIC, which Oracle performs NAT for at the gateway.

Returns:

  • (String) 


45
46
47
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 45

def public_ip
  @public_ip
end

#subnet_id ⇒ String

The OCID of the subnet the VNIC is in.

Returns:

  • (String) 


49
50
51
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 49

def subnet_id
  @subnet_id
end

#time_created ⇒ DateTime

The date and time the VNIC was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


56
57
58
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 56

def time_created
  @time_created
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 117

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      availability_domain == other_object.availability_domain &&
      compartment_id == other_object.compartment_id &&
      display_name == other_object.display_name &&
      id == other_object.id &&
      lifecycle_state == other_object.lifecycle_state &&
      private_ip == other_object.private_ip &&
      public_ip == other_object.public_ip &&
      subnet_id == other_object.subnet_id &&
      time_created == other_object.time_created
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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 146

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)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(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_object) ⇒ Boolean

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


133
134
135
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 133

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 139

def hash
  [availability_domain, compartment_id, display_name, id, lifecycle_state, private_ip, public_ip, subnet_id, time_created].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 171

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



165
166
167
 
# File 'lib/oraclebmc/core/models/vnic.rb', line 165

def to_s
  to_hash.to_s
end