### YamlMime:JavaType
uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata"
name: "SearchMetadata"
nameWithType: "SearchMetadata"
summary: "Metadata for search results."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public final class **SearchMetadata**"
constructors:
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.SearchMetadata()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.SearchMetadata()"
name: "SearchMetadata()"
nameWithType: "SearchMetadata.SearchMetadata()"
summary: "Creates an instance of SearchMetadata class."
syntax: "public SearchMetadata()"
desc: "Creates an instance of SearchMetadata class."
methods:
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.aggregatedGroupingFields()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.aggregatedGroupingFields()"
name: "aggregatedGroupingFields()"
nameWithType: "SearchMetadata.aggregatedGroupingFields()"
summary: "Get the aggregatedGroupingFields property: The aggregated grouping fields."
syntax: "public String aggregatedGroupingFields()"
desc: "Get the aggregatedGroupingFields property: The aggregated grouping fields."
returns:
description: "the aggregatedGroupingFields value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.aggregatedValueField()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.aggregatedValueField()"
name: "aggregatedValueField()"
nameWithType: "SearchMetadata.aggregatedValueField()"
summary: "Get the aggregatedValueField property: The aggregated value field."
syntax: "public String aggregatedValueField()"
desc: "Get the aggregatedValueField property: The aggregated value field."
returns:
description: "the aggregatedValueField value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.coreSummaries()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.coreSummaries()"
name: "coreSummaries()"
nameWithType: "SearchMetadata.coreSummaries()"
summary: "Get the coreSummaries property: The core summaries."
syntax: "public List coreSummaries()"
desc: "Get the coreSummaries property: The core summaries."
returns:
description: "the coreSummaries value."
type: "List<>"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.etag()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.etag()"
name: "etag()"
nameWithType: "SearchMetadata.etag()"
summary: "Get the etag property: The ETag of the search results."
syntax: "public String etag()"
desc: "Get the etag property: The ETag of the search results."
returns:
description: "the etag value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.id()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.id()"
name: "id()"
nameWithType: "SearchMetadata.id()"
summary: "Get the id property: The id of the search results request."
syntax: "public String id()"
desc: "Get the id property: The id of the search results request."
returns:
description: "the id value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.lastUpdated()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.lastUpdated()"
name: "lastUpdated()"
nameWithType: "SearchMetadata.lastUpdated()"
summary: "Get the lastUpdated property: The time of last update."
syntax: "public OffsetDateTime lastUpdated()"
desc: "Get the lastUpdated property: The time of last update."
returns:
description: "the lastUpdated value."
type: "OffsetDateTime"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.max()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.max()"
name: "max()"
nameWithType: "SearchMetadata.max()"
summary: "Get the max property: The max of all aggregates returned in the result set."
syntax: "public Long max()"
desc: "Get the max property: The max of all aggregates returned in the result set."
returns:
description: "the max value."
type: "Long"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.requestTime()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.requestTime()"
name: "requestTime()"
nameWithType: "SearchMetadata.requestTime()"
summary: "Get the requestTime property: The request time."
syntax: "public Long requestTime()"
desc: "Get the requestTime property: The request time."
returns:
description: "the requestTime value."
type: "Long"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.resultType()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.resultType()"
name: "resultType()"
nameWithType: "SearchMetadata.resultType()"
summary: "Get the resultType property: The search result type."
syntax: "public String resultType()"
desc: "Get the resultType property: The search result type."
returns:
description: "the resultType value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.schema()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.schema()"
name: "schema()"
nameWithType: "SearchMetadata.schema()"
summary: "Get the schema property: The schema."
syntax: "public SearchMetadataSchema schema()"
desc: "Get the schema property: The schema."
returns:
description: "the schema value."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.searchId()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.searchId()"
name: "searchId()"
nameWithType: "SearchMetadata.searchId()"
summary: "Get the searchId property: The request id of the search."
syntax: "public String searchId()"
desc: "Get the searchId property: The request id of the search."
returns:
description: "the searchId value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.sort()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.sort()"
name: "sort()"
nameWithType: "SearchMetadata.sort()"
summary: "Get the sort property: How the results are sorted."
syntax: "public List sort()"
desc: "Get the sort property: How the results are sorted."
returns:
description: "the sort value."
type: "List<>"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.startTime()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.startTime()"
name: "startTime()"
nameWithType: "SearchMetadata.startTime()"
summary: "Get the startTime property: The start time for the search."
syntax: "public OffsetDateTime startTime()"
desc: "Get the startTime property: The start time for the search."
returns:
description: "the startTime value."
type: "OffsetDateTime"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.status()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.status()"
name: "status()"
nameWithType: "SearchMetadata.status()"
summary: "Get the status property: The status of the search results."
syntax: "public String status()"
desc: "Get the status property: The status of the search results."
returns:
description: "the status value."
type: "String"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.sum()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.sum()"
name: "sum()"
nameWithType: "SearchMetadata.sum()"
summary: "Get the sum property: The sum of all aggregates returned in the result set."
syntax: "public Long sum()"
desc: "Get the sum property: The sum of all aggregates returned in the result set."
returns:
description: "the sum value."
type: "Long"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.top()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.top()"
name: "top()"
nameWithType: "SearchMetadata.top()"
summary: "Get the top property: The number of top search results."
syntax: "public Long top()"
desc: "Get the top property: The number of top search results."
returns:
description: "the top value."
type: "Long"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.total()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.total()"
name: "total()"
nameWithType: "SearchMetadata.total()"
summary: "Get the total property: The total number of search results."
syntax: "public Long total()"
desc: "Get the total property: The total number of search results."
returns:
description: "the total value."
type: "Long"
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.validate()"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.validate()"
name: "validate()"
nameWithType: "SearchMetadata.validate()"
summary: "Validates the instance."
syntax: "public void validate()"
desc: "Validates the instance."
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withAggregatedGroupingFields(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withAggregatedGroupingFields(String aggregatedGroupingFields)"
name: "withAggregatedGroupingFields(String aggregatedGroupingFields)"
nameWithType: "SearchMetadata.withAggregatedGroupingFields(String aggregatedGroupingFields)"
summary: "Set the aggregatedGroupingFields property: The aggregated grouping fields."
parameters:
- description: "the aggregatedGroupingFields value to set."
name: "aggregatedGroupingFields"
type: "String"
syntax: "public SearchMetadata withAggregatedGroupingFields(String aggregatedGroupingFields)"
desc: "Set the aggregatedGroupingFields property: The aggregated grouping fields."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withAggregatedValueField(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withAggregatedValueField(String aggregatedValueField)"
name: "withAggregatedValueField(String aggregatedValueField)"
nameWithType: "SearchMetadata.withAggregatedValueField(String aggregatedValueField)"
summary: "Set the aggregatedValueField property: The aggregated value field."
parameters:
- description: "the aggregatedValueField value to set."
name: "aggregatedValueField"
type: "String"
syntax: "public SearchMetadata withAggregatedValueField(String aggregatedValueField)"
desc: "Set the aggregatedValueField property: The aggregated value field."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withCoreSummaries(java.util.List)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withCoreSummaries(List coreSummaries)"
name: "withCoreSummaries(List coreSummaries)"
nameWithType: "SearchMetadata.withCoreSummaries(List coreSummaries)"
summary: "Set the coreSummaries property: The core summaries."
parameters:
- description: "the coreSummaries value to set."
name: "coreSummaries"
type: "List<>"
syntax: "public SearchMetadata withCoreSummaries(List coreSummaries)"
desc: "Set the coreSummaries property: The core summaries."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withEtag(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withEtag(String etag)"
name: "withEtag(String etag)"
nameWithType: "SearchMetadata.withEtag(String etag)"
summary: "Set the etag property: The ETag of the search results."
parameters:
- description: "the etag value to set."
name: "etag"
type: "String"
syntax: "public SearchMetadata withEtag(String etag)"
desc: "Set the etag property: The ETag of the search results."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withId(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withId(String id)"
name: "withId(String id)"
nameWithType: "SearchMetadata.withId(String id)"
summary: "Set the id property: The id of the search results request."
parameters:
- description: "the id value to set."
name: "id"
type: "String"
syntax: "public SearchMetadata withId(String id)"
desc: "Set the id property: The id of the search results request."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withLastUpdated(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withLastUpdated(OffsetDateTime lastUpdated)"
name: "withLastUpdated(OffsetDateTime lastUpdated)"
nameWithType: "SearchMetadata.withLastUpdated(OffsetDateTime lastUpdated)"
summary: "Set the lastUpdated property: The time of last update."
parameters:
- description: "the lastUpdated value to set."
name: "lastUpdated"
type: "OffsetDateTime"
syntax: "public SearchMetadata withLastUpdated(OffsetDateTime lastUpdated)"
desc: "Set the lastUpdated property: The time of last update."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withMax(java.lang.Long)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withMax(Long max)"
name: "withMax(Long max)"
nameWithType: "SearchMetadata.withMax(Long max)"
summary: "Set the max property: The max of all aggregates returned in the result set."
parameters:
- description: "the max value to set."
name: "max"
type: "Long"
syntax: "public SearchMetadata withMax(Long max)"
desc: "Set the max property: The max of all aggregates returned in the result set."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withRequestTime(java.lang.Long)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withRequestTime(Long requestTime)"
name: "withRequestTime(Long requestTime)"
nameWithType: "SearchMetadata.withRequestTime(Long requestTime)"
summary: "Set the requestTime property: The request time."
parameters:
- description: "the requestTime value to set."
name: "requestTime"
type: "Long"
syntax: "public SearchMetadata withRequestTime(Long requestTime)"
desc: "Set the requestTime property: The request time."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withResultType(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withResultType(String resultType)"
name: "withResultType(String resultType)"
nameWithType: "SearchMetadata.withResultType(String resultType)"
summary: "Set the resultType property: The search result type."
parameters:
- description: "the resultType value to set."
name: "resultType"
type: "String"
syntax: "public SearchMetadata withResultType(String resultType)"
desc: "Set the resultType property: The search result type."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSchema(com.azure.resourcemanager.loganalytics.models.SearchMetadataSchema)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSchema(SearchMetadataSchema schema)"
name: "withSchema(SearchMetadataSchema schema)"
nameWithType: "SearchMetadata.withSchema(SearchMetadataSchema schema)"
summary: "Set the schema property: The schema."
parameters:
- description: "the schema value to set."
name: "schema"
type: ""
syntax: "public SearchMetadata withSchema(SearchMetadataSchema schema)"
desc: "Set the schema property: The schema."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSearchId(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSearchId(String searchId)"
name: "withSearchId(String searchId)"
nameWithType: "SearchMetadata.withSearchId(String searchId)"
summary: "Set the searchId property: The request id of the search."
parameters:
- description: "the searchId value to set."
name: "searchId"
type: "String"
syntax: "public SearchMetadata withSearchId(String searchId)"
desc: "Set the searchId property: The request id of the search."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSort(java.util.List)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSort(List sort)"
name: "withSort(List sort)"
nameWithType: "SearchMetadata.withSort(List sort)"
summary: "Set the sort property: How the results are sorted."
parameters:
- description: "the sort value to set."
name: "sort"
type: "List<>"
syntax: "public SearchMetadata withSort(List sort)"
desc: "Set the sort property: How the results are sorted."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withStartTime(java.time.OffsetDateTime)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withStartTime(OffsetDateTime startTime)"
name: "withStartTime(OffsetDateTime startTime)"
nameWithType: "SearchMetadata.withStartTime(OffsetDateTime startTime)"
summary: "Set the startTime property: The start time for the search."
parameters:
- description: "the startTime value to set."
name: "startTime"
type: "OffsetDateTime"
syntax: "public SearchMetadata withStartTime(OffsetDateTime startTime)"
desc: "Set the startTime property: The start time for the search."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withStatus(java.lang.String)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withStatus(String status)"
name: "withStatus(String status)"
nameWithType: "SearchMetadata.withStatus(String status)"
summary: "Set the status property: The status of the search results."
parameters:
- description: "the status value to set."
name: "status"
type: "String"
syntax: "public SearchMetadata withStatus(String status)"
desc: "Set the status property: The status of the search results."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSum(java.lang.Long)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withSum(Long sum)"
name: "withSum(Long sum)"
nameWithType: "SearchMetadata.withSum(Long sum)"
summary: "Set the sum property: The sum of all aggregates returned in the result set."
parameters:
- description: "the sum value to set."
name: "sum"
type: "Long"
syntax: "public SearchMetadata withSum(Long sum)"
desc: "Set the sum property: The sum of all aggregates returned in the result set."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withTop(java.lang.Long)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withTop(Long top)"
name: "withTop(Long top)"
nameWithType: "SearchMetadata.withTop(Long top)"
summary: "Set the top property: The number of top search results."
parameters:
- description: "the top value to set."
name: "top"
type: "Long"
syntax: "public SearchMetadata withTop(Long top)"
desc: "Set the top property: The number of top search results."
returns:
description: "the SearchMetadata object itself."
type: ""
- uid: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withTotal(java.lang.Long)"
fullName: "com.azure.resourcemanager.loganalytics.models.SearchMetadata.withTotal(Long total)"
name: "withTotal(Long total)"
nameWithType: "SearchMetadata.withTotal(Long total)"
summary: "Set the total property: The total number of search results."
parameters:
- description: "the total value to set."
name: "total"
type: "Long"
syntax: "public SearchMetadata withTotal(Long total)"
desc: "Set the total property: The total number of search results."
returns:
description: "the SearchMetadata object itself."
type: ""
type: "class"
desc: "Metadata for search results."
metadata: {}
package: "com.azure.resourcemanager.loganalytics.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-loganalytics:1.0.0