Class: OCI::Loggingsearch::Models::SearchLogsDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/loggingsearch/models/search_logs_details.rb

Overview

Search request object.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchLogsDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_start (DateTime) —

    The value to assign to the #time_start property

  • :time_end (DateTime) —

    The value to assign to the #time_end property

  • :search_query (String) —

    The value to assign to the #search_query property

  • :is_return_field_info (BOOLEAN) —

    The value to assign to the #is_return_field_info property



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 67

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.time_start = attributes[:'timeStart'] if attributes[:'timeStart']

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

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

  self.time_end = attributes[:'timeEnd'] if attributes[:'timeEnd']

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

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

  self.search_query = attributes[:'searchQuery'] if attributes[:'searchQuery']

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

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

  self.is_return_field_info = attributes[:'isReturnFieldInfo'] unless attributes[:'isReturnFieldInfo'].nil?

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

  self.is_return_field_info = attributes[:'is_return_field_info'] unless attributes[:'is_return_field_info'].nil?
end

Instance Attribute Details

#is_return_field_info ⇒ BOOLEAN

Whether to return field schema information for the log stream specified in searchQuery.

Returns:

  • (BOOLEAN) 


31
32
33
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 31

def is_return_field_info
  @is_return_field_info
end

#search_query ⇒ String

[Required] Query corresponding to the search operation. This query is parsed and validated before execution and should follow the specification. For more information on the query language specification, see Logging Query Language Specification.

Returns:

  • (String) 


26
27
28
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 26

def search_query
  @search_query
end

#time_end ⇒ DateTime

[Required] End filter log's date and time, in the format defined by RFC3339.

Returns:

  • (DateTime) 


19
20
21
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 19

def time_end
  @time_end
end

#time_start ⇒ DateTime

[Required] Start filter log's date and time, in the format defined by RFC3339.

Returns:

  • (DateTime) 


14
15
16
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 14

def time_start
  @time_start
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
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_start': :'timeStart',
    'time_end': :'timeEnd',
    'search_query': :'searchQuery',
    'is_return_field_info': :'isReturnFieldInfo'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



46
47
48
49
50
51
52
53
54
55
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 46

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_start': :'DateTime',
    'time_end': :'DateTime',
    'search_query': :'String',
    'is_return_field_info': :'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



105
106
107
108
109
110
111
112
113
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 105

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

  self.class == other.class &&
    time_start == other.time_start &&
    time_end == other.time_end &&
    search_query == other.search_query &&
    is_return_field_info == other.is_return_field_info
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



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 138

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


118
119
120
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 118

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



127
128
129
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 127

def hash
  [time_start, time_end, search_query, is_return_field_info].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 171

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



165
166
167
 
# File 'lib/oci/loggingsearch/models/search_logs_details.rb', line 165

def to_s
  to_hash.to_s
end