class OCI::Apigateway::Models::ExecutionLogPolicy
Configures the logging policies for the execution logs of an API Deployment.
Constants
- LOG_LEVEL_ENUM
Attributes
Enables pushing of execution logs to the legacy OCI
Object
Storage log archival bucket.
Oracle recommends using the OCI
Logging
service to enable, retrieve, and query execution logs for an API Deployment. If there is an active log object for the API Deployment and its category is set to 'execution' in OCI
Logging
service, the logs will not be uploaded to the legacy OCI
Object
Storage log archival bucket.
Please note that the functionality to push to the legacy OCI
Object
Storage log archival bucket has been deprecated and will be removed in the future.
@return [BOOLEAN]
Specifies the log level used to control logging output of execution logs. Enabling logging at a given level also enables logging at all higher levels.
@return [String]
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/oci/apigateway/models/execution_log_policy.rb, line 39 def self.attribute_map { # rubocop:disable Style/SymbolLiteral 'is_enabled': :'isEnabled', 'log_level': :'logLevel' # rubocop:enable Style/SymbolLiteral } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash @option attributes [BOOLEAN] :is_enabled The value to assign to the {#is_enabled} property @option attributes [String] :log_level The value to assign to the {#log_level} property
# File lib/oci/apigateway/models/execution_log_policy.rb, line 66 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.is_enabled = attributes[:'isEnabled'] unless attributes[:'isEnabled'].nil? self.is_enabled = false if is_enabled.nil? && !attributes.key?(:'isEnabled') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :isEnabled and :is_enabled' if attributes.key?(:'isEnabled') && attributes.key?(:'is_enabled') self.is_enabled = attributes[:'is_enabled'] unless attributes[:'is_enabled'].nil? self.is_enabled = false if is_enabled.nil? && !attributes.key?(:'isEnabled') && !attributes.key?(:'is_enabled') # rubocop:disable Style/StringLiterals self.log_level = attributes[:'logLevel'] if attributes[:'logLevel'] self.log_level = "INFO" if log_level.nil? && !attributes.key?(:'logLevel') # rubocop:disable Style/StringLiterals raise 'You cannot provide both :logLevel and :log_level' if attributes.key?(:'logLevel') && attributes.key?(:'log_level') self.log_level = attributes[:'log_level'] if attributes[:'log_level'] self.log_level = "INFO" if log_level.nil? && !attributes.key?(:'logLevel') && !attributes.key?(:'log_level') # rubocop:disable Style/StringLiterals end
Attribute type mapping.
# File lib/oci/apigateway/models/execution_log_policy.rb, line 49 def self.swagger_types { # rubocop:disable Style/SymbolLiteral 'is_enabled': :'BOOLEAN', 'log_level': :'String' # 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/apigateway/models/execution_log_policy.rb, line 109 def ==(other) return true if equal?(other) self.class == other.class && is_enabled == other.is_enabled && log_level == other.log_level 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/apigateway/models/execution_log_policy.rb, line 140 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/apigateway/models/execution_log_policy.rb, line 120 def eql?(other) self == other end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/oci/apigateway/models/execution_log_policy.rb, line 129 def hash [is_enabled, log_level].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] log_level
Object
to be assigned
# File lib/oci/apigateway/models/execution_log_policy.rb, line 93 def log_level=(log_level) # rubocop:disable Style/ConditionalAssignment if log_level && !LOG_LEVEL_ENUM.include?(log_level) OCI.logger.debug("Unknown value for 'log_level' [" + log_level + "]. Mapping to 'LOG_LEVEL_UNKNOWN_ENUM_VALUE'") if OCI.logger @log_level = LOG_LEVEL_UNKNOWN_ENUM_VALUE else @log_level = log_level 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/apigateway/models/execution_log_policy.rb, line 173 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/apigateway/models/execution_log_policy.rb, line 167 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/apigateway/models/execution_log_policy.rb, line 190 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