Retail V2 API - Class Google::Cloud::Retail::V2::ExportAnalyticsMetricsRequest (v0.19.0)

Reference documentation and code samples for the Retail V2 API class Google::Cloud::Retail::V2::ExportAnalyticsMetricsRequest.

Request message for the ExportAnalyticsMetrics method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#catalog

def catalog() -> ::String
Returns
  • (::String) — Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*

#catalog=

def catalog=(value) -> ::String
Parameter
  • value (::String) — 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/*

#filter

def filter() -> ::String
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"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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"
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"

#output_config

def output_config() -> ::Google::Cloud::Retail::V2::OutputConfig
Returns

#output_config=

def output_config=(value) -> ::Google::Cloud::Retail::V2::OutputConfig
Parameter
Returns