Class: Azure::ResourceGraph::Mgmt::V2019_04_01::Models::FacetRequestOptions

Inherits:
Object
  • Object
show all
Includes:
MsRestAzure
Defined in:
lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb

Overview

The options for facet evaluation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#filter ⇒ String

which will be run on main query’s result, just before the actual faceting.

Returns:

  • (String) —

    Specifies the filter condition for the ‘where’ clause



27
28
29
 
# File 'lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb', line 27

def filter
  @filter
end

#sort_by ⇒ String

Defaults to count if not present.

Returns:

  • (String) —

    The column name or query expression to sort on.



17
18
19
 
# File 'lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb', line 17

def sort_by
  @sort_by
end

#sort_order ⇒ FacetSortOrder

(count by default). Possible values include: ‘asc’, ‘desc’. Default value: ‘desc’ .

Returns:



22
23
24
 
# File 'lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb', line 22

def sort_order
  @sort_order
end

#top ⇒ Integer

returned.

Returns:

  • (Integer) —

    The maximum number of facet rows that should be



31
32
33
 
# File 'lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb', line 31

def top
  @top
end

Class Method Details

.mapper ⇒ Object

Mapper for FacetRequestOptions class as Ruby Hash. This will be used for serialization/deserialization.



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/2019-04-01/generated/azure_mgmt_resourcegraph/models/facet_request_options.rb', line 38

def self.mapper()
  {
    client_side_validation: true,
    required: false,
    serialized_name: 'FacetRequestOptions',
    type: {
      name: 'Composite',
      class_name: 'FacetRequestOptions',
      model_properties: {
        sort_by: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sortBy',
          type: {
            name: 'String'
          }
        },
        sort_order: {
          client_side_validation: true,
          required: false,
          serialized_name: 'sortOrder',
          default_value: 'desc',
          type: {
            name: 'Enum',
            module: 'FacetSortOrder'
          }
        },
        filter: {
          client_side_validation: true,
          required: false,
          serialized_name: 'filter',
          type: {
            name: 'String'
          }
        },
        top: {
          client_side_validation: true,
          required: false,
          serialized_name: '$top',
          constraints: {
            InclusiveMaximum: 1000,
            InclusiveMinimum: 1
          },
          type: {
            name: 'Number'
          }
        }
      }
    }
  }
end