Class DocumentProcessorServiceSettings (2.46.0)

Version 2.46.0

• 2.47.0 (latest)
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.41.0
• 2.40.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.28.0
• 2.27.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.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.5
• 2.6.2
• 2.5.1
• 2.4.3
• 2.3.1
• 2.2.1
• 2.1.9

public class DocumentProcessorServiceSettings extends 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();
 

Inheritance

java.lang.Object > ClientSettings > DocumentProcessorServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getUniverseDomain()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(DocumentProcessorServiceStubSettings stub)

public static final DocumentProcessorServiceSettings create(DocumentProcessorServiceStubSettings stub)

Parameter
Name	Description
stub	DocumentProcessorServiceStubSettings

Returns
Type	Description
DocumentProcessorServiceSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns
Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type	Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Beta

This feature 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.

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns
Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type	Description
List<String>

newBuilder()

public static DocumentProcessorServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
DocumentProcessorServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentProcessorServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
DocumentProcessorServiceSettings.Builder

newHttpJsonBuilder()

public static DocumentProcessorServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
DocumentProcessorServiceSettings.Builder

Constructors

DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder)

protected DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	DocumentProcessorServiceSettings.Builder

Methods

batchProcessDocumentsOperationSettings()

public OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationSettings()

Returns the object with the settings used for calls to batchProcessDocuments.

Returns
Type	Description
OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata>

batchProcessDocumentsSettings()

public UnaryCallSettings<BatchProcessRequest,Operation> batchProcessDocumentsSettings()

Returns the object with the settings used for calls to batchProcessDocuments.

Returns
Type	Description
UnaryCallSettings<BatchProcessRequest,Operation>

createProcessorSettings()

public UnaryCallSettings<CreateProcessorRequest,Processor> createProcessorSettings()

Returns the object with the settings used for calls to createProcessor.

Returns
Type	Description
UnaryCallSettings<CreateProcessorRequest,Processor>

deleteProcessorOperationSettings()

public OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> deleteProcessorOperationSettings()

Returns the object with the settings used for calls to deleteProcessor.

Returns
Type	Description
OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata>

deleteProcessorSettings()

public UnaryCallSettings<DeleteProcessorRequest,Operation> deleteProcessorSettings()

Returns the object with the settings used for calls to deleteProcessor.

Returns
Type	Description
UnaryCallSettings<DeleteProcessorRequest,Operation>

deleteProcessorVersionOperationSettings()

public OperationCallSettings<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionOperationSettings()

Returns the object with the settings used for calls to deleteProcessorVersion.

Returns
Type	Description
OperationCallSettings<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata>

deleteProcessorVersionSettings()

public UnaryCallSettings<DeleteProcessorVersionRequest,Operation> deleteProcessorVersionSettings()

Returns the object with the settings used for calls to deleteProcessorVersion.

Returns
Type	Description
UnaryCallSettings<DeleteProcessorVersionRequest,Operation>

deployProcessorVersionOperationSettings()

public OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionOperationSettings()

Returns the object with the settings used for calls to deployProcessorVersion.

Returns
Type	Description
OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata>

deployProcessorVersionSettings()

public UnaryCallSettings<DeployProcessorVersionRequest,Operation> deployProcessorVersionSettings()

Returns the object with the settings used for calls to deployProcessorVersion.

Returns
Type	Description
UnaryCallSettings<DeployProcessorVersionRequest,Operation>

disableProcessorOperationSettings()

public OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationSettings()

Returns the object with the settings used for calls to disableProcessor.

Returns
Type	Description
OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata>

disableProcessorSettings()

public UnaryCallSettings<DisableProcessorRequest,Operation> disableProcessorSettings()

Returns the object with the settings used for calls to disableProcessor.

Returns
Type	Description
UnaryCallSettings<DisableProcessorRequest,Operation>

enableProcessorOperationSettings()

public OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationSettings()

Returns the object with the settings used for calls to enableProcessor.

Returns
Type	Description
OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata>

enableProcessorSettings()

public UnaryCallSettings<EnableProcessorRequest,Operation> enableProcessorSettings()

Returns the object with the settings used for calls to enableProcessor.

Returns
Type	Description
UnaryCallSettings<EnableProcessorRequest,Operation>

evaluateProcessorVersionOperationSettings()

public OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionOperationSettings()

Returns the object with the settings used for calls to evaluateProcessorVersion.

Returns
Type	Description
OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata>

evaluateProcessorVersionSettings()

public UnaryCallSettings<EvaluateProcessorVersionRequest,Operation> evaluateProcessorVersionSettings()

Returns the object with the settings used for calls to evaluateProcessorVersion.

Returns
Type	Description
UnaryCallSettings<EvaluateProcessorVersionRequest,Operation>

fetchProcessorTypesSettings()

public UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesSettings()

Returns the object with the settings used for calls to fetchProcessorTypes.

Returns
Type	Description
UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse>

getEvaluationSettings()

public UnaryCallSettings<GetEvaluationRequest,Evaluation> getEvaluationSettings()

Returns the object with the settings used for calls to getEvaluation.

Returns
Type	Description
UnaryCallSettings<GetEvaluationRequest,Evaluation>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

Returns the object with the settings used for calls to getLocation.

Returns
Type	Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getProcessorSettings()

public UnaryCallSettings<GetProcessorRequest,Processor> getProcessorSettings()

Returns the object with the settings used for calls to getProcessor.

Returns
Type	Description
UnaryCallSettings<GetProcessorRequest,Processor>

getProcessorTypeSettings()

public UnaryCallSettings<GetProcessorTypeRequest,ProcessorType> getProcessorTypeSettings()

Returns the object with the settings used for calls to getProcessorType.

Returns
Type	Description
UnaryCallSettings<GetProcessorTypeRequest,ProcessorType>

getProcessorVersionSettings()

public UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion> getProcessorVersionSettings()

Returns the object with the settings used for calls to getProcessorVersion.

Returns
Type	Description
UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion>

listEvaluationsSettings()

public PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse,DocumentProcessorServiceClient.ListEvaluationsPagedResponse> listEvaluationsSettings()

Returns the object with the settings used for calls to listEvaluations.

Returns
Type	Description
PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse,ListEvaluationsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DocumentProcessorServiceClient.ListLocationsPagedResponse> listLocationsSettings()

Returns the object with the settings used for calls to listLocations.

Returns
Type	Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listProcessorTypesSettings()

public PagedCallSettings<ListProcessorTypesRequest,ListProcessorTypesResponse,DocumentProcessorServiceClient.ListProcessorTypesPagedResponse> listProcessorTypesSettings()

Returns the object with the settings used for calls to listProcessorTypes.

Returns
Type	Description
PagedCallSettings<ListProcessorTypesRequest,ListProcessorTypesResponse,ListProcessorTypesPagedResponse>

listProcessorVersionsSettings()

public PagedCallSettings<ListProcessorVersionsRequest,ListProcessorVersionsResponse,DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse> listProcessorVersionsSettings()

Returns the object with the settings used for calls to listProcessorVersions.

Returns
Type	Description
PagedCallSettings<ListProcessorVersionsRequest,ListProcessorVersionsResponse,ListProcessorVersionsPagedResponse>

listProcessorsSettings()

public PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,DocumentProcessorServiceClient.ListProcessorsPagedResponse> listProcessorsSettings()

Returns the object with the settings used for calls to listProcessors.

Returns
Type	Description
PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,ListProcessorsPagedResponse>

processDocumentSettings()

public UnaryCallSettings<ProcessRequest,ProcessResponse> processDocumentSettings()

Returns the object with the settings used for calls to processDocument.

Returns
Type	Description
UnaryCallSettings<ProcessRequest,ProcessResponse>

reviewDocumentOperationSettings()

public OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationSettings()

Returns the object with the settings used for calls to reviewDocument.

Returns
Type	Description
OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata>

reviewDocumentSettings()

public UnaryCallSettings<ReviewDocumentRequest,Operation> reviewDocumentSettings()

Returns the object with the settings used for calls to reviewDocument.

Returns
Type	Description
UnaryCallSettings<ReviewDocumentRequest,Operation>

setDefaultProcessorVersionOperationSettings()

public OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationSettings()

Returns the object with the settings used for calls to setDefaultProcessorVersion.

Returns
Type	Description
OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata>

setDefaultProcessorVersionSettings()

public UnaryCallSettings<SetDefaultProcessorVersionRequest,Operation> setDefaultProcessorVersionSettings()

Returns the object with the settings used for calls to setDefaultProcessorVersion.

Returns
Type	Description
UnaryCallSettings<SetDefaultProcessorVersionRequest,Operation>

toBuilder()

public DocumentProcessorServiceSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
DocumentProcessorServiceSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

trainProcessorVersionOperationSettings()

public OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionOperationSettings()

Returns the object with the settings used for calls to trainProcessorVersion.

Returns
Type	Description
OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata>

trainProcessorVersionSettings()

public UnaryCallSettings<TrainProcessorVersionRequest,Operation> trainProcessorVersionSettings()

Returns the object with the settings used for calls to trainProcessorVersion.

Returns
Type	Description
UnaryCallSettings<TrainProcessorVersionRequest,Operation>

undeployProcessorVersionOperationSettings()

public OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionOperationSettings()

Returns the object with the settings used for calls to undeployProcessorVersion.

Returns
Type	Description
OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata>

undeployProcessorVersionSettings()

public UnaryCallSettings<UndeployProcessorVersionRequest,Operation> undeployProcessorVersionSettings()

Returns the object with the settings used for calls to undeployProcessorVersion.

Returns
Type	Description
UnaryCallSettings<UndeployProcessorVersionRequest,Operation>