Class: OCI::LogAnalytics::Models::StreamAction

Inherits:
Action
  • Object
show all
Defined in:
lib/oci/log_analytics/models/stream_action.rb

Overview

Stream action for scheduled task.

Constant Summary

Constants inherited from Action

Action::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Action

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Action

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ StreamAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 84

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

  attributes['type'] = 'STREAM'

  super(attributes)

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

  self.saved_search_id = attributes[:'savedSearchId'] if attributes[:'savedSearchId']

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

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

  self.template_details = attributes[:'templateDetails'] if attributes[:'templateDetails']

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

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

  self.metric_extraction = attributes[:'metricExtraction'] if attributes[:'metricExtraction']

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

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

  self.saved_search_duration = attributes[:'savedSearchDuration'] if attributes[:'savedSearchDuration']

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

  self.saved_search_duration = attributes[:'saved_search_duration'] if attributes[:'saved_search_duration']
end

Instance Attribute Details

#metric_extraction ⇒ OCI::LogAnalytics::Models::MetricExtraction

Returns:



20
21
22
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 20

def metric_extraction
  @metric_extraction
end

#saved_search_duration ⇒ String

The duration of data to be searched for SAVED_SEARCH tasks, used when the task fires to calculate the query time range.

Duration in ISO 8601 extended format as described in en.wikipedia.org/wiki/ISO_8601#Durations. The value should be positive. The largest supported unit (as opposed to value) is D, e.g. P14D (not P2W).

There are restrictions on the maximum duration value relative to the task schedule value as specified in the following table. Schedule Interval Range | Maximum Duration ———————————– | —————– 5 Minutes to 30 Minutes | 1 hour "PT60M" 31 Minutes to 1 Hour | 12 hours "PT720M" 1 Hour+1Minute to 1 Day | 1 day "P1D" 1 Day+1Minute to 1 Week-1Minute | 7 days "P7D" 1 Week to 2 Weeks | 14 days "P14D" greater than 2 Weeks | 30 days "P30D"

If not specified, the duration will be based on the schedule. For example, if the schedule is every 5 minutes then the savedSearchDuration will be "PT5M"; if the schedule is every 3 weeks then the savedSearchDuration will be "P21D".

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 46

def saved_search_duration
  @saved_search_duration
end

#saved_search_id ⇒ String

The ManagementSavedSearch id [OCID] utilized in the action.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 14

def saved_search_id
  @saved_search_id
end

#template_details ⇒ OCI::LogAnalytics::Models::TemplateDetails

Returns:



17
18
19
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 17

def template_details
  @template_details
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 49

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'saved_search_id': :'savedSearchId',
    'template_details': :'templateDetails',
    'metric_extraction': :'metricExtraction',
    'saved_search_duration': :'savedSearchDuration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'saved_search_id': :'String',
    'template_details': :'OCI::LogAnalytics::Models::TemplateDetails',
    'metric_extraction': :'OCI::LogAnalytics::Models::MetricExtraction',
    'saved_search_duration': :'String'
    # 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



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 126

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

  self.class == other.class &&
    type == other.type &&
    saved_search_id == other.saved_search_id &&
    template_details == other.template_details &&
    metric_extraction == other.metric_extraction &&
    saved_search_duration == other.saved_search_duration
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



160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 160

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


140
141
142
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 140

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



149
150
151
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 149

def hash
  [type, saved_search_id, template_details, metric_extraction, saved_search_duration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



193
194
195
196
197
198
199
200
201
202
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 193

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



187
188
189
 
# File 'lib/oci/log_analytics/models/stream_action.rb', line 187

def to_s
  to_hash.to_s
end