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
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

  • :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



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
226
227
228
229
230
231
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 159

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  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.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) 


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

def checksum_type
  @checksum_type
end

#checksum_value ⇒ String

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

Returns:

  • (String) 


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

def checksum_value
  @checksum_value
end

#compartment_id ⇒ String

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

Returns:

  • (String) 


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

def compartment_id
  @compartment_id
end

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

This attribute is required.

Returns:



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

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>>) 


87
88
89
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 87

def defined_tags
  @defined_tags
end

#display_name ⇒ String

[Required] Display name for the Java download report.

Returns:

  • (String) 


42
43
44
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 42

def display_name
  @display_name
end

#file_size_in_bytes ⇒ Integer

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

Returns:

  • (Integer) 


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

def file_size_in_bytes
  @file_size_in_bytes
end

#format ⇒ String

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

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 46

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>) 


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

def freeform_tags
  @freeform_tags
end

#id ⇒ String

[Required] The OCID of the Java download report.

Returns:

  • (String) 


38
39
40
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 38

def id
  @id
end

#lifecycle_state ⇒ String

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

Returns:

  • (String) 


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

def lifecycle_state
  @lifecycle_state
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>>) 


96
97
98
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 96

def system_tags
  @system_tags
end

#time_created ⇒ DateTime

[Required] The time the Java download report was created. An RFC3339 formatted datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

Class Method Details

.attribute_map ⇒ Object

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



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 99

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',
    'lifecycle_state': :'lifecycleState',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 120

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',
    '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



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 279

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 &&
    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



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 321

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


301
302
303
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 301

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



310
311
312
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 310

def hash
  [id, display_name, format, file_size_in_bytes, checksum_type, checksum_value, compartment_id, created_by, time_created, 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



354
355
356
357
358
359
360
361
362
363
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 354

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



348
349
350
 
# File 'lib/oci/jms_java_downloads/models/java_download_report.rb', line 348

def to_s
  to_hash.to_s
end