HostQueryArgs class

The set of arguments for HostQuery. The set of arguments for HostQuery.

Constructors

HostQueryArgs({Input<String>? csvDelimiter, Input<List<String>>? dimensions, Input<String>? envgroupHostname, Input<String>? filter, Input<String>? groupByTimeUnit, Input<int>? limit, Input<List<GoogleCloudApigeeV1QueryMetric>>? metrics, Input<String>? name, required Input<String> organizationId, Input<String>? outputFormat, Input<String>? reportDefinitionId, required Input timeRange})
Creates a new HostQueryArgs. 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). dimensions A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions 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. 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 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. limit Maximum number of rows that can be returned in the result. metrics A list of Metrics. name Asynchronous Query Name. organizationId Required. outputFormat Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property. reportDefinitionId Asynchronous Report ID. timeRange 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" }
const
HostQueryArgs.fromMap(Map<String, dynamic> map)
factory

Properties

csvDelimiter → Input<String>?
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).
final
dimensions → Input<List<String>>?
A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics-reference#dimensions
final
envgroupHostname → Input<String>?
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.
final
filter → Input<String>?
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
final
groupByTimeUnit → Input<String>?
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.
final
hashCode → int
The hash code for this object.
no setterinherited
limit → Input<int>?
Maximum number of rows that can be returned in the result.
final
metrics → Input<List<GoogleCloudApigeeV1QueryMetric>>?
A list of Metrics.
final
name → Input<String>?
Asynchronous Query Name.
final
organizationId → Input<String>
final
outputFormat → Input<String>?
Valid values include: csv or json. Defaults to json. Note: Configure the delimiter for CSV output using the csvDelimiter property.
final
reportDefinitionId → Input<String>?
Asynchronous Report ID.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timeRange → Input
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" }
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited