LoadedPartitionInformationQueryDescription

  • Article

Represents data structure that contains query information.

Properties

Name Type Required
MetricName string No
ServiceName string No
Ordering string (enum) No
MaxResults integer (int64) No
ContinuationToken string No

MetricName

Type: string
Required: No

Name of the metric for which this information is provided.

ServiceName

Type: string
Required: No

Name of the service this partition belongs to.

Ordering

Type: string (enum)
Required: No
Default: Desc

Ordering of partitions' load.

Defines the order.

Possible values are:

  • Desc - Descending sort order.
  • Asc - Ascending sort order.

MaxResults

Type: integer (int64)
Required: No

The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.

ContinuationToken

Type: string
Required: No

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.