Class: OCI::JmsJavaDownloads::Models::JavaDownloadReport

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/jms_java_downloads/models/java_download_report.rb

Overview

Details about a Java download report in a tenancy. The report is a file in Object Storage. It contains the download records in a specific format.

Constant Summary collapse

FORMAT_ENUM = 
[
  FORMAT_CSV = 'CSV'.freeze,
  FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
CHECKSUM_TYPE_ENUM = 
[
  CHECKSUM_TYPE_SHA256 = 'SHA256'.freeze,
  CHECKSUM_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SORT_BY_ENUM = 
[
  SORT_BY_TIME_DOWNLOADED = 'timeDownloaded'.freeze,
  SORT_BY_DOWNLOAD_SOURCE_ID = 'downloadSourceId'.freeze,
  SORT_BY_DOWNLOAD_TYPE = 'downloadType'.freeze,
  SORT_BY_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
SORT_ORDER_ENUM = 
[
  SORT_ORDER_ASC = 'ASC'.freeze,
  SORT_ORDER_DESC = 'DESC'.freeze,
  SORT_ORDER_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze
LIFECYCLE_STATE_ENUM = 
[
  LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze,
  LIFECYCLE_STATE_CREATING = 'CREATING'.freeze,
  LIFECYCLE_STATE_DELETED = 'DELETED'.freeze,
  LIFECYCLE_STATE_DELETING = 'DELETING'.freeze,
  LIFECYCLE_STATE_FAILED = 'FAILED'.freeze,
  LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'.freeze,
  LIFECYCLE_STATE_UPDATING = 'UPDATING'.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 = {}) ⇒ JavaDownloadReport

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

  • :format (String) —

    The value to assign to the #format property

  • :file_size_in_bytes (Integer) —

    The value to assign to the #file_size_in_bytes property

  • :checksum_type (String) —

    The value to assign to the #checksum_type property

  • :checksum_value (String) —

    The value to assign to the #checksum_value property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :created_by (OCI::JmsJavaDownloads::Models::Principal) —

    The value to assign to the #created_by property

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :time_start (DateTime) —

    The value to assign to the #time_start property

  • :time_end (DateTime) —

    The value to assign to the #time_end property

  • :sort_by (String) —

    The value to assign to the #sort_by property

  • :sort_order (String) —

    The value to assign to the #sort_order property

  • :lifecycle_state (String) —

    The value to assign to the #lifecycle_state property

  • :freeform_tags (Hash<String, String>) —

    The value to assign to the #freeform_tags property

  • :defined_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #defined_tags property

  • :system_tags (Hash<String, Hash<String, Object>>) —

    The value to assign to the #system_tags property



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 202

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

  self.file_size_in_bytes = attributes[:'fileSizeInBytes'] if attributes[:'fileSizeInBytes']

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

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

  self.checksum_type = attributes[:'checksumType'] if attributes[:'checksumType']

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

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

  self.checksum_value = attributes[:'checksumValue'] if attributes[:'checksumValue']

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

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

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

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

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

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

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

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

  self.sort_order = attributes[:'sortOrder'] if attributes[:'sortOrder']

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

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

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

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#checksum_type ⇒ String

[Required] The algorithm used for calculating the checksum.

Returns:

  • (String) 


67
68
69
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 67

def checksum_type
  @checksum_type
end

#checksum_value ⇒ String

[Required] The checksum value of the Java download report file.

Returns:

  • (String) 


71
72
73
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 71

def checksum_value
  @checksum_value
end

#compartment_id ⇒ String

[Required] The OCID of the tenancy scoped to the Java download report.

Returns:

  • (String) 


76
77
78
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 76

def compartment_id
  @compartment_id
end

#created_by ⇒ OCI::JmsJavaDownloads::Models::Principal

This attribute is required.

Returns:



80
81
82
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 80

def created_by
  @created_by
end

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}. (See {Understanding Free-form Tags}[https://docs.cloud.oracle.com/Content/Tagging/Tasks/managingtagsandtagnamespaces.htm]).

Returns:

  • (Hash<String, Hash<String, Object>>) 


118
119
120
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 118

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Display name for the Java download report.

Returns:

  • (String) 


55
56
57
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 55

def display_name
  @display_name
end

#file_size_in_bytes ⇒ Integer

[Required] Approximate size of the Java download report file in bytes.

Returns:

  • (Integer) 


63
64
65
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 63

def file_size_in_bytes
  @file_size_in_bytes
end

#format ⇒ String

[Required] The file format of the Java download report.

Returns:

  • (String) 


59
60
61
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 59

def format
  @format
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}. (See {Managing Tags and Tag Namespaces}[https://docs.cloud.oracle.com/Content/Tagging/Concepts/understandingfreeformtags.htm].)

Returns:

  • (Hash<String, String>) 


112
113
114
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 112

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Java download report.

Returns:

  • (String) 


51
52
53
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 51

def id
  @id
end

#lifecycle_state ⇒ String

[Required] The current state of the Java download report.

Returns:

  • (String) 


106
107
108
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 106

def lifecycle_state
  @lifecycle_state
end

#sort_by ⇒ String

The property used for sorting the records.

Returns:

  • (String) 


98
99
100
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 98

def sort_by
  @sort_by
end

#sort_order ⇒ String

The sort order for the records.

Returns:

  • (String) 


102
103
104
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 102

def sort_order
  @sort_order
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. System tags can be viewed by users, but can only be created by the system.

Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


127
128
129
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 127

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Java download report was created, displayed as an RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


84
85
86
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 84

def time_created
  @time_created
end

#time_end ⇒ DateTime

The end time until when the download records are included (formatted according to RFC3339).

Returns:

  • (DateTime) 


94
95
96
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 94

def time_end
  @time_end
end

#time_start ⇒ DateTime

The start time from when the download records are included (formatted according to RFC3339).

Returns:

  • (DateTime) 


89
90
91
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 89

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



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/jms_java_downloads/models/java_download_report.rb', line 130

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'id',
    'display_name': :'displayName',
    'format': :'format',
    'file_size_in_bytes': :'fileSizeInBytes',
    'checksum_type': :'checksumType',
    'checksum_value': :'checksumValue',
    'compartment_id': :'compartmentId',
    'created_by': :'createdBy',
    'time_created': :'timeCreated',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'sort_by': :'sortBy',
    'sort_order': :'sortOrder',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 155

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'id': :'String',
    'display_name': :'String',
    'format': :'String',
    'file_size_in_bytes': :'Integer',
    'checksum_type': :'String',
    'checksum_value': :'String',
    'compartment_id': :'String',
    'created_by': :'OCI::JmsJavaDownloads::Models::Principal',
    'time_created': :'DateTime',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'sort_by': :'String',
    'sort_order': :'String',
    'lifecycle_state': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 375

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

  self.class == other.class &&
    id == other.id &&
    display_name == other.display_name &&
    format == other.format &&
    file_size_in_bytes == other.file_size_in_bytes &&
    checksum_type == other.checksum_type &&
    checksum_value == other.checksum_value &&
    compartment_id == other.compartment_id &&
    created_by == other.created_by &&
    time_created == other.time_created &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    sort_by == other.sort_by &&
    sort_order == other.sort_order &&
    lifecycle_state == other.lifecycle_state &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 421

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


401
402
403
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 401

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



410
411
412
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 410

def hash
  [id, display_name, format, file_size_in_bytes, checksum_type, checksum_value, compartment_id, created_by, time_created, time_start, time_end, sort_by, sort_order, lifecycle_state, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



454
455
456
457
458
459
460
461
462
463
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 454

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



448
449
450
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 448

def to_s
  to_hash.to_s
end