Class: OCI::LogAnalytics::Models::TimeClusterCommandDescriptor

Inherits:
AbstractCommandDescriptor show all
Defined in:
lib/oci/log_analytics/models/time_cluster_command_descriptor.rb

Overview

Command descriptor for querylanguage TIMECLUSTER command.

Constant Summary

Constants inherited from AbstractCommandDescriptor

AbstractCommandDescriptor::NAME_ENUM

Instance Attribute Summary collapse

Attributes inherited from AbstractCommandDescriptor

#category, #declared_fields, #display_query_string, #internal_query_string, #is_hidden, #name, #referenced_fields

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from AbstractCommandDescriptor

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ TimeClusterCommandDescriptor

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 87

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

  attributes['name'] = 'TIME_CLUSTER'

  super(attributes)

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

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

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

  self.group_by_fields = attributes[:'groupByFields'] if attributes[:'groupByFields']

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

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

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

Instance Attribute Details

#functions ⇒ Array<OCI::LogAnalytics::Models::FunctionField>

Statistical functions specified in the query string. Atleast 1 is required for a TIMECLUSTER command.

Returns:



31
32
33
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 31

def functions
  @functions
end

#group_by_fields ⇒ Array<OCI::LogAnalytics::Models::AbstractField>

Group by fields specified in the query string.

Returns:



26
27
28
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 26

def group_by_fields
  @group_by_fields
end

#span ⇒ String

Option to control the size of buckets in the timeseries. Will be adjusted to a larger span if time range is very large.

Returns:

  • (String) 


21
22
23
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 21

def span
  @span
end

#time ⇒ OCI::LogAnalytics::Models::AbstractField

Optional timestamp datatype field if specified. Default field is 'Start Time'.

Returns:



16
17
18
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 16

def time
  @time
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'display_query_string': :'displayQueryString',
    'internal_query_string': :'internalQueryString',
    'category': :'category',
    'referenced_fields': :'referencedFields',
    'declared_fields': :'declaredFields',
    'is_hidden': :'isHidden',
    'time': :'time',
    'span': :'span',
    'group_by_fields': :'groupByFields',
    'functions': :'functions'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 53

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'display_query_string': :'String',
    'internal_query_string': :'String',
    'category': :'String',
    'referenced_fields': :'Array<OCI::LogAnalytics::Models::AbstractField>',
    'declared_fields': :'Array<OCI::LogAnalytics::Models::AbstractField>',
    'is_hidden': :'BOOLEAN',
    'time': :'OCI::LogAnalytics::Models::AbstractField',
    'span': :'String',
    'group_by_fields': :'Array<OCI::LogAnalytics::Models::AbstractField>',
    'functions': :'Array<OCI::LogAnalytics::Models::FunctionField>'
    # 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



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 117

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

  self.class == other.class &&
    name == other.name &&
    display_query_string == other.display_query_string &&
    internal_query_string == other.internal_query_string &&
    category == other.category &&
    referenced_fields == other.referenced_fields &&
    declared_fields == other.declared_fields &&
    is_hidden == other.is_hidden &&
    time == other.time &&
    span == other.span &&
    group_by_fields == other.group_by_fields &&
    functions == other.functions
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



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

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


137
138
139
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 137

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



146
147
148
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 146

def hash
  [name, display_query_string, internal_query_string, category, referenced_fields, declared_fields, is_hidden, time, span, group_by_fields, functions].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



190
191
192
193
194
195
196
197
198
199
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 190

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



184
185
186
 
# File 'lib/oci/log_analytics/models/time_cluster_command_descriptor.rb', line 184

def to_s
  to_hash.to_s
end