- 2.50.0 (latest)
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.1
- 2.4.0
- 2.3.0
- 2.2.3
- 2.1.0
- 2.0.19
GitHub Repository | Product Reference |
Service Description: Service for managing & accessing retail search business metric. Retail recommendation business metric is currently not available.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
ExportAnalyticsMetricsRequest request =
ExportAnalyticsMetricsRequest.newBuilder()
.setCatalog("catalog555704345")
.setOutputConfig(OutputConfig.newBuilder().build())
.setFilter("filter-1274492040")
.build();
ExportAnalyticsMetricsResponse response =
analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
}
Note: close() needs to be called on the AnalyticsServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
Method | Description | Method Variants |
---|---|---|
ExportAnalyticsMetrics | Exports analytics metrics. |
Request object method variants only take one parameter, a request object, which must be constructed before the call.
Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
|
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of AnalyticsServiceSettings to create(). For example:
To customize credentials:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsServiceSettings analyticsServiceSettings =
AnalyticsServiceSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
AnalyticsServiceClient analyticsServiceClient =
AnalyticsServiceClient.create(analyticsServiceSettings);
To customize the endpoint:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsServiceSettings analyticsServiceSettings =
AnalyticsServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
AnalyticsServiceClient analyticsServiceClient =
AnalyticsServiceClient.create(analyticsServiceSettings);
To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
AnalyticsServiceSettings analyticsServiceSettings =
AnalyticsServiceSettings.newHttpJsonBuilder().build();
AnalyticsServiceClient analyticsServiceClient =
AnalyticsServiceClient.create(analyticsServiceSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Static Methods
create()
public static final AnalyticsServiceClient create()
Constructs an instance of AnalyticsServiceClient with default settings.
Returns | |
---|---|
Type | Description |
AnalyticsServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AnalyticsServiceSettings settings)
public static final AnalyticsServiceClient create(AnalyticsServiceSettings settings)
Constructs an instance of AnalyticsServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Parameter | |
---|---|
Name | Description |
settings | AnalyticsServiceSettings |
Returns | |
---|---|
Type | Description |
AnalyticsServiceClient |
Exceptions | |
---|---|
Type | Description |
IOException |
create(AnalyticsServiceStub stub)
public static final AnalyticsServiceClient create(AnalyticsServiceStub stub)
Constructs an instance of AnalyticsServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(AnalyticsServiceSettings).
Parameter | |
---|---|
Name | Description |
stub | AnalyticsServiceStub |
Returns | |
---|---|
Type | Description |
AnalyticsServiceClient |
Constructors
AnalyticsServiceClient(AnalyticsServiceSettings settings)
protected AnalyticsServiceClient(AnalyticsServiceSettings settings)
Constructs an instance of AnalyticsServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
Parameter | |
---|---|
Name | Description |
settings | AnalyticsServiceSettings |
AnalyticsServiceClient(AnalyticsServiceStub stub)
protected AnalyticsServiceClient(AnalyticsServiceStub stub)
Parameter | |
---|---|
Name | Description |
stub | AnalyticsServiceStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Parameters | |
---|---|
Name | Description |
duration | long |
unit | TimeUnit |
Returns | |
---|---|
Type | Description |
boolean |
Exceptions | |
---|---|
Type | Description |
InterruptedException |
close()
public final void close()
exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request)
public final OperationFuture<ExportAnalyticsMetricsResponse,ExportMetadata> exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request)
Exports analytics metrics.
Operation.response
is of type ExportAnalyticsMetricsResponse
. Operation.metadata
is of
type ExportMetadata
.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
ExportAnalyticsMetricsRequest request =
ExportAnalyticsMetricsRequest.newBuilder()
.setCatalog("catalog555704345")
.setOutputConfig(OutputConfig.newBuilder().build())
.setFilter("filter-1274492040")
.build();
ExportAnalyticsMetricsResponse response =
analyticsServiceClient.exportAnalyticsMetricsAsync(request).get();
}
Parameter | |
---|---|
Name | Description |
request | ExportAnalyticsMetricsRequest The request object containing all of the parameters for the API call. |
Returns | |
---|---|
Type | Description |
OperationFuture<ExportAnalyticsMetricsResponse,ExportMetadata> |
exportAnalyticsMetricsCallable()
public final UnaryCallable<ExportAnalyticsMetricsRequest,Operation> exportAnalyticsMetricsCallable()
Exports analytics metrics.
Operation.response
is of type ExportAnalyticsMetricsResponse
. Operation.metadata
is of
type ExportMetadata
.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
ExportAnalyticsMetricsRequest request =
ExportAnalyticsMetricsRequest.newBuilder()
.setCatalog("catalog555704345")
.setOutputConfig(OutputConfig.newBuilder().build())
.setFilter("filter-1274492040")
.build();
ApiFuture<Operation> future =
analyticsServiceClient.exportAnalyticsMetricsCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Returns | |
---|---|
Type | Description |
UnaryCallable<ExportAnalyticsMetricsRequest,Operation> |
exportAnalyticsMetricsOperationCallable()
public final OperationCallable<ExportAnalyticsMetricsRequest,ExportAnalyticsMetricsResponse,ExportMetadata> exportAnalyticsMetricsOperationCallable()
Exports analytics metrics.
Operation.response
is of type ExportAnalyticsMetricsResponse
. Operation.metadata
is of
type ExportMetadata
.
Sample code:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
try (AnalyticsServiceClient analyticsServiceClient = AnalyticsServiceClient.create()) {
ExportAnalyticsMetricsRequest request =
ExportAnalyticsMetricsRequest.newBuilder()
.setCatalog("catalog555704345")
.setOutputConfig(OutputConfig.newBuilder().build())
.setFilter("filter-1274492040")
.build();
OperationFuture<ExportAnalyticsMetricsResponse, ExportMetadata> future =
analyticsServiceClient.exportAnalyticsMetricsOperationCallable().futureCall(request);
// Do something.
ExportAnalyticsMetricsResponse response = future.get();
}
Returns | |
---|---|
Type | Description |
OperationCallable<ExportAnalyticsMetricsRequest,ExportAnalyticsMetricsResponse,ExportMetadata> |
getHttpJsonOperationsClient()
public final OperationsClient getHttpJsonOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Returns | |
---|---|
Type | Description |
OperationsClient |
getSettings()
public final AnalyticsServiceSettings getSettings()
Returns | |
---|---|
Type | Description |
AnalyticsServiceSettings |
getStub()
public AnalyticsServiceStub getStub()
Returns | |
---|---|
Type | Description |
AnalyticsServiceStub |
isShutdown()
public boolean isShutdown()
Returns | |
---|---|
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Returns | |
---|---|
Type | Description |
boolean |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()