com.google.cloud.retail.v2.AnalyticsServiceClient Maven / Gradle / Ivy
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.retail.v2;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.retail.v2.stub.AnalyticsServiceStub;
import com.google.cloud.retail.v2.stub.AnalyticsServiceStubSettings;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* 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:
*
*
{@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();
* }
* }
*
* 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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* ExportAnalyticsMetrics
Exports analytics metrics.
*
`Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of type `ExportMetadata`.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* exportAnalyticsMetricsOperationCallable()
*
exportAnalyticsMetricsCallable()
*
*
*
*
*
* 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:
*
*
{@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
* AnalyticsServiceSettings analyticsServiceSettings =
* AnalyticsServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* AnalyticsServiceClient analyticsServiceClient =
* AnalyticsServiceClient.create(analyticsServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* AnalyticsServiceSettings analyticsServiceSettings =
* AnalyticsServiceSettings.newHttpJsonBuilder().build();
* AnalyticsServiceClient analyticsServiceClient =
* AnalyticsServiceClient.create(analyticsServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class AnalyticsServiceClient implements BackgroundResource {
private final AnalyticsServiceSettings settings;
private final AnalyticsServiceStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of AnalyticsServiceClient with default settings. */
public static final AnalyticsServiceClient create() throws IOException {
return create(AnalyticsServiceSettings.newBuilder().build());
}
/**
* 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.
*/
public static final AnalyticsServiceClient create(AnalyticsServiceSettings settings)
throws IOException {
return new AnalyticsServiceClient(settings);
}
/**
* Constructs an instance of AnalyticsServiceClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(AnalyticsServiceSettings).
*/
public static final AnalyticsServiceClient create(AnalyticsServiceStub stub) {
return new AnalyticsServiceClient(stub);
}
/**
* 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.
*/
protected AnalyticsServiceClient(AnalyticsServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((AnalyticsServiceStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected AnalyticsServiceClient(AnalyticsServiceStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final AnalyticsServiceSettings getSettings() {
return settings;
}
public AnalyticsServiceStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports analytics metrics.
*
*
`Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
* type `ExportMetadata`.
*
*
Sample code:
*
*
{@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();
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture
exportAnalyticsMetricsAsync(ExportAnalyticsMetricsRequest request) {
return exportAnalyticsMetricsOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports analytics metrics.
*
* `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
* type `ExportMetadata`.
*
*
Sample code:
*
*
{@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 future =
* analyticsServiceClient.exportAnalyticsMetricsOperationCallable().futureCall(request);
* // Do something.
* ExportAnalyticsMetricsResponse response = future.get();
* }
* }
*/
public final OperationCallable<
ExportAnalyticsMetricsRequest, ExportAnalyticsMetricsResponse, ExportMetadata>
exportAnalyticsMetricsOperationCallable() {
return stub.exportAnalyticsMetricsOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Exports analytics metrics.
*
* `Operation.response` is of type `ExportAnalyticsMetricsResponse`. `Operation.metadata` is of
* type `ExportMetadata`.
*
*
Sample code:
*
*
{@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 future =
* analyticsServiceClient.exportAnalyticsMetricsCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }
*/
public final UnaryCallable
exportAnalyticsMetricsCallable() {
return stub.exportAnalyticsMetricsCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}