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
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
+ * }
+ * }
+ *
* Note: close() needs to be called on the CatalogServiceClient object to clean up resources such * as threads. In the example above, try-with-resources is used, which automatically calls close(). * @@ -162,6 +170,16 @@ public final OperationsClient getOperationsClient() { /** * Creates a catalog item. * + *
Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
+ * }
+ * }
+ *
* @param parent Required. The parent catalog resource name, such as
* "projects/*/locations/global/catalogs/default_catalog".
* @param catalogItem Required. The catalog item to create.
@@ -180,6 +198,16 @@ public final CatalogItem createCatalogItem(CatalogName parent, CatalogItem catal
/**
* Creates a catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
+ * }
+ * }
+ *
* @param parent Required. The parent catalog resource name, such as
* "projects/*/locations/global/catalogs/default_catalog".
* @param catalogItem Required. The catalog item to create.
@@ -195,6 +223,19 @@ public final CatalogItem createCatalogItem(String parent, CatalogItem catalogIte
/**
* Creates a catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CreateCatalogItemRequest request =
+ * CreateCatalogItemRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setCatalogItem(CatalogItem.newBuilder().build())
+ * .build();
+ * CatalogItem response = catalogServiceClient.createCatalogItem(request);
+ * }
+ * }
+ *
* @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
*/
@@ -207,6 +248,20 @@ public final CatalogItem createCatalogItem(CreateCatalogItemRequest request) {
* Creates a catalog item.
*
* Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CreateCatalogItemRequest request =
+ * CreateCatalogItemRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setCatalogItem(CatalogItem.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.createCatalogItemCallable().futureCall(request);
+ * // Do something.
+ * CatalogItem response = future.get();
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogItemPathName name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]");
+ * CatalogItem response = catalogServiceClient.getCatalogItem(name);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -230,6 +295,17 @@ public final CatalogItem getCatalogItem(CatalogItemPathName name) {
/**
* Gets a specific catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString();
+ * CatalogItem response = catalogServiceClient.getCatalogItem(name);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogitems/some_catalog_item_id".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -243,6 +319,21 @@ public final CatalogItem getCatalogItem(String name) {
/**
* Gets a specific catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * GetCatalogItemRequest request =
+ * GetCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .build();
+ * CatalogItem response = catalogServiceClient.getCatalogItem(request);
+ * }
+ * }
+ *
* @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
*/
@@ -255,6 +346,22 @@ public final CatalogItem getCatalogItem(GetCatalogItemRequest request) {
* Gets a specific catalog item.
*
* Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * GetCatalogItemRequest request =
+ * GetCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.getCatalogItemCallable().futureCall(request);
+ * // Do something.
+ * CatalogItem response = future.get();
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
+ * String filter = "filter-1274492040";
+ * for (CatalogItem element :
+ * catalogServiceClient.listCatalogItems(parent, filter).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent catalog resource name, such as
* "projects/*/locations/global/catalogs/default_catalog".
* @param filter Optional. A filter to apply on the list results.
@@ -282,6 +402,19 @@ public final ListCatalogItemsPagedResponse listCatalogItems(CatalogName parent,
/**
* Gets a list of catalog items.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
+ * String filter = "filter-1274492040";
+ * for (CatalogItem element :
+ * catalogServiceClient.listCatalogItems(parent, filter).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent catalog resource name, such as
* "projects/*/locations/global/catalogs/default_catalog".
* @param filter Optional. A filter to apply on the list results.
@@ -297,6 +430,23 @@ public final ListCatalogItemsPagedResponse listCatalogItems(String parent, Strin
/**
* Gets a list of catalog items.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * ListCatalogItemsRequest request =
+ * ListCatalogItemsRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * for (CatalogItem element : catalogServiceClient.listCatalogItems(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @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
*/
@@ -309,6 +459,24 @@ public final ListCatalogItemsPagedResponse listCatalogItems(ListCatalogItemsRequ
* Gets a list of catalog items.
*
* Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * ListCatalogItemsRequest request =
+ * ListCatalogItemsRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.listCatalogItemsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (CatalogItem element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * while (true) {
+ * ListCatalogItemsResponse response =
+ * catalogServiceClient.listCatalogItemsCallable().call(request);
+ * for (CatalogItem element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogItemPathName name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]");
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.updateCatalogItem(name, catalogItem, updateMask);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* @param catalogItem Required. The catalog item to update/create. The 'catalog_item_id' field has
@@ -353,6 +551,19 @@ public final CatalogItem updateCatalogItem(
/**
* Updates a catalog item. Partial updating is supported. Non-existing items will be created.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString();
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * FieldMask updateMask = FieldMask.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.updateCatalogItem(name, catalogItem, updateMask);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* @param catalogItem Required. The catalog item to update/create. The 'catalog_item_id' field has
@@ -376,6 +587,23 @@ public final CatalogItem updateCatalogItem(
/**
* Updates a catalog item. Partial updating is supported. Non-existing items will be created.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * UpdateCatalogItemRequest request =
+ * UpdateCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .setCatalogItem(CatalogItem.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * CatalogItem response = catalogServiceClient.updateCatalogItem(request);
+ * }
+ * }
+ *
* @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
*/
@@ -388,6 +616,24 @@ public final CatalogItem updateCatalogItem(UpdateCatalogItemRequest request) {
* Updates a catalog item. Partial updating is supported. Non-existing items will be created.
*
* Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * UpdateCatalogItemRequest request =
+ * UpdateCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .setCatalogItem(CatalogItem.newBuilder().build())
+ * .setUpdateMask(FieldMask.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.updateCatalogItemCallable().futureCall(request);
+ * // Do something.
+ * CatalogItem response = future.get();
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogItemPathName name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]");
+ * catalogServiceClient.deleteCatalogItem(name);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -413,6 +669,17 @@ public final void deleteCatalogItem(CatalogItemPathName name) {
/**
* Deletes a catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String name =
+ * CatalogItemPathName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString();
+ * catalogServiceClient.deleteCatalogItem(name);
+ * }
+ * }
+ *
* @param name Required. Full resource name of catalog item, such as
* "projects/*/locations/global/catalogs/default_catalog/catalogItems/some_catalog_item_id".
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -426,6 +693,21 @@ public final void deleteCatalogItem(String name) {
/**
* Deletes a catalog item.
*
+ * Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * DeleteCatalogItemRequest request =
+ * DeleteCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .build();
+ * catalogServiceClient.deleteCatalogItem(request);
+ * }
+ * }
+ *
* @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
*/
@@ -438,6 +720,22 @@ public final void deleteCatalogItem(DeleteCatalogItemRequest request) {
* Deletes a catalog item.
*
* Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * DeleteCatalogItemRequest request =
+ * DeleteCatalogItemRequest.newBuilder()
+ * .setName(
+ * CatalogItemPathName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[CATALOG_ITEM_PATH]")
+ * .toString())
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.deleteCatalogItemCallable().futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallableOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully updated. * + *
Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
+ * String requestId = "requestId693933066";
+ * InputConfig inputConfig = InputConfig.newBuilder().build();
+ * ImportErrorsConfig errorsConfig = ImportErrorsConfig.newBuilder().build();
+ * ImportCatalogItemsResponse response =
+ * catalogServiceClient
+ * .importCatalogItemsAsync(parent, requestId, inputConfig, errorsConfig)
+ * .get();
+ * }
+ * }
+ *
* @param parent Required. "projects/1234/locations/global/catalogs/default_catalog"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency and used for request deduplication. Server-generated if
@@ -483,6 +796,21 @@ public final OperationFutureOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully updated. * + *
Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * String parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString();
+ * String requestId = "requestId693933066";
+ * InputConfig inputConfig = InputConfig.newBuilder().build();
+ * ImportErrorsConfig errorsConfig = ImportErrorsConfig.newBuilder().build();
+ * ImportCatalogItemsResponse response =
+ * catalogServiceClient
+ * .importCatalogItemsAsync(parent, requestId, inputConfig, errorsConfig)
+ * .get();
+ * }
+ * }
+ *
* @param parent Required. "projects/1234/locations/global/catalogs/default_catalog"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
* scope. Ensures idempotency and used for request deduplication. Server-generated if
@@ -512,6 +840,22 @@ public final OperationFutureOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully updated. * + *
Sample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * ImportCatalogItemsRequest request =
+ * ImportCatalogItemsRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * ImportCatalogItemsResponse response =
+ * catalogServiceClient.importCatalogItemsAsync(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
*/
@@ -529,6 +873,22 @@ public final OperationFutureSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * ImportCatalogItemsRequest request =
+ * ImportCatalogItemsRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * OperationFuture future =
+ * catalogServiceClient.importCatalogItemsOperationCallable().futureCall(request);
+ * // Do something.
+ * ImportCatalogItemsResponse response = future.get();
+ * }
+ * }
*/
public final OperationCallable<
ImportCatalogItemsRequest, ImportCatalogItemsResponse, ImportMetadata>
@@ -545,6 +905,22 @@ public final OperationFutureSample code: + * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * ImportCatalogItemsRequest request =
+ * ImportCatalogItemsRequest.newBuilder()
+ * .setParent(CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]").toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * catalogServiceClient.importCatalogItemsCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallableThis 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
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * PredictionApiKeyRegistration predictionApiKeyRegistration =
+ * PredictionApiKeyRegistration.newBuilder().build();
+ * PredictionApiKeyRegistration response =
+ * predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
+ * parent, predictionApiKeyRegistration);
+ * }
+ * }
+ *
* Note: close() needs to be called on the PredictionApiKeyRegistryClient object to clean up * resources such as threads. In the example above, try-with-resources is used, which automatically * calls close(). @@ -154,6 +167,21 @@ public PredictionApiKeyRegistryStub getStub() { /** * Register an API key for use with predict method. * + *
Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * PredictionApiKeyRegistration predictionApiKeyRegistration =
+ * PredictionApiKeyRegistration.newBuilder().build();
+ * PredictionApiKeyRegistration response =
+ * predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
+ * parent, predictionApiKeyRegistration);
+ * }
+ * }
+ *
* @param parent Required. The parent resource path.
* "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param predictionApiKeyRegistration Required. The prediction API key registration.
@@ -173,6 +201,21 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
/**
* Register an API key for use with predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * PredictionApiKeyRegistration predictionApiKeyRegistration =
+ * PredictionApiKeyRegistration.newBuilder().build();
+ * PredictionApiKeyRegistration response =
+ * predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
+ * parent, predictionApiKeyRegistration);
+ * }
+ * }
+ *
* @param parent Required. The parent resource path.
* "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param predictionApiKeyRegistration Required. The prediction API key registration.
@@ -192,6 +235,23 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
/**
* Register an API key for use with predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * CreatePredictionApiKeyRegistrationRequest request =
+ * CreatePredictionApiKeyRegistrationRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPredictionApiKeyRegistration(PredictionApiKeyRegistration.newBuilder().build())
+ * .build();
+ * PredictionApiKeyRegistration response =
+ * predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(request);
+ * }
+ * }
+ *
* @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
*/
@@ -205,6 +265,25 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
* Register an API key for use with predict method.
*
* Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * CreatePredictionApiKeyRegistrationRequest request =
+ * CreatePredictionApiKeyRegistrationRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPredictionApiKeyRegistration(PredictionApiKeyRegistration.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * predictionApiKeyRegistryClient
+ * .createPredictionApiKeyRegistrationCallable()
+ * .futureCall(request);
+ * // Do something.
+ * PredictionApiKeyRegistration response = future.get();
+ * }
+ * }
*/
public final UnaryCallable<
CreatePredictionApiKeyRegistrationRequest, PredictionApiKeyRegistration>
@@ -216,6 +295,20 @@ public final PredictionApiKeyRegistration createPredictionApiKeyRegistration(
/**
* List the registered apiKeys for use with predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * for (PredictionApiKeyRegistration element :
+ * predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent placement resource name such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -233,6 +326,20 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
/**
* List the registered apiKeys for use with predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * for (PredictionApiKeyRegistration element :
+ * predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(parent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent placement resource name such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -248,6 +355,26 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
/**
* List the registered apiKeys for use with predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * ListPredictionApiKeyRegistrationsRequest request =
+ * ListPredictionApiKeyRegistrationsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * for (PredictionApiKeyRegistration element :
+ * predictionApiKeyRegistryClient.listPredictionApiKeyRegistrations(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @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
*/
@@ -261,6 +388,28 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
* List the registered apiKeys for use with predict method.
*
* Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * ListPredictionApiKeyRegistrationsRequest request =
+ * ListPredictionApiKeyRegistrationsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .build();
+ * ApiFuture future =
+ * predictionApiKeyRegistryClient
+ * .listPredictionApiKeyRegistrationsPagedCallable()
+ * .futureCall(request);
+ * // Do something.
+ * for (PredictionApiKeyRegistration element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallable<
ListPredictionApiKeyRegistrationsRequest, ListPredictionApiKeyRegistrationsPagedResponse>
@@ -273,6 +422,27 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
* List the registered apiKeys for use with predict method.
*
* Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * while (true) {
+ * ListPredictionApiKeyRegistrationsResponse response =
+ * predictionApiKeyRegistryClient
+ * .listPredictionApiKeyRegistrationsCallable()
+ * .call(request);
+ * for (PredictionApiKeyRegistration element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallable<
ListPredictionApiKeyRegistrationsRequest, ListPredictionApiKeyRegistrationsResponse>
@@ -284,6 +454,22 @@ public final ListPredictionApiKeyRegistrationsPagedResponse listPredictionApiKey
/**
* Unregister an apiKey from using for predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * PredictionApiKeyRegistrationName name =
+ * PredictionApiKeyRegistrationName.of(
+ * "[PROJECT]",
+ * "[LOCATION]",
+ * "[CATALOG]",
+ * "[EVENT_STORE]",
+ * "[PREDICTION_API_KEY_REGISTRATION]");
+ * predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
+ * }
+ * }
+ *
* @param name Required. The API key to unregister including full resource path.
* "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -300,6 +486,23 @@ public final void deletePredictionApiKeyRegistration(PredictionApiKeyRegistratio
/**
* Unregister an apiKey from using for predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * String name =
+ * PredictionApiKeyRegistrationName.of(
+ * "[PROJECT]",
+ * "[LOCATION]",
+ * "[CATALOG]",
+ * "[EVENT_STORE]",
+ * "[PREDICTION_API_KEY_REGISTRATION]")
+ * .toString();
+ * predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(name);
+ * }
+ * }
+ *
* @param name Required. The API key to unregister including full resource path.
* "projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/predictionApiKeyRegistrations/<YOUR_API_KEY>"
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
@@ -314,6 +517,26 @@ public final void deletePredictionApiKeyRegistration(String name) {
/**
* Unregister an apiKey from using for predict method.
*
+ * Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * DeletePredictionApiKeyRegistrationRequest request =
+ * DeletePredictionApiKeyRegistrationRequest.newBuilder()
+ * .setName(
+ * PredictionApiKeyRegistrationName.of(
+ * "[PROJECT]",
+ * "[LOCATION]",
+ * "[CATALOG]",
+ * "[EVENT_STORE]",
+ * "[PREDICTION_API_KEY_REGISTRATION]")
+ * .toString())
+ * .build();
+ * predictionApiKeyRegistryClient.deletePredictionApiKeyRegistration(request);
+ * }
+ * }
+ *
* @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
*/
@@ -327,6 +550,29 @@ public final void deletePredictionApiKeyRegistration(
* Unregister an apiKey from using for predict method.
*
* Sample code: + * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * DeletePredictionApiKeyRegistrationRequest request =
+ * DeletePredictionApiKeyRegistrationRequest.newBuilder()
+ * .setName(
+ * PredictionApiKeyRegistrationName.of(
+ * "[PROJECT]",
+ * "[LOCATION]",
+ * "[CATALOG]",
+ * "[EVENT_STORE]",
+ * "[PREDICTION_API_KEY_REGISTRATION]")
+ * .toString())
+ * .build();
+ * ApiFuture future =
+ * predictionApiKeyRegistryClient
+ * .deletePredictionApiKeyRegistrationCallable()
+ * .futureCall(request);
+ * // Do something.
+ * future.get();
+ * }
+ * }
*/
public final UnaryCallableThis 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
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * PlacementName name =
+ * PlacementName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * for (PredictResponse.PredictionResult element :
+ * predictionServiceClient.predict(name, userEvent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* Note: close() needs to be called on the PredictionServiceClient object to clean up resources * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). @@ -151,6 +163,20 @@ public PredictionServiceStub getStub() { * [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry] * service. [Learn more](/recommendations-ai/docs/setting-up#register-key). * + *
Sample code: + * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * PlacementName name =
+ * PlacementName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * for (PredictResponse.PredictionResult element :
+ * predictionServiceClient.predict(name, userEvent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param name Required. Full resource name of the format:
* {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}
* The id of the recommendation engine placement. This id is used to identify the set of
@@ -201,6 +227,21 @@ public final PredictPagedResponse predict(PlacementName name, UserEvent userEven
* [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry]
* service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
*
+ * Sample code: + * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * String name =
+ * PlacementName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]")
+ * .toString();
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * for (PredictResponse.PredictionResult element :
+ * predictionServiceClient.predict(name, userEvent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param name Required. Full resource name of the format:
* {name=projects/*/locations/global/catalogs/default_catalog/eventStores/default_event_store/placements/*}
* The id of the recommendation engine placement. This id is used to identify the set of
@@ -248,6 +289,31 @@ public final PredictPagedResponse predict(String name, UserEvent userEvent) {
* [PredictionApiKeyRegistry][google.cloud.recommendationengine.v1beta1.PredictionApiKeyRegistry]
* service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
*
+ * Sample code: + * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * PredictRequest request =
+ * PredictRequest.newBuilder()
+ * .setName(
+ * PlacementName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]")
+ * .toString())
+ * .setUserEvent(UserEvent.newBuilder().build())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .setDryRun(true)
+ * .putAllParams(new HashMap())
+ * .putAllLabels(new HashMap())
+ * .build();
+ * for (PredictResponse.PredictionResult element :
+ * predictionServiceClient.predict(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @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
*/
@@ -263,6 +329,31 @@ public final PredictPagedResponse predict(PredictRequest request) {
* service. [Learn more](/recommendations-ai/docs/setting-up#register-key).
*
* Sample code: + * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * PredictRequest request =
+ * PredictRequest.newBuilder()
+ * .setName(
+ * PlacementName.of(
+ * "[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]")
+ * .toString())
+ * .setUserEvent(UserEvent.newBuilder().build())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .setDryRun(true)
+ * .putAllParams(new HashMap())
+ * .putAllLabels(new HashMap())
+ * .build();
+ * ApiFuture future =
+ * predictionServiceClient.predictPagedCallable().futureCall(request);
+ * // Do something.
+ * for (PredictResponse.PredictionResult element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * while (true) {
+ * PredictResponse response = predictionServiceClient.predictCallable().call(request);
+ * for (PredictResponse.PredictionResult element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallableThis 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
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
+ * }
+ * }
+ *
* Note: close() needs to be called on the UserEventServiceClient object to clean up resources * such as threads. In the example above, try-with-resources is used, which automatically calls * close(). @@ -164,6 +173,17 @@ public final OperationsClient getOperationsClient() { /** * Writes a single user event. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. User event to write.
@@ -182,6 +202,17 @@ public final UserEvent writeUserEvent(EventStoreName parent, UserEvent userEvent
/**
* Writes a single user event.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore resource name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. User event to write.
@@ -197,6 +228,21 @@ public final UserEvent writeUserEvent(String parent, UserEvent userEvent) {
/**
* Writes a single user event.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * WriteUserEventRequest request =
+ * WriteUserEventRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setUserEvent(UserEvent.newBuilder().build())
+ * .build();
+ * UserEvent response = userEventServiceClient.writeUserEvent(request);
+ * }
+ * }
+ *
* @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
*/
@@ -209,6 +255,22 @@ public final UserEvent writeUserEvent(WriteUserEventRequest request) {
* Writes a single user event.
*
* Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * WriteUserEventRequest request =
+ * WriteUserEventRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setUserEvent(UserEvent.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * userEventServiceClient.writeUserEventCallable().futureCall(request);
+ * // Do something.
+ * UserEvent response = future.get();
+ * }
+ * }
*/
public final UnaryCallableThis method is used only by the Recommendations AI JavaScript pixel. Users should not call * this method directly. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * String userEvent = "userEvent315571599";
+ * String uri = "uri116076";
+ * long ets = 100772;
+ * HttpBody response = userEventServiceClient.collectUserEvent(parent, userEvent, uri, ets);
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. URL encoded UserEvent proto.
@@ -253,6 +328,19 @@ public final HttpBody collectUserEvent(
* This method is used only by the Recommendations AI JavaScript pixel. Users should not call * this method directly. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * String userEvent = "userEvent315571599";
+ * String uri = "uri116076";
+ * long ets = 100772;
+ * HttpBody response = userEventServiceClient.collectUserEvent(parent, userEvent, uri, ets);
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore name, such as
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store".
* @param userEvent Required. URL encoded UserEvent proto.
@@ -283,6 +371,23 @@ public final HttpBody collectUserEvent(String parent, String userEvent, String u
* This method is used only by the Recommendations AI JavaScript pixel. Users should not call * this method directly. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * CollectUserEventRequest request =
+ * CollectUserEventRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setUserEvent("userEvent315571599")
+ * .setUri("uri116076")
+ * .setEts(100772)
+ * .build();
+ * HttpBody response = userEventServiceClient.collectUserEvent(request);
+ * }
+ * }
+ *
* @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
*/
@@ -299,6 +404,24 @@ public final HttpBody collectUserEvent(CollectUserEventRequest request) {
* this method directly.
*
* Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * CollectUserEventRequest request =
+ * CollectUserEventRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setUserEvent("userEvent315571599")
+ * .setUri("uri116076")
+ * .setEts(100772)
+ * .build();
+ * ApiFuture future =
+ * userEventServiceClient.collectUserEventCallable().futureCall(request);
+ * // Do something.
+ * HttpBody response = future.get();
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * String filter = "filter-1274492040";
+ * for (UserEvent element : userEventServiceClient.listUserEvents(parent, filter).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore resource name, such as
* "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
@@ -345,6 +481,19 @@ public final ListUserEventsPagedResponse listUserEvents(EventStoreName parent, S
/**
* Gets a list of user events within a time range, with potential filtering.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * String filter = "filter-1274492040";
+ * for (UserEvent element : userEventServiceClient.listUserEvents(parent, filter).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @param parent Required. The parent eventStore resource name, such as
* "projects/*/locations/*/catalogs/default_catalog/eventStores/default_event_store".
* @param filter Optional. Filtering expression to specify restrictions over returned events. This
@@ -379,6 +528,25 @@ public final ListUserEventsPagedResponse listUserEvents(String parent, String fi
/**
* Gets a list of user events within a time range, with potential filtering.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * ListUserEventsRequest request =
+ * ListUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * for (UserEvent element : userEventServiceClient.listUserEvents(request).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* @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
*/
@@ -391,6 +559,26 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
* Gets a list of user events within a time range, with potential filtering.
*
* Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * ListUserEventsRequest request =
+ * ListUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setPageSize(883849137)
+ * .setPageToken("pageToken873572522")
+ * .setFilter("filter-1274492040")
+ * .build();
+ * ApiFuture future =
+ * userEventServiceClient.listUserEventsPagedCallable().futureCall(request);
+ * // Do something.
+ * for (UserEvent element : future.get().iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * while (true) {
+ * ListUserEventsResponse response =
+ * userEventServiceClient.listUserEventsCallable().call(request);
+ * for (UserEvent element : response.getResponsesList()) {
+ * // doThingsWith(element);
+ * }
+ * String nextPageToken = response.getNextPageToken();
+ * if (!Strings.isNullOrEmpty(nextPageToken)) {
+ * request = request.toBuilder().setPageToken(nextPageToken).build();
+ * } else {
+ * break;
+ * }
+ * }
+ * }
+ * }
*/
public final UnaryCallableSample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * String filter = "filter-1274492040";
+ * boolean force = true;
+ * PurgeUserEventsResponse response =
+ * userEventServiceClient.purgeUserEventsAsync(parent, filter, force).get();
+ * }
+ * }
+ *
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
@@ -455,6 +674,19 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * String filter = "filter-1274492040";
+ * boolean force = true;
+ * PurgeUserEventsResponse response =
+ * userEventServiceClient.purgeUserEventsAsync(parent, filter, force).get();
+ * }
+ * }
+ *
* @param parent Required. The resource name of the event_store under which the events are
* created. The format is
* "projects/${projectId}/locations/global/catalogs/${catalogId}/eventStores/${eventStoreId}"
@@ -496,6 +728,22 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
* of events specified by the filter, this operation could take hours or days to complete. To test
* a filter, use the list command first.
*
+ * Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * PurgeUserEventsRequest request =
+ * PurgeUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setFilter("filter-1274492040")
+ * .setForce(true)
+ * .build();
+ * PurgeUserEventsResponse response = userEventServiceClient.purgeUserEventsAsync(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
*/
@@ -511,6 +759,23 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
* a filter, use the list command first.
*
* Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * PurgeUserEventsRequest request =
+ * PurgeUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setFilter("filter-1274492040")
+ * .setForce(true)
+ * .build();
+ * OperationFuture future =
+ * userEventServiceClient.purgeUserEventsOperationCallable().futureCall(request);
+ * // Do something.
+ * PurgeUserEventsResponse response = future.get();
+ * }
+ * }
*/
public final OperationCallable<
PurgeUserEventsRequest, PurgeUserEventsResponse, PurgeUserEventsMetadata>
@@ -525,6 +790,23 @@ public final ListUserEventsPagedResponse listUserEvents(ListUserEventsRequest re
* a filter, use the list command first.
*
* Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * PurgeUserEventsRequest request =
+ * PurgeUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setFilter("filter-1274492040")
+ * .setForce(true)
+ * .build();
+ * ApiFuture future =
+ * userEventServiceClient.purgeUserEventsCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallableOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully inserted. Operation.metadata is of type ImportMetadata. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * String requestId = "requestId693933066";
+ * InputConfig inputConfig = InputConfig.newBuilder().build();
+ * ImportErrorsConfig errorsConfig = ImportErrorsConfig.newBuilder().build();
+ * ImportUserEventsResponse response =
+ * userEventServiceClient
+ * .importUserEventsAsync(parent, requestId, inputConfig, errorsConfig)
+ * .get();
+ * }
+ * }
+ *
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
@@ -572,6 +870,22 @@ public final OperationFutureOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully inserted. Operation.metadata is of type ImportMetadata. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * String parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]").toString();
+ * String requestId = "requestId693933066";
+ * InputConfig inputConfig = InputConfig.newBuilder().build();
+ * ImportErrorsConfig errorsConfig = ImportErrorsConfig.newBuilder().build();
+ * ImportUserEventsResponse response =
+ * userEventServiceClient
+ * .importUserEventsAsync(parent, requestId, inputConfig, errorsConfig)
+ * .get();
+ * }
+ * }
+ *
* @param parent Required.
* "projects/1234/locations/global/catalogs/default_catalog/eventStores/default_event_store"
* @param requestId Optional. Unique identifier provided by client, within the ancestor dataset
@@ -603,6 +917,24 @@ public final OperationFutureOperation.response is of type ImportResponse. Note that it is possible for a subset of the * items to be successfully inserted. Operation.metadata is of type ImportMetadata. * + *
Sample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * ImportUserEventsRequest request =
+ * ImportUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * ImportUserEventsResponse response =
+ * userEventServiceClient.importUserEventsAsync(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
*/
@@ -620,6 +952,24 @@ public final OperationFutureSample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * ImportUserEventsRequest request =
+ * ImportUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * OperationFuture future =
+ * userEventServiceClient.importUserEventsOperationCallable().futureCall(request);
+ * // Do something.
+ * ImportUserEventsResponse response = future.get();
+ * }
+ * }
*/
public final OperationCallableSample code: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * ImportUserEventsRequest request =
+ * ImportUserEventsRequest.newBuilder()
+ * .setParent(
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]")
+ * .toString())
+ * .setRequestId("requestId693933066")
+ * .setInputConfig(InputConfig.newBuilder().build())
+ * .setErrorsConfig(ImportErrorsConfig.newBuilder().build())
+ * .build();
+ * ApiFuture future =
+ * userEventServiceClient.importUserEventsCallable().futureCall(request);
+ * // Do something.
+ * Operation response = future.get();
+ * }
+ * }
*/
public final UnaryCallableSample for CatalogServiceClient: * + *
{@code
+ * try (CatalogServiceClient catalogServiceClient = CatalogServiceClient.create()) {
+ * CatalogName parent = CatalogName.of("[PROJECT]", "[LOCATION]", "[CATALOG]");
+ * CatalogItem catalogItem = CatalogItem.newBuilder().build();
+ * CatalogItem response = catalogServiceClient.createCatalogItem(parent, catalogItem);
+ * }
+ * }
+ *
* ======================= PredictionApiKeyRegistryClient ======================= * *
Service Description: Service for registering API keys for use with the `predict` method. If @@ -32,17 +40,51 @@ * *
Sample for PredictionApiKeyRegistryClient: * + *
{@code
+ * try (PredictionApiKeyRegistryClient predictionApiKeyRegistryClient =
+ * PredictionApiKeyRegistryClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * PredictionApiKeyRegistration predictionApiKeyRegistration =
+ * PredictionApiKeyRegistration.newBuilder().build();
+ * PredictionApiKeyRegistration response =
+ * predictionApiKeyRegistryClient.createPredictionApiKeyRegistration(
+ * parent, predictionApiKeyRegistration);
+ * }
+ * }
+ *
* ======================= PredictionServiceClient ======================= * *
Service Description: Service for making recommendation prediction. * *
Sample for PredictionServiceClient: * + *
{@code
+ * try (PredictionServiceClient predictionServiceClient = PredictionServiceClient.create()) {
+ * PlacementName name =
+ * PlacementName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]", "[PLACEMENT]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * for (PredictResponse.PredictionResult element :
+ * predictionServiceClient.predict(name, userEvent).iterateAll()) {
+ * // doThingsWith(element);
+ * }
+ * }
+ * }
+ *
* ======================= UserEventServiceClient ======================= * *
Service Description: Service for ingesting end user actions on the customer website. * *
Sample for UserEventServiceClient: + * + *
{@code
+ * try (UserEventServiceClient userEventServiceClient = UserEventServiceClient.create()) {
+ * EventStoreName parent =
+ * EventStoreName.of("[PROJECT]", "[LOCATION]", "[CATALOG]", "[EVENT_STORE]");
+ * UserEvent userEvent = UserEvent.newBuilder().build();
+ * UserEvent response = userEventServiceClient.writeUserEvent(parent, userEvent);
+ * }
+ * }
*/
@Generated("by gapic-generator-java")
package com.google.cloud.recommendationengine.v1beta1;
diff --git a/synth.metadata b/synth.metadata
index 8f096b23..fcad8f70 100644
--- a/synth.metadata
+++ b/synth.metadata
@@ -4,15 +4,15 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-recommendations-ai.git",
- "sha": "eae362bb95b83bf8ed7f2472bc92a491832538ad"
+ "sha": "dc72bc0ed0f19ca40656ef02d5b551a3292aae54"
}
},
{
"git": {
"name": "googleapis",
"remote": "https://github.com/googleapis/googleapis.git",
- "sha": "91e206bcfeaf8948ea03fe3cb1b7616108496cd3",
- "internalRef": "350949863"
+ "sha": "8d8c008e56f1af31d57f75561e0f1848ffb29eeb",
+ "internalRef": "356341083"
}
},
{