Search Results for

    Show / Hide Table of Contents

    Class GetAlertsRequestParameters

    Request options for GetAlerts

    https://docs.opensearch.org/docs/latest/security-analytics/api-tools/alert-finding-api/#get-alerts

    Inheritance
    object
    RequestParameters<GetAlertsRequestParameters>
    GetAlertsRequestParameters
    Implements
    IRequestParameters
    Inherited Members
    RequestParameters<GetAlertsRequestParameters>.CustomResponseBuilder
    RequestParameters<GetAlertsRequestParameters>.QueryString
    RequestParameters<GetAlertsRequestParameters>.RequestConfiguration
    RequestParameters<GetAlertsRequestParameters>.ContainsQueryString(string)
    RequestParameters<GetAlertsRequestParameters>.GetQueryStringValue<TOut>(string)
    RequestParameters<GetAlertsRequestParameters>.GetResolvedQueryStringValue(string, IConnectionConfigurationValues)
    RequestParameters<GetAlertsRequestParameters>.SetQueryString(string, object)
    RequestParameters<GetAlertsRequestParameters>.Q<TOut>(string)
    RequestParameters<GetAlertsRequestParameters>.Q(string, object)
    RequestParameters<GetAlertsRequestParameters>.SetAcceptHeader(string)
    RequestParameters<GetAlertsRequestParameters>.AcceptHeaderFromFormat(string)
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: OpenSearch.Net.Specification.SecurityAnalyticsApi
    Assembly: OpenSearch.Net.dll
    Syntax
    public class GetAlertsRequestParameters : RequestParameters<GetAlertsRequestParameters>, IRequestParameters

    Properties

    | Edit this page View Source

    AlertState

    Used to filter by alert state. Optional.

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

    DefaultHttpMethod

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

    DetectorId

    The ID of the detector used to fetch alerts. Optional when detectorType is specified. Otherwise required.

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

    DetectorType

    The type of detector used to fetch alerts. Optional when detector_id is specified. Otherwise required.

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

    EndTime

    The end timestamp (in ms) of the time window in which you want to retrieve alerts. Optional.

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

    Missing

    Used to sort by whether the field missing exists or not in the documents associated with the alert. Optional.

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

    SearchString

    The alert attribute you want returned in the search. Optional.

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

    SeverityLevel

    Used to filter by alert severity level. Optional.

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

    Size

    The maximum number of results returned in the response. Optional.

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

    SortOrder

    The order used to sort the list of findings. Possible values are asc or desc. Optional.

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

    SortString

    The string used by Security Analytics to sort the alerts. Optional.

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

    StartIndex

    The pagination index. Optional.

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

    StartTime

    The beginning timestamp (in ms) of the time window in which you want to retrieve alerts. Optional.

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

    SupportsBody

    Declaration
    public override bool SupportsBody { get; }
    Property Value
    Type Description
    bool
    Overrides
    RequestParameters<GetAlertsRequestParameters>.SupportsBody

    Implements

    IRequestParameters

    Extension Methods

    SuffixExtensions.Suffix(object, string)
    • Edit this page
    • View Source
    In this article
    • Properties
      • AlertState
      • DefaultHttpMethod
      • DetectorId
      • DetectorType
      • EndTime
      • Missing
      • SearchString
      • SeverityLevel
      • Size
      • SortOrder
      • SortString
      • StartIndex
      • StartTime
      • SupportsBody
    • Implements
    • Extension Methods
    Back to top Generated by DocFX