class OCI::LogAnalytics::Models::Schedule
Schedule
for scheduled task. This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class
Constants
- MISFIRE_POLICY_ENUM
- TYPE_ENUM
Attributes
Schedule
misfire retry policy. @return [String]
The date and time the scheduled task should execute first time after create or update; thereafter the task will execute as specified in the schedule.
@return [DateTime]
[Required] Schedule
type discriminator. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/log_analytics/models/schedule.rb, line 40 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'misfire_policy': :'misfirePolicy', 'time_of_first_execution': :'timeOfFirstExecution' # rubocop:enable Style/SymbolLiteral } end
Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
# File lib/oci/log_analytics/models/schedule.rb, line 66 def self.get_subtype(object_hash) type = object_hash[:'type'] # rubocop:disable Style/SymbolLiteral return 'OCI::LogAnalytics::Models::CronSchedule' if type == 'CRON' return 'OCI::LogAnalytics::Models::FixedFrequencySchedule' if type == 'FIXED_FREQUENCY' # TODO: Log a warning when the subtype is not found. 'OCI::LogAnalytics::Models::Schedule' end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :type The value to assign to the {#type} property @option attributes [String] :misfire_policy The value to assign to the {#misfire_policy} property @option attributes [DateTime] :time_of_first_execution The value to assign to the {#time_of_first_execution} property
# File lib/oci/log_analytics/models/schedule.rb, line 86 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.type = attributes[:'type'] if attributes[:'type'] self.misfire_policy = attributes[:'misfirePolicy'] if attributes[:'misfirePolicy'] self.misfire_policy = "RETRY_INDEFINITELY" if misfire_policy.nil? && !attributes.key?(:'misfirePolicy') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :misfirePolicy and :misfire_policy' if attributes.key?(:'misfirePolicy') && attributes.key?(:'misfire_policy') self.misfire_policy = attributes[:'misfire_policy'] if attributes[:'misfire_policy'] self.misfire_policy = "RETRY_INDEFINITELY" if misfire_policy.nil? && !attributes.key?(:'misfirePolicy') && !attributes.key?(:'misfire_policy') # rubocop:disable Style/StringLiterals self.time_of_first_execution = attributes[:'timeOfFirstExecution'] if attributes[:'timeOfFirstExecution'] raise 'You cannot provide both :timeOfFirstExecution and :time_of_first_execution' if attributes.key?(:'timeOfFirstExecution') && attributes.key?(:'time_of_first_execution') self.time_of_first_execution = attributes[:'time_of_first_execution'] if attributes[:'time_of_first_execution'] end
Attribute type mapping.
# File lib/oci/log_analytics/models/schedule.rb, line 51 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'misfire_policy': :'String', 'time_of_first_execution': :'DateTime' # rubocop:enable Style/SymbolLiteral } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] other the other object to be compared
# File lib/oci/log_analytics/models/schedule.rb, line 142 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && misfire_policy == other.misfire_policy && time_of_first_execution == other.time_of_first_execution end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/oci/log_analytics/models/schedule.rb, line 174 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
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/log_analytics/models/schedule.rb, line 154 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/log_analytics/models/schedule.rb, line 163 def hash [type, misfire_policy, time_of_first_execution].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] misfire_policy
Object
to be assigned
# File lib/oci/log_analytics/models/schedule.rb, line 126 def misfire_policy=(misfire_policy) # rubocop:disable Style/ConditionalAssignment if misfire_policy && !MISFIRE_POLICY_ENUM.include?(misfire_policy) OCI.logger.debug("Unknown value for 'misfire_policy' [" + misfire_policy + "]. Mapping to 'MISFIRE_POLICY_UNKNOWN_ENUM_VALUE'") if OCI.logger @misfire_policy = MISFIRE_POLICY_UNKNOWN_ENUM_VALUE else @misfire_policy = misfire_policy end # rubocop:enable Style/ConditionalAssignment end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/oci/log_analytics/models/schedule.rb, line 207 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/oci/log_analytics/models/schedule.rb, line 201 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object
to be assigned
# File lib/oci/log_analytics/models/schedule.rb, line 113 def type=(type) # rubocop:disable Style/ConditionalAssignment if type && !TYPE_ENUM.include?(type) OCI.logger.debug("Unknown value for 'type' [" + type + "]. Mapping to 'TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @type = TYPE_UNKNOWN_ENUM_VALUE else @type = type end # rubocop:enable Style/ConditionalAssignment end
Private Instance Methods
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# File lib/oci/log_analytics/models/schedule.rb, line 224 def _to_hash(value) if value.is_a?(Array) value.compact.map { |v| _to_hash(v) } elsif value.is_a?(Hash) {}.tap do |hash| value.each { |k, v| hash[k] = _to_hash(v) } end elsif value.respond_to? :to_hash value.to_hash else value end end