Class: OCI::DataSafe::Models::GenerateReportDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/data_safe/models/generate_report_details.rb

Overview

Details for the report generation.

Constant Summary collapse

MIME_TYPE_ENUM = 
[
  MIME_TYPE_PDF = 'PDF'.freeze,
  MIME_TYPE_XLS = 'XLS'.freeze,
  MIME_TYPE_JSON = 'JSON'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GenerateReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :display_name (String) —

    The value to assign to the #display_name property

  • :target_ids (Array<String>) —

    The value to assign to the #target_ids property

  • :description (String) —

    The value to assign to the #description property

  • :compartment_id (String) —

    The value to assign to the #compartment_id property

  • :mime_type (String) —

    The value to assign to the #mime_type property

  • :time_less_than (DateTime) —

    The value to assign to the #time_less_than property

  • :time_greater_than (DateTime) —

    The value to assign to the #time_greater_than property

  • :row_limit (Integer) —

    The value to assign to the #row_limit property



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
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 97

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

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

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

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

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

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

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

  self.time_less_than = attributes[:'timeLessThan'] if attributes[:'timeLessThan']

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

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

  self.time_greater_than = attributes[:'timeGreaterThan'] if attributes[:'timeGreaterThan']

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

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

  self.row_limit = attributes[:'rowLimit'] if attributes[:'rowLimit']

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

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

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment into which the resource should be moved.

Returns:

  • (String) 


33
34
35
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 33

def compartment_id
  @compartment_id
end

#description ⇒ String

The description of the report to be generated

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 27

def description
  @description
end

#display_name ⇒ String

[Required] The name of the report to be generated

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 19

def display_name
  @display_name
end

#mime_type ⇒ String

[Required] Specifies the format of report to be .xls or .pdf or .json

Returns:

  • (String) 


37
38
39
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 37

def mime_type
  @mime_type
end

#row_limit ⇒ Integer

Specifies the limit on the number of rows in the report.

Returns:

  • (Integer) 


49
50
51
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 49

def row_limit
  @row_limit
end

#target_ids ⇒ Array<String>

Array of database target OCIDs.

Returns:

  • (Array<String>) 


23
24
25
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 23

def target_ids
  @target_ids
end

#time_greater_than ⇒ DateTime

Specifies the time after which the data needs to be reported.

Returns:

  • (DateTime) 


45
46
47
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 45

def time_greater_than
  @time_greater_than
end

#time_less_than ⇒ DateTime

Specifies the time until which the data needs to be reported.

Returns:

  • (DateTime) 


41
42
43
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 41

def time_less_than
  @time_less_than
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 52

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'target_ids': :'targetIds',
    'description': :'description',
    'compartment_id': :'compartmentId',
    'mime_type': :'mimeType',
    'time_less_than': :'timeLessThan',
    'time_greater_than': :'timeGreaterThan',
    'row_limit': :'rowLimit'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 68

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'target_ids': :'Array<String>',
    'description': :'String',
    'compartment_id': :'String',
    'mime_type': :'String',
    'time_less_than': :'DateTime',
    'time_greater_than': :'DateTime',
    'row_limit': :'Integer'
    # 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



163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 163

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

  self.class == other.class &&
    display_name == other.display_name &&
    target_ids == other.target_ids &&
    description == other.description &&
    compartment_id == other.compartment_id &&
    mime_type == other.mime_type &&
    time_less_than == other.time_less_than &&
    time_greater_than == other.time_greater_than &&
    row_limit == other.row_limit
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 200

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


180
181
182
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 180

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



189
190
191
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 189

def hash
  [display_name, target_ids, description, compartment_id, mime_type, time_less_than, time_greater_than, row_limit].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



233
234
235
236
237
238
239
240
241
242
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 233

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



227
228
229
 
# File 'lib/oci/data_safe/models/generate_report_details.rb', line 227

def to_s
  to_hash.to_s
end