Package com.google.cloud.discoveryengine.v1beta.stub (0.23.0)

Version 0.23.0

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Beta

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

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 (discoveryengine.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.

ConversationalSearchServiceStub

Base stub class for the ConversationalSearchService service API.

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

ConversationalSearchServiceStubSettings

Settings class to configure an instance of ConversationalSearchServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.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 converseConversation 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
 ConversationalSearchServiceStubSettings.Builder conversationalSearchServiceSettingsBuilder =
     ConversationalSearchServiceStubSettings.newBuilder();
 conversationalSearchServiceSettingsBuilder
     .converseConversationSettings()
     .setRetrySettings(
         conversationalSearchServiceSettingsBuilder
             .converseConversationSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConversationalSearchServiceStubSettings conversationalSearchServiceSettings =
     conversationalSearchServiceSettingsBuilder.build();
 

ConversationalSearchServiceStubSettings.Builder

Builder for ConversationalSearchServiceStubSettings.

DocumentServiceStub

Base stub class for the DocumentService service API.

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

DocumentServiceStubSettings

Settings class to configure an instance of DocumentServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.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 getDocument 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
 DocumentServiceStubSettings.Builder documentServiceSettingsBuilder =
     DocumentServiceStubSettings.newBuilder();
 documentServiceSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         documentServiceSettingsBuilder
             .getDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentServiceStubSettings documentServiceSettings = documentServiceSettingsBuilder.build();
 

DocumentServiceStubSettings.Builder

Builder for DocumentServiceStubSettings.

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.

GrpcConversationalSearchServiceCallableFactory

gRPC callable factory implementation for the ConversationalSearchService service API.

This class is for advanced usage.

GrpcConversationalSearchServiceStub

gRPC stub implementation for the ConversationalSearchService service API.

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

GrpcDocumentServiceCallableFactory

gRPC callable factory implementation for the DocumentService service API.

This class is for advanced usage.

GrpcDocumentServiceStub

gRPC stub implementation for the DocumentService service API.

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

GrpcRecommendationServiceCallableFactory

gRPC callable factory implementation for the RecommendationService service API.

This class is for advanced usage.

GrpcRecommendationServiceStub

gRPC stub implementation for the RecommendationService service API.

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

GrpcSchemaServiceCallableFactory

gRPC callable factory implementation for the SchemaService service API.

This class is for advanced usage.

GrpcSchemaServiceStub

gRPC stub implementation for the SchemaService 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.

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.

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.

HttpJsonConversationalSearchServiceCallableFactory

REST callable factory implementation for the ConversationalSearchService service API.

This class is for advanced usage.

HttpJsonConversationalSearchServiceStub

REST stub implementation for the ConversationalSearchService service API.

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

HttpJsonDocumentServiceCallableFactory

REST callable factory implementation for the DocumentService service API.

This class is for advanced usage.

HttpJsonDocumentServiceStub

REST stub implementation for the DocumentService service API.

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

HttpJsonRecommendationServiceCallableFactory

REST callable factory implementation for the RecommendationService service API.

This class is for advanced usage.

HttpJsonRecommendationServiceStub

REST stub implementation for the RecommendationService service API.

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

HttpJsonSchemaServiceCallableFactory

REST callable factory implementation for the SchemaService service API.

This class is for advanced usage.

HttpJsonSchemaServiceStub

REST stub implementation for the SchemaService 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.

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.

RecommendationServiceStub

Base stub class for the RecommendationService service API.

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

RecommendationServiceStubSettings

Settings class to configure an instance of RecommendationServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.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 recommend 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
 RecommendationServiceStubSettings.Builder recommendationServiceSettingsBuilder =
     RecommendationServiceStubSettings.newBuilder();
 recommendationServiceSettingsBuilder
     .recommendSettings()
     .setRetrySettings(
         recommendationServiceSettingsBuilder
             .recommendSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 RecommendationServiceStubSettings recommendationServiceSettings =
     recommendationServiceSettingsBuilder.build();
 

RecommendationServiceStubSettings.Builder

Builder for RecommendationServiceStubSettings.

SchemaServiceStub

Base stub class for the SchemaService service API.

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

SchemaServiceStubSettings

Settings class to configure an instance of SchemaServiceStub.

The default instance has everything set to sensible defaults:

• The default service address (discoveryengine.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 getSchema 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
 SchemaServiceStubSettings.Builder schemaServiceSettingsBuilder =
     SchemaServiceStubSettings.newBuilder();
 schemaServiceSettingsBuilder
     .getSchemaSettings()
     .setRetrySettings(
         schemaServiceSettingsBuilder
             .getSchemaSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SchemaServiceStubSettings schemaServiceSettings = schemaServiceSettingsBuilder.build();
 

SchemaServiceStubSettings.Builder

Builder for SchemaServiceStubSettings.

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 (discoveryengine.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.

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 (discoveryengine.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.