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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudApigeeV1Query

Returns a new instance of GoogleCloudApigeeV1Query.



3108
3109
3110
# File 'generated/google/apis/apigee_v1/classes.rb', line 3108

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

Instance Attribute Details

#csv_delimiterString

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)


3032
3033
3034
# File 'generated/google/apis/apigee_v1/classes.rb', line 3032

def csv_delimiter
  @csv_delimiter
end

#dimensionsArray<String>

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

Returns:

  • (Array<String>)


3038
3039
3040
# File 'generated/google/apis/apigee_v1/classes.rb', line 3038

def dimensions
  @dimensions
end

#filterString

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)


3052
3053
3054
# File 'generated/google/apis/apigee_v1/classes.rb', line 3052

def filter
  @filter
end

#group_by_time_unitString

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)


3063
3064
3065
# File 'generated/google/apis/apigee_v1/classes.rb', line 3063

def group_by_time_unit
  @group_by_time_unit
end

#limitFixnum

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

Returns:

  • (Fixnum)


3068
3069
3070
# File 'generated/google/apis/apigee_v1/classes.rb', line 3068

def limit
  @limit
end

#metricsArray<Google::Apis::ApigeeV1::GoogleCloudApigeeV1QueryMetric>

A list of Metrics Corresponds to the JSON property metrics



3073
3074
3075
# File 'generated/google/apis/apigee_v1/classes.rb', line 3073

def metrics
  @metrics
end

#nameString

Asynchronous Query Name. Corresponds to the JSON property name

Returns:

  • (String)


3078
3079
3080
# File 'generated/google/apis/apigee_v1/classes.rb', line 3078

def name
  @name
end

#output_formatString

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)


3085
3086
3087
# File 'generated/google/apis/apigee_v1/classes.rb', line 3085

def output_format
  @output_format
end

#report_definition_idString

Asynchronous Report ID. Corresponds to the JSON property reportDefinitionId

Returns:

  • (String)


3090
3091
3092
# File 'generated/google/apis/apigee_v1/classes.rb', line 3090

def report_definition_id
  @report_definition_id
end

#time_rangeObject

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)


3106
3107
3108
# File 'generated/google/apis/apigee_v1/classes.rb', line 3106

def time_range
  @time_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
# File 'generated/google/apis/apigee_v1/classes.rb', line 3113

def update!(**args)
  @csv_delimiter = args[:csv_delimiter] if args.key?(:csv_delimiter)
  @dimensions = args[:dimensions] if args.key?(:dimensions)
  @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