extends |
AbstractNamespace |
|---|
Class TransformsNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
delete(array $params = []): array
Delete an index transform.
Delete an index transform. $params['id'] = (string) Transform to delete
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
explain(array $params = []): array
Returns the status and metadata of a transform job.
Returns the status and metadata of a transform job. $params['id'] = (string) Transform to explain
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
get(array $params = []): array
Returns the status and metadata of a transform job.
Returns the status and metadata of a transform job. $params['id'] = (string) Transform to access
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
preview(array $params = []): array
Returns a preview of what a transformed index would look like.
Returns a preview of what a transformed index would look like. $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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
put(array $params = []): array
Create an index transform, or update a transform if `if_seq_no` and `if_primary_term` are provided.
Create an index transform, or update a transform if $params['id'] = (string) Transform to create/update
$params['if_primary_term'] = (number) Only perform the operation if the document has this primary term.
$params['if_seq_no'] = (integer) Only perform the operation if the document has this sequence number.
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
search(array $params = []): array
Returns the details of all transform jobs.
Returns the details of all transform jobs. $params['from'] = (number) The starting transform to return. Default is Parameters
|
# | ||
public
|
start(array $params = []): array
Start transform.
Start transform. $params['id'] = (string) Transform to start
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
public
|
stop(array $params = []): array
Stop transform.
Stop transform. $params['id'] = (string) Transform to stop
$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 = false)
$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) A comma-separated list of filters used to filter the response. Use wildcards to match any field or part of a field's name. To exclude fields, use Parameters
|
# | ||
| Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
__construct(), extractArgument(), performRequest() |
| Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
$transport, $httpTransport, $endpointFactory, $endpoints |