Class: OCI::DataSafe::Models::ScheduleAuditReportDetails

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

Overview

Details for the audit report schedule.

Constant Summary

Constants inherited from ReportDetails

ReportDetails::REPORT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ReportDetails

#report_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ReportDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ ScheduleAuditReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :row_limit (Integer) —

    The value to assign to the #row_limit property

  • :record_time_span (String) —

    The value to assign to the #record_time_span property



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 59

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

  attributes['reportType'] = 'AUDIT'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.row_limit = attributes[:'rowLimit'] if attributes[:'rowLimit']
  self.row_limit = 1000 if row_limit.nil? && !attributes.key?(:'rowLimit') # rubocop:disable Style/StringLiterals

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

  self.record_time_span = attributes[:'recordTimeSpan'] if attributes[:'recordTimeSpan']

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

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

Instance Attribute Details

#record_time_span ⇒ String

[Required] The time span of records in report to be scheduled. <period-value><period> Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1)

Returns:

  • (String) 


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

def record_time_span
  @record_time_span
end

#row_limit ⇒ Integer

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

Returns:

  • (Integer) 


14
15
16
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 14

def row_limit
  @row_limit
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'report_type': :'reportType',
    'row_limit': :'rowLimit',
    'record_time_span': :'recordTimeSpan'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'report_type': :'String',
    'row_limit': :'Integer',
    'record_time_span': :'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



91
92
93
94
95
96
97
98
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 91

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

  self.class == other.class &&
    report_type == other.report_type &&
    row_limit == other.row_limit &&
    record_time_span == other.record_time_span
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



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 123

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


103
104
105
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 103

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



112
113
114
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 112

def hash
  [report_type, row_limit, record_time_span].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 156

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



150
151
152
 
# File 'lib/oci/data_safe/models/schedule_audit_report_details.rb', line 150

def to_s
  to_hash.to_s
end