Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BuildReq

Static build function arguments.

Hierarchy

  • BuildReq

Index

Properties

Optional Readonly axiosOptions

axiosOptions?: AxiosRequestConfig<any>

A {@link AxiosRequestConfig}. For example, to use HTTP keep-alive,

  • @example ```typescript import { Agent } from 'https';from '@vertexvis/api-client-node';

const main = async () => { const client = await VertexClient.build({ axiosOptions: { httpsAgent: new Agent({ keepAlive: true }) } }); };

main();


see

Axios request config for details.

Optional Readonly basePath

basePath?: string

Base path to use, @see BasePath.

Optional Readonly client

client?: { id?: string; secret?: string }

Your Vertex API client ID and secret.

Type declaration

  • Optional Readonly id?: string
  • Optional Readonly secret?: string

Optional Readonly initialToken

initialToken?: OAuth2Token