Class: OCI::JmsJavaDownloads::Models::CreateJavaDownloadReportDetails

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

Overview

Attributes to create a Java download report.

Constant Summary collapse

SORT_BY_ENUM = 
[
  SORT_BY_TIME_DOWNLOADED = 'timeDownloaded'.freeze,
  SORT_BY_DOWNLOAD_SOURCE_ID = 'downloadSourceId'.freeze,
  SORT_BY_DOWNLOAD_TYPE = 'downloadType'.freeze
].freeze
SORT_ORDER_ENUM = 
[
  SORT_ORDER_ASC = 'ASC'.freeze,
  SORT_ORDER_DESC = 'DESC'.freeze
].freeze
FORMAT_ENUM = 
[
  FORMAT_CSV = 'CSV'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateJavaDownloadReportDetails

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

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

  • :format (String) —

    The value to assign to the #format property



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 94

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.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 = "timeDownloaded" 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 = "timeDownloaded" 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.format = attributes[:'format'] if attributes[:'format']
  self.format = "CSV" if format.nil? && !attributes.key?(:'format') # rubocop:disable Style/StringLiterals
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/create_java_download_report_details.rb', line 30

def compartment_id
  @compartment_id
end

#format ⇒ String

[Required] The format of the report that is generated.

Returns:

  • (String) 


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

def format
  @format
end

#sort_by ⇒ String

The property to be used for sorting the reports.

Returns:

  • (String) 


44
45
46
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 44

def sort_by
  @sort_by
end

#sort_order ⇒ String

The sort order for the reports.

Returns:

  • (String) 


48
49
50
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 48

def sort_order
  @sort_order
end

#time_end ⇒ DateTime

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

Returns:

  • (DateTime) 


40
41
42
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 40

def time_end
  @time_end
end

#time_start ⇒ DateTime

The start time from when download records have to be included (formatted according to RFC3339).

Returns:

  • (DateTime) 


35
36
37
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 35

def time_start
  @time_start
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 55

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'sort_by': :'sortBy',
    'sort_order': :'sortOrder',
    'format': :'format'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 69

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



169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 169

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    sort_by == other.sort_by &&
    sort_order == other.sort_order &&
    format == other.format
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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 204

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


184
185
186
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 184

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



193
194
195
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 193

def hash
  [compartment_id, time_start, time_end, sort_by, sort_order, format].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
240
241
242
243
244
245
246
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 237

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



231
232
233
 
# File 'lib/oci/jms_java_downloads/models/create_java_download_report_details.rb', line 231

def to_s
  to_hash.to_s
end