Class: OCI::Core::Models::LetterOfAuthority

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/core/models/letter_of_authority.rb

Overview

The Letter of Authority for the cross-connect. You must submit this letter when requesting cabling for the cross-connect at the FastConnect location.

Constant Summary collapse

CIRCUIT_TYPE_ENUM = 
[CIRCUIT_TYPE_SINGLE_MODE_LC = 'Single_mode_LC',
CIRCUIT_TYPE_SINGLE_MODE_SC = 'Single_mode_SC',
CIRCUIT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE']

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LetterOfAuthority

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :authorized_entity_name (String) —

    The value to assign to the #authorized_entity_name property

  • :circuit_type (String) —

    The value to assign to the #circuit_type property

  • :cross_connect_id (String) —

    The value to assign to the #cross_connect_id property

  • :facility_location (String) —

    The value to assign to the #facility_location property

  • :port_name (String) —

    The value to assign to the #port_name property

  • :time_expires (DateTime) —

    The value to assign to the #time_expires property

  • :time_issued (DateTime) —

    The value to assign to the #time_issued property



57
58
59
60
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
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
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 57

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[:'authorizedEntityName']
    self.authorized_entity_name = attributes[:'authorizedEntityName']
  end

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

  if attributes[:'authorized_entity_name']
    self.authorized_entity_name = attributes[:'authorized_entity_name']
  end

  if attributes[:'circuitType']
    self.circuit_type = attributes[:'circuitType']
  end

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

  if attributes[:'circuit_type']
    self.circuit_type = attributes[:'circuit_type']
  end

  if attributes[:'crossConnectId']
    self.cross_connect_id = attributes[:'crossConnectId']
  end

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

  if attributes[:'cross_connect_id']
    self.cross_connect_id = attributes[:'cross_connect_id']
  end

  if attributes[:'facilityLocation']
    self.facility_location = attributes[:'facilityLocation']
  end

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

  if attributes[:'facility_location']
    self.facility_location = attributes[:'facility_location']
  end

  if attributes[:'portName']
    self.port_name = attributes[:'portName']
  end

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

  if attributes[:'port_name']
    self.port_name = attributes[:'port_name']
  end

  if attributes[:'timeExpires']
    self.time_expires = attributes[:'timeExpires']
  end

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

  if attributes[:'time_expires']
    self.time_expires = attributes[:'time_expires']
  end

  if attributes[:'timeIssued']
    self.time_issued = attributes[:'timeIssued']
  end

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

  if attributes[:'time_issued']
    self.time_issued = attributes[:'time_issued']
  end

end

Instance Attribute Details

#authorized_entity_name ⇒ String

The name of the entity authorized by this Letter of Authority.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 17

def authorized_entity_name
  @authorized_entity_name
end

#circuit_type ⇒ String

The type of cross-connect fiber, termination, and optical specification.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 21

def circuit_type
  @circuit_type
end

#cross_connect_id ⇒ String

The OCID of the cross-connect.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 25

def cross_connect_id
  @cross_connect_id
end

#facility_location ⇒ String

The address of the FastConnect location.

Returns:

  • (String) 


29
30
31
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 29

def facility_location
  @facility_location
end

#port_name ⇒ String

The meet-me room port for this cross-connect.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 33

def port_name
  @port_name
end

#time_expires ⇒ DateTime

The date and time when the Letter of Authority expires, in the format defined by RFC3339.

Returns:

  • (DateTime) 


38
39
40
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 38

def time_expires
  @time_expires
end

#time_issued ⇒ DateTime

The date and time the Letter of Authority was created, in the format defined by RFC3339.

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

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 45

def time_issued
  @time_issued
end

Instance Method Details

#==(other_object) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other_object (Object) —

    to be compared



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 147

def ==(other_object)
  return true if self.equal?(other_object)
  self.class == other_object.class &&
      authorized_entity_name == other_object.authorized_entity_name &&
      circuit_type == other_object.circuit_type &&
      cross_connect_id == other_object.cross_connect_id &&
      facility_location == other_object.facility_location &&
      port_name == other_object.port_name &&
      time_expires == other_object.time_expires &&
      time_issued == other_object.time_issued
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



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 174

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

Parameters:

  • other_object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


161
162
163
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 161

def eql?(other_object)
  self == other_object
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



167
168
169
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 167

def hash
  [authorized_entity_name, circuit_type, cross_connect_id, facility_location, port_name, time_expires, time_issued].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 199

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



193
194
195
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 193

def to_s
  to_hash.to_s
end