Class: OCI::Jms::Models::LibraryUsage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms/models/library_usage.rb

Overview

Library usage during a specified time period.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ LibraryUsage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/oci/jms/models/library_usage.rb', line 142

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

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

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

  self.fleet_id = attributes[:'fleetId'] if attributes[:'fleetId']

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

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

  self.library_name = attributes[:'libraryName'] if attributes[:'libraryName']

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

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

  self.library_version = attributes[:'libraryVersion'] if attributes[:'libraryVersion']

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

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

  self.cvss_score = attributes[:'cvssScore'] if attributes[:'cvssScore']

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

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

  self.approximate_application_count = attributes[:'approximateApplicationCount'] if attributes[:'approximateApplicationCount']

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

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

  self.approximate_java_server_instance_count = attributes[:'approximateJavaServerInstanceCount'] if attributes[:'approximateJavaServerInstanceCount']

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

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

  self.approximate_deployed_application_count = attributes[:'approximateDeployedApplicationCount'] if attributes[:'approximateDeployedApplicationCount']

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

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

  self.approximate_managed_instance_count = attributes[:'approximateManagedInstanceCount'] if attributes[:'approximateManagedInstanceCount']

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

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

  self.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

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

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

  self.time_first_seen = attributes[:'timeFirstSeen'] if attributes[:'timeFirstSeen']

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

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

  self.time_last_seen = attributes[:'timeLastSeen'] if attributes[:'timeLastSeen']

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

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

Instance Attribute Details

#approximate_application_count ⇒ Integer

The approximate count of applications using the library.

Returns:

  • (Integer) 


40
41
42
 
# File 'lib/oci/jms/models/library_usage.rb', line 40

def approximate_application_count
  @approximate_application_count
end

#approximate_deployed_application_count ⇒ Integer

The approximate count of deployed applications using the library.

Returns:

  • (Integer) 


50
51
52
 
# File 'lib/oci/jms/models/library_usage.rb', line 50

def approximate_deployed_application_count
  @approximate_deployed_application_count
end

#approximate_java_server_instance_count ⇒ Integer

The approximate count of Java Server instances using the library.

Returns:

  • (Integer) 


45
46
47
 
# File 'lib/oci/jms/models/library_usage.rb', line 45

def approximate_java_server_instance_count
  @approximate_java_server_instance_count
end

#approximate_managed_instance_count ⇒ Integer

The approximate count of managed instances using the library.

Returns:

  • (Integer) 


55
56
57
 
# File 'lib/oci/jms/models/library_usage.rb', line 55

def approximate_managed_instance_count
  @approximate_managed_instance_count
end

#cvss_score ⇒ Float

The Common Vulnerability Scoring System (CVSS) score.

Returns:

  • (Float) 


35
36
37
 
# File 'lib/oci/jms/models/library_usage.rb', line 35

def cvss_score
  @cvss_score
end

#fleet_id ⇒ String

[Required] The OCID of the related fleet.

Returns:

  • (String) 


20
21
22
 
# File 'lib/oci/jms/models/library_usage.rb', line 20

def fleet_id
  @fleet_id
end

#library_key ⇒ String

[Required] The internal identifier of the library.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/jms/models/library_usage.rb', line 15

def library_key
  @library_key
end

#library_name ⇒ String

[Required] The name of the library.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/jms/models/library_usage.rb', line 25

def library_name
  @library_name
end

#library_version ⇒ String

The version of the library.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/jms/models/library_usage.rb', line 30

def library_version
  @library_version
end

#time_end ⇒ DateTime

Upper bound of the specified time period filter. JMS provides a view of the data that is per day. The query uses only the date element of the parameter.

Returns:

  • (DateTime) 


63
64
65
 
# File 'lib/oci/jms/models/library_usage.rb', line 63

def time_end
  @time_end
end

#time_first_seen ⇒ DateTime

The date and time the resource was first reported to JMS. This is potentially before the specified time period provided by the filters. For example, a resource can be first reported to JMS before the start of a specified time period, if it is also reported during the time period.

Returns:

  • (DateTime) 


71
72
73
 
# File 'lib/oci/jms/models/library_usage.rb', line 71

def time_first_seen
  @time_first_seen
end

#time_last_seen ⇒ DateTime

The date and time the resource was last reported to JMS. This is potentially after the specified time period provided by the filters. For example, a resource can be last reported to JMS before the start of a specified time period, if it is also reported during the time period.

Returns:

  • (DateTime) 


79
80
81
 
# File 'lib/oci/jms/models/library_usage.rb', line 79

def time_last_seen
  @time_last_seen
end

#time_start ⇒ DateTime

Lower bound of the specified time period filter. JMS provides a view of the data that is per day. The query uses only the date element of the parameter.

Returns:

  • (DateTime) 


59
60
61
 
# File 'lib/oci/jms/models/library_usage.rb', line 59

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/oci/jms/models/library_usage.rb', line 82

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'library_key': :'libraryKey',
    'fleet_id': :'fleetId',
    'library_name': :'libraryName',
    'library_version': :'libraryVersion',
    'cvss_score': :'cvssScore',
    'approximate_application_count': :'approximateApplicationCount',
    'approximate_java_server_instance_count': :'approximateJavaServerInstanceCount',
    'approximate_deployed_application_count': :'approximateDeployedApplicationCount',
    'approximate_managed_instance_count': :'approximateManagedInstanceCount',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'time_first_seen': :'timeFirstSeen',
    'time_last_seen': :'timeLastSeen'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/oci/jms/models/library_usage.rb', line 103

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'library_key': :'String',
    'fleet_id': :'String',
    'library_name': :'String',
    'library_version': :'String',
    'cvss_score': :'Float',
    'approximate_application_count': :'Integer',
    'approximate_java_server_instance_count': :'Integer',
    'approximate_deployed_application_count': :'Integer',
    'approximate_managed_instance_count': :'Integer',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'time_first_seen': :'DateTime',
    'time_last_seen': :'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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/oci/jms/models/library_usage.rb', line 234

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

  self.class == other.class &&
    library_key == other.library_key &&
    fleet_id == other.fleet_id &&
    library_name == other.library_name &&
    library_version == other.library_version &&
    cvss_score == other.cvss_score &&
    approximate_application_count == other.approximate_application_count &&
    approximate_java_server_instance_count == other.approximate_java_server_instance_count &&
    approximate_deployed_application_count == other.approximate_deployed_application_count &&
    approximate_managed_instance_count == other.approximate_managed_instance_count &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    time_first_seen == other.time_first_seen &&
    time_last_seen == other.time_last_seen
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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/jms/models/library_usage.rb', line 276

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


256
257
258
 
# File 'lib/oci/jms/models/library_usage.rb', line 256

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



265
266
267
 
# File 'lib/oci/jms/models/library_usage.rb', line 265

def hash
  [library_key, fleet_id, library_name, library_version, cvss_score, approximate_application_count, approximate_java_server_instance_count, approximate_deployed_application_count, approximate_managed_instance_count, time_start, time_end, time_first_seen, time_last_seen].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
318
 
# File 'lib/oci/jms/models/library_usage.rb', line 309

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



303
304
305
 
# File 'lib/oci/jms/models/library_usage.rb', line 303

def to_s
  to_hash.to_s
end