Class: OCI::Core::Models::UpdateCrossConnectLetterOfAuthorityDetails

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

Overview

Update the details of the Letter of Authority associated with a cross-connect. Upon successful alterations a new updated copy of the LOA will be attached to the cross-connect.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ UpdateCrossConnectLetterOfAuthorityDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 66

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.should_extend = attributes[:'shouldExtend'] unless attributes[:'shouldExtend'].nil?

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

  self.should_extend = attributes[:'should_extend'] unless attributes[:'should_extend'].nil?

  self.should_remove_authorized_agent = attributes[:'shouldRemoveAuthorizedAgent'] unless attributes[:'shouldRemoveAuthorizedAgent'].nil?

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

  self.should_remove_authorized_agent = attributes[:'should_remove_authorized_agent'] unless attributes[:'should_remove_authorized_agent'].nil?

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

Instance Attribute Details

#authorized_agent ⇒ String

Name of a customer authorized agent which will be appended to the LOA as the field 'Authorized Agent'. If the field is left un-set in the request body, no changes will be done on the LOA for Authorized Agent.

Returns:

  • (String) 


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

def authorized_agent
  @authorized_agent
end

#should_extend ⇒ BOOLEAN

A boolean flag to indicate whether to extend the expiry of the associated LOA with the provided cross-connect. If un-set or set to false, it does not alter the existing expiry of the LOA. On extension an updated copy of the LOA will be provided with the new expiry date. An LOA cannot be extended more than 3 times.

Returns:

  • (BOOLEAN) 


19
20
21
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 19

def should_extend
  @should_extend
end

#should_remove_authorized_agent ⇒ BOOLEAN

A boolean flag to indicate whether to remove an attached Authorized Agent to the LOA. If this boolean flag is set, an attempt will be made to remove the attached authorized agent to the LOA, if any, and any value given in the field 'authorizedAgent' will be ignored. In case, of updating an existing Authorized Agent, keep this flag unset and set the expected value in 'authorizedAgent'.

Returns:

  • (BOOLEAN) 


27
28
29
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 27

def should_remove_authorized_agent
  @should_remove_authorized_agent
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'should_extend': :'shouldExtend',
    'should_remove_authorized_agent': :'shouldRemoveAuthorizedAgent',
    'authorized_agent': :'authorizedAgent'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 47

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'should_extend': :'BOOLEAN',
    'should_remove_authorized_agent': :'BOOLEAN',
    'authorized_agent': :'String'
    # 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



98
99
100
101
102
103
104
105
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 98

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

  self.class == other.class &&
    should_extend == other.should_extend &&
    should_remove_authorized_agent == other.should_remove_authorized_agent &&
    authorized_agent == other.authorized_agent
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 130

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


110
111
112
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 110

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



119
120
121
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 119

def hash
  [should_extend, should_remove_authorized_agent, authorized_agent].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



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

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



157
158
159
 
# File 'lib/oci/core/models/update_cross_connect_letter_of_authority_details.rb', line 157

def to_s
  to_hash.to_s
end