Class IndexCandidate

Schema for an index that was not chosen for serving the query with the reason for the exclusion.

Index

Constructors

Properties

Methods

deserialize serialize

Constructors

constructor

new IndexCandidate(): CloudantV1.IndexCandidate
Returns CloudantV1.IndexCandidate

Properties

analysis

analysis: CloudantV1.IndexAnalysis

Schema for detailed explanation of why the specific index was excluded by the query planner.

index

index: CloudantV1.IndexInformation

Schema for information about an index.

Methods

`Static`deserialize

deserialize(obj: any): CloudantV1.IndexCandidate
Parameters
- obj: any
Returns CloudantV1.IndexCandidate
- Defined in cloudant/v1.ts:14889

`Static`serialize

serialize(obj: any): CloudantV1.IndexCandidate.Transport
Parameters
- obj: any
Returns CloudantV1.IndexCandidate.Transport
- Defined in cloudant/v1.ts:14875