Package com.google.cloud.documentai.v1beta3

Class DocumentProcessorServiceSettings

  • @BetaApi
@Generated("by gapic-generator-java")
public class DocumentProcessorServiceSettings
extends com.google.api.gax.rpc.ClientSettings<DocumentProcessorServiceSettings>
    Settings class to configure an instance of DocumentProcessorServiceClient.

    The default instance has everything set to sensible defaults:

    • The default service address (documentai.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 processDocument 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
 DocumentProcessorServiceSettings.Builder documentProcessorServiceSettingsBuilder =
     DocumentProcessorServiceSettings.newBuilder();
 documentProcessorServiceSettingsBuilder
     .processDocumentSettings()
     .setRetrySettings(
         documentProcessorServiceSettingsBuilder
             .processDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentProcessorServiceSettings documentProcessorServiceSettings =
     documentProcessorServiceSettingsBuilder.build();

    • Method Detail

      • processDocumentSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ProcessRequest,​ProcessResponse> processDocumentSettings()
        Returns the object with the settings used for calls to processDocument.

      • batchProcessDocumentsSettings

        public com.google.api.gax.rpc.UnaryCallSettings<BatchProcessRequest,​com.google.longrunning.Operation> batchProcessDocumentsSettings()
        Returns the object with the settings used for calls to batchProcessDocuments.

      • getProcessorTypeSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorTypeRequest,​ProcessorType> getProcessorTypeSettings()
        Returns the object with the settings used for calls to getProcessorType.

      • getProcessorSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorRequest,​Processor> getProcessorSettings()
        Returns the object with the settings used for calls to getProcessor.

      • trainProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<TrainProcessorVersionRequest,​com.google.longrunning.Operation> trainProcessorVersionSettings()
        Returns the object with the settings used for calls to trainProcessorVersion.

      • getProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorVersionRequest,​ProcessorVersion> getProcessorVersionSettings()
        Returns the object with the settings used for calls to getProcessorVersion.

      • deleteProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorVersionRequest,​com.google.longrunning.Operation> deleteProcessorVersionSettings()
        Returns the object with the settings used for calls to deleteProcessorVersion.

      • deleteProcessorVersionOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorVersionRequest,​com.google.protobuf.Empty,​DeleteProcessorVersionMetadata> deleteProcessorVersionOperationSettings()
        Returns the object with the settings used for calls to deleteProcessorVersion.

      • deployProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeployProcessorVersionRequest,​com.google.longrunning.Operation> deployProcessorVersionSettings()
        Returns the object with the settings used for calls to deployProcessorVersion.

      • undeployProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UndeployProcessorVersionRequest,​com.google.longrunning.Operation> undeployProcessorVersionSettings()
        Returns the object with the settings used for calls to undeployProcessorVersion.

      • createProcessorSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateProcessorRequest,​Processor> createProcessorSettings()
        Returns the object with the settings used for calls to createProcessor.

      • deleteProcessorSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorRequest,​com.google.longrunning.Operation> deleteProcessorSettings()
        Returns the object with the settings used for calls to deleteProcessor.

      • deleteProcessorOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorRequest,​com.google.protobuf.Empty,​DeleteProcessorMetadata> deleteProcessorOperationSettings()
        Returns the object with the settings used for calls to deleteProcessor.

      • enableProcessorSettings

        public com.google.api.gax.rpc.UnaryCallSettings<EnableProcessorRequest,​com.google.longrunning.Operation> enableProcessorSettings()
        Returns the object with the settings used for calls to enableProcessor.

      • disableProcessorSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DisableProcessorRequest,​com.google.longrunning.Operation> disableProcessorSettings()
        Returns the object with the settings used for calls to disableProcessor.

      • setDefaultProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<SetDefaultProcessorVersionRequest,​com.google.longrunning.Operation> setDefaultProcessorVersionSettings()
        Returns the object with the settings used for calls to setDefaultProcessorVersion.

      • reviewDocumentSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ReviewDocumentRequest,​com.google.longrunning.Operation> reviewDocumentSettings()
        Returns the object with the settings used for calls to reviewDocument.

      • evaluateProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<EvaluateProcessorVersionRequest,​com.google.longrunning.Operation> evaluateProcessorVersionSettings()
        Returns the object with the settings used for calls to evaluateProcessorVersion.

      • getEvaluationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetEvaluationRequest,​Evaluation> getEvaluationSettings()
        Returns the object with the settings used for calls to getEvaluation.

      • importProcessorVersionSettings

        public com.google.api.gax.rpc.UnaryCallSettings<ImportProcessorVersionRequest,​com.google.longrunning.Operation> importProcessorVersionSettings()
        Returns the object with the settings used for calls to importProcessorVersion.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​DocumentProcessorServiceClient.ListLocationsPagedResponse> listLocationsSettings()
        Returns the object with the settings used for calls to listLocations.

      • getLocationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationSettings()
        Returns the object with the settings used for calls to getLocation.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
        Returns a builder for the default ExecutorProvider for this service.

      • getDefaultEndpoint

        public static String getDefaultEndpoint()
        Returns the default service endpoint.

      • getDefaultServiceScopes

        public static List<String> getDefaultServiceScopes()
        Returns the default service scopes.

      • defaultCredentialsProviderBuilder

        public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
        Returns a builder for the default credentials for this service.

      • defaultGrpcTransportProviderBuilder

        public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
        Returns a builder for the default gRPC ChannelProvider for this service.

      • defaultHttpJsonTransportProviderBuilder

        @BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
        Returns a builder for the default REST ChannelProvider for this service.

      • defaultTransportChannelProvider

        public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

      • defaultApiClientHeaderProviderBuilder

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()