Package com.azure.resourcemanager.resourcegraph.models

Class QueryRequestOptions

  • public final class QueryRequestOptions
extends Object
    The options for query evaluation.

    • Constructor Detail

      • QueryRequestOptions

        public QueryRequestOptions()

    • Method Detail

      • skipToken

        public String skipToken()
        Get the skipToken property: Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
        Returns:
        the skipToken value.

      • withSkipToken

        public QueryRequestOptions withSkipToken​(String skipToken)
        Set the skipToken property: Continuation token for pagination, capturing the next page size and offset, as well as the context of the query.
        Parameters:
        skipToken - the skipToken value to set.
        Returns:
        the QueryRequestOptions object itself.

      • top

        public Integer top()
        Get the top property: The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present.
        Returns:
        the top value.

      • withTop

        public QueryRequestOptions withTop​(Integer top)
        Set the top property: The maximum number of rows that the query should return. Overrides the page size when ```$skipToken``` property is present.
        Parameters:
        top - the top value to set.
        Returns:
        the QueryRequestOptions object itself.

      • skip

        public Integer skip()
        Get the skip property: The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present.
        Returns:
        the skip value.

      • withSkip

        public QueryRequestOptions withSkip​(Integer skip)
        Set the skip property: The number of rows to skip from the beginning of the results. Overrides the next page offset when ```$skipToken``` property is present.
        Parameters:
        skip - the skip value to set.
        Returns:
        the QueryRequestOptions object itself.

      • resultFormat

        public ResultFormat resultFormat()
        Get the resultFormat property: Defines in which format query result returned.
        Returns:
        the resultFormat value.

      • withResultFormat

        public QueryRequestOptions withResultFormat​(ResultFormat resultFormat)
        Set the resultFormat property: Defines in which format query result returned.
        Parameters:
        resultFormat - the resultFormat value to set.
        Returns:
        the QueryRequestOptions object itself.

      • allowPartialScopes

        public Boolean allowPartialScopes()
        Get the allowPartialScopes property: Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.
        Returns:
        the allowPartialScopes value.

      • withAllowPartialScopes

        public QueryRequestOptions withAllowPartialScopes​(Boolean allowPartialScopes)
        Set the allowPartialScopes property: Only applicable for tenant and management group level queries to decide whether to allow partial scopes for result in case the number of subscriptions exceed allowed limits.
        Parameters:
        allowPartialScopes - the allowPartialScopes value to set.
        Returns:
        the QueryRequestOptions object itself.

      • validate

        public void validate()
        Validates the instance.
        Throws:
        IllegalArgumentException - thrown if the instance is not valid.