Class DocsResultRow

Schema for a row of document information in a DocsResult.

Index

Constructors

Properties

causedBy? doc? error? id? key reason? ref? value?

Methods

deserialize serialize

Constructors

constructor

new DocsResultRow(): CloudantV1.DocsResultRow
Returns CloudantV1.DocsResultRow

Properties

`Optional`causedBy

causedBy?: string

The cause of the error (if available).

`Optional`doc

doc?: CloudantV1.Document

Schema for a document.

`Optional`error

error?: string

The name of the error.

`Optional`id

id?: string

Schema for a document ID.

key

key: string

Schema for a document ID.

`Optional`reason

reason?: string

The reason the error occurred (if available).

`Optional`ref

ref?: number

An internal error reference (if available).

`Optional`value

value?: CloudantV1.DocsResultRowValue

Value of built-in /_all_docs style view.

Methods

`Static`deserialize

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

`Static`serialize

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