Retail v2 API - Class ExportAnalyticsMetricsRequest (2.12.0)

public sealed class ExportAnalyticsMetricsRequest : IMessage<ExportAnalyticsMetricsRequest>, IEquatable<ExportAnalyticsMetricsRequest>, IDeepCloneable<ExportAnalyticsMetricsRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Retail v2 API class ExportAnalyticsMetricsRequest.

Request message for the ExportAnalyticsMetrics method.

Inheritance

object > ExportAnalyticsMetricsRequest

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

ExportAnalyticsMetricsRequest()

public ExportAnalyticsMetricsRequest()

ExportAnalyticsMetricsRequest(ExportAnalyticsMetricsRequest)

public ExportAnalyticsMetricsRequest(ExportAnalyticsMetricsRequest other)
Parameter
Name Description
other ExportAnalyticsMetricsRequest

Properties

Catalog

public string Catalog { get; set; }

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

Property Value
Type Description
string

Filter

public string Filter { get; set; }

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"
Property Value
Type Description
string

OutputConfig

public OutputConfig OutputConfig { get; set; }

Required. The output location of the data.

Property Value
Type Description
OutputConfig