extends |
AbstractNamespace |
---|
Class IngestNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
Methods | ||||
---|---|---|---|---|
public
|
deletePipeline(array $params = []): array
Deletes an ingest pipeline.
Deletes an ingest pipeline. $params['id'] = (string) The pipeline ID or wildcard expression of pipeline IDs used to limit the request. To delete all ingest pipelines in a cluster, use a value of Parameters
|
# | ||
public
|
getPipeline(array $params = []): array
Returns an ingest pipeline.
Returns an ingest pipeline. $params['id'] = (string) A comma-separated list of pipeline IDs to retrieve. Wildcard ( Parameters
|
# | ||
public
|
processorGrok(array $params = []): array
Returns a list of built-in grok patterns.
Returns a list of built-in grok patterns. $params['s'] = (boolean) Determines how to sort returned grok patterns by key name. (Default = false) $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". Parameters
|
# | ||
public
|
putPipeline(array $params = []): array
Creates or updates an ingest pipeline.
Creates or updates an ingest pipeline. $params['id'] = (string) The ID of the ingest pipeline. $params['cluster_manager_timeout'] = (string) The amount of time allowed to establish a connection to the cluster manager node. $params['master_timeout'] = (string) Period to wait for a connection to the cluster-manager node. If no response is received before the timeout expires, the request fails and returns an error. $params['timeout'] = (string) The amount of time to wait for a response. $params['pretty'] = (boolean) Whether to pretty format the returned JSON response. (Default = false) $params['human'] = (boolean) Whether to return human readable values for statistics. (Default = true) $params['error_trace'] = (boolean) Whether to include the stack trace of returned errors. (Default = false) $params['source'] = (string) The URL-encoded request definition. Useful for libraries that do not accept a request body for non-POST requests. $params['filter_path'] = (any) Used to reduce the response. This parameter takes a comma-separated list of filters. It supports using wildcards to match any field or part of a field’s name. You can also exclude fields with "-". $params['body'] = (array) The ingest definition. (Required) Parameters
|
# | ||
public
|
simulate(array $params = []): array
Simulates an ingest pipeline with example documents.
Simulates an ingest pipeline with example documents. $params['id'] = (string) The pipeline to test. If you don't specify a Parameters
|
# |
Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
__construct(), extractArgument(), performRequest() |
Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
---|
$transport, $httpTransport, $endpointFactory, $endpoints |