Retail v2 API - Class AnalyticsService.AnalyticsServiceClient (2.6.0)

Version 2.6.0

• 2.12.0 (latest)
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class AnalyticsService.AnalyticsServiceClient : ClientBase<AnalyticsService.AnalyticsServiceClient>

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

Client for AnalyticsService

Inheritance

object > ClientBase > ClientBaseAnalyticsServiceAnalyticsServiceClient > AnalyticsService.AnalyticsServiceClient

Inherited Members

ClientBase<AnalyticsService.AnalyticsServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

AnalyticsServiceClient()

protected AnalyticsServiceClient()

Protected parameterless constructor to allow creation of test doubles.

AnalyticsServiceClient(CallInvoker)

public AnalyticsServiceClient(CallInvoker callInvoker)

Creates a new client for AnalyticsService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

AnalyticsServiceClient(ChannelBase)

public AnalyticsServiceClient(ChannelBase channel)

Creates a new client for AnalyticsService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

AnalyticsServiceClient(ClientBaseConfiguration)

protected AnalyticsServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest, CallOptions)

public virtual Operation ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest request, CallOptions options)

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Parameters
Name	Description
request	ExportAnalyticsMetricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportAnalyticsMetrics(ExportAnalyticsMetricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Parameters
Name	Description
request	ExportAnalyticsMetricsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request, CallOptions options)

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Parameters
Name	Description
request	ExportAnalyticsMetricsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Exports analytics metrics.

Operation.response is of type ExportAnalyticsMetricsResponse. Operation.metadata is of type ExportMetadata.

Parameters
Name	Description
request	ExportAnalyticsMetricsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

NewInstance(ClientBaseConfiguration)

protected override AnalyticsService.AnalyticsServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
AnalyticsServiceAnalyticsServiceClient

Overrides

ClientBase<AnalyticsService.AnalyticsServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)