Package com.google.cloud.retail.v2alpha.stub (2.21.0)

Version 2.21.0

• 2.55.0 (latest)
• 2.54.0
• 2.53.0
• 2.51.0
• 2.50.0
• 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

Alpha

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Classes

CatalogServiceStub

Base stub class for the CatalogService service API.

This class is for advanced usage and reflects the underlying API directly.

CatalogServiceStubSettings

Settings class to configure an instance of CatalogServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of updateCatalog to 30 seconds:

 // 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
 CatalogServiceStubSettings.Builder catalogServiceSettingsBuilder =
     CatalogServiceStubSettings.newBuilder();
 catalogServiceSettingsBuilder
     .updateCatalogSettings()
     .setRetrySettings(
         catalogServiceSettingsBuilder
             .updateCatalogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CatalogServiceStubSettings catalogServiceSettings = catalogServiceSettingsBuilder.build();
 

CatalogServiceStubSettings.Builder

Builder for CatalogServiceStubSettings.

CompletionServiceStub

Base stub class for the CompletionService service API.

This class is for advanced usage and reflects the underlying API directly.

CompletionServiceStubSettings

Settings class to configure an instance of CompletionServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of completeQuery to 30 seconds:

 // 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
 CompletionServiceStubSettings.Builder completionServiceSettingsBuilder =
     CompletionServiceStubSettings.newBuilder();
 completionServiceSettingsBuilder
     .completeQuerySettings()
     .setRetrySettings(
         completionServiceSettingsBuilder
             .completeQuerySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 CompletionServiceStubSettings completionServiceSettings =
     completionServiceSettingsBuilder.build();
 

CompletionServiceStubSettings.Builder

Builder for CompletionServiceStubSettings.

ControlServiceStub

Base stub class for the ControlService service API.

This class is for advanced usage and reflects the underlying API directly.

ControlServiceStubSettings

Settings class to configure an instance of ControlServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createControl to 30 seconds:

 // 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
 ControlServiceStubSettings.Builder controlServiceSettingsBuilder =
     ControlServiceStubSettings.newBuilder();
 controlServiceSettingsBuilder
     .createControlSettings()
     .setRetrySettings(
         controlServiceSettingsBuilder
             .createControlSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ControlServiceStubSettings controlServiceSettings = controlServiceSettingsBuilder.build();
 

ControlServiceStubSettings.Builder

Builder for ControlServiceStubSettings.

GrpcCatalogServiceCallableFactory

gRPC callable factory implementation for the CatalogService service API.

This class is for advanced usage.

GrpcCatalogServiceStub

gRPC stub implementation for the CatalogService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcCompletionServiceCallableFactory

gRPC callable factory implementation for the CompletionService service API.

This class is for advanced usage.

GrpcCompletionServiceStub

gRPC stub implementation for the CompletionService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcControlServiceCallableFactory

gRPC callable factory implementation for the ControlService service API.

This class is for advanced usage.

GrpcControlServiceStub

gRPC stub implementation for the ControlService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcMerchantCenterAccountLinkServiceCallableFactory

gRPC callable factory implementation for the MerchantCenterAccountLinkService service API.

This class is for advanced usage.

GrpcMerchantCenterAccountLinkServiceStub

gRPC stub implementation for the MerchantCenterAccountLinkService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcModelServiceCallableFactory

gRPC callable factory implementation for the ModelService service API.

This class is for advanced usage.

GrpcModelServiceStub

gRPC stub implementation for the ModelService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcPredictionServiceCallableFactory

gRPC callable factory implementation for the PredictionService service API.

This class is for advanced usage.

GrpcPredictionServiceStub

gRPC stub implementation for the PredictionService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcProductServiceCallableFactory

gRPC callable factory implementation for the ProductService service API.

This class is for advanced usage.

GrpcProductServiceStub

gRPC stub implementation for the ProductService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcSearchServiceCallableFactory

gRPC callable factory implementation for the SearchService service API.

This class is for advanced usage.

GrpcSearchServiceStub

gRPC stub implementation for the SearchService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcServingConfigServiceCallableFactory

gRPC callable factory implementation for the ServingConfigService service API.

This class is for advanced usage.

GrpcServingConfigServiceStub

gRPC stub implementation for the ServingConfigService service API.

This class is for advanced usage and reflects the underlying API directly.

GrpcUserEventServiceCallableFactory

gRPC callable factory implementation for the UserEventService service API.

This class is for advanced usage.

GrpcUserEventServiceStub

gRPC stub implementation for the UserEventService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonCatalogServiceCallableFactory

REST callable factory implementation for the CatalogService service API.

This class is for advanced usage.

HttpJsonCatalogServiceStub

REST stub implementation for the CatalogService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonCompletionServiceCallableFactory

REST callable factory implementation for the CompletionService service API.

This class is for advanced usage.

HttpJsonCompletionServiceStub

REST stub implementation for the CompletionService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonControlServiceCallableFactory

REST callable factory implementation for the ControlService service API.

This class is for advanced usage.

HttpJsonControlServiceStub

REST stub implementation for the ControlService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonMerchantCenterAccountLinkServiceCallableFactory

REST callable factory implementation for the MerchantCenterAccountLinkService service API.

This class is for advanced usage.

HttpJsonMerchantCenterAccountLinkServiceStub

REST stub implementation for the MerchantCenterAccountLinkService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonModelServiceCallableFactory

REST callable factory implementation for the ModelService service API.

This class is for advanced usage.

HttpJsonModelServiceStub

REST stub implementation for the ModelService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonPredictionServiceCallableFactory

REST callable factory implementation for the PredictionService service API.

This class is for advanced usage.

HttpJsonPredictionServiceStub

REST stub implementation for the PredictionService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonProductServiceCallableFactory

REST callable factory implementation for the ProductService service API.

This class is for advanced usage.

HttpJsonProductServiceStub

REST stub implementation for the ProductService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonSearchServiceCallableFactory

REST callable factory implementation for the SearchService service API.

This class is for advanced usage.

HttpJsonSearchServiceStub

REST stub implementation for the SearchService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonServingConfigServiceCallableFactory

REST callable factory implementation for the ServingConfigService service API.

This class is for advanced usage.

HttpJsonServingConfigServiceStub

REST stub implementation for the ServingConfigService service API.

This class is for advanced usage and reflects the underlying API directly.

HttpJsonUserEventServiceCallableFactory

REST callable factory implementation for the UserEventService service API.

This class is for advanced usage.

HttpJsonUserEventServiceStub

REST stub implementation for the UserEventService service API.

This class is for advanced usage and reflects the underlying API directly.

MerchantCenterAccountLinkServiceStub

Base stub class for the MerchantCenterAccountLinkService service API.

This class is for advanced usage and reflects the underlying API directly.

MerchantCenterAccountLinkServiceStubSettings

Settings class to configure an instance of MerchantCenterAccountLinkServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of listMerchantCenterAccountLinks to 30 seconds:

 // 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
 MerchantCenterAccountLinkServiceStubSettings.Builder
     merchantCenterAccountLinkServiceSettingsBuilder =
         MerchantCenterAccountLinkServiceStubSettings.newBuilder();
 merchantCenterAccountLinkServiceSettingsBuilder
     .listMerchantCenterAccountLinksSettings()
     .setRetrySettings(
         merchantCenterAccountLinkServiceSettingsBuilder
             .listMerchantCenterAccountLinksSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MerchantCenterAccountLinkServiceStubSettings merchantCenterAccountLinkServiceSettings =
     merchantCenterAccountLinkServiceSettingsBuilder.build();
 

MerchantCenterAccountLinkServiceStubSettings.Builder

Builder for MerchantCenterAccountLinkServiceStubSettings.

ModelServiceStub

Base stub class for the ModelService service API.

This class is for advanced usage and reflects the underlying API directly.

ModelServiceStubSettings

Settings class to configure an instance of ModelServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getModel to 30 seconds:

 // 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
 ModelServiceStubSettings.Builder modelServiceSettingsBuilder =
     ModelServiceStubSettings.newBuilder();
 modelServiceSettingsBuilder
     .getModelSettings()
     .setRetrySettings(
         modelServiceSettingsBuilder
             .getModelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ModelServiceStubSettings modelServiceSettings = modelServiceSettingsBuilder.build();
 

ModelServiceStubSettings.Builder

Builder for ModelServiceStubSettings.

PredictionServiceStub

Base stub class for the PredictionService service API.

This class is for advanced usage and reflects the underlying API directly.

PredictionServiceStubSettings

Settings class to configure an instance of PredictionServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of predict to 30 seconds:

 // 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
 PredictionServiceStubSettings.Builder predictionServiceSettingsBuilder =
     PredictionServiceStubSettings.newBuilder();
 predictionServiceSettingsBuilder
     .predictSettings()
     .setRetrySettings(
         predictionServiceSettingsBuilder
             .predictSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 PredictionServiceStubSettings predictionServiceSettings =
     predictionServiceSettingsBuilder.build();
 

PredictionServiceStubSettings.Builder

Builder for PredictionServiceStubSettings.

ProductServiceStub

Base stub class for the ProductService service API.

This class is for advanced usage and reflects the underlying API directly.

ProductServiceStubSettings

Settings class to configure an instance of ProductServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createProduct to 30 seconds:

 // 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
 ProductServiceStubSettings.Builder productServiceSettingsBuilder =
     ProductServiceStubSettings.newBuilder();
 productServiceSettingsBuilder
     .createProductSettings()
     .setRetrySettings(
         productServiceSettingsBuilder
             .createProductSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ProductServiceStubSettings productServiceSettings = productServiceSettingsBuilder.build();
 

ProductServiceStubSettings.Builder

Builder for ProductServiceStubSettings.

SearchServiceStub

Base stub class for the SearchService service API.

This class is for advanced usage and reflects the underlying API directly.

SearchServiceStubSettings

Settings class to configure an instance of SearchServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of search to 30 seconds:

 // 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
 SearchServiceStubSettings.Builder searchServiceSettingsBuilder =
     SearchServiceStubSettings.newBuilder();
 searchServiceSettingsBuilder
     .searchSettings()
     .setRetrySettings(
         searchServiceSettingsBuilder
             .searchSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SearchServiceStubSettings searchServiceSettings = searchServiceSettingsBuilder.build();
 

SearchServiceStubSettings.Builder

Builder for SearchServiceStubSettings.

ServingConfigServiceStub

Base stub class for the ServingConfigService service API.

This class is for advanced usage and reflects the underlying API directly.

ServingConfigServiceStubSettings

Settings class to configure an instance of ServingConfigServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createServingConfig to 30 seconds:

 // 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
 ServingConfigServiceStubSettings.Builder servingConfigServiceSettingsBuilder =
     ServingConfigServiceStubSettings.newBuilder();
 servingConfigServiceSettingsBuilder
     .createServingConfigSettings()
     .setRetrySettings(
         servingConfigServiceSettingsBuilder
             .createServingConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServingConfigServiceStubSettings servingConfigServiceSettings =
     servingConfigServiceSettingsBuilder.build();
 

ServingConfigServiceStubSettings.Builder

Builder for ServingConfigServiceStubSettings.

UserEventServiceStub

Base stub class for the UserEventService service API.

This class is for advanced usage and reflects the underlying API directly.

UserEventServiceStubSettings

Settings class to configure an instance of UserEventServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (retail.googleapis.com) and default port (443) are used.
• Credentials are acquired automatically through Application Default Credentials.
• Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of writeUserEvent to 30 seconds:

 // 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
 UserEventServiceStubSettings.Builder userEventServiceSettingsBuilder =
     UserEventServiceStubSettings.newBuilder();
 userEventServiceSettingsBuilder
     .writeUserEventSettings()
     .setRetrySettings(
         userEventServiceSettingsBuilder
             .writeUserEventSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 UserEventServiceStubSettings userEventServiceSettings = userEventServiceSettingsBuilder.build();
 

UserEventServiceStubSettings.Builder

Builder for UserEventServiceStubSettings.