Class: OCI::DataSafe::Models::CreateReportDefinitionDetails

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

Overview

Description of a new report definition.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateReportDefinitionDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 109

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

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

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

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

  self.column_info = attributes[:'columnInfo'] if attributes[:'columnInfo']

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

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

  self.column_filters = attributes[:'columnFilters'] if attributes[:'columnFilters']

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

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

  self.column_sortings = attributes[:'columnSortings'] if attributes[:'columnSortings']

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

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

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

  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']
end

Instance Attribute Details

#column_filters ⇒ Array<OCI::DataSafe::Models::ColumnFilter>

[Required] An array of column filter objects. A column Filter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden.

Returns:



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

def column_filters
  @column_filters
end

#column_info ⇒ Array<OCI::DataSafe::Models::Column>

[Required] An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user).

Returns:



29
30
31
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 29

def column_info
  @column_info
end

#column_sortings ⇒ Array<OCI::DataSafe::Models::ColumnSorting>

[Required] An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc.

Returns:



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

def column_sortings
  @column_sortings
end

#compartment_id ⇒ String

[Required] The OCID of the compartment containing the report definition.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 13

def compartment_id
  @compartment_id
end

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

Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags

Example: {\"Operations\": {\"CostCenter\": \"42\"}}

Returns:

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


55
56
57
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 55

def defined_tags
  @defined_tags
end

#description ⇒ String

The description of the report definition.

Returns:

  • (String) 


25
26
27
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 25

def description
  @description
end

#display_name ⇒ String

[Required] Specifies the name of the report definition.

Returns:

  • (String) 


17
18
19
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 17

def display_name
  @display_name
end

#freeform_tags ⇒ Hash<String, String>

Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags

Example: {\"Department\": \"Finance\"}

Returns:

  • (Hash<String, String>) 


48
49
50
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 48

def freeform_tags
  @freeform_tags
end

#parent_id ⇒ String

[Required] The OCID of the parent report definition.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 21

def parent_id
  @parent_id
end

#summary ⇒ Array<OCI::DataSafe::Models::Summary>

[Required] An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user).

Returns:



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

def summary
  @summary
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 58

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'parent_id': :'parentId',
    'description': :'description',
    'column_info': :'columnInfo',
    'column_filters': :'columnFilters',
    'column_sortings': :'columnSortings',
    'summary': :'summary',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 76

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'compartment_id': :'String',
    'display_name': :'String',
    'parent_id': :'String',
    'description': :'String',
    'column_info': :'Array<OCI::DataSafe::Models::Column>',
    'column_filters': :'Array<OCI::DataSafe::Models::ColumnFilter>',
    'column_sortings': :'Array<OCI::DataSafe::Models::ColumnSorting>',
    'summary': :'Array<OCI::DataSafe::Models::Summary>',
    'freeform_tags': :'Hash<String, String>',
    'defined_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



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 175

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

  self.class == other.class &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    parent_id == other.parent_id &&
    description == other.description &&
    column_info == other.column_info &&
    column_filters == other.column_filters &&
    column_sortings == other.column_sortings &&
    summary == other.summary &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 214

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


194
195
196
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 194

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



203
204
205
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 203

def hash
  [compartment_id, display_name, parent_id, description, column_info, column_filters, column_sortings, summary, freeform_tags, defined_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



247
248
249
250
251
252
253
254
255
256
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 247

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



241
242
243
 
# File 'lib/oci/data_safe/models/create_report_definition_details.rb', line 241

def to_s
  to_hash.to_s
end