QueryRequestOptions Class

Package:
com.azure.resourcemanager.resourcegraph.models
Maven Artifact:
com.azure.resourcemanager:azure-resourcemanager-resourcegraph:1.1.0
  • java.lang.Object
    • com.azure.resourcemanager.resourcegraph.models.QueryRequestOptions

Implements

JsonSerializable<QueryRequestOptions>

public final class QueryRequestOptions
implements JsonSerializable<QueryRequestOptions>

The options for query evaluation.

Constructor Summary

Constructor Description
QueryRequestOptions()

Creates an instance of QueryRequestOptions class.

Method Summary

Modifier and Type Method and Description
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.
static QueryRequestOptions fromJson(JsonReader jsonReader)

Reads an instance of QueryRequestOptions from the JsonReader.
ResultFormat resultFormat()

Get the resultFormat property: Defines in which format query result returned.
Integer skip()

Get the skip property: The number of rows to skip from the beginning of the results.
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.
JsonWriter toJson(JsonWriter jsonWriter)
Integer top()

Get the top property: The maximum number of rows that the query should return.
void validate()

Validates the instance.
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.
QueryRequestOptions withResultFormat(ResultFormat resultFormat)

Set the resultFormat property: Defines in which format query result returned.
QueryRequestOptions withSkip(Integer skip)

Set the skip property: The number of rows to skip from the beginning of the results.
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.
QueryRequestOptions withTop(Integer top)

Set the top property: The maximum number of rows that the query should return.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

QueryRequestOptions

public QueryRequestOptions()

Creates an instance of QueryRequestOptions class.

Method Details

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.

fromJson

public static QueryRequestOptions fromJson(JsonReader jsonReader)

Reads an instance of QueryRequestOptions from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of QueryRequestOptions if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the QueryRequestOptions.

resultFormat

public ResultFormat resultFormat()

Get the resultFormat property: Defines in which format query result returned.

Returns:

the resultFormat value.

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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

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.

validate

public void validate()

Validates the instance.

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.

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.

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.

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.

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.

Applies to