class Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query
Attributes
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`). Corresponds to the JSON property `csvDelimiter` @return [String]
A list of dimensions. docs.apigee.com/api-platform/analytics/analytics- reference#dimensions Corresponds to the JSON property `dimensions` @return [Array<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. Corresponds to the JSON property `envgroupHostname` @return [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. docs.apigee.com/api-platform/analytics/asynch-reports-api#filter- expression-syntax Corresponds to the JSON property `filter` @return [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. Corresponds to the JSON property `groupByTimeUnit` @return [String]
Maximum number of rows that can be returned in the result. Corresponds to the JSON property `limit` @return [Fixnum]
A list of Metrics. Corresponds to the JSON property `metrics` @return [Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetric>]
Asynchronous Query Name. Corresponds to the JSON property `name` @return [String]
Valid values include: `csv` or `json`. Defaults to `json`. Note: Configure the delimiter for CSV output using the csvDelimiter property. Corresponds to the JSON property `outputFormat` @return [String]
Asynchronous Report ID. Corresponds to the JSON property `reportDefinitionId` @return [String]
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” ` Corresponds to the JSON property `timeRange` @return [Object]
Public Class Methods
# File lib/google/apis/apigee_v1/classes.rb, line 5416 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/apigee_v1/classes.rb, line 5421 def update!(**args) @csv_delimiter = args[:csv_delimiter] if args.key?(:csv_delimiter) @dimensions = args[:dimensions] if args.key?(:dimensions) @envgroup_hostname = args[:envgroup_hostname] if args.key?(:envgroup_hostname) @filter = args[:filter] if args.key?(:filter) @group_by_time_unit = args[:group_by_time_unit] if args.key?(:group_by_time_unit) @limit = args[:limit] if args.key?(:limit) @metrics = args[:metrics] if args.key?(:metrics) @name = args[:name] if args.key?(:name) @output_format = args[:output_format] if args.key?(:output_format) @report_definition_id = args[:report_definition_id] if args.key?(:report_definition_id) @time_range = args[:time_range] if args.key?(:time_range) end