Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1Query

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/apigee_v1/classes.rb,
lib/google/apis/apigee_v1/representations.rb,
lib/google/apis/apigee_v1/representations.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1Query

Returns a new instance of GoogleCloudApigeeV1Query.



6307
6308
6309
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6307

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#csv_delimiter ⇒ 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). Corresponds to the JSON property csvDelimiter

Returns:

  • (String) 


6236
6237
6238
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6236

def csv_delimiter
  @csv_delimiter
end

#dimensions ⇒ Array<String>

A list of dimensions. https://docs.apigee.com/api-platform/analytics/analytics- reference#dimensions Corresponds to the JSON property dimensions

Returns:

  • (Array<String>) 


6242
6243
6244
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6242

def dimensions
  @dimensions
end

#envgroup_hostname ⇒ 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

Returns:

  • (String) 


6249
6250
6251
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6249

def envgroup_hostname
  @envgroup_hostname
end

#filter ⇒ 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 Corresponds to the JSON property filter

Returns:

  • (String) 


6261
6262
6263
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6261

def filter
  @filter
end

#group_by_time_unit ⇒ 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

Returns:

  • (String) 


6270
6271
6272
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6270

def group_by_time_unit
  @group_by_time_unit
end

#limit ⇒ Fixnum

Maximum number of rows that can be returned in the result. Corresponds to the JSON property limit

Returns:

  • (Fixnum) 


6275
6276
6277
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6275

def limit
  @limit
end

#metrics ⇒ Array<Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetric>

A list of Metrics. Corresponds to the JSON property metrics

Returns:



6280
6281
6282
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6280

def metrics
  @metrics
end

#name ⇒ String

Asynchronous Query Name. Corresponds to the JSON property name

Returns:

  • (String) 


6285
6286
6287
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6285

def name
  @name
end

#output_format ⇒ 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

Returns:

  • (String) 


6291
6292
6293
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6291

def output_format
  @output_format
end

#report_definition_id ⇒ String

Asynchronous Report ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String) 


6296
6297
6298
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6296

def report_definition_id
  @report_definition_id
end

#time_range ⇒ Object

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

Returns:

  • (Object) 


6305
6306
6307
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6305

def time_range
  @time_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6312

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