- 2.58.0 (latest)
- 2.57.0
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.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.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:
DocumentProcessorServiceSettings.Builder documentProcessorServiceSettingsBuilder =
DocumentProcessorServiceSettings.newBuilder();
documentProcessorServiceSettingsBuilder
.processDocumentSettings()
.setRetrySettings(
documentProcessorServiceSettingsBuilder
.processDocumentSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
DocumentProcessorServiceSettings documentProcessorServiceSettings =
documentProcessorServiceSettingsBuilder.build();
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> |
create(DocumentProcessorServiceStubSettings stub)
public static final DocumentProcessorServiceSettings create(DocumentProcessorServiceStubSettings stub)
Name | Description |
stub | DocumentProcessorServiceStubSettings |
Type | Description |
DocumentProcessorServiceSettings |
Type | Description |
IOException |
createProcessorSettings()
public UnaryCallSettings<CreateProcessorRequest,Processor> createProcessorSettings()
Returns the object with the settings used for calls to createProcessor.
Type | Description |
UnaryCallSettings<CreateProcessorRequest,Processor> |
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 ChannelProvider for this service.
Type | Description |
Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Type | Description |
TransportChannelProvider |
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> |
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> |
fetchProcessorTypesSettings()
public UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesSettings()
Returns the object with the settings used for calls to fetchProcessorTypes.
Type | Description |
UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> |
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> |
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> |
newBuilder()
public static DocumentProcessorServiceSettings.Builder newBuilder()
Returns a new 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 |
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> |
toBuilder()
public DocumentProcessorServiceSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Type | Description |
DocumentProcessorServiceSettings.Builder |