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'.freeze,
  CIRCUIT_TYPE_SINGLE_MODE_SC = 'Single_mode_SC'.freeze,
  CIRCUIT_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method 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):



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 108

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  self.authorized_agent = attributes[:'authorizedAgent'] if attributes[:'authorizedAgent']

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

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

  self.extension_details = attributes[:'extensionDetails'] if attributes[:'extensionDetails']

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

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

Instance Attribute Details

#authorized_agent ⇒ String

Name of a customer authorized agent which will be appended to the LOA as 'Authorized Agent'.

Returns:

  • (String) 


54
55
56
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 54

def authorized_agent
  @authorized_agent
end

#authorized_entity_name ⇒ String

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

Returns:

  • (String) 


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

def authorized_entity_name
  @authorized_entity_name
end

#circuit_type ⇒ String

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

Returns:

  • (String) 


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

def circuit_type
  @circuit_type
end

#cross_connect_id ⇒ String

The OCID of the cross-connect.

Returns:

  • (String) 


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

def cross_connect_id
  @cross_connect_id
end

#extension_details ⇒ OCI::Core::Models::LoaExtensionData

Returns:



57
58
59
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 57

def extension_details
  @extension_details
end

#facility_location ⇒ String

The address of the FastConnect location.

Returns:

  • (String) 


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

def facility_location
  @facility_location
end

#port_name ⇒ String

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

Returns:

  • (String) 


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

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) 


43
44
45
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 43

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) 


50
51
52
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 50

def time_issued
  @time_issued
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 60

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'authorized_entity_name': :'authorizedEntityName',
    'circuit_type': :'circuitType',
    'cross_connect_id': :'crossConnectId',
    'facility_location': :'facilityLocation',
    'port_name': :'portName',
    'time_expires': :'timeExpires',
    'time_issued': :'timeIssued',
    'authorized_agent': :'authorizedAgent',
    'extension_details': :'extensionDetails'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'authorized_entity_name': :'String',
    'circuit_type': :'String',
    'cross_connect_id': :'String',
    'facility_location': :'String',
    'port_name': :'String',
    'time_expires': :'DateTime',
    'time_issued': :'DateTime',
    'authorized_agent': :'String',
    'extension_details': :'OCI::Core::Models::LoaExtensionData'
    # 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



189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 189

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

  self.class == other.class &&
    authorized_entity_name == other.authorized_entity_name &&
    circuit_type == other.circuit_type &&
    cross_connect_id == other.cross_connect_id &&
    facility_location == other.facility_location &&
    port_name == other.port_name &&
    time_expires == other.time_expires &&
    time_issued == other.time_issued &&
    authorized_agent == other.authorized_agent &&
    extension_details == other.extension_details
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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 227

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


207
208
209
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 207

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



216
217
218
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 216

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

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



260
261
262
263
264
265
266
267
268
269
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 260

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



254
255
256
 
# File 'lib/oci/core/models/letter_of_authority.rb', line 254

def to_s
  to_hash.to_s
end