@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ExportDetails.Builder |
static class |
ExportDetails.OutputFormat
Specifies the format for the returned results.
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ExportDetails(String compartmentId,
Boolean compartmentIdInSubtree,
String queryString,
SubSystemName subSystem,
List<ScopeFilter> scopeFilters,
Integer maxTotalCount,
TimeRange timeFilter,
Integer queryTimeoutInSeconds,
Boolean shouldIncludeColumns,
ExportDetails.OutputFormat outputFormat,
Boolean shouldLocalize,
Boolean shouldUseAcceleration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ExportDetails.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
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 retrieved from data source is determined by the specific query used
and the maxTotalCount input field.
|
ExportDetails.OutputFormat |
getOutputFormat()
Specifies the format for the returned results.
|
String |
getQueryString()
Query to perform.
|
Integer |
getQueryTimeoutInSeconds()
Amount of time, in seconds, allowed for a query to execute.
|
List<ScopeFilter> |
getScopeFilters()
List of filters to be applied when the query executes.
|
Boolean |
getShouldIncludeColumns()
Include columns in response
|
Boolean |
getShouldLocalize()
Localize results, including header columns, List-Of-Values and timestamp values.
|
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() |
ExportDetails.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"compartmentId","compartmentIdInSubtree","queryString","subSystem","scopeFilters","maxTotalCount","timeFilter","queryTimeoutInSeconds","shouldIncludeColumns","outputFormat","shouldLocalize","shouldUseAcceleration"}) public ExportDetails(String compartmentId, Boolean compartmentIdInSubtree, String queryString, SubSystemName subSystem, List<ScopeFilter> scopeFilters, Integer maxTotalCount, TimeRange timeFilter, Integer queryTimeoutInSeconds, Boolean shouldIncludeColumns, ExportDetails.OutputFormat outputFormat, Boolean shouldLocalize, Boolean shouldUseAcceleration)
public static ExportDetails.Builder builder()
Create a new builder.
public ExportDetails.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 getQueryString()
Query to perform.
public SubSystemName getSubSystem()
Default subsystem to qualify fields with in the queryString if not specified.
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 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.
public TimeRange getTimeFilter()
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 getShouldIncludeColumns()
Include columns in response
public ExportDetails.OutputFormat getOutputFormat()
Specifies the format for the returned results.
public Boolean getShouldLocalize()
Localize results, including header columns, List-Of-Values and timestamp values.
public Boolean getShouldUseAcceleration()
Controls if query should ignore pre-calculated results if available and only use 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.