Class GetPoliciesRequestParameters

Request options for GetPolicies

Inheritance
object
RequestParameters<GetPoliciesRequestParameters>
GetPoliciesRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.SmApi
Assembly: OpenSearch.Net.dll
Syntax
public class GetPoliciesRequestParameters : RequestParameters<GetPoliciesRequestParameters>, 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

From

The starting index from which to retrieve snapshot management policies.

Declaration
public int? From { get; set; }
Property Value
Type Description
int?
| 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

QueryStringParam

The query string to filter the returned snapshot management policies.

Declaration
public string QueryStringParam { get; set; }
Property Value
Type Description
string
| Edit this page View Source

Size

The number of snapshot management policies to return.

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

SortField

The name of the field to sort the snapshot management policies by.

Declaration
public string SortField { get; set; }
Property Value
Type Description
string
| Edit this page View Source

SortOrder

The order to sort the snapshot management policies.

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

SupportsBody

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

Implements

Extension Methods