Package com.oracle.bmc.loganalytics.model

Class ExportDetails

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public final class ExportDetails
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Input arguments for running a query synchronosly and streaming the results as soon as they become available.
    Note: Objects should always be created or deserialized using the ExportDetails.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 ExportDetails.Builder, which maintain a set of all explicitly set fields called ExportDetails.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).

    • 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

      • getQueryString

        public String getQueryString()
        Query to perform.
        Returns:
        the value

      • getSubSystem

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

      • 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

      • getMaxTotalCount

        public Integer getMaxTotalCount()
        Maximum number of results retrieved from data source is determined by the specific query used and the maxTotalCount input field.

        If the export results can be streamed, the maximum will be 1,000,000. If the results cannot be streamed, the maximum limit is 500 for queries that include the link command and 10,000 for the queries that do not include the link command.

        Queries that include certain commands such as head, tail or stats cannot be streamed and are subject to a maximum of 10,000 results. Queries that include the sort command cannot be streamed unless the sort fields are restricted to id and/or time. The maximum number of results retrieved is the lesser of the maxTotalCount input provided and the applicable limit described above.

        Returns:
        the value

      • getTimeFilter

        public TimeRange getTimeFilter()

      • 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

      • getShouldIncludeColumns

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

      • getOutputFormat

        public ExportDetails.OutputFormat getOutputFormat()
        Specifies the format for the returned results.
        Returns:
        the value

      • getShouldLocalize

        public Boolean getShouldLocalize()
        Localize results, including header columns, List-Of-Values and timestamp values.
        Returns:
        the value

      • getShouldUseAcceleration

        public Boolean getShouldUseAcceleration()
        Controls if query should ignore pre-calculated results if available and only use 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