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:



2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
 
# File 'proto_docs/google/cloud/visionai/v1/warehouse.rb', line 2706

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