Class: OCI::Batch::Models::OciLoggingConfiguration

Inherits:
LoggingConfiguration show all
Defined in:
lib/oci/batch/models/oci_logging_configuration.rb

Overview

Logging configuration for OCI Logging service.

Constant Summary

Constants inherited from LoggingConfiguration

LoggingConfiguration::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from LoggingConfiguration

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from LoggingConfiguration

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ OciLoggingConfiguration

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash

Options Hash (attributes):



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 57

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  attributes['type'] = 'OCI_LOGGING'

  super(attributes)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.log_group_id = attributes[:'logGroupId'] if attributes[:'logGroupId']

  raise 'You cannot provide both :logGroupId and :log_group_id' if attributes.key?(:'logGroupId') && attributes.key?(:'log_group_id')

  self.log_group_id = attributes[:'log_group_id'] if attributes[:'log_group_id']

  self.log_id = attributes[:'logId'] if attributes[:'logId']

  raise 'You cannot provide both :logId and :log_id' if attributes.key?(:'logId') && attributes.key?(:'log_id')

  self.log_id = attributes[:'log_id'] if attributes[:'log_id']

  self.is_job_task_events_propagation_enabled = attributes[:'isJobTaskEventsPropagationEnabled'] unless attributes[:'isJobTaskEventsPropagationEnabled'].nil?
  self.is_job_task_events_propagation_enabled = false if is_job_task_events_propagation_enabled.nil? && !attributes.key?(:'isJobTaskEventsPropagationEnabled') # rubocop:disable Style/StringLiterals

  raise 'You cannot provide both :isJobTaskEventsPropagationEnabled and :is_job_task_events_propagation_enabled' if attributes.key?(:'isJobTaskEventsPropagationEnabled') && attributes.key?(:'is_job_task_events_propagation_enabled')

  self.is_job_task_events_propagation_enabled = attributes[:'is_job_task_events_propagation_enabled'] unless attributes[:'is_job_task_events_propagation_enabled'].nil?
  self.is_job_task_events_propagation_enabled = false if is_job_task_events_propagation_enabled.nil? && !attributes.key?(:'isJobTaskEventsPropagationEnabled') && !attributes.key?(:'is_job_task_events_propagation_enabled') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#is_job_task_events_propagation_enabled ⇒ BOOLEAN

A switch to enable or disable propagation of job and task events to the customer's logs in OCI logging service.

Returns:

  • (BOOLEAN) 


22
23
24
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 22

def is_job_task_events_propagation_enabled
  @is_job_task_events_propagation_enabled
end

#log_group_id ⇒ String

[Required] The OCID of the log group.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 14

def log_group_id
  @log_group_id
end

#log_id ⇒ String

[Required] The OCID of the log.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 18

def log_id
  @log_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'log_group_id': :'logGroupId',
    'log_id': :'logId',
    'is_job_task_events_propagation_enabled': :'isJobTaskEventsPropagationEnabled'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'log_group_id': :'String',
    'log_id': :'String',
    'is_job_task_events_propagation_enabled': :'BOOLEAN'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



95
96
97
98
99
100
101
102
103
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 95

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    type == other.type &&
    log_group_id == other.log_group_id &&
    log_id == other.log_id &&
    is_job_task_events_propagation_enabled == other.is_job_task_events_propagation_enabled
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 128

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

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


108
109
110
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 108

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



117
118
119
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 117

def hash
  [type, log_group_id, log_id, is_job_task_events_propagation_enabled].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 161

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

Returns:

  • (String) —

    String presentation of the object



155
156
157
 
# File 'lib/oci/batch/models/oci_logging_configuration.rb', line 155

def to_s
  to_hash.to_s
end