SearchMetadata Class

Metadata for search results.

Inheritance

Model

SearchMetadata

Constructor

SearchMetadata(*, search_id: Optional[str] = None, result_type: Optional[str] = None, total: Optional[int] = None, top: Optional[int] = None, id: Optional[str] = None, core_summaries: Optional[List[azure.mgmt.loganalytics.models._models_py3.CoreSummary]] = None, status: Optional[str] = None, start_time: Optional[datetime.datetime] = None, last_updated: Optional[datetime.datetime] = None, e_tag: Optional[str] = None, sort: Optional[List[azure.mgmt.loganalytics.models._models_py3.SearchSort]] = None, request_time: Optional[int] = None, aggregated_value_field: Optional[str] = None, aggregated_grouping_fields: Optional[str] = None, sum: Optional[int] = None, max: Optional[int] = None, schema: Optional[azure.mgmt.loganalytics.models._models_py3.SearchMetadataSchema] = None, **kwargs)

Parameters

search_id

str

Required

The request id of the search.

result_type

str

Required

The search result type.

total

<xref:long>

Required

The total number of search results.

top

<xref:long>

Required

The number of top search results.

id

str

Required

The id of the search results request.

core_summaries

list[CoreSummary]

Required

The core summaries.

status

str

Required

The status of the search results.

start_time

datetime

Required

The start time for the search.

last_updated

datetime

Required

The time of last update.

e_tag

str

Required

The ETag of the search results.

sort

list[SearchSort]

Required

How the results are sorted.

request_time

<xref:long>

Required

The request time.

aggregated_value_field

str

Required

The aggregated value field.

aggregated_grouping_fields

str

Required

The aggregated grouping fields.

sum

<xref:long>

Required

The sum of all aggregates returned in the result set.

max

<xref:long>

Required

The max of all aggregates returned in the result set.

schema

SearchMetadataSchema

Required

The schema.