Skip to content

Latest commit

 

History

History
218 lines (171 loc) · 8.23 KB

SearchApi.md

File metadata and controls

218 lines (171 loc) · 8.23 KB
Raw

.SearchApi

All URIs are relative to http://127.0.0.1:4646/v1

Method HTTP request Description
getFuzzySearch POST /search/fuzzy
getSearch POST /search

getFuzzySearch

FuzzySearchResponse getFuzzySearch(fuzzySearchRequest)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .SearchApi(configuration);

let body:.SearchApiGetFuzzySearchRequest = {
  // FuzzySearchRequest
  fuzzySearchRequest: {
    allowStale: true,
    authToken: "authToken_example",
    context: "context_example",
    filter: "filter_example",
    headers: {
      "key": "key_example",
    },
    namespace: "namespace_example",
    nextToken: "nextToken_example",
    params: {
      "key": "key_example",
    },
    perPage: 1,
    prefix: "prefix_example",
    region: "region_example",
    reverse: true,
    text: "text_example",
    waitIndex: 0,
    waitTime: 1,
  },
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // number | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional)
  index: 1,
  // string | Provided with IndexParam to wait for change. (optional)
  wait: "wait_example",
  // string | If present, results will include stale reads. (optional)
  stale: "stale_example",
  // string | Constrains results to jobs that start with the defined prefix (optional)
  prefix: "prefix_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // number | Maximum number of results to return. (optional)
  perPage: 1,
  // string | Indicates where to start paging for queries that support pagination. (optional)
  nextToken: "next_token_example",
};

apiInstance.getFuzzySearch(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
fuzzySearchRequest FuzzySearchRequest
region [string] Filters results based on the specified region. (optional) defaults to undefined
namespace [string] Filters results based on the specified namespace. (optional) defaults to undefined
index [number] If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) defaults to undefined
wait [string] Provided with IndexParam to wait for change. (optional) defaults to undefined
stale [string] If present, results will include stale reads. (optional) defaults to undefined
prefix [string] Constrains results to jobs that start with the defined prefix (optional) defaults to undefined
xNomadToken [string] A Nomad ACL token. (optional) defaults to undefined
perPage [number] Maximum number of results to return. (optional) defaults to undefined
nextToken [string] Indicates where to start paging for queries that support pagination. (optional) defaults to undefined

Return type

FuzzySearchResponse

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 * X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
* X-Nomad-KnownLeader - Boolean indicating if there is a known cluster leader.
* X-Nomad-LastContact - The time in milliseconds that a server was last contacted by the leader node.
400 Bad request -
403 Forbidden -
405 Method not allowed -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSearch

SearchResponse getSearch(searchRequest)

Example

import {  } from '';
import * as fs from 'fs';

const configuration = .createConfiguration();
const apiInstance = new .SearchApi(configuration);

let body:.SearchApiGetSearchRequest = {
  // SearchRequest
  searchRequest: {
    allowStale: true,
    authToken: "authToken_example",
    context: "context_example",
    filter: "filter_example",
    headers: {
      "key": "key_example",
    },
    namespace: "namespace_example",
    nextToken: "nextToken_example",
    params: {
      "key": "key_example",
    },
    perPage: 1,
    prefix: "prefix_example",
    region: "region_example",
    reverse: true,
    waitIndex: 0,
    waitTime: 1,
  },
  // string | Filters results based on the specified region. (optional)
  region: "region_example",
  // string | Filters results based on the specified namespace. (optional)
  namespace: "namespace_example",
  // number | If set, wait until query exceeds given index. Must be provided with WaitParam. (optional)
  index: 1,
  // string | Provided with IndexParam to wait for change. (optional)
  wait: "wait_example",
  // string | If present, results will include stale reads. (optional)
  stale: "stale_example",
  // string | Constrains results to jobs that start with the defined prefix (optional)
  prefix: "prefix_example",
  // string | A Nomad ACL token. (optional)
  xNomadToken: "X-Nomad-Token_example",
  // number | Maximum number of results to return. (optional)
  perPage: 1,
  // string | Indicates where to start paging for queries that support pagination. (optional)
  nextToken: "next_token_example",
};

apiInstance.getSearch(body).then((data:any) => {
  console.log('API called successfully. Returned data: ' + data);
}).catch((error:any) => console.error(error));

Parameters

Name Type Description Notes
searchRequest SearchRequest
region [string] Filters results based on the specified region. (optional) defaults to undefined
namespace [string] Filters results based on the specified namespace. (optional) defaults to undefined
index [number] If set, wait until query exceeds given index. Must be provided with WaitParam. (optional) defaults to undefined
wait [string] Provided with IndexParam to wait for change. (optional) defaults to undefined
stale [string] If present, results will include stale reads. (optional) defaults to undefined
prefix [string] Constrains results to jobs that start with the defined prefix (optional) defaults to undefined
xNomadToken [string] A Nomad ACL token. (optional) defaults to undefined
perPage [number] Maximum number of results to return. (optional) defaults to undefined
nextToken [string] Indicates where to start paging for queries that support pagination. (optional) defaults to undefined

Return type

SearchResponse

Authorization

X-Nomad-Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 * X-Nomad-Index - A unique identifier representing the current state of the requested resource. On a new Nomad cluster the value of this index starts at 1.
* X-Nomad-KnownLeader - Boolean indicating if there is a known cluster leader.
* X-Nomad-LastContact - The time in milliseconds that a server was last contacted by the leader node.
400 Bad request -
403 Forbidden -
405 Method not allowed -
500 Internal server error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]