QueryDetails.Builder (Oracle Cloud Infrastructure Java SDK

java.lang.Object
- com.oracle.bmc.loganalytics.model.QueryDetails.Builder

Enclosing class:: QueryDetails

public static class QueryDetails.Builder
extends Object

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`QueryDetails.Builder`	`asyncMode(JobMode asyncMode)` Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
`QueryDetails`	`build()`
`QueryDetails.Builder`	`compartmentId(String compartmentId)` Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
`QueryDetails.Builder`	`compartmentIdInSubtree(Boolean compartmentIdInSubtree)` Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
`QueryDetails.Builder`	`copy(QueryDetails model)`
`QueryDetails.Builder`	`maxTotalCount(Integer maxTotalCount)` Maximum number of results to count.
`QueryDetails.Builder`	`queryString(String queryString)` Query to perform.
`QueryDetails.Builder`	`queryTimeoutInSeconds(Integer queryTimeoutInSeconds)` Amount of time, in seconds, allowed for a query to execute.
`QueryDetails.Builder`	`savedSearchId(String savedSearchId)` Saved search OCID for this query if known.
`QueryDetails.Builder`	`scopeFilters(List<ScopeFilter> scopeFilters)` List of filters to be applied when the query executes.
`QueryDetails.Builder`	`shouldIncludeColumns(Boolean shouldIncludeColumns)` Include columns in response
`QueryDetails.Builder`	`shouldIncludeFields(Boolean shouldIncludeFields)` Include fields in response
`QueryDetails.Builder`	`shouldIncludeTotalCount(Boolean shouldIncludeTotalCount)` Include the total number of results from the query.
`QueryDetails.Builder`	`shouldRunAsync(Boolean shouldRunAsync)` Option to run the query asynchronously.
`QueryDetails.Builder`	`shouldUseAcceleration(Boolean shouldUseAcceleration)` Controls if query should ignore pre-calculated results if available and only use raw data.
`QueryDetails.Builder`	`subSystem(SubSystemName subSystem)` Default subsystem to qualify fields with in the queryString if not specified.
`QueryDetails.Builder`	`timeFilter(TimeRange timeFilter)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - compartmentId
```
public QueryDetails.Builder compartmentId(String compartmentId)
```
    Compartment Identifier [OCID] (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
    
    Parameters:
    
    compartmentId - the value to set
    
    Returns:
    
    this builder
  - compartmentIdInSubtree
```
public QueryDetails.Builder compartmentIdInSubtree(Boolean compartmentIdInSubtree)
```
    Flag to search all child compartments of the compartment Id specified in the compartmentId query parameter.
    
    Parameters:
    
    compartmentIdInSubtree - the value to set
    
    Returns:
    
    this builder
  - savedSearchId
```
public QueryDetails.Builder savedSearchId(String savedSearchId)
```
    Saved search OCID for this query if known.
    
    Parameters:
    
    savedSearchId - the value to set
    
    Returns:
    
    this builder
  - queryString
```
public QueryDetails.Builder queryString(String queryString)
```
    Query to perform. Must conform to logging analytic querylanguage syntax. Syntax errors will be returned if present.
    
    Parameters:
    
    queryString - the value to set
    
    Returns:
    
    this builder
  - subSystem
```
public QueryDetails.Builder subSystem(SubSystemName subSystem)
```
    Default subsystem to qualify fields with in the queryString if not specified.
    
    Parameters:
    
    subSystem - the value to set
    
    Returns:
    
    this builder
  - maxTotalCount
```
public QueryDetails.Builder maxTotalCount(Integer maxTotalCount)
```
    Maximum number of results to count. Note a maximum of 2001 will be enforced; that is, actualMaxTotalCountUsed = Math.min(maxTotalCount, 2001).
    
    Parameters:
    
    maxTotalCount - the value to set
    
    Returns:
    
    this builder
  - timeFilter
```
public QueryDetails.Builder timeFilter(TimeRange timeFilter)
```
  - scopeFilters
```
public QueryDetails.Builder scopeFilters(List<ScopeFilter> scopeFilters)
```
    List of filters to be applied when the query executes. More than one filter per field is not permitted.
    
    Parameters:
    
    scopeFilters - the value to set
    
    Returns:
    
    this builder
  - queryTimeoutInSeconds
```
public QueryDetails.Builder queryTimeoutInSeconds(Integer queryTimeoutInSeconds)
```
    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.
    
    Parameters:
    
    queryTimeoutInSeconds - the value to set
    
    Returns:
    
    this builder
  - shouldRunAsync
```
public QueryDetails.Builder shouldRunAsync(Boolean shouldRunAsync)
```
    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.
    
    Parameters:
    
    shouldRunAsync - the value to set
    
    Returns:
    
    this builder
  - asyncMode
```
public QueryDetails.Builder asyncMode(JobMode asyncMode)
```
    Execution mode for the query if running asynchronously i.e (shouldRunAsync is set to true).
    
    Parameters:
    
    asyncMode - the value to set
    
    Returns:
    
    this builder
  - shouldIncludeTotalCount
```
public QueryDetails.Builder shouldIncludeTotalCount(Boolean shouldIncludeTotalCount)
```
    Include the total number of results from the query. Note, this value will always be equal to or less than maxTotalCount.
    
    Parameters:
    
    shouldIncludeTotalCount - the value to set
    
    Returns:
    
    this builder
  - shouldIncludeColumns
```
public QueryDetails.Builder shouldIncludeColumns(Boolean shouldIncludeColumns)
```
    Include columns in response
    
    Parameters:
    
    shouldIncludeColumns - the value to set
    
    Returns:
    
    this builder
  - shouldIncludeFields
```
public QueryDetails.Builder shouldIncludeFields(Boolean shouldIncludeFields)
```
    Include fields in response
    
    Parameters:
    
    shouldIncludeFields - the value to set
    
    Returns:
    
    this builder
  - shouldUseAcceleration
```
public QueryDetails.Builder shouldUseAcceleration(Boolean shouldUseAcceleration)
```
    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.
    
    Parameters:
    
    shouldUseAcceleration - the value to set
    
    Returns:
    
    this builder
  - build
```
public QueryDetails build()
```
  - copy
```
public QueryDetails.Builder copy(QueryDetails model)
```

Class QueryDetails.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

compartmentId

compartmentIdInSubtree

savedSearchId

queryString

subSystem

maxTotalCount

timeFilter

scopeFilters

queryTimeoutInSeconds

shouldRunAsync

asyncMode

shouldIncludeTotalCount

shouldIncludeColumns

shouldIncludeFields

shouldUseAcceleration

build

copy