Reference documentation and code samples for the Google Cloud Retail V2 Client class ExportAnalyticsMetricsRequest.
Request message for the ExportAnalyticsMetrics
method.
Generated from protobuf message google.cloud.retail.v2.ExportAnalyticsMetricsRequest
Namespace
Google \ Cloud \ Retail \ V2Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ catalog
string
Required. Full resource name of the parent catalog. Expected format: projects/*/locations/*/catalogs/*
↳ output_config
↳ 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"
getCatalog
Required. Full resource name of the parent catalog.
Expected format: projects/*/locations/*/catalogs/*
string
setCatalog
Required. Full resource name of the parent catalog.
Expected format: projects/*/locations/*/catalogs/*
var
string
$this
getOutputConfig
Required. The output location of the data.
hasOutputConfig
clearOutputConfig
setOutputConfig
Required. The output location of the data.
$this
getFilter
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. Thetimestamp
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"
- Example 1:
string
setFilter
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. Thetimestamp
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"
- Example 1:
var
string
$this