Skip to main content

model.go

model.go - Overview​

  1. Overview This file defines the QueueListRequest struct and its associated Validate method, used for handling and validating requests for listing queues.

  2. Detailed Documentation

QueueListRequest​

  • Purpose: Represents a request for listing queues, including start and end times, filters, and a limit on the number of results.
    • Parameters:
      • Start (int64): The start time for the queue list request, represented as Unix nanoseconds.
      • End (int64): The end time for the queue list request, represented as Unix nanoseconds.
      • Filters (*v3.FilterSet): A set of filters to apply to the queue list request. Uses github.com/SigNoz/signoz/pkg/query-service/model/v3
      • Limit (int): The maximum number of queues to return in the list.
    • Returns: None

Validate​

  • Purpose: Validates the QueueListRequest to ensure that the start and end times are non-negative and that the filters are valid.
    • Parameters: None
    • Returns: error. Returns an error if validation fails; otherwise, returns nil.

  1. Code Examples None

  2. Clarity and Accuracy The documentation is based on the code provided.

  3. Markdown & MDX Perfection The markdown is properly formatted.

  4. Edge Cases To Avoid Breaking MDX No MDX errors are present.

  5. Getting Started Relevance Include in Getting Started: NO