class OCI::LogAnalytics::Models::PurgeAction
Purge action for scheduled task.
Constants
- DATA_TYPE_ENUM
Attributes
if true, purge child compartments data @return [BOOLEAN]
[Required] the type of the log data to be purged @return [String]
[Required] the compartment OCID under which the data will be purged @return [String]
[Required] The duration of data to be retained, which is used to calculate the timeDataEnded when the task fires. The value should be negative. Purge duration in ISO 8601 extended format as described in en.wikipedia.org/wiki/ISO_8601#Durations. The largest supported unit is D, e.g. -P365D (not -P1Y) or -P14D (not -P2W).
@return [String]
[Required] Purge query string. @return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/log_analytics/models/purge_action.rb, line 45 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'type': :'type', 'query_string': :'queryString', 'data_type': :'dataType', 'purge_duration': :'purgeDuration', 'purge_compartment_id': :'purgeCompartmentId', 'compartment_id_in_subtree': :'compartmentIdInSubtree' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [String] :query_string The value to assign to the {#query_string} property @option attributes [String] :data_type The value to assign to the {#data_type} property @option attributes [String] :purge_duration The value to assign to the {#purge_duration} property @option attributes [String] :purge_compartment_id The value to assign to the {#purge_compartment_id} property @option attributes [BOOLEAN] :compartment_id_in_subtree The value to assign to the {#compartment_id_in_subtree} property
OCI::LogAnalytics::Models::Action::new
# File lib/oci/log_analytics/models/purge_action.rb, line 83 def initialize(attributes = {}) return unless attributes.is_a?(Hash) attributes['type'] = 'PURGE' super(attributes) # convert string to symbol for hash key attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v } self.query_string = attributes[:'queryString'] if attributes[:'queryString'] raise 'You cannot provide both :queryString and :query_string' if attributes.key?(:'queryString') && attributes.key?(:'query_string') self.query_string = attributes[:'query_string'] if attributes[:'query_string'] self.data_type = attributes[:'dataType'] if attributes[:'dataType'] raise 'You cannot provide both :dataType and :data_type' if attributes.key?(:'dataType') && attributes.key?(:'data_type') self.data_type = attributes[:'data_type'] if attributes[:'data_type'] self.purge_duration = attributes[:'purgeDuration'] if attributes[:'purgeDuration'] raise 'You cannot provide both :purgeDuration and :purge_duration' if attributes.key?(:'purgeDuration') && attributes.key?(:'purge_duration') self.purge_duration = attributes[:'purge_duration'] if attributes[:'purge_duration'] self.purge_compartment_id = attributes[:'purgeCompartmentId'] if attributes[:'purgeCompartmentId'] raise 'You cannot provide both :purgeCompartmentId and :purge_compartment_id' if attributes.key?(:'purgeCompartmentId') && attributes.key?(:'purge_compartment_id') self.purge_compartment_id = attributes[:'purge_compartment_id'] if attributes[:'purge_compartment_id'] self.compartment_id_in_subtree = attributes[:'compartmentIdInSubtree'] unless attributes[:'compartmentIdInSubtree'].nil? self.compartment_id_in_subtree = false if compartment_id_in_subtree.nil? && !attributes.key?(:'compartmentIdInSubtree') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :compartmentIdInSubtree and :compartment_id_in_subtree' if attributes.key?(:'compartmentIdInSubtree') && attributes.key?(:'compartment_id_in_subtree') self.compartment_id_in_subtree = attributes[:'compartment_id_in_subtree'] unless attributes[:'compartment_id_in_subtree'].nil? self.compartment_id_in_subtree = false if compartment_id_in_subtree.nil? && !attributes.key?(:'compartmentIdInSubtree') && !attributes.key?(:'compartment_id_in_subtree') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/log_analytics/models/purge_action.rb, line 59 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'type': :'String', 'query_string': :'String', 'data_type': :'String', 'purge_duration': :'String', 'purge_compartment_id': :'String', 'compartment_id_in_subtree': :'BOOLEAN' # 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/purge_action.rb, line 146 def ==(other) return true if equal?(other) self.class == other.class && type == other.type && query_string == other.query_string && data_type == other.data_type && purge_duration == other.purge_duration && purge_compartment_id == other.purge_compartment_id && compartment_id_in_subtree == other.compartment_id_in_subtree 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/purge_action.rb, line 181 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
Custom attribute writer method checking allowed values (enum). @param [Object] data_type
Object
to be assigned
# File lib/oci/log_analytics/models/purge_action.rb, line 130 def data_type=(data_type) # rubocop:disable Style/ConditionalAssignment if data_type && !DATA_TYPE_ENUM.include?(data_type) OCI.logger.debug("Unknown value for 'data_type' [" + data_type + "]. Mapping to 'DATA_TYPE_UNKNOWN_ENUM_VALUE'") if OCI.logger @data_type = DATA_TYPE_UNKNOWN_ENUM_VALUE else @data_type = data_type end # rubocop:enable Style/ConditionalAssignment end
@see the `==` method @param [Object] other the other object to be compared
# File lib/oci/log_analytics/models/purge_action.rb, line 161 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/log_analytics/models/purge_action.rb, line 170 def hash [type, query_string, data_type, purge_duration, purge_compartment_id, compartment_id_in_subtree].hash 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/purge_action.rb, line 214 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/purge_action.rb, line 208 def to_s to_hash.to_s 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/purge_action.rb, line 231 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