Service for managing & accessing retail search business metric.
Retail recommendation business metric is currently not available.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
AnalyticsServiceClient(AnalyticsServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AnalyticsServiceClient const &
|
AnalyticsServiceClient(AnalyticsServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AnalyticsServiceClient &&
|
AnalyticsServiceClient(std::shared_ptr< AnalyticsServiceConnection >, Options)
| Parameters | |
|---|---|
| Name | Description |
connection |
std::shared_ptr< AnalyticsServiceConnection >
|
opts |
Options
|
Operators
operator=(AnalyticsServiceClient const &)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AnalyticsServiceClient const &
|
| Returns | |
|---|---|
| Type | Description |
AnalyticsServiceClient & |
|
operator=(AnalyticsServiceClient &&)
Copy and move support
| Parameter | |
|---|---|
| Name | Description |
|
AnalyticsServiceClient &&
|
| Returns | |
|---|---|
| Type | Description |
AnalyticsServiceClient & |
|
Functions
ExportAnalyticsMetrics(google::cloud::retail::v2::ExportAnalyticsMetricsRequest const &, Options)
Exports analytics metrics.
Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.
| Parameters | |
|---|---|
| Name | Description |
request |
google::cloud::retail::v2::ExportAnalyticsMetricsRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::retail::v2::ExportAnalyticsMetricsResponse > > |
A |
ExportAnalyticsMetrics(ExperimentalTag, NoAwaitTag, google::cloud::retail::v2::ExportAnalyticsMetricsRequest const &, Options)
Exports analytics metrics.
Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
| Parameters | |
|---|---|
| Name | Description |
|
ExperimentalTag
|
|
NoAwaitTag
|
request |
google::cloud::retail::v2::ExportAnalyticsMetricsRequest const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
StatusOr< google::longrunning::Operation > |
|
ExportAnalyticsMetrics(ExperimentalTag, google::longrunning::Operation const &, Options)
Exports analytics metrics.
This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
| Parameters | |
|---|---|
| Name | Description |
|
ExperimentalTag
|
operation |
google::longrunning::Operation const &
|
opts |
Options
|
| Returns | |
|---|---|
| Type | Description |
future< StatusOr< google::cloud::retail::v2::ExportAnalyticsMetricsResponse > > |
|