Class: Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryTimeSeriesStatsRequest

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

Overview

QueryTimeSeriesStatsRequest represents a query that returns a collection of time series sequences grouped by their values.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1QueryTimeSeriesStatsRequest

Returns a new instance of GoogleCloudApigeeV1QueryTimeSeriesStatsRequest.



6535
6536
6537
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6535

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

Instance Attribute Details

#dimensions ⇒ Array<String>

List of dimension names to group the aggregations by. If no dimensions are passed, a single trend line representing the requested metric aggregations grouped by environment is returned. Corresponds to the JSON property dimensions

Returns:

  • (Array<String>) 


6490
6491
6492
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6490

def dimensions
  @dimensions
end

#filter ⇒ String

Filter further on specific dimension values. Follows the same grammar as custom report's filter expressions. Example, apiproxy eq 'foobar'. https:// cloud.google.com/apigee/docs/api-platform/analytics/analytics-reference# filters Corresponds to the JSON property filter

Returns:

  • (String) 


6498
6499
6500
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6498

def filter
  @filter
end

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

Required. List of metrics and their aggregations. Corresponds to the JSON property metrics

Returns:



6503
6504
6505
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6503

def metrics
  @metrics
end

#page_size ⇒ Fixnum

Page size represents the number of time series sequences, one per unique set of dimensions and their values. Corresponds to the JSON property pageSize

Returns:

  • (Fixnum) 


6509
6510
6511
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6509

def page_size
  @page_size
end

#page_token ⇒ String

Page token stands for a specific collection of time series sequences. Corresponds to the JSON property pageToken

Returns:

  • (String) 


6514
6515
6516
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6514

def page_token
  @page_token
end

#time_range ⇒ Google::Apis::ApigeeV1::GoogleTypeInterval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. Corresponds to the JSON property timeRange

Returns:



6522
6523
6524
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6522

def time_range
  @time_range
end

#timestamp_order ⇒ String

Order the sequences in increasing or decreasing order of timestamps. Default is descending order of timestamps (latest first). Corresponds to the JSON property timestampOrder

Returns:

  • (String) 


6528
6529
6530
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6528

def timestamp_order
  @timestamp_order
end

#window_size ⇒ String

Time buckets to group the stats by. Corresponds to the JSON property windowSize

Returns:

  • (String) 


6533
6534
6535
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6533

def window_size
  @window_size
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
 
# File 'lib/google/apis/apigee_v1/classes.rb', line 6540

def update!(**args)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @filter = args[:filter] if args.key?(:filter)
  @metrics = args[:metrics] if args.key?(:metrics)
  @page_size = args[:page_size] if args.key?(:page_size)
  @page_token = args[:page_token] if args.key?(:page_token)
  @time_range = args[:time_range] if args.key?(:time_range)
  @timestamp_order = args[:timestamp_order] if args.key?(:timestamp_order)
  @window_size = args[:window_size] if args.key?(:window_size)
end