Docs
API
Interfaces
ThriftHandler

Interface: ThriftHandler

types/src.YamlConfig.ThriftHandler

Handler for OData

Table of contents

Properties

Properties

hostName

hostName: string

The name of the host to connect to.

Defined in

packages/types/src/config.ts:1136


https

Optional https: boolean

Boolean value indicating whether to use https. Defaults to false.

Defined in

packages/types/src/config.ts:1148


idl

idl: string

Path to IDL file

Defined in

packages/types/src/config.ts:1172


operationHeaders

Optional operationHeaders: Object

JSON object representing the Headers to add to the runtime of the API calls

Index signature

▪ [k: string]: any

Defined in

packages/types/src/config.ts:1160


path

Optional path: string

The path on which the Thrift service is listening. Defaults to '/thrift'.

Defined in

packages/types/src/config.ts:1144


port

port: number

The port number to attach to on the host.

Defined in

packages/types/src/config.ts:1140


protocol

Optional protocol: "json" | "binary" | "compact"

Name of the Thrift protocol type to use. Defaults to 'binary'. (Allowed values: binary, compact, json)

Defined in

packages/types/src/config.ts:1152


schemaHeaders

Optional schemaHeaders: Object

If you are using a remote URL endpoint to fetch your schema, you can set headers for the HTTP request to fetch your schema.

Index signature

▪ [k: string]: any

Defined in

packages/types/src/config.ts:1166


serviceName

serviceName: string

The name of your service. Used for logging.

Defined in

packages/types/src/config.ts:1156