Class: OCI::ManagementAgent::Models::CreateManagementAgentInstallKeyDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/management_agent/models/create_management_agent_install_key_details.rb

Overview

The information about new Management Agent install Key.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateManagementAgentInstallKeyDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :allowed_key_install_count (Integer) —

    The value to assign to the #allowed_key_install_count property

  • :time_expires (DateTime) —

    The value to assign to the #time_expires property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :is_unlimited (BOOLEAN) —

    The value to assign to the #is_unlimited property



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/oci/management_agent/models/create_management_agent_install_key_details.rb', line 67

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

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

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

  self.allowed_key_install_count = attributes[:'allowedKeyInstallCount'] if attributes[:'allowedKeyInstallCount']

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

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

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

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

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

  self.is_unlimited = attributes[:'isUnlimited'] unless attributes[:'isUnlimited'].nil?
  self.is_unlimited = false if is_unlimited.nil? && !attributes.key?(:'isUnlimited') # rubocop:disable Style/StringLiterals

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

  self.is_unlimited = attributes[:'is_unlimited'] unless attributes[:'is_unlimited'].nil?
  self.is_unlimited = false if is_unlimited.nil? && !attributes.key?(:'isUnlimited') && !attributes.key?(:'is_unlimited') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#allowed_key_install_count ⇒ Integer

Total number of install for this keys

Returns:

  • (Integer) 


16
17
18
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 16

def allowed_key_install_count
  @allowed_key_install_count
end

#compartment_id ⇒ String

**[Required]** Compartment Identifier

Returns:

  • (String) 


24
25
26
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 24

def compartment_id
  @compartment_id
end

#display_name ⇒ String

**[Required]** Management Agent install Key Name

Returns:

  • (String) 


12
13
14
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 12

def display_name
  @display_name
end

#is_unlimited ⇒ BOOLEAN

If set to true, the install key has no expiration date or usage limit. Defaults to false

Returns:

  • (BOOLEAN) 


28
29
30
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 28

def is_unlimited
  @is_unlimited
end

#time_expires ⇒ DateTime

date after which key would expire after creation

Returns:

  • (DateTime) 


20
21
22
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 20

def time_expires
  @time_expires
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'allowed_key_install_count': :'allowedKeyInstallCount',
    'time_expires': :'timeExpires',
    'compartment_id': :'compartmentId',
    'is_unlimited': :'isUnlimited'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 44

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'allowed_key_install_count': :'Integer',
    'time_expires': :'DateTime',
    'compartment_id': :'String',
    'is_unlimited': :'BOOLEAN'
    # 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



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 113

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

  self.class == other.class &&
    display_name == other.display_name &&
    allowed_key_install_count == other.allowed_key_install_count &&
    time_expires == other.time_expires &&
    compartment_id == other.compartment_id &&
    is_unlimited == other.is_unlimited
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



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 147

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


127
128
129
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 127

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 136

def hash
  [display_name, allowed_key_install_count, time_expires, compartment_id, is_unlimited].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 180

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



174
175
176
 
# File 'lib/oci/management_agent/models/create_management_agent_install_key_details.rb', line 174

def to_s
  to_hash.to_s
end