172 строки
13 KiB
YAML
172 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.monitor.query.models.LogsQueryOptions"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions"
|
|
name: "LogsQueryOptions"
|
|
nameWithType: "LogsQueryOptions"
|
|
summary: "The options type to configure the logs query"
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **LogsQueryOptions**"
|
|
constructors:
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.LogsQueryOptions()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.LogsQueryOptions()"
|
|
name: "LogsQueryOptions()"
|
|
nameWithType: "LogsQueryOptions.LogsQueryOptions()"
|
|
summary: "Creates an instance of Logs<wbr>Query<wbr>Options."
|
|
syntax: "public LogsQueryOptions()"
|
|
desc: "Creates an instance of LogsQueryOptions."
|
|
methods:
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.getAdditionalWorkspaces()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.getAdditionalWorkspaces()"
|
|
name: "getAdditionalWorkspaces()"
|
|
nameWithType: "LogsQueryOptions.getAdditionalWorkspaces()"
|
|
summary: "Returns the list of additional workspaces on which this query is executed."
|
|
syntax: "public List<String> getAdditionalWorkspaces()"
|
|
desc: "Returns the list of additional workspaces on which this query is executed. The list can contain any of the following workspace identifiers:\n\n * Workspace Name - human-readable string `` of the OMS workspace\n * Qualified Name - string with format `//`\n * Workspace ID - GUID string\n * Azure Resource ID - string with format `/subscriptions//resourceGroups//providers/microsoft .operationalinsights/workspaces/`"
|
|
returns:
|
|
description: "the list of additional workspaces on which this query is executed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.getServerTimeout()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.getServerTimeout()"
|
|
name: "getServerTimeout()"
|
|
nameWithType: "LogsQueryOptions.getServerTimeout()"
|
|
summary: "Returns the server timeout for this query."
|
|
syntax: "public Duration getServerTimeout()"
|
|
desc: "Returns the server timeout for this query."
|
|
returns:
|
|
description: "The server timeout duration."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.isAllowPartialErrors()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.isAllowPartialErrors()"
|
|
name: "isAllowPartialErrors()"
|
|
nameWithType: "LogsQueryOptions.isAllowPartialErrors()"
|
|
summary: "If a query has partial errors, the result is returned instead of throwing an exception if this is set to true."
|
|
syntax: "public boolean isAllowPartialErrors()"
|
|
desc: "If a query has partial errors, the result is returned instead of throwing an exception if this is set to true. The partial error information is available as part of the query result."
|
|
returns:
|
|
description: "Returns true if partial errors should not throw exception."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.isIncludeStatistics()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.isIncludeStatistics()"
|
|
name: "isIncludeStatistics()"
|
|
nameWithType: "LogsQueryOptions.isIncludeStatistics()"
|
|
summary: "Returns the flag that indicates if the query should include statistics."
|
|
syntax: "public boolean isIncludeStatistics()"
|
|
desc: "Returns the flag that indicates if the query should include statistics."
|
|
returns:
|
|
description: "the flag that indicates if the query should include statistics."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.isIncludeVisualization()"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.isIncludeVisualization()"
|
|
name: "isIncludeVisualization()"
|
|
nameWithType: "LogsQueryOptions.isIncludeVisualization()"
|
|
summary: "Returns the flag that indicates if the query should return visualization details."
|
|
syntax: "public boolean isIncludeVisualization()"
|
|
desc: "Returns the flag that indicates if the query should return visualization details."
|
|
returns:
|
|
description: "The flag that indicates if the query should return visualization details."
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setAdditionalWorkspaces(java.lang.String...)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setAdditionalWorkspaces(String[] additionalWorkspaces)"
|
|
name: "setAdditionalWorkspaces(String[] additionalWorkspaces)"
|
|
nameWithType: "LogsQueryOptions.setAdditionalWorkspaces(String[] additionalWorkspaces)"
|
|
summary: "Sets the list of additional workspaces on which this query is executed."
|
|
parameters:
|
|
- description: "additional workspaces on which this query is executed."
|
|
name: "additionalWorkspaces"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>[]"
|
|
syntax: "public LogsQueryOptions setAdditionalWorkspaces(String[] additionalWorkspaces)"
|
|
desc: "Sets the list of additional workspaces on which this query is executed. The list can contain any of the following workspace identifiers:\n\n * Workspace Name - human-readable string `` of the OMS workspace\n * Qualified Name - string with format `//`\n * Workspace ID - GUID string\n * Azure Resource ID - string with format `/subscriptions//resourceGroups//providers/microsoft .operationalinsights/workspaces/`"
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setAdditionalWorkspaces(java.util.List<java.lang.String>)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setAdditionalWorkspaces(List<String> additionalWorkspaces)"
|
|
name: "setAdditionalWorkspaces(List<String> additionalWorkspaces)"
|
|
nameWithType: "LogsQueryOptions.setAdditionalWorkspaces(List<String> additionalWorkspaces)"
|
|
summary: "Sets the list of additional workspaces on which this query is executed."
|
|
parameters:
|
|
- description: "the list of additional workspaces on which this query is executed."
|
|
name: "additionalWorkspaces"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>>"
|
|
syntax: "public LogsQueryOptions setAdditionalWorkspaces(List<String> additionalWorkspaces)"
|
|
desc: "Sets the list of additional workspaces on which this query is executed. The list can contain any of the following workspace identifiers:\n\n * Workspace Name - human-readable string `` of the OMS workspace\n * Qualified Name - string with format `//`\n * Workspace ID - GUID string\n * Azure Resource ID - string with format `/subscriptions//resourceGroups//providers/microsoft .operationalinsights/workspaces/`"
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setAllowPartialErrors(boolean)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setAllowPartialErrors(boolean allowPartialErrors)"
|
|
name: "setAllowPartialErrors(boolean allowPartialErrors)"
|
|
nameWithType: "LogsQueryOptions.setAllowPartialErrors(boolean allowPartialErrors)"
|
|
summary: "If set to `true`, exception is not thrown if query returns partial errors."
|
|
parameters:
|
|
- description: "set this to <code>true</code> to not throw exception if a query returns partial errors."
|
|
name: "allowPartialErrors"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LogsQueryOptions setAllowPartialErrors(boolean allowPartialErrors)"
|
|
desc: "If set to `true`, exception is not thrown if query returns partial errors. The partial error information is available as part of the query result."
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setIncludeStatistics(boolean)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setIncludeStatistics(boolean includeStatistics)"
|
|
name: "setIncludeStatistics(boolean includeStatistics)"
|
|
nameWithType: "LogsQueryOptions.setIncludeStatistics(boolean includeStatistics)"
|
|
summary: "Sets the flag that indicates if the query should include statistics."
|
|
parameters:
|
|
- description: "the flag that indicates if the query should include statistics."
|
|
name: "includeStatistics"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LogsQueryOptions setIncludeStatistics(boolean includeStatistics)"
|
|
desc: "Sets the flag that indicates if the query should include statistics."
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setIncludeVisualization(boolean)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setIncludeVisualization(boolean includeVisualization)"
|
|
name: "setIncludeVisualization(boolean includeVisualization)"
|
|
nameWithType: "LogsQueryOptions.setIncludeVisualization(boolean includeVisualization)"
|
|
summary: "Sets the flag that indicates if the query should return visualization details."
|
|
parameters:
|
|
- description: "The flag that indicates if the query should return visualization details."
|
|
name: "includeVisualization"
|
|
type: "<xref href=\"boolean?alt=boolean&text=boolean\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public LogsQueryOptions setIncludeVisualization(boolean includeVisualization)"
|
|
desc: "Sets the flag that indicates if the query should return visualization details."
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.monitor.query.models.LogsQueryOptions.setServerTimeout(java.time.Duration)"
|
|
fullName: "com.azure.monitor.query.models.LogsQueryOptions.setServerTimeout(Duration serverTimeout)"
|
|
name: "setServerTimeout(Duration serverTimeout)"
|
|
nameWithType: "LogsQueryOptions.setServerTimeout(Duration serverTimeout)"
|
|
summary: "Sets the server timeout for this query."
|
|
parameters:
|
|
- description: "The server timeout duration."
|
|
name: "serverTimeout"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html\">Duration</a>"
|
|
syntax: "public LogsQueryOptions setServerTimeout(Duration serverTimeout)"
|
|
desc: "Sets the server timeout for this query."
|
|
returns:
|
|
description: "The updated options instance."
|
|
type: "<xref href=\"com.azure.monitor.query.models.LogsQueryOptions?alt=com.azure.monitor.query.models.LogsQueryOptions&text=LogsQueryOptions\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "The options type to configure the logs query"
|
|
metadata: {}
|
|
package: "com.azure.monitor.query.models"
|
|
artifact: com.azure:azure-monitor-query:1.5.1
|