Class: Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest

Inherits:

Object

• Object
• Google::Apis::RetailV2::GoogleCloudRetailV2ExportAnalyticsMetricsRequest

Includes:

Core::Hashable, Core::JsonObjectSupport

Defined in:

lib/google/apis/retail_v2/classes.rb,
lib/google/apis/retail_v2/representations.rb,
lib/google/apis/retail_v2/representations.rb

Overview

Request message for the ExportAnalyticsMetrics method.

Instance Attribute Summary

• #filter ⇒ String

  A filtering expression to specify restrictions on returned metrics.

• #output_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig

  The output configuration setting.

Instance Method Summary

• #initialize(**args) ⇒ GoogleCloudRetailV2ExportAnalyticsMetricsRequest constructor

  A new instance of GoogleCloudRetailV2ExportAnalyticsMetricsRequest.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ GoogleCloudRetailV2ExportAnalyticsMetricsRequest

Returns a new instance of GoogleCloudRetailV2ExportAnalyticsMetricsRequest.

# File 'lib/google/apis/retail_v2/classes.rb', line 1658

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

Instance Attribute Details

#filter ⇒ String

A filtering expression to specify restrictions on returned metrics. The expression is a sequence of terms. Each term applies a restriction to the returned metrics. Use this expression to restrict results to a specific time range. Currently we expect only one types of fields: * timestamp: This can be specified twice, once with a less than operator and once with a greater than operator. The timestamp restriction should result in one, contiguous, valid, timestamp range. Some examples of valid filters expressions: * Example 1: timestamp > "2012-04-23T18:25:43.511Z" timestamp < "2012-04-23T18: 30:43.511Z" * Example 2: timestamp > "2012-04-23T18:25:43.511Z" Corresponds to the JSON property filter

Returns:

• (String)

# File 'lib/google/apis/retail_v2/classes.rb', line 1651

def filter
  @filter
end

#output_config ⇒ Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig

The output configuration setting. Corresponds to the JSON property outputConfig

Returns:

• (Google::Apis::RetailV2::GoogleCloudRetailV2OutputConfig)

# File 'lib/google/apis/retail_v2/classes.rb', line 1656

def output_config
  @output_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

# File 'lib/google/apis/retail_v2/classes.rb', line 1663

def update!(**args)
  @filter = args[:filter] if args.key?(:filter)
  @output_config = args[:output_config] if args.key?(:output_config)
end