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

  • :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



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
134
135
136
137
138
139
140
141
# File 'lib/oci/core/models/letter_of_authority.rb', line 94

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

Instance Attribute Details

#authorized_entity_nameString

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

Returns:

  • (String)


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

def authorized_entity_name
  @authorized_entity_name
end

#circuit_typeString

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

Returns:

  • (String)


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

def circuit_type
  @circuit_type
end

#cross_connect_idString

The OCID of the cross-connect.

Returns:

  • (String)


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

def cross_connect_id
  @cross_connect_id
end

#facility_locationString

The address of the FastConnect location.

Returns:

  • (String)


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

def facility_location
  @facility_location
end

#port_nameString

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

Returns:

  • (String)


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

def port_name
  @port_name
end

#time_expiresDateTime

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

Returns:

  • (DateTime)


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

def time_expires
  @time_expires
end

#time_issuedDateTime

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)


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

def time_issued
  @time_issued
end

Class Method Details

.attribute_mapObject

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



52
53
54
55
56
57
58
59
60
61
62
63
64
# File 'lib/oci/core/models/letter_of_authority.rb', line 52

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'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_typesObject

Attribute type mapping.



67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/oci/core/models/letter_of_authority.rb', line 67

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'
    # 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



163
164
165
166
167
168
169
170
171
172
173
174
# File 'lib/oci/core/models/letter_of_authority.rb', line 163

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



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/oci/core/models/letter_of_authority.rb', line 199

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


179
180
181
# File 'lib/oci/core/models/letter_of_authority.rb', line 179

def eql?(other)
  self == other
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



188
189
190
# File 'lib/oci/core/models/letter_of_authority.rb', line 188

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

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



232
233
234
235
236
237
238
239
240
241
# File 'lib/oci/core/models/letter_of_authority.rb', line 232

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



226
227
228
# File 'lib/oci/core/models/letter_of_authority.rb', line 226

def to_s
  to_hash.to_s
end