- 2.52.0 (latest)
- 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.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();
Static Methods
create(DocumentProcessorServiceStubSettings stub)
public static final DocumentProcessorServiceSettings create(DocumentProcessorServiceStubSettings stub)
Name | Description |
stub | DocumentProcessorServiceStubSettings |
Type | Description |
DocumentProcessorServiceSettings |
Type | Description |
IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Type | Description |
Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
Type | Description |
Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
Type | Description |
Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
Type | Description |
Builder |
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
Type | Description |
Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Type | Description |
TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
Type | Description |
String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
Type | Description |
List<String> |
newBuilder()
public static DocumentProcessorServiceSettings.Builder newBuilder()
Returns a new gRPC builder for this class.
Type | Description |
DocumentProcessorServiceSettings.Builder |
newBuilder(ClientContext clientContext)
public static DocumentProcessorServiceSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Name | Description |
clientContext | ClientContext |
Type | Description |
DocumentProcessorServiceSettings.Builder |
newHttpJsonBuilder()
public static DocumentProcessorServiceSettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Type | Description |
DocumentProcessorServiceSettings.Builder |
Constructors
DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder)
protected DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder)
Name | Description |
settingsBuilder | DocumentProcessorServiceSettings.Builder |
Methods
batchProcessDocumentsOperationSettings()
public OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationSettings()
Returns the object with the settings used for calls to batchProcessDocuments.
Type | Description |
OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> |
batchProcessDocumentsSettings()
public UnaryCallSettings<BatchProcessRequest,Operation> batchProcessDocumentsSettings()
Returns the object with the settings used for calls to batchProcessDocuments.
Type | Description |
UnaryCallSettings<BatchProcessRequest,Operation> |
createProcessorSettings()
public UnaryCallSettings<CreateProcessorRequest,Processor> createProcessorSettings()
Returns the object with the settings used for calls to createProcessor.
Type | Description |
UnaryCallSettings<CreateProcessorRequest,Processor> |
deleteProcessorOperationSettings()
public OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> deleteProcessorOperationSettings()
Returns the object with the settings used for calls to deleteProcessor.
Type | Description |
OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> |
deleteProcessorSettings()
public UnaryCallSettings<DeleteProcessorRequest,Operation> deleteProcessorSettings()
Returns the object with the settings used for calls to deleteProcessor.
Type | Description |
UnaryCallSettings<DeleteProcessorRequest,Operation> |
deleteProcessorVersionOperationSettings()
public OperationCallSettings<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionOperationSettings()
Returns the object with the settings used for calls to deleteProcessorVersion.
Type | Description |
OperationCallSettings<DeleteProcessorVersionRequest,Empty,DeleteProcessorVersionMetadata> |
deleteProcessorVersionSettings()
public UnaryCallSettings<DeleteProcessorVersionRequest,Operation> deleteProcessorVersionSettings()
Returns the object with the settings used for calls to deleteProcessorVersion.
Type | Description |
UnaryCallSettings<DeleteProcessorVersionRequest,Operation> |
deployProcessorVersionOperationSettings()
public OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionOperationSettings()
Returns the object with the settings used for calls to deployProcessorVersion.
Type | Description |
OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
deployProcessorVersionSettings()
public UnaryCallSettings<DeployProcessorVersionRequest,Operation> deployProcessorVersionSettings()
Returns the object with the settings used for calls to deployProcessorVersion.
Type | Description |
UnaryCallSettings<DeployProcessorVersionRequest,Operation> |
disableProcessorOperationSettings()
public OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationSettings()
Returns the object with the settings used for calls to disableProcessor.
Type | Description |
OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> |
disableProcessorSettings()
public UnaryCallSettings<DisableProcessorRequest,Operation> disableProcessorSettings()
Returns the object with the settings used for calls to disableProcessor.
Type | Description |
UnaryCallSettings<DisableProcessorRequest,Operation> |
enableProcessorOperationSettings()
public OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationSettings()
Returns the object with the settings used for calls to enableProcessor.
Type | Description |
OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> |
enableProcessorSettings()
public UnaryCallSettings<EnableProcessorRequest,Operation> enableProcessorSettings()
Returns the object with the settings used for calls to enableProcessor.
Type | Description |
UnaryCallSettings<EnableProcessorRequest,Operation> |
evaluateProcessorVersionOperationSettings()
public OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionOperationSettings()
Returns the object with the settings used for calls to evaluateProcessorVersion.
Type | Description |
OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> |
evaluateProcessorVersionSettings()
public UnaryCallSettings<EvaluateProcessorVersionRequest,Operation> evaluateProcessorVersionSettings()
Returns the object with the settings used for calls to evaluateProcessorVersion.
Type | Description |
UnaryCallSettings<EvaluateProcessorVersionRequest,Operation> |
fetchProcessorTypesSettings()
public UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesSettings()
Returns the object with the settings used for calls to fetchProcessorTypes.
Type | Description |
UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> |
getEvaluationSettings()
public UnaryCallSettings<GetEvaluationRequest,Evaluation> getEvaluationSettings()
Returns the object with the settings used for calls to getEvaluation.
Type | Description |
UnaryCallSettings<GetEvaluationRequest,Evaluation> |
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()
Returns the object with the settings used for calls to getLocation.
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.
Type | Description |
UnaryCallSettings<GetProcessorRequest,Processor> |
getProcessorTypeSettings()
public UnaryCallSettings<GetProcessorTypeRequest,ProcessorType> getProcessorTypeSettings()
Returns the object with the settings used for calls to getProcessorType.
Type | Description |
UnaryCallSettings<GetProcessorTypeRequest,ProcessorType> |
getProcessorVersionSettings()
public UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion> getProcessorVersionSettings()
Returns the object with the settings used for calls to getProcessorVersion.
Type | Description |
UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion> |
listEvaluationsSettings()
public PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse,DocumentProcessorServiceClient.ListEvaluationsPagedResponse> listEvaluationsSettings()
Returns the object with the settings used for calls to listEvaluations.
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.
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.
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.
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.
Type | Description |
PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,ListProcessorsPagedResponse> |
processDocumentSettings()
public UnaryCallSettings<ProcessRequest,ProcessResponse> processDocumentSettings()
Returns the object with the settings used for calls to processDocument.
Type | Description |
UnaryCallSettings<ProcessRequest,ProcessResponse> |
reviewDocumentOperationSettings()
public OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationSettings()
Returns the object with the settings used for calls to reviewDocument.
Type | Description |
OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
reviewDocumentSettings()
public UnaryCallSettings<ReviewDocumentRequest,Operation> reviewDocumentSettings()
Returns the object with the settings used for calls to reviewDocument.
Type | Description |
UnaryCallSettings<ReviewDocumentRequest,Operation> |
setDefaultProcessorVersionOperationSettings()
public OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationSettings()
Returns the object with the settings used for calls to setDefaultProcessorVersion.
Type | Description |
OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> |
setDefaultProcessorVersionSettings()
public UnaryCallSettings<SetDefaultProcessorVersionRequest,Operation> setDefaultProcessorVersionSettings()
Returns the object with the settings used for calls to setDefaultProcessorVersion.
Type | Description |
UnaryCallSettings<SetDefaultProcessorVersionRequest,Operation> |
toBuilder()
public DocumentProcessorServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Type | Description |
DocumentProcessorServiceSettings.Builder |
trainProcessorVersionOperationSettings()
public OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionOperationSettings()
Returns the object with the settings used for calls to trainProcessorVersion.
Type | Description |
OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> |
trainProcessorVersionSettings()
public UnaryCallSettings<TrainProcessorVersionRequest,Operation> trainProcessorVersionSettings()
Returns the object with the settings used for calls to trainProcessorVersion.
Type | Description |
UnaryCallSettings<TrainProcessorVersionRequest,Operation> |
undeployProcessorVersionOperationSettings()
public OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionOperationSettings()
Returns the object with the settings used for calls to undeployProcessorVersion.
Type | Description |
OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |
undeployProcessorVersionSettings()
public UnaryCallSettings<UndeployProcessorVersionRequest,Operation> undeployProcessorVersionSettings()
Returns the object with the settings used for calls to undeployProcessorVersion.
Type | Description |
UnaryCallSettings<UndeployProcessorVersionRequest,Operation> |