oci 2.16.0 → 2.17.0

data/lib/oci/apm_traces/models/aggregated_stack_trace.rb

@@ -0,0 +1,165 @@
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A branching tree with aggregated stack trace.
+  #
+  class ApmTraces::Models::AggregatedStackTrace
+    # @return [OCI::ApmTraces::Models::StackTraceElement]
+    attr_accessor :stack_trace_element
+
+    # List of child aggregated stack trace to represent branches.
+    #
+    # @return [Array<OCI::ApmTraces::Models::AggregatedStackTrace>]
+    attr_accessor :children
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'stack_trace_element': :'stackTraceElement',
+        'children': :'children'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'stack_trace_element': :'OCI::ApmTraces::Models::StackTraceElement',
+        'children': :'Array<OCI::ApmTraces::Models::AggregatedStackTrace>'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [OCI::ApmTraces::Models::StackTraceElement] :stack_trace_element The value to assign to the {#stack_trace_element} property
+    # @option attributes [Array<OCI::ApmTraces::Models::AggregatedStackTrace>] :children The value to assign to the {#children} property
+    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.stack_trace_element = attributes[:'stackTraceElement'] if attributes[:'stackTraceElement']
+
+      raise 'You cannot provide both :stackTraceElement and :stack_trace_element' if attributes.key?(:'stackTraceElement') && attributes.key?(:'stack_trace_element')
+
+      self.stack_trace_element = attributes[:'stack_trace_element'] if attributes[:'stack_trace_element']
+
+      self.children = attributes[:'children'] if attributes[:'children']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        stack_trace_element == other.stack_trace_element &&
+        children == other.children
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [stack_trace_element, children].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/apm_traces/models/query_details.rb

@@ -5,10 +5,10 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Request object containing the query to be run against our repository.
+  # Request object containing the query to be run against the trace data.
   #
   class ApmTraces::Models::QueryDetails
-    # APM defined query string to run against our repository and return results for.
+    # Application Performance Monitoring defined query string that filters and retrieves trace data results.
     #
     # @return [String]
     attr_accessor :query_text

data/lib/oci/apm_traces/models/query_result_metadata_summary.rb

@@ -9,12 +9,12 @@ module OCI
   #
   class ApmTraces::Models::QueryResultMetadataSummary
     # A collection of QueryResultRowTypeSummary objects that describe the type and properties of the individual row elements of the query rows
-    # being returned.  The ith element in this list contains the QueryResultRowTypeSummary of the ith key value pair in the QueryResultRowData map.
+    # being returned.  The i-th element in this list contains the QueryResultRowTypeSummary of the i-th key-value pair in the QueryResultRowData map.
     #
     # @return [Array<OCI::ApmTraces::Models::QueryResultRowTypeSummary>]
     attr_accessor :query_result_row_type_summaries
 
-    # Source of the query result set (traces, spans, etc).
+    # Source of the query result set (traces, spans, and so on).
     #
     # @return [String]
     attr_accessor :source_name

data/lib/oci/apm_traces/models/query_result_row.rb

@@ -5,8 +5,8 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # An object that represents a single row of the query result.  It contains the queryResultRowData object that holds the actual data
-  # represented by the elements of the query result row, and a queryResultRowMetadata object that holds the metadata about the data contained in
+  # Object that represents a single row of the query result.  It contains the queryResultRowData object that contains the actual data
+  # represented by the elements of the query result row, and a queryResultRowMetadata object that contains the metadata about the data contained in
   # the query result row.
   #
   class ApmTraces::Models::QueryResultRow
@@ -15,16 +15,15 @@ module OCI
     # The value is the actual value of that attribute or aggregate function of the corresponding single row of the query result set.
     # If an alias name is specified for an attribute or an aggregate function, then the key will be the alias name specified in the show
     # clause.  If an alias name is not specified for the group by aggregate function in the show clause, then the corresponding key
-    # will be the appropriate aggregate_function_name_column_name (Eg: count(traces) will be keyed as count_traces).  For more details
-    # on the supported aggregate functions, look at the APM confluence doc on High Level Query Aggregation.  The datatype of the value
-    # is presented in the queryResultRowTypeSummaries list in the queryResultMetadata structure, where the ith queryResultRowTypeSummary object
-    # represents the datatype of the ith value when this map is iterated in order.
+    # will be the appropriate aggregate_function_name_column_name (For example: count(traces) will be keyed as count_traces).  The datatype of the value
+    # is presented in the queryResultRowTypeSummaries list in the queryResultMetadata structure, where the i-th queryResultRowTypeSummary object
+    # represents the datatype of the i-th value when this map is iterated in order.
     #
     # @return [Hash<String, Object>]
     attr_accessor :query_result_row_data
 
     # **[Required]** A map containing metadata or add-on data for the data presented in the queryResultRowData map.  Data required to present drill down
-    # information from the queryResultRowData is presented as key value pairs.
+    # information from the queryResultRowData is presented as key-value pairs.
     #
     # @return [Hash<String, Object>]
     attr_accessor :query_result_row_metadata

data/lib/oci/apm_traces/models/query_result_row_type_summary.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # A summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.
+  # Summary of the datatype, unit and related metadata of an individual row element of a query result row that is returned.
   #
   class ApmTraces::Models::QueryResultRowTypeSummary
     # Datatype of the query result row element.

data/lib/oci/apm_traces/models/query_results_grouped_by_summary.rb

@@ -5,10 +5,10 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Summary of the attribute based on which the query results are grouped by.
+  # Summary of the attribute based on which the query results are grouped.
   #
   class ApmTraces::Models::QueryResultsGroupedBySummary
-    # Column or attribute in the query result which is a group by value.
+    # Column or attribute in the query result, which is a group by value.
     #
     # @return [String]
     attr_accessor :query_results_grouped_by_column

data/lib/oci/apm_traces/models/query_results_ordered_by_summary.rb

@@ -5,10 +5,10 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Summary of the sort attribute and order by which the query results are organized.
+  # Summary of the sort and order by attribute based on which the query results are organized.
   #
   class ApmTraces::Models::QueryResultsOrderedBySummary
-    # Attribute by which the query result is sorted by.
+    # Attribute by which the query results are sorted.
     #
     # @return [String]
     attr_accessor :query_results_ordered_by

data/lib/oci/apm_traces/models/quick_pick_summary.rb

@@ -5,15 +5,15 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Summary of quick pick query objects that contains the quick pick queries.
+  # Summary of the Quick Pick query objects.
   #
   class ApmTraces::Models::QuickPickSummary
-    # **[Required]** Quick pick name for the query.
+    # **[Required]** Quick Pick name for the query.
     #
     # @return [String]
     attr_accessor :quick_pick_name
 
-    # **[Required]** Query for the quick pick.
+    # **[Required]** Query for the Quick Pick.
     #
     # @return [String]
     attr_accessor :quick_pick_query

data/lib/oci/apm_traces/models/snapshot_detail.rb

@@ -0,0 +1,163 @@
+# Copyright (c) 2016, 2022, Oracle and/or its affiliates.  All rights reserved.
+# This software is dual-licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl or Apache License 2.0 as shown at http://www.apache.org/licenses/LICENSE-2.0. You may choose either license.
+
+require 'date'
+
+# rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
+module OCI
+  # A generic key value pair object, which contains information such as the thread ID, thread name, and thread state.
+  #
+  class ApmTraces::Models::SnapshotDetail
+    # Name of the property.
+    #
+    # @return [String]
+    attr_accessor :key
+
+    # Value of the property.
+    #
+    # @return [Object]
+    attr_accessor :value
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'key': :'key',
+        'value': :'value'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        # rubocop:disable Style/SymbolLiteral
+        'key': :'String',
+        'value': :'Object'
+        # rubocop:enable Style/SymbolLiteral
+      }
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @option attributes [String] :key The value to assign to the {#key} property
+    # @option attributes [Object] :value The value to assign to the {#value} property
+    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.key = attributes[:'key'] if attributes[:'key']
+
+      self.value = attributes[:'value'] if attributes[:'value']
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength, Layout/EmptyLines, Style/SymbolLiteral
+
+    # rubocop:disable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] other the other object to be compared
+    def ==(other)
+      return true if equal?(other)
+
+      self.class == other.class &&
+        key == other.key &&
+        value == other.value
+    end
+    # rubocop:enable Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/PerceivedComplexity, Layout/EmptyLines
+
+    # @see the `==` method
+    # @param [Object] other the other object to be compared
+    def eql?(other)
+      self == other
+    end
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [key, value].hash
+    end
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # rubocop:disable Metrics/AbcSize, Layout/EmptyLines
+
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    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
+    # rubocop:enable Metrics/AbcSize, Layout/EmptyLines
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    private
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end
+# rubocop:enable Lint/UnneededCopDisableDirective, Metrics/LineLength

data/lib/oci/apm_traces/models/span.rb

@@ -9,8 +9,8 @@ module OCI
   #
   class ApmTraces::Models::Span
     # **[Required]** Unique identifier (spanId) for the span.  Note that this field is
-    # defined as spanKey in the API to comply with OCI API fields naming conventions.
-    # The spanKey maps to the spanId in the APM repository.
+    # defined as spanKey in the API and it maps to the spanId in the trace data
+    # in Application Performance Monitoring.
     #
     # @return [String]
     attr_accessor :key
@@ -40,7 +40,7 @@ module OCI
     # @return [Integer]
     attr_accessor :duration_in_ms
 
-    # **[Required]** Span name associated with the trace.  This is usually the method or uri of the request.
+    # **[Required]** Span name associated with the trace.  This is usually the method or URI of the request.
     #
     # @return [String]
     attr_accessor :operation_name
@@ -65,7 +65,7 @@ module OCI
     # @return [Array<OCI::ApmTraces::Models::SpanLogCollection>]
     attr_accessor :logs
 
-    # **[Required]** Indicates if the span has an error
+    # **[Required]** Indicates if the span has an error.
     #
     # @return [BOOLEAN]
     attr_accessor :is_error

data/lib/oci/apm_traces/models/span_log.rb

@@ -5,7 +5,7 @@ require 'date'
 
 # rubocop:disable Lint/UnneededCopDisableDirective, Metrics/LineLength
 module OCI
-  # Definition of a log which is a key value pair of log data.
+  # Definition of a log which is a key-value pair of log data.
   #
   class ApmTraces::Models::SpanLog
     # **[Required]** Key that specifies the log name.