Class: OCI::DataSafe::Models::ScheduleReportDetails
- Inherits:
-
Object
- Object
- OCI::DataSafe::Models::ScheduleReportDetails
- 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 ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the resource should be created.
-
#display_name ⇒ String
The name of the report to be scheduled.
-
#mime_type ⇒ String
[Required] Specifies if the report will be in .xls or .pdf format.
-
#report_details ⇒ OCI::DataSafe::Models::ReportDetails
This attribute is required.
-
#schedule ⇒ String
[Required] The schedule to generate the report periodically in the specified format: <version-string>;<version-specific-schedule>.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(other) ⇒ Object
Checks equality by comparing each attribute.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(other) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ ScheduleReportDetails
constructor
Initializes the object.
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
Constructor Details
#initialize(attributes = {}) ⇒ ScheduleReportDetails
Initializes the object
89 90 91 92 93 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 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 89 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'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The OCID of the compartment in which the resource should be created.
46 47 48 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 46 def compartment_id @compartment_id end |
#display_name ⇒ String
The name of the report to be scheduled
18 19 20 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 18 def display_name @display_name end |
#mime_type ⇒ String
[Required] Specifies if the report will be in .xls or .pdf format
40 41 42 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 40 def mime_type @mime_type end |
#report_details ⇒ OCI::DataSafe::Models::ReportDetails
This attribute is required.
50 51 52 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 50 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
36 37 38 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 36 def schedule @schedule end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
53 54 55 56 57 58 59 60 61 62 63 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 53 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'display_name': :'displayName', 'schedule': :'schedule', 'mime_type': :'mimeType', 'compartment_id': :'compartmentId', 'report_details': :'reportDetails' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
66 67 68 69 70 71 72 73 74 75 76 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 66 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' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
137 138 139 140 141 142 143 144 145 146 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 137 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 end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 171 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
151 152 153 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 151 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
160 161 162 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 160 def hash [display_name, schedule, mime_type, compartment_id, report_details].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
204 205 206 207 208 209 210 211 212 213 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 204 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
198 199 200 |
# File 'lib/oci/data_safe/models/schedule_report_details.rb', line 198 def to_s to_hash.to_s end |