class Azure::ResourceGraph::Mgmt::V2019_04_01::Models::FacetRequestOptions

The options for facet evaluation

Attributes

filter[RW]

@return [String] Specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

sort_by[RW]

@return [String] The column name or query expression to sort on. Defaults to count if not present.

sort_order[RW]

@return [FacetSortOrder] The sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'. Default value: 'desc' .

top[RW]

@return [Integer] The maximum number of facet rows that should be returned.

Private Class Methods

mapper() click to toggle source

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

# 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