@BetaApi @Generated(value="by gapic-generator-java") public class DocumentProcessorServiceSettings extends com.google.api.gax.rpc.ClientSettings<DocumentProcessorServiceSettings>
DocumentProcessorServiceClient.
The default instance has everything set to sensible defaults:
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of processDocument:
// 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()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
DocumentProcessorServiceSettings documentProcessorServiceSettings =
documentProcessorServiceSettingsBuilder.build();
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for batchProcessDocuments:
// 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();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
documentProcessorServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
| Modifier and Type | Class and Description |
|---|---|
static class |
DocumentProcessorServiceSettings.Builder
Builder for DocumentProcessorServiceSettings.
|
| Modifier | Constructor and Description |
|---|---|
protected |
DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder) |
| Modifier and Type | Method and Description |
|---|---|
com.google.api.gax.rpc.OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> |
batchProcessDocumentsOperationSettings()
Returns the object with the settings used for calls to batchProcessDocuments.
|
com.google.api.gax.rpc.UnaryCallSettings<BatchProcessRequest,com.google.longrunning.Operation> |
batchProcessDocumentsSettings()
Returns the object with the settings used for calls to batchProcessDocuments.
|
static DocumentProcessorServiceSettings |
create(DocumentProcessorServiceStubSettings stub) |
com.google.api.gax.rpc.UnaryCallSettings<CreateProcessorRequest,Processor> |
createProcessorSettings()
Returns the object with the settings used for calls to createProcessor.
|
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder |
defaultApiClientHeaderProviderBuilder() |
static com.google.api.gax.core.GoogleCredentialsProvider.Builder |
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
|
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder |
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
|
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder |
defaultGrpcTransportProviderBuilder()
Returns a builder for the default gRPC ChannelProvider for this service.
|
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder |
defaultHttpJsonTransportProviderBuilder()
Returns a builder for the default REST ChannelProvider for this service.
|
static com.google.api.gax.rpc.TransportChannelProvider |
defaultTransportChannelProvider() |
com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty,DeleteProcessorMetadata> |
deleteProcessorOperationSettings()
Returns the object with the settings used for calls to deleteProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorRequest,com.google.longrunning.Operation> |
deleteProcessorSettings()
Returns the object with the settings used for calls to deleteProcessor.
|
com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorVersionRequest,com.google.protobuf.Empty,DeleteProcessorVersionMetadata> |
deleteProcessorVersionOperationSettings()
Returns the object with the settings used for calls to deleteProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorVersionRequest,com.google.longrunning.Operation> |
deleteProcessorVersionSettings()
Returns the object with the settings used for calls to deleteProcessorVersion.
|
com.google.api.gax.rpc.OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> |
deployProcessorVersionOperationSettings()
Returns the object with the settings used for calls to deployProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<DeployProcessorVersionRequest,com.google.longrunning.Operation> |
deployProcessorVersionSettings()
Returns the object with the settings used for calls to deployProcessorVersion.
|
com.google.api.gax.rpc.OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> |
disableProcessorOperationSettings()
Returns the object with the settings used for calls to disableProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<DisableProcessorRequest,com.google.longrunning.Operation> |
disableProcessorSettings()
Returns the object with the settings used for calls to disableProcessor.
|
com.google.api.gax.rpc.OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> |
enableProcessorOperationSettings()
Returns the object with the settings used for calls to enableProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<EnableProcessorRequest,com.google.longrunning.Operation> |
enableProcessorSettings()
Returns the object with the settings used for calls to enableProcessor.
|
com.google.api.gax.rpc.OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> |
evaluateProcessorVersionOperationSettings()
Returns the object with the settings used for calls to evaluateProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<EvaluateProcessorVersionRequest,com.google.longrunning.Operation> |
evaluateProcessorVersionSettings()
Returns the object with the settings used for calls to evaluateProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> |
fetchProcessorTypesSettings()
Returns the object with the settings used for calls to fetchProcessorTypes.
|
static String |
getDefaultEndpoint()
Returns the default service endpoint.
|
static List<String> |
getDefaultServiceScopes()
Returns the default service scopes.
|
com.google.api.gax.rpc.UnaryCallSettings<GetEvaluationRequest,Evaluation> |
getEvaluationSettings()
Returns the object with the settings used for calls to getEvaluation.
|
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.
|
com.google.api.gax.rpc.UnaryCallSettings<GetProcessorRequest,Processor> |
getProcessorSettings()
Returns the object with the settings used for calls to getProcessor.
|
com.google.api.gax.rpc.UnaryCallSettings<GetProcessorTypeRequest,ProcessorType> |
getProcessorTypeSettings()
Returns the object with the settings used for calls to getProcessorType.
|
com.google.api.gax.rpc.UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion> |
getProcessorVersionSettings()
Returns the object with the settings used for calls to getProcessorVersion.
|
com.google.api.gax.rpc.OperationCallSettings<ImportProcessorVersionRequest,ImportProcessorVersionResponse,ImportProcessorVersionMetadata> |
importProcessorVersionOperationSettings()
Returns the object with the settings used for calls to importProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<ImportProcessorVersionRequest,com.google.longrunning.Operation> |
importProcessorVersionSettings()
Returns the object with the settings used for calls to importProcessorVersion.
|
com.google.api.gax.rpc.PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse,DocumentProcessorServiceClient.ListEvaluationsPagedResponse> |
listEvaluationsSettings()
Returns the object with the settings used for calls to listEvaluations.
|
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.
|
com.google.api.gax.rpc.PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,DocumentProcessorServiceClient.ListProcessorsPagedResponse> |
listProcessorsSettings()
Returns the object with the settings used for calls to listProcessors.
|
com.google.api.gax.rpc.PagedCallSettings<ListProcessorTypesRequest,ListProcessorTypesResponse,DocumentProcessorServiceClient.ListProcessorTypesPagedResponse> |
listProcessorTypesSettings()
Returns the object with the settings used for calls to listProcessorTypes.
|
com.google.api.gax.rpc.PagedCallSettings<ListProcessorVersionsRequest,ListProcessorVersionsResponse,DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse> |
listProcessorVersionsSettings()
Returns the object with the settings used for calls to listProcessorVersions.
|
static DocumentProcessorServiceSettings.Builder |
newBuilder()
Returns a new gRPC builder for this class.
|
static DocumentProcessorServiceSettings.Builder |
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
|
static DocumentProcessorServiceSettings.Builder |
newHttpJsonBuilder()
Returns a new REST builder for this class.
|
com.google.api.gax.rpc.UnaryCallSettings<ProcessRequest,ProcessResponse> |
processDocumentSettings()
Returns the object with the settings used for calls to processDocument.
|
com.google.api.gax.rpc.OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> |
reviewDocumentOperationSettings()
Returns the object with the settings used for calls to reviewDocument.
|
com.google.api.gax.rpc.UnaryCallSettings<ReviewDocumentRequest,com.google.longrunning.Operation> |
reviewDocumentSettings()
Returns the object with the settings used for calls to reviewDocument.
|
com.google.api.gax.rpc.OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> |
setDefaultProcessorVersionOperationSettings()
Returns the object with the settings used for calls to setDefaultProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<SetDefaultProcessorVersionRequest,com.google.longrunning.Operation> |
setDefaultProcessorVersionSettings()
Returns the object with the settings used for calls to setDefaultProcessorVersion.
|
DocumentProcessorServiceSettings.Builder |
toBuilder()
Returns a builder containing all the values of this settings class.
|
com.google.api.gax.rpc.OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> |
trainProcessorVersionOperationSettings()
Returns the object with the settings used for calls to trainProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<TrainProcessorVersionRequest,com.google.longrunning.Operation> |
trainProcessorVersionSettings()
Returns the object with the settings used for calls to trainProcessorVersion.
|
com.google.api.gax.rpc.OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> |
undeployProcessorVersionOperationSettings()
Returns the object with the settings used for calls to undeployProcessorVersion.
|
com.google.api.gax.rpc.UnaryCallSettings<UndeployProcessorVersionRequest,com.google.longrunning.Operation> |
undeployProcessorVersionSettings()
Returns the object with the settings used for calls to undeployProcessorVersion.
|
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toStringprotected DocumentProcessorServiceSettings(DocumentProcessorServiceSettings.Builder settingsBuilder) throws IOException
IOExceptionpublic com.google.api.gax.rpc.UnaryCallSettings<ProcessRequest,ProcessResponse> processDocumentSettings()
public com.google.api.gax.rpc.UnaryCallSettings<BatchProcessRequest,com.google.longrunning.Operation> batchProcessDocumentsSettings()
public com.google.api.gax.rpc.OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListProcessorTypesRequest,ListProcessorTypesResponse,DocumentProcessorServiceClient.ListProcessorTypesPagedResponse> listProcessorTypesSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorTypeRequest,ProcessorType> getProcessorTypeSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,DocumentProcessorServiceClient.ListProcessorsPagedResponse> listProcessorsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorRequest,Processor> getProcessorSettings()
public com.google.api.gax.rpc.UnaryCallSettings<TrainProcessorVersionRequest,com.google.longrunning.Operation> trainProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<TrainProcessorVersionRequest,TrainProcessorVersionResponse,TrainProcessorVersionMetadata> trainProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetProcessorVersionRequest,ProcessorVersion> getProcessorVersionSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListProcessorVersionsRequest,ListProcessorVersionsResponse,DocumentProcessorServiceClient.ListProcessorVersionsPagedResponse> listProcessorVersionsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorVersionRequest,com.google.longrunning.Operation> deleteProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorVersionRequest,com.google.protobuf.Empty,DeleteProcessorVersionMetadata> deleteProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeployProcessorVersionRequest,com.google.longrunning.Operation> deployProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeployProcessorVersionRequest,DeployProcessorVersionResponse,DeployProcessorVersionMetadata> deployProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<UndeployProcessorVersionRequest,com.google.longrunning.Operation> undeployProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<UndeployProcessorVersionRequest,UndeployProcessorVersionResponse,UndeployProcessorVersionMetadata> undeployProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<CreateProcessorRequest,Processor> createProcessorSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DeleteProcessorRequest,com.google.longrunning.Operation> deleteProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<DeleteProcessorRequest,com.google.protobuf.Empty,DeleteProcessorMetadata> deleteProcessorOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<EnableProcessorRequest,com.google.longrunning.Operation> enableProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<DisableProcessorRequest,com.google.longrunning.Operation> disableProcessorSettings()
public com.google.api.gax.rpc.OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<SetDefaultProcessorVersionRequest,com.google.longrunning.Operation> setDefaultProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<SetDefaultProcessorVersionRequest,SetDefaultProcessorVersionResponse,SetDefaultProcessorVersionMetadata> setDefaultProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<ReviewDocumentRequest,com.google.longrunning.Operation> reviewDocumentSettings()
public com.google.api.gax.rpc.OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<EvaluateProcessorVersionRequest,com.google.longrunning.Operation> evaluateProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<EvaluateProcessorVersionRequest,EvaluateProcessorVersionResponse,EvaluateProcessorVersionMetadata> evaluateProcessorVersionOperationSettings()
public com.google.api.gax.rpc.UnaryCallSettings<GetEvaluationRequest,Evaluation> getEvaluationSettings()
public com.google.api.gax.rpc.PagedCallSettings<ListEvaluationsRequest,ListEvaluationsResponse,DocumentProcessorServiceClient.ListEvaluationsPagedResponse> listEvaluationsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<ImportProcessorVersionRequest,com.google.longrunning.Operation> importProcessorVersionSettings()
public com.google.api.gax.rpc.OperationCallSettings<ImportProcessorVersionRequest,ImportProcessorVersionResponse,ImportProcessorVersionMetadata> importProcessorVersionOperationSettings()
public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DocumentProcessorServiceClient.ListLocationsPagedResponse> listLocationsSettings()
public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> getLocationSettings()
public static final DocumentProcessorServiceSettings create(DocumentProcessorServiceStubSettings stub) throws IOException
IOExceptionpublic static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
public static String getDefaultEndpoint()
public static List<String> getDefaultServiceScopes()
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
@BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
public static DocumentProcessorServiceSettings.Builder newBuilder()
public static DocumentProcessorServiceSettings.Builder newHttpJsonBuilder()
public static DocumentProcessorServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
public DocumentProcessorServiceSettings.Builder toBuilder()
toBuilder in class com.google.api.gax.rpc.ClientSettings<DocumentProcessorServiceSettings>Copyright © 2024 Google LLC. All rights reserved.