extends |
AbstractNamespace |
---|
Class IngestNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
Methods | ||||
---|---|---|---|---|
public
|
deletePipeline(array $params = []): array
Deletes a pipeline.
Deletes a pipeline. $params['id'] = (string) 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 a pipeline.
Returns a pipeline. $params['id'] = (string) Comma-separated list of pipeline IDs to retrieve. Wildcard ( Parameters
|
# | ||
public
|
processorGrok(array $params = []): array
Returns a list of the built-in patterns.
Returns a list of the built-in patterns. $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 a pipeline.
Creates or updates a pipeline. $params['id'] = (string) ID of the ingest pipeline to create or update. $params['cluster_manager_timeout'] = (string) Operation timeout for connection to cluster-manager node. $params['master_timeout'] = (string) Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. $params['timeout'] = (string) Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. $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
Allows to simulate a pipeline with example documents.
Allows to simulate a pipeline with example documents. $params['id'] = (string) 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, $endpointFactory, $endpoints |