Class SearchFindingCorrelationsRequestParameters

Request options for SearchFindingCorrelations

<p>https://docs.opensearch.org/latest/security-analytics/api-tools/correlation-eng/#list-correlations-for-a-finding-belonging-to-a-log-type</p>
Inheritance
object
RequestParameters<SearchFindingCorrelationsRequestParameters>
SearchFindingCorrelationsRequestParameters
Implements
Inherited Members
Namespace: OpenSearch.Net.Specification.SecurityAnalyticsApi
Assembly: OpenSearch.Net.dll
Syntax
public class SearchFindingCorrelationsRequestParameters : RequestParameters<SearchFindingCorrelationsRequestParameters>, 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

DetectorType

The log type of findings you want to correlate with the specified finding. Required.

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

Finding

The finding ID for which you want to find other findings that are correlated. Required.

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

NearbyFindings

The number of nearby findings you want to return. Optional.

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

SupportsBody

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

TimeWindow

The time window (in ms) in which all of the correlations must have occurred together. Optional.

Declaration
public long? TimeWindow { get; set; }
Property Value
Type Description
long?

Implements

Extension Methods