Class: OCI::JmsJavaDownloads::Models::RequestSummarizedJavaDownloadCountsDetails

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

Overview

Attributes to summarize the Java download counts in a tenancy.

Constant Summary collapse

GROUP_AS_ENUM = 
[
  GROUP_AS_JAVA_FAMILY = 'JAVA_FAMILY'.freeze,
  GROUP_AS_JAVA_RELEASE = 'JAVA_RELEASE'.freeze,
  GROUP_AS_PLATFORM = 'PLATFORM'.freeze
].freeze
SORT_BY_ENUM = 
[
  SORT_BY_FAMILY_VERSION = 'FAMILY_VERSION'.freeze,
  SORT_BY_DOWNLOAD_COUNT = 'DOWNLOAD_COUNT'.freeze
].freeze
SORT_ORDER_ENUM = 
[
  SORT_ORDER_ASC = 'ASC'.freeze,
  SORT_ORDER_DESC = 'DESC'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RequestSummarizedJavaDownloadCountsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :group_as (String) —

    The value to assign to the #group_as property

  • :family_version (String) —

    The value to assign to the #family_version property

  • :release_version (String) —

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

  • :limit (Integer) —

    The value to assign to the #limit property

  • :page (String) —

    The value to assign to the #page 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
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.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.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.group_as = attributes[:'groupAs'] if attributes[:'groupAs']

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

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

  self.family_version = attributes[:'familyVersion'] if attributes[:'familyVersion']

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

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

  self.release_version = attributes[:'releaseVersion'] if attributes[:'releaseVersion']

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

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

  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']
  self.sort_by = "FAMILY_VERSION" if sort_by.nil? && !attributes.key?(:'sortBy') # rubocop:disable Style/StringLiterals

  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_by = "FAMILY_VERSION" if sort_by.nil? && !attributes.key?(:'sortBy') && !attributes.key?(:'sort_by') # rubocop:disable Style/StringLiterals

  self.sort_order = attributes[:'sortOrder'] if attributes[:'sortOrder']
  self.sort_order = "DESC" if sort_order.nil? && !attributes.key?(:'sortOrder') # rubocop:disable Style/StringLiterals

  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.sort_order = "DESC" if sort_order.nil? && !attributes.key?(:'sortOrder') && !attributes.key?(:'sort_order') # rubocop:disable Style/StringLiterals

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The compartment OCID here should be the tenancy OCID.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 30

def compartment_id
  @compartment_id
end

#family_version ⇒ String

Unique Java family version identifier.

Returns:

  • (String) 


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

def family_version
  @family_version
end

#group_as ⇒ String

[Required] Group as property specifying the aggregation type for download counts.

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 34

def group_as
  @group_as
end

#limit ⇒ Integer

The maximum number of items to return.

Returns:

  • (Integer) 


64
65
66
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 64

def limit
  @limit
end

#page ⇒ String

The page token representing the page at which to start retrieving results. The token is usually retrieved from a previous call.

Returns:

  • (String) 


69
70
71
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 69

def page
  @page
end

#release_version ⇒ String

Unique Java release version identifier.

Returns:

  • (String) 


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

def release_version
  @release_version
end

#sort_by ⇒ String

The property to be used for sorting the aggregated report.

Returns:

  • (String) 


56
57
58
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 56

def sort_by
  @sort_by
end

#sort_order ⇒ String

The sort order for the aggregated report.

Returns:

  • (String) 


60
61
62
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 60

def sort_order
  @sort_order
end

#time_end ⇒ DateTime

The end time until when the download data has to be included (formatted according to RFC3339).

Returns:

  • (DateTime) 


52
53
54
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 52

def time_end
  @time_end
end

#time_start ⇒ DateTime

The start time from when download data has to be included (formatted according to RFC3339).

Returns:

  • (DateTime) 


47
48
49
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 47

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 72

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'group_as': :'groupAs',
    'family_version': :'familyVersion',
    'release_version': :'releaseVersion',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'sort_by': :'sortBy',
    'sort_order': :'sortOrder',
    'limit': :'limit',
    'page': :'page'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 90

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'group_as': :'String',
    'family_version': :'String',
    'release_version': :'String',
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'sort_by': :'String',
    'sort_order': :'String',
    'limit': :'Integer',
    'page': :'String'
    # 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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 217

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    group_as == other.group_as &&
    family_version == other.family_version &&
    release_version == other.release_version &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    sort_by == other.sort_by &&
    sort_order == other.sort_order &&
    limit == other.limit &&
    page == other.page
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



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

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


236
237
238
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 236

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



245
246
247
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 245

def hash
  [compartment_id, group_as, family_version, release_version, time_start, time_end, sort_by, sort_order, limit, page].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



289
290
291
292
293
294
295
296
297
298
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 289

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



283
284
285
 
# File 'lib/oci/jms_java_downloads/models/request_summarized_java_download_counts_details.rb', line 283

def to_s
  to_hash.to_s
end