Loading

stack es get cli command

Auth required Idempotent Scope: global
elastic stack es get --id <id> --index <index> [options]
		

Get a document by its ID.

--id string required
A unique document identifier.
--index string required
The name of the index that contains the document.
--preference string
The node or shard the operation should be performed on. By default, the operation is randomized between the shard replicas. If it is set to _local, the operation will prefer to be run on a local allocated shard when possible. If it is set to a custom value, the value is used to guarantee that the same shards will be used for the same custom value. This can help with "jumping values" when hitting different shards in different refresh states. A sample value can be something like the web session ID or the user name.
--[no-]realtime
If true, the request is real-time as opposed to near-real-time.
--[no-]refresh
If true, the request refreshes the relevant shards before retrieving the document. Setting it to true should be done after careful thought and verification that this does not cause a heavy load on the system (and slow down indexing).
--routing string

A custom value used to route operations to a specific shard.

Repeatable: pass --routing multiple times to supply more than one value

--[no-]source

Indicates whether to return the _source field (true or false) or lists the fields to return.

Repeatable: pass --source multiple times to supply more than one value

--source-excludes string

A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

Repeatable: pass --source-excludes multiple times to supply more than one value

--[no-]source-exclude-vectors
Whether vectors should be excluded from _source
--source-includes string

A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

Repeatable: pass --source-includes multiple times to supply more than one value

--stored-fields string

A comma-separated list of stored fields to return as part of a hit. If no fields are specified, no stored fields are included in the response. If this field is specified, the _source parameter defaults to false. Only leaf fields can be retrieved with the stored_fields option. Object fields can't be returned; if specified, the request fails.

Repeatable: pass --stored-fields multiple times to supply more than one value

--version number
The version number for concurrency control. It must match the current version of the document for the request to succeed.
--version-type string
The version type.
--input-file string
path to a JSON file to use as command input
-V --[no-]version
Print the Elastic CLI version
--config-file string
path to a config file (default: ~/.elasticrc.yml)
--use-context string
override the active context from the config file
--command-profile string
restrict available commands to a deployment profile (serverless, stack, default)
--[no-]json
output as JSON
--output-fields string
comma-separated list of fields to include in output (dot-notation supported)
--output-template string
Mustache-like template for custom text output (e.g. "{{id}}: {{name}}")
--[no-]dry-run

validate all inputs and exit without performing any action (preview changes without applying them)