Package com.oracle.bmc.loganalytics.model

Class QueryDetails

  • @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).

    • Constructor Detail

      • QueryDetails

        @Deprecated
@ConstructorProperties({"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)
        Deprecated.

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        Compartment Identifier [OCID] (https://docs.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
        Returns:
        the value

      • getCompartmentIdInSubtree

        public Boolean getCompartmentIdInSubtree()
        Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
        Returns:
        the value

      • getSavedSearchId

        public String getSavedSearchId()
        Saved search OCID for this query if known.
        Returns:
        the value

      • getQueryString

        public String getQueryString()
        Query to perform.

        Must conform to logging analytic querylanguage syntax. Syntax errors will be returned if present.

        Returns:
        the value

      • getSubSystem

        public SubSystemName getSubSystem()
        Default subsystem to qualify fields with in the queryString if not specified.
        Returns:
        the value

      • getMaxTotalCount

        public Integer getMaxTotalCount()
        Maximum number of results to count.

        Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).

        Returns:
        the value

      • getTimeFilter

        public TimeRange getTimeFilter()

      • getScopeFilters

        public List<ScopeFilter> getScopeFilters()
        List of filters to be applied when the query executes.

        More than one filter per field is not permitted.

        Returns:
        the value

      • getQueryTimeoutInSeconds

        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.

        Returns:
        the value

      • getShouldRunAsync

        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.

        Returns:
        the value

      • getAsyncMode

        public JobMode getAsyncMode()
        Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
        Returns:
        the value

      • getShouldIncludeTotalCount

        public Boolean getShouldIncludeTotalCount()
        Include the total number of results from the query.

        Note, this value will always be equal to or less than maxTotalCount.

        Returns:
        the value

      • getShouldIncludeColumns

        public Boolean getShouldIncludeColumns()
        Include columns in response
        Returns:
        the value

      • getShouldIncludeFields

        public Boolean getShouldIncludeFields()
        Include fields in response
        Returns:
        the value

      • getShouldUseAcceleration

        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.

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel