GoogleCloudApigeeV1Query (Apigee API v1-rev20251125-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.apigee.v1.model.GoogleCloudApigeeV1Query

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudApigeeV1Query
extends com.google.api.client.json.GenericJson
```
Model definition for GoogleCloudApigeeV1Query.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Apigee API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudApigeeV1Query()

Constructors
Constructor and Description
`GoogleCloudApigeeV1Query()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudApigeeV1Query`	`clone()`
`String`	`getCsvDelimiter()` Delimiter used in the CSV file, if `outputFormat` is set to `csv`.
`List<String>`	`getDimensions()` A list of dimensions.
`String`	`getEnvgroupHostname()` Hostname needs to be specified if query intends to run at host level.
`String`	`getFilter()` Boolean expression that can be used to filter data.
`String`	`getGroupByTimeUnit()` Time unit used to group the result set.
`Integer`	`getLimit()` Maximum number of rows that can be returned in the result.
`List<GoogleCloudApigeeV1QueryMetric>`	`getMetrics()` A list of Metrics.
`String`	`getName()` Asynchronous Query Name.
`String`	`getOutputFormat()` Valid values include: `csv` or `json`.
`String`	`getReportDefinitionId()` Asynchronous Report ID.
`Object`	`getTimeRange()` Required.
`GoogleCloudApigeeV1Query`	`set(String fieldName, Object value)`
`GoogleCloudApigeeV1Query`	`setCsvDelimiter(String csvDelimiter)` Delimiter used in the CSV file, if `outputFormat` is set to `csv`.
`GoogleCloudApigeeV1Query`	`setDimensions(List<String> dimensions)` A list of dimensions.
`GoogleCloudApigeeV1Query`	`setEnvgroupHostname(String envgroupHostname)` Hostname needs to be specified if query intends to run at host level.
`GoogleCloudApigeeV1Query`	`setFilter(String filter)` Boolean expression that can be used to filter data.
`GoogleCloudApigeeV1Query`	`setGroupByTimeUnit(String groupByTimeUnit)` Time unit used to group the result set.
`GoogleCloudApigeeV1Query`	`setLimit(Integer limit)` Maximum number of rows that can be returned in the result.
`GoogleCloudApigeeV1Query`	`setMetrics(List<GoogleCloudApigeeV1QueryMetric> metrics)` A list of Metrics.
`GoogleCloudApigeeV1Query`	`setName(String name)` Asynchronous Query Name.
`GoogleCloudApigeeV1Query`	`setOutputFormat(String outputFormat)` Valid values include: `csv` or `json`.
`GoogleCloudApigeeV1Query`	`setReportDefinitionId(String reportDefinitionId)` Asynchronous Report ID.
`GoogleCloudApigeeV1Query`	`setTimeRange(Object timeRange)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudApigeeV1Query
```
public GoogleCloudApigeeV1Query()
```
- Method Detail
  - getCsvDelimiter
```
public String getCsvDelimiter()
```
    Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`).
    
    Returns:
    
    value or null for none
  - setCsvDelimiter
```
public GoogleCloudApigeeV1Query setCsvDelimiter(String csvDelimiter)
```
    Delimiter used in the CSV file, if `outputFormat` is set to `csv`. Defaults to the `,` (comma) character. Supported delimiter characters include comma (`,`), pipe (`|`), and tab (`\t`).
    
    Parameters:
    
    csvDelimiter - csvDelimiter or null for none
  - getDimensions
```
public List<String> getDimensions()
```
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics- reference#dimensions
    
    Returns:
    
    value or null for none
  - setDimensions
```
public GoogleCloudApigeeV1Query setDimensions(List<String> dimensions)
```
    A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics- reference#dimensions
    
    Parameters:
    
    dimensions - dimensions or null for none
  - getEnvgroupHostname
```
public String getEnvgroupHostname()
```
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    
    Returns:
    
    value or null for none
  - setEnvgroupHostname
```
public GoogleCloudApigeeV1Query setEnvgroupHostname(String envgroupHostname)
```
    Hostname needs to be specified if query intends to run at host level. This field is only allowed when query is submitted by CreateHostAsyncQuery where analytics data will be grouped by organization and hostname.
    
    Parameters:
    
    envgroupHostname - envgroupHostname or null for none
  - getFilter
```
public String getFilter()
```
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics- reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    
    Returns:
    
    value or null for none
  - setFilter
```
public GoogleCloudApigeeV1Query setFilter(String filter)
```
    Boolean expression that can be used to filter data. Filter expressions can be combined using AND/OR terms and should be fully parenthesized to avoid ambiguity. See Analytics metrics, dimensions, and filters reference https://docs.apigee.com/api-platform/analytics/analytics- reference for more information on the fields available to filter on. For more information on the tokens that you use to build filter expressions, see Filter expression syntax. https://docs.apigee.com/api-platform/analytics/asynch-reports-api#filter-expression-syntax
    
    Parameters:
    
    filter - filter or null for none
  - getGroupByTimeUnit
```
public String getGroupByTimeUnit()
```
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    
    Returns:
    
    value or null for none
  - setGroupByTimeUnit
```
public GoogleCloudApigeeV1Query setGroupByTimeUnit(String groupByTimeUnit)
```
    Time unit used to group the result set. Valid values include: second, minute, hour, day, week, or month. If a query includes groupByTimeUnit, then the result is an aggregation based on the specified time unit and the resultant timestamp does not include milliseconds precision. If a query omits groupByTimeUnit, then the resultant timestamp includes milliseconds precision.
    
    Parameters:
    
    groupByTimeUnit - groupByTimeUnit or null for none
  - getLimit
```
public Integer getLimit()
```
    Maximum number of rows that can be returned in the result.
    
    Returns:
    
    value or null for none
  - setLimit
```
public GoogleCloudApigeeV1Query setLimit(Integer limit)
```
    Maximum number of rows that can be returned in the result.
    
    Parameters:
    
    limit - limit or null for none
  - getMetrics
```
public List<GoogleCloudApigeeV1QueryMetric> getMetrics()
```
    A list of Metrics.
    
    Returns:
    
    value or null for none
  - setMetrics
```
public GoogleCloudApigeeV1Query setMetrics(List<GoogleCloudApigeeV1QueryMetric> metrics)
```
    A list of Metrics.
    
    Parameters:
    
    metrics - metrics or null for none
  - getName
```
public String getName()
```
    Asynchronous Query Name.
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudApigeeV1Query setName(String name)
```
    Asynchronous Query Name.
    
    Parameters:
    
    name - name or null for none
  - getOutputFormat
```
public String getOutputFormat()
```
    Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    
    Returns:
    
    value or null for none
  - setOutputFormat
```
public GoogleCloudApigeeV1Query setOutputFormat(String outputFormat)
```
    Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property.
    
    Parameters:
    
    outputFormat - outputFormat or null for none
  - getReportDefinitionId
```
public String getReportDefinitionId()
```
    Asynchronous Report ID.
    
    Returns:
    
    value or null for none
  - setReportDefinitionId
```
public GoogleCloudApigeeV1Query setReportDefinitionId(String reportDefinitionId)
```
    Asynchronous Report ID.
    
    Parameters:
    
    reportDefinitionId - reportDefinitionId or null for none
  - getTimeRange
```
public Object getTimeRange()
```
    Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    
    Returns:
    
    value or null for none
  - setTimeRange
```
public GoogleCloudApigeeV1Query setTimeRange(Object timeRange)
```
    Required. Time range for the query. Can use the following predefined strings to specify the time range: `last60minutes` `last24hours` `last7days` Or, specify the timeRange as a structure describing start and end timestamps in the ISO format: yyyy-mm-ddThh:mm:ssZ. Example: "timeRange": { "start": "2018-07-29T00:13:00Z", "end": "2018-08-01T00:18:00Z" }
    
    Parameters:
    
    timeRange - timeRange or null for none
  - set
```
public GoogleCloudApigeeV1Query set(String fieldName,
                                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudApigeeV1Query clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudApigeeV1Query

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudApigeeV1Query

Method Detail

getCsvDelimiter

setCsvDelimiter

getDimensions

setDimensions

getEnvgroupHostname

setEnvgroupHostname

getFilter

setFilter

getGroupByTimeUnit

setGroupByTimeUnit

getLimit

setLimit

getMetrics

setMetrics

getName

setName

getOutputFormat

setOutputFormat

getReportDefinitionId

setReportDefinitionId

getTimeRange

setTimeRange

set

clone