IndexResource

IndexResource · Type

Methods

configure

indexResource.configure(pod_type: string, replicas: int) → Result

Change this index’s pod type and number of replicas.

createPod

indexResource.createPod(dimension: int, metric?: string, environment?: string, replicas?: int, pod_type?: string, pods?: int, shards?: int, metadataConfig?: array, sourceCollection?: string) → Result

Create a pod-based index with this name.

createServerless

indexResource.createServerless(dimension: int, metric?: string, cloud?: string, region?: string) → Result

Create a serverless index with this name.

delete

indexResource.delete() → Result

Delete this index.

describe

indexResource.describe() → Result

Describe this index.

list

indexResource.list() → Result

List the indexes.