Class: OCI::UsageApi::Models::Schedule
- Inherits:
-
Object
- Object
- OCI::UsageApi::Models::Schedule
- Defined in:
- lib/oci/usage_api/models/schedule.rb
Overview
The schedule.
Constant Summary collapse
- OUTPUT_FILE_FORMAT_ENUM =
[ OUTPUT_FILE_FORMAT_CSV = 'CSV'.freeze, OUTPUT_FILE_FORMAT_PDF = 'PDF'.freeze, OUTPUT_FILE_FORMAT_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
- LIFECYCLE_STATE_ENUM =
[ LIFECYCLE_STATE_ACTIVE = 'ACTIVE'.freeze, LIFECYCLE_STATE_INACTIVE = 'INACTIVE'.freeze, LIFECYCLE_STATE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze ].freeze
Instance Attribute Summary collapse
-
#compartment_id ⇒ String
[Required] The customer tenancy.
-
#defined_tags ⇒ Hash<String, Hash<String, Object>>
Defined tags for this resource.
-
#description ⇒ String
The description of the schedule.
-
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope.
-
#id ⇒ String
[Required] The OCID representing a unique shedule.
-
#lifecycle_state ⇒ String
[Required] The schedule lifecycle state.
-
#name ⇒ String
[Required] The unique name of the schedule created by the user.
-
#output_file_format ⇒ String
Specifies the supported output file format.
- #query_properties ⇒ OCI::UsageApi::Models::QueryProperties
-
#result_location ⇒ OCI::UsageApi::Models::ResultLocation
This attribute is required.
-
#saved_report_id ⇒ String
The saved report ID which can also be used to generate a query.
-
#schedule_recurrences ⇒ String
[Required] Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10.
-
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys.
-
#time_created ⇒ DateTime
[Required] The date and time the schedule was created.
-
#time_next_run ⇒ DateTime
The date and time of the next job execution.
-
#time_scheduled ⇒ DateTime
[Required] The date and time of the first time job execution.
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 = {}) ⇒ Schedule
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 = {}) ⇒ Schedule
Initializes the object
164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/oci/usage_api/models/schedule.rb', line 164 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.id = attributes[:'id'] if attributes[:'id'] self.name = attributes[:'name'] if attributes[:'name'] 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.result_location = attributes[:'resultLocation'] if attributes[:'resultLocation'] raise 'You cannot provide both :resultLocation and :result_location' if attributes.key?(:'resultLocation') && attributes.key?(:'result_location') self.result_location = attributes[:'result_location'] if attributes[:'result_location'] self.description = attributes[:'description'] if attributes[:'description'] self.time_next_run = attributes[:'timeNextRun'] if attributes[:'timeNextRun'] raise 'You cannot provide both :timeNextRun and :time_next_run' if attributes.key?(:'timeNextRun') && attributes.key?(:'time_next_run') self.time_next_run = attributes[:'time_next_run'] if attributes[:'time_next_run'] self.output_file_format = attributes[:'outputFileFormat'] if attributes[:'outputFileFormat'] self.output_file_format = "CSV" if output_file_format.nil? && !attributes.key?(:'outputFileFormat') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :outputFileFormat and :output_file_format' if attributes.key?(:'outputFileFormat') && attributes.key?(:'output_file_format') self.output_file_format = attributes[:'output_file_format'] if attributes[:'output_file_format'] self.output_file_format = "CSV" if output_file_format.nil? && !attributes.key?(:'outputFileFormat') && !attributes.key?(:'output_file_format') # rubocop:disable Style/StringLiterals self.saved_report_id = attributes[:'savedReportId'] if attributes[:'savedReportId'] raise 'You cannot provide both :savedReportId and :saved_report_id' if attributes.key?(:'savedReportId') && attributes.key?(:'saved_report_id') self.saved_report_id = attributes[:'saved_report_id'] if attributes[:'saved_report_id'] self.schedule_recurrences = attributes[:'scheduleRecurrences'] if attributes[:'scheduleRecurrences'] raise 'You cannot provide both :scheduleRecurrences and :schedule_recurrences' if attributes.key?(:'scheduleRecurrences') && attributes.key?(:'schedule_recurrences') self.schedule_recurrences = attributes[:'schedule_recurrences'] if attributes[:'schedule_recurrences'] self.time_scheduled = attributes[:'timeScheduled'] if attributes[:'timeScheduled'] raise 'You cannot provide both :timeScheduled and :time_scheduled' if attributes.key?(:'timeScheduled') && attributes.key?(:'time_scheduled') self.time_scheduled = attributes[:'time_scheduled'] if attributes[:'time_scheduled'] self.query_properties = attributes[:'queryProperties'] if attributes[:'queryProperties'] raise 'You cannot provide both :queryProperties and :query_properties' if attributes.key?(:'queryProperties') && attributes.key?(:'query_properties') self.query_properties = attributes[:'query_properties'] if attributes[:'query_properties'] self.time_created = attributes[:'timeCreated'] if attributes[:'timeCreated'] raise 'You cannot provide both :timeCreated and :time_created' if attributes.key?(:'timeCreated') && attributes.key?(:'time_created') self.time_created = attributes[:'time_created'] if attributes[:'time_created'] self.lifecycle_state = attributes[:'lifecycleState'] if attributes[:'lifecycleState'] raise 'You cannot provide both :lifecycleState and :lifecycle_state' if attributes.key?(:'lifecycleState') && attributes.key?(:'lifecycle_state') self.lifecycle_state = attributes[:'lifecycle_state'] if attributes[:'lifecycle_state'] self. = attributes[:'freeformTags'] if attributes[:'freeformTags'] raise 'You cannot provide both :freeformTags and :freeform_tags' if attributes.key?(:'freeformTags') && attributes.key?(:'freeform_tags') self. = attributes[:'freeform_tags'] if attributes[:'freeform_tags'] self. = attributes[:'definedTags'] if attributes[:'definedTags'] raise 'You cannot provide both :definedTags and :defined_tags' if attributes.key?(:'definedTags') && attributes.key?(:'defined_tags') self. = attributes[:'defined_tags'] if attributes[:'defined_tags'] self. = attributes[:'systemTags'] if attributes[:'systemTags'] raise 'You cannot provide both :systemTags and :system_tags' if attributes.key?(:'systemTags') && attributes.key?(:'system_tags') self. = attributes[:'system_tags'] if attributes[:'system_tags'] end |
Instance Attribute Details
#compartment_id ⇒ String
[Required] The customer tenancy.
34 35 36 |
# File 'lib/oci/usage_api/models/schedule.rb', line 34 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. See Resource Tags. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}
87 88 89 |
# File 'lib/oci/usage_api/models/schedule.rb', line 87 def @defined_tags end |
#description ⇒ String
The description of the schedule.
42 43 44 |
# File 'lib/oci/usage_api/models/schedule.rb', line 42 def description @description end |
#freeform_tags ⇒ Hash<String, String>
Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. See Resource Tags. Example: {\"bar-key\": \"value\"}
82 83 84 |
# File 'lib/oci/usage_api/models/schedule.rb', line 82 def @freeform_tags end |
#id ⇒ String
[Required] The OCID representing a unique shedule.
26 27 28 |
# File 'lib/oci/usage_api/models/schedule.rb', line 26 def id @id end |
#lifecycle_state ⇒ String
[Required] The schedule lifecycle state.
76 77 78 |
# File 'lib/oci/usage_api/models/schedule.rb', line 76 def lifecycle_state @lifecycle_state end |
#name ⇒ String
[Required] The unique name of the schedule created by the user.
30 31 32 |
# File 'lib/oci/usage_api/models/schedule.rb', line 30 def name @name end |
#output_file_format ⇒ String
Specifies the supported output file format.
50 51 52 |
# File 'lib/oci/usage_api/models/schedule.rb', line 50 def output_file_format @output_file_format end |
#query_properties ⇒ OCI::UsageApi::Models::QueryProperties
68 69 70 |
# File 'lib/oci/usage_api/models/schedule.rb', line 68 def query_properties @query_properties end |
#result_location ⇒ OCI::UsageApi::Models::ResultLocation
This attribute is required.
38 39 40 |
# File 'lib/oci/usage_api/models/schedule.rb', line 38 def result_location @result_location end |
#saved_report_id ⇒ String
The saved report ID which can also be used to generate a query.
54 55 56 |
# File 'lib/oci/usage_api/models/schedule.rb', line 54 def saved_report_id @saved_report_id end |
#schedule_recurrences ⇒ String
[Required] Specifies the frequency according to when the schedule will be run, in the x-obmcs-recurring-time format described in RFC 5545 section 3.3.10. Supported values are : ONE_TIME, DAILY, WEEKLY and MONTHLY.
61 62 63 |
# File 'lib/oci/usage_api/models/schedule.rb', line 61 def schedule_recurrences @schedule_recurrences end |
#system_tags ⇒ Hash<String, Hash<String, Object>>
Usage of system tag keys. These predefined keys are scoped to namespaces. See Resource Tags. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}
92 93 94 |
# File 'lib/oci/usage_api/models/schedule.rb', line 92 def @system_tags end |
#time_created ⇒ DateTime
[Required] The date and time the schedule was created.
72 73 74 |
# File 'lib/oci/usage_api/models/schedule.rb', line 72 def time_created @time_created end |
#time_next_run ⇒ DateTime
The date and time of the next job execution.
46 47 48 |
# File 'lib/oci/usage_api/models/schedule.rb', line 46 def time_next_run @time_next_run end |
#time_scheduled ⇒ DateTime
[Required] The date and time of the first time job execution.
65 66 67 |
# File 'lib/oci/usage_api/models/schedule.rb', line 65 def time_scheduled @time_scheduled end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/oci/usage_api/models/schedule.rb', line 95 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'id': :'id', 'name': :'name', 'compartment_id': :'compartmentId', 'result_location': :'resultLocation', 'description': :'description', 'time_next_run': :'timeNextRun', 'output_file_format': :'outputFileFormat', 'saved_report_id': :'savedReportId', 'schedule_recurrences': :'scheduleRecurrences', 'time_scheduled': :'timeScheduled', 'query_properties': :'queryProperties', 'time_created': :'timeCreated', 'lifecycle_state': :'lifecycleState', 'freeform_tags': :'freeformTags', 'defined_tags': :'definedTags', 'system_tags': :'systemTags' # rubocop:enable Style/SymbolLiteral } end |
.swagger_types ⇒ Object
Attribute type mapping.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/oci/usage_api/models/schedule.rb', line 119 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'id': :'String', 'name': :'String', 'compartment_id': :'String', 'result_location': :'OCI::UsageApi::Models::ResultLocation', 'description': :'String', 'time_next_run': :'DateTime', 'output_file_format': :'String', 'saved_report_id': :'String', 'schedule_recurrences': :'String', 'time_scheduled': :'DateTime', 'query_properties': :'OCI::UsageApi::Models::QueryProperties', 'time_created': :'DateTime', 'lifecycle_state': :'String', 'freeform_tags': :'Hash<String, String>', 'defined_tags': :'Hash<String, Hash<String, Object>>', 'system_tags': :'Hash<String, Hash<String, Object>>' # rubocop:enable Style/SymbolLiteral } end |
Instance Method Details
#==(other) ⇒ Object
Checks equality by comparing each attribute.
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 |
# File 'lib/oci/usage_api/models/schedule.rb', line 290 def ==(other) return true if equal?(other) self.class == other.class && id == other.id && name == other.name && compartment_id == other.compartment_id && result_location == other.result_location && description == other.description && time_next_run == other.time_next_run && output_file_format == other.output_file_format && saved_report_id == other.saved_report_id && schedule_recurrences == other.schedule_recurrences && time_scheduled == other.time_scheduled && query_properties == other.query_properties && time_created == other.time_created && lifecycle_state == other.lifecycle_state && == other. && == other. && == other. end |
#build_from_hash(attributes) ⇒ Object
Builds the object from hash
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 |
# File 'lib/oci/usage_api/models/schedule.rb', line 335 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
315 316 317 |
# File 'lib/oci/usage_api/models/schedule.rb', line 315 def eql?(other) self == other end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
324 325 326 |
# File 'lib/oci/usage_api/models/schedule.rb', line 324 def hash [id, name, compartment_id, result_location, description, time_next_run, output_file_format, saved_report_id, schedule_recurrences, time_scheduled, query_properties, time_created, lifecycle_state, , , ].hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
368 369 370 371 372 373 374 375 376 377 |
# File 'lib/oci/usage_api/models/schedule.rb', line 368 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
362 363 364 |
# File 'lib/oci/usage_api/models/schedule.rb', line 362 def to_s to_hash.to_s end |