Class: OCI::ManagementAgent::Models::ManagementAgentInstallKeySummary

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

Overview

The summary of the Agent Install Key details.

Constant Summary collapse

LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.freeze,
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze,
  LIFECYCLE_STATE_TERMINATED = 'TERMINATED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ManagementAgentInstallKeySummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :id (String) —

    The value to assign to the #id property

  • :display_name (String) —

    The value to assign to the #display_name property

  • :created_by_principal_id (String) —

    The value to assign to the #created_by_principal_id property

  • :allowed_key_install_count (Integer) —

    The value to assign to the #allowed_key_install_count property

  • :current_key_install_count (Integer) —

    The value to assign to the #current_key_install_count property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :lifecycle_details (String) —

    The value to assign to the #lifecycle_details property

  • :time_created (DateTime) —

    The value to assign to the #time_created 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



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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 123

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

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

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

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

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

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

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

  self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState']

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

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

  self.lifecycle_details = attributes[:'lifecycleDetails'] if attributes[:'lifecycleDetails']

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

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

  self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated']

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

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

  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) 


38
39
40
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 38

def allowed_key_install_count
  @allowed_key_install_count
end

#compartment_id ⇒ String

[Required] Compartment Identifier

Returns:

  • (String) 


62
63
64
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 62

def compartment_id
  @compartment_id
end

#created_by_principal_id ⇒ String

Principal id of user who created the Agent Install key

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 34

def created_by_principal_id
  @created_by_principal_id
end

#current_key_install_count ⇒ Integer

Total number of install for this keys

Returns:

  • (Integer) 


42
43
44
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 42

def current_key_install_count
  @current_key_install_count
end

#display_name ⇒ String

Management Agent Install Key Name

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 30

def display_name
  @display_name
end

#id ⇒ String

[Required] Agent Install Key identifier

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 26

def id
  @id
end

#is_unlimited ⇒ BOOLEAN

If set to true, the install key has no expiration date or usage limit. Properties allowedKeyInstallCount and timeExpires are ignored if set to true. Defaults to false.

Returns:

  • (BOOLEAN) 


66
67
68
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 66

def is_unlimited
  @is_unlimited
end

#lifecycle_details ⇒ String

A message describing the current state in more detail. For example, can be used to provide actionable information for a resource in Failed state.

Returns:

  • (String) 


50
51
52
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 50

def lifecycle_details
  @lifecycle_details
end

#lifecycle_state ⇒ String

Status of Key

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 46

def lifecycle_state
  @lifecycle_state
end

#time_created ⇒ DateTime

The time when Management Agent install Key was created. An RFC3339 formatted date time string

Returns:

  • (DateTime) 


54
55
56
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 54

def time_created
  @time_created
end

#time_expires ⇒ DateTime

date after which key would expire after creation

Returns:

  • (DateTime) 


58
59
60
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 58

def time_expires
  @time_expires
end

Class Method Details

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 69

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'created_by_principal_id': :'createdByPrincipalId',
    'allowed_key_install_count': :'allowedKeyInstallCount',
    'current_key_install_count': :'currentKeyInstallCount',
    'lifecycle_state': :'lifecycleState',
    'lifecycle_details': :'lifecycleDetails',
    'time_created': :'timeCreated',
    'time_expires': :'timeExpires',
    'compartment_id': :'compartmentId',
    'is_unlimited': :'isUnlimited'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 88

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'created_by_principal_id': :'String',
    'allowed_key_install_count': :'Integer',
    'current_key_install_count': :'Integer',
    'lifecycle_state': :'String',
    'lifecycle_details': :'String',
    'time_created': :'DateTime',
    '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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 214

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    created_by_principal_id == other.created_by_principal_id &&
    allowed_key_install_count == other.allowed_key_install_count &&
    current_key_install_count == other.current_key_install_count &&
    lifecycle_state == other.lifecycle_state &&
    lifecycle_details == other.lifecycle_details &&
    time_created == other.time_created &&
    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



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 254

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


234
235
236
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 234

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



243
244
245
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 243

def hash
  [id, display_name, created_by_principal_id, allowed_key_install_count, current_key_install_count, lifecycle_state, lifecycle_details, time_created, 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



287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 287

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



281
282
283
 
# File 'lib/oci/management_agent/models/management_agent_install_key_summary.rb', line 281

def to_s
  to_hash.to_s
end