Class: OCI::DataSafe::Models::ScheduleReportDetails

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

Overview

The details of the report schedule.

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 = {}) ⇒ ScheduleReportDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 100

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

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

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

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

  self.is_pagination_enabled = attributes[:'isPaginationEnabled'] unless attributes[:'isPaginationEnabled'].nil?
  self.is_pagination_enabled = false if is_pagination_enabled.nil? && !attributes.key?(:'isPaginationEnabled') # rubocop:disable Style/StringLiterals

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

  self.is_pagination_enabled = attributes[:'is_pagination_enabled'] unless attributes[:'is_pagination_enabled'].nil?
  self.is_pagination_enabled = false if is_pagination_enabled.nil? && !attributes.key?(:'isPaginationEnabled') && !attributes.key?(:'is_pagination_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#compartment_id ⇒ String

[Required] The OCID of the compartment in which the resource should be created.

Returns:

  • (String) 


47
48
49
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 47

def compartment_id
  @compartment_id
end

#display_name ⇒ String

The name of the report to be scheduled

Returns:

  • (String) 


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

def display_name
  @display_name
end

#is_pagination_enabled ⇒ BOOLEAN

Indicates if the reports being generated should be paginated. If set to true, multiple reports can be generated and the details of next and previous report are present in Report. Values can either be 'true' or 'false'.

Returns:

  • (BOOLEAN) 


58
59
60
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 58

def is_pagination_enabled
  @is_pagination_enabled
end

#mime_type ⇒ String

[Required] Specifies if the report will be in .xls or .pdf or .json format

Returns:

  • (String) 


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

def mime_type
  @mime_type
end

#report_details ⇒ OCI::DataSafe::Models::ReportDetails

This attribute is required.

Returns:



51
52
53
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 51

def report_details
  @report_details
end

#schedule ⇒ String

[Required] The schedule to generate the report periodically in the specified format: <version-string>;<version-specific-schedule>

Allowed version strings - "v1" v1's version specific schedule -<ss> <mm> <hh> <day-of-week> <day-of-month> Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = <ss> (So, the allowed range for <ss> is [0, 59]) 2. minutes = <mm> (So, the allowed range for <mm> is [0, 59]) 3. hours = <hh> (So, the allowed range for <hh> is [0, 23]) 4. <day-of-week> can be either '' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is ''. When not, day of week must equal the given value 5. <day-of-month> can be either '' (without quotes or a number between 1 and 28) No constraint introduced when it is ''. When not, day of month must equal the given value

Returns:

  • (String) 


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

def schedule
  @schedule
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'displayName',
    'schedule': :'schedule',
    'mime_type': :'mimeType',
    'compartment_id': :'compartmentId',
    'report_details': :'reportDetails',
    'is_pagination_enabled': :'isPaginationEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 75

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'display_name': :'String',
    'schedule': :'String',
    'mime_type': :'String',
    'compartment_id': :'String',
    'report_details': :'OCI::DataSafe::Models::ReportDetails',
    'is_pagination_enabled': :'BOOLEAN'
    # 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



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

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

  self.class == other.class &&
    display_name == other.display_name &&
    schedule == other.schedule &&
    mime_type == other.mime_type &&
    compartment_id == other.compartment_id &&
    report_details == other.report_details &&
    is_pagination_enabled == other.is_pagination_enabled
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



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 191

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


171
172
173
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 171

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [display_name, schedule, mime_type, compartment_id, report_details, is_pagination_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 224

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



218
219
220
 
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 218

def to_s
  to_hash.to_s
end