Class CloseRequestParameters

Request options for Close

<p>https://docs.opensearch.org/latest/search-plugins/sql/sql-ppl-api/</p>
Inheritance
object
RequestParameters<CloseRequestParameters>
CloseRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.SqlApi
Assembly: OpenSearch.Net.dll
Syntax
public class CloseRequestParameters : RequestParameters<CloseRequestParameters>, IRequestParameters

Properties

| Edit this page View Source

DefaultHttpMethod

Declaration
public override HttpMethod DefaultHttpMethod { get; }
Property Value
Type Description
HttpMethod
Overrides
| Edit this page View Source

Format

Specifies the response format (JSON or YAML).

Declaration
public SqlResponseFormat? Format { get; set; }
Property Value
Type Description
SqlResponseFormat?
| Edit this page View Source

OperationName

The OpenSearch REST API operation name this request maps to (for example search or indices.create), used as the OpenTelemetry span name and db.operation tag. null for requests that do not correspond to a named API operation.

Declaration
public override string OperationName { get; }
Property Value
Type Description
string
Overrides
| Edit this page View Source

Sanitize

Whether to escape special characters in the results.

Declaration
public bool? Sanitize { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

SupportsBody

Declaration
public override bool SupportsBody { get; }
Property Value
Type Description
bool
Overrides

Implements

Extension Methods