Class: Google::Cloud::Retail::V2::ExportAnalyticsMetricsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/retail/v2/export_config.rb

Overview

Request message for the ExportAnalyticsMetrics method.

Instance Attribute Summary collapse

Instance Attribute Details

#catalog ⇒ ::String

Returns Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*.

Returns:

  • (::String) —

    Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*



108
109
110
111
 
# File 'proto_docs/google/cloud/retail/v2/export_config.rb', line 108

class ExportAnalyticsMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#filter ⇒ ::String

Returns 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".

Returns:

  • (::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"


108
109
110
111
 
# File 'proto_docs/google/cloud/retail/v2/export_config.rb', line 108

class ExportAnalyticsMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#output_config ⇒ ::Google::Cloud::Retail::V2::OutputConfig

Returns Required. The output location of the data.

Returns:



108
109
110
111
 
# File 'proto_docs/google/cloud/retail/v2/export_config.rb', line 108

class ExportAnalyticsMetricsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end