Sha256: 1d4e8880555363b84d3fdc6997e307569ccf03d95d47f49d8b97edb637634790

Contents?: true

Size: 1.13 KB

Versions: 19

Compression:

Stored size: 1.13 KB

Contents

[[enterprise-search-api]]
== Enterprise Search API

=== Health API

[source,rb]
----------------------------
> response = ent_client.health
> response.body
 => {"name"=>"...",
     "version"=>{"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."},
     "jvm"=>{...},
     "filebeat"=>{...},
     "system"=>{...}
    }
----------------------------

=== Version API

[source,rb]
----------------------------
> response = ent_client.version
> response.body
 => {"number"=>"7.10.0", "build_hash"=>"...", "build_date"=>"..."}
----------------------------

=== Managing Read-Only mode:

[source,rb]
----------------------------
# Set read-only flag state
ent_client.put_read_only(body: { enabled: false })

# Get read-only flag state
ent_client.read_only
----------------------------

=== Stats API

[source,rb]
----------------------------
> ent_client.stats.body
 => {"app"=>{"pid"=>1, "start"=>"...", "end"=>"", "metrics"=>{...}},
     "queues"=>{"connectors"=>{...}, "document_destroyer"=>{...}, "engine_destroyer"=>{...}, "index_adder"=>{...}, ...},
     "connectors"=>{"alive"=>true, "pool"=>{...}, "job_store"=>{...}}}}
----------------------------

Version data entries

19 entries across 19 versions & 1 rubygems

Version Path
elastic-enterprise-search-7.17.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.2.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.1.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.0.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.2.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.1.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.0.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-8.0.0.pre docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.17.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.16.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.15.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.14.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.15.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.14.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.12.1 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.13.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.13.0.pre docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.12.0 docs/guide/enterprise-search-api.asciidoc
elastic-enterprise-search-7.11.0 docs/guide/enterprise-search-api.asciidoc