Skip to main content

@terascope/opensearch-client / client/method-helpers/index-method

client/method-helpers/index-method

Functions​

convertIndexParams()​

convertIndexParams(params, distributionMeta): { body?: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; } | { document: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; } | { body?: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; type: string; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; }

Defined in: opensearch-client/src/client/method-helpers/index-method.ts:3

Parameters​

ParameterType
paramsIndexParams
distributionMetaClientMetadata

Returns​

{ body?: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; } | { document: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; } | { body?: unknown; id?: string; if_primary_term?: number; if_seq_no?: number; index: string; op_type?: OpType; refresh?: IndexRefresh; routing?: string; timeout?: string | number; type: string; version?: number; version_type?: VersionType; wait_for_active_shards?: WaitForActiveShards; }