Class: OCI::LogAnalytics::Models::CreateStandardTaskDetails

Inherits:
CreateScheduledTaskDetails show all
Defined in:
lib/oci/log_analytics/models/create_standard_task_details.rb

Overview

Details for creating a scheduled task. The client must fully specify the details. Not supported for TaskType ACCELERATION.

Constant Summary collapse

TASK_TYPE_ENUM = 
[
  TASK_TYPE_SAVED_SEARCH = 'SAVED_SEARCH'.freeze,
  TASK_TYPE_ACCELERATION = 'ACCELERATION'.freeze,
  TASK_TYPE_PURGE = 'PURGE'.freeze
].freeze

Constants inherited from CreateScheduledTaskDetails

OCI::LogAnalytics::Models::CreateScheduledTaskDetails::KIND_ENUM

Instance Attribute Summary collapse

Attributes inherited from CreateScheduledTaskDetails

#compartment_id, #defined_tags, #display_name, #freeform_tags, #kind

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CreateScheduledTaskDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ CreateStandardTaskDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 80

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

  attributes['kind'] = 'STANDARD'

  super(attributes)

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

  self.task_type = attributes[:'taskType'] if attributes[:'taskType']

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

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

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

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

Instance Attribute Details

#action ⇒ OCI::LogAnalytics::Models::Action

This attribute is required.

Returns:



33
34
35
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 33

def action
  @action
end

#schedules ⇒ Array<OCI::LogAnalytics::Models::Schedule>

[Required] Schedules, typically a single schedule. Note there may only be a single schedule for SAVED_SEARCH and PURGE scheduled tasks.

Returns:



29
30
31
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 29

def schedules
  @schedules
end

#task_type ⇒ String

[Required] Task type.

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 23

def task_type
  @task_type
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 36

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'kind',
    'compartment_id': :'compartmentId',
    'display_name': :'displayName',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'task_type': :'taskType',
    'schedules': :'schedules',
    'action': :'action'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 52

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'kind': :'String',
    'compartment_id': :'String',
    'display_name': :'String',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'task_type': :'String',
    'schedules': :'Array<OCI::LogAnalytics::Models::Schedule>',
    'action': :'OCI::LogAnalytics::Models::Action'
    # 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



116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 116

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

  self.class == other.class &&
    kind == other.kind &&
    compartment_id == other.compartment_id &&
    display_name == other.display_name &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    task_type == other.task_type &&
    schedules == other.schedules &&
    action == other.action
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



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 153

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


133
134
135
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 133

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 142

def hash
  [kind, compartment_id, display_name, freeform_tags, defined_tags, task_type, schedules, action].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 186

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



180
181
182
 
# File 'lib/oci/log_analytics/models/create_standard_task_details.rb', line 180

def to_s
  to_hash.to_s
end