extends |
AbstractNamespace |
|---|
Class IsmNamespace
NOTE: This file is autogenerated using util/GenerateEndpoints.php
| Methods | ||||
|---|---|---|---|---|
public
|
addPolicy(array $params = []): array
Adds a policy to an index.
Adds a policy to an index. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
public
|
changePolicy(array $params = []): array
Updates the managed index policy to a new policy.
Updates the managed index policy to a new policy. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
public
|
deletePolicy(array $params = []): array
Deletes a policy.
Deletes a policy. $params['policy_id'] = (string) (Required) $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
|
existsPolicy(array $params = []): bool
Checks whether the policy exists.
Checks whether the policy exists. $params['policy_id'] = (string) (Required) $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
|
explainPolicy(array $params = []): array
Gets the currently applied policy on indices.
Gets the currently applied policy on indices. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
public
|
getPolicies(array $params = []): array
Gets the policies.
Gets the policies. $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
|
getPolicy(array $params = []): array
Gets a policy.
Gets a policy. $params['policy_id'] = (string) (Required) $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
|
putPolicies(array $params = []): array
Gets the policies.
Gets the policies. $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['policyID'] = (string) $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
|
putPolicy(array $params = []): array
Creates or updates a policy.
Creates or updates a policy. $params['policy_id'] = (string) (Required) $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 = 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
|
refreshSearchAnalyzers(array $params = []): array
Refresh search analyzers in real time.
Refresh search analyzers in real time. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
public
|
removePolicy(array $params = []): array
Removes a policy from an index.
Removes a policy from an index. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
public
|
retryIndex(array $params = []): array
Retry the failed action for an index.
Retry the failed action for an index. $params['index'] = (string) Comma-separated list of data streams, indexes, and aliases. Supports wildcards ( Parameters
|
# | ||
| Methods inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
__construct(), extractArgument(), performRequest() |
| Properties inherited from OpenSearch\Namespaces\AbstractNamespace |
|---|
$transport, $endpointFactory, $endpoints |