@Generated(value="OracleSDKGenerator",
comments="API Version: 20200601")
public final class QueryDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
Input arguments for running a log anlaytics query. If the request is set to run in asynchronous
mode then shouldIncludeColumns and shouldIncludeFields can be overwritten when retrieving the
results.
Note: Objects should always be created or deserialized using the QueryDetails.Builder. This model
distinguishes fields that are null because they are unset from fields that are explicitly
set to null. This is done in the setter methods of the QueryDetails.Builder, which maintain a
set of all explicitly set fields called QueryDetails.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set
fields into account. The constructor, on the other hand, does not take the explicitly set fields
into account (since the constructor cannot distinguish explicit null from unset null).
| Modifier and Type | Class and Description |
|---|---|
static class |
QueryDetails.Builder |
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
QueryDetails(String compartmentId,
Boolean compartmentIdInSubtree,
String savedSearchId,
String queryString,
SubSystemName subSystem,
Integer maxTotalCount,
TimeRange timeFilter,
List<ScopeFilter> scopeFilters,
Integer queryTimeoutInSeconds,
Boolean shouldRunAsync,
JobMode asyncMode,
Boolean shouldIncludeTotalCount,
Boolean shouldIncludeColumns,
Boolean shouldIncludeFields,
Boolean shouldUseAcceleration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static QueryDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
JobMode |
getAsyncMode()
Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
|
String |
getCompartmentId()
Compartment Identifier [OCID]
(https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
|
Boolean |
getCompartmentIdInSubtree()
Flag to search all child compartments of the compartment Id specified in the compartmentId
query parameter.
|
Integer |
getMaxTotalCount()
Maximum number of results to count.
|
String |
getQueryString()
Query to perform.
|
Integer |
getQueryTimeoutInSeconds()
Amount of time, in seconds, allowed for a query to execute.
|
String |
getSavedSearchId()
Saved search OCID for this query if known.
|
List<ScopeFilter> |
getScopeFilters()
List of filters to be applied when the query executes.
|
Boolean |
getShouldIncludeColumns()
Include columns in response
|
Boolean |
getShouldIncludeFields()
Include fields in response
|
Boolean |
getShouldIncludeTotalCount()
Include the total number of results from the query.
|
Boolean |
getShouldRunAsync()
Option to run the query asynchronously.
|
Boolean |
getShouldUseAcceleration()
Controls if query should ignore pre-calculated results if available and only use raw data.
|
SubSystemName |
getSubSystem()
Default subsystem to qualify fields with in the queryString if not specified.
|
TimeRange |
getTimeFilter() |
int |
hashCode() |
QueryDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","compartmentIdInSubtree","savedSearchId","queryString","subSystem","maxTotalCount","timeFilter","scopeFilters","queryTimeoutInSeconds","shouldRunAsync","asyncMode","shouldIncludeTotalCount","shouldIncludeColumns","shouldIncludeFields","shouldUseAcceleration"}) public QueryDetails(String compartmentId, Boolean compartmentIdInSubtree, String savedSearchId, String queryString, SubSystemName subSystem, Integer maxTotalCount, TimeRange timeFilter, List<ScopeFilter> scopeFilters, Integer queryTimeoutInSeconds, Boolean shouldRunAsync, JobMode asyncMode, Boolean shouldIncludeTotalCount, Boolean shouldIncludeColumns, Boolean shouldIncludeFields, Boolean shouldUseAcceleration)
public static QueryDetails.Builder builder()
Create a new builder.
public QueryDetails.Builder toBuilder()
public String getCompartmentId()
Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
public Boolean getCompartmentIdInSubtree()
Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
public String getSavedSearchId()
Saved search OCID for this query if known.
public String getQueryString()
Query to perform. Must conform to logging analytic querylanguage syntax. Syntax errors will be returned if present.
public SubSystemName getSubSystem()
Default subsystem to qualify fields with in the queryString if not specified.
public Integer getMaxTotalCount()
Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).
public TimeRange getTimeFilter()
public List<ScopeFilter> getScopeFilters()
List of filters to be applied when the query executes. More than one filter per field is not permitted.
public Integer getQueryTimeoutInSeconds()
Amount of time, in seconds, allowed for a query to execute. If this time expires before the query is complete, any partial results will be returned.
public Boolean getShouldRunAsync()
Option to run the query asynchronously. This will lead to a LogAnalyticsQueryJobWorkRequest being submitted and the {workRequestId} will be returned to use for fetching the results.
public JobMode getAsyncMode()
Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
public Boolean getShouldIncludeTotalCount()
Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.
public Boolean getShouldIncludeColumns()
Include columns in response
public Boolean getShouldIncludeFields()
Include fields in response
public Boolean getShouldUseAcceleration()
Controls if query should ignore pre-calculated results if available and only use raw data. If set and no acceleration data is found it will fallback to raw data.
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.