Class: Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/visionai/v1/warehouse.rb

Overview

A strategy to specify how to sort by data schema key.

Defined Under Namespace

Classes: Option

Instance Attribute Summary collapse

Instance Attribute Details

#options ⇒ ::Array<::Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy::Option>

Returns Options in the front have high priority than those in the back.

Returns:



2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2758

class SchemaKeySortingStrategy
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Option for one data schema key.
  # @!attribute [rw] data_schema_key
  #   @return [::String]
  #     The data used to sort.
  # @!attribute [rw] sort_decreasing
  #   @return [::Boolean]
  #     Whether to sort in decreasing order or increasing order.
  #     By default, results are sorted in incresing order.
  # @!attribute [rw] aggregate_method
  #   @return [::Google::Cloud::VisionAI::V1::SchemaKeySortingStrategy::Option::AggregateMethod]
  #     Aggregate method for the current data schema key.
  class Option
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # When one result has multiple values with the same key, specify
    # which value is used to sort. By default, AGGREGATE_METHOD_LARGEST
    # is used when results are sorted in decreasing order,
    # AGGREGATE_METHOD_SMALLEST is used when results are sorted in
    # incresing order.
    module AggregateMethod
      # The unspecified aggregate method will be overwritten as mentioned
      # above.
      AGGREGATE_METHOD_UNSPECIFIED = 0

      # Take the (lexicographical or numerical) largest value to sort.
      AGGREGATE_METHOD_LARGEST = 1

      # Take the (lexicographical or numerical) smallest value to sort.
      AGGREGATE_METHOD_SMALLEST = 2
    end
  end
end