FacetRequestOptions Class

  • java.lang.Object
    • com.microsoft.azure.management.resourcegraph.v2019_04_01.FacetRequestOptions

public class FacetRequestOptions

The options for facet evaluation.

Constructor Summary

Constructor Description
FacetRequestOptions()

Method Summary

Modifier and Type Method and Description
java.lang.String filter()

Get specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

java.lang.String sortBy()

Get the column name or query expression to sort on.

FacetSortOrder sortOrder()

Get the sorting order by the selected column (count by default).

java.lang.Integer top()

Get the maximum number of facet rows that should be returned.

FacetRequestOptions withFilter(String filter)

Set specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

FacetRequestOptions withSortBy(String sortBy)

Set the column name or query expression to sort on.

FacetRequestOptions withSortOrder(FacetSortOrder sortOrder)

Set the sorting order by the selected column (count by default).

FacetRequestOptions withTop(Integer top)

Set the maximum number of facet rows that should be returned.

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

FacetRequestOptions

public FacetRequestOptions()

Method Details

filter

public String filter()

Get specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

Returns:

the filter value

sortBy

public String sortBy()

Get the column name or query expression to sort on. Defaults to count if not present.

Returns:

the sortBy value

sortOrder

public FacetSortOrder sortOrder()

Get the sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'.

Returns:

the sortOrder value

top

public Integer top()

Get the maximum number of facet rows that should be returned.

Returns:

the top value

withFilter

public FacetRequestOptions withFilter(String filter)

Set specifies the filter condition for the 'where' clause which will be run on main query's result, just before the actual faceting.

Parameters:

filter - the filter value to set

Returns:

the FacetRequestOptions object itself.

withSortBy

public FacetRequestOptions withSortBy(String sortBy)

Set the column name or query expression to sort on. Defaults to count if not present.

Parameters:

sortBy - the sortBy value to set

Returns:

the FacetRequestOptions object itself.

withSortOrder

public FacetRequestOptions withSortOrder(FacetSortOrder sortOrder)

Set the sorting order by the selected column (count by default). Possible values include: 'asc', 'desc'.

Parameters:

sortOrder - the sortOrder value to set

Returns:

the FacetRequestOptions object itself.

withTop

public FacetRequestOptions withTop(Integer top)

Set the maximum number of facet rows that should be returned.

Parameters:

top - the top value to set

Returns:

the FacetRequestOptions object itself.

Applies to