Class DocumentUnderstandingServiceSettings (2.55.0) 

public class DocumentUnderstandingServiceSettings extends ClientSettings<DocumentUnderstandingServiceSettings>

Settings class to configure an instance of DocumentUnderstandingServiceClient.

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 RetrySettings of 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
 DocumentUnderstandingServiceSettings.Builder documentUnderstandingServiceSettingsBuilder =
     DocumentUnderstandingServiceSettings.newBuilder();
 documentUnderstandingServiceSettingsBuilder
     .batchProcessDocumentsSettings()
     .setRetrySettings(
         documentUnderstandingServiceSettingsBuilder
             .batchProcessDocumentsSettings()
             .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());
 DocumentUnderstandingServiceSettings documentUnderstandingServiceSettings =
     documentUnderstandingServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

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
 DocumentUnderstandingServiceSettings.Builder documentUnderstandingServiceSettingsBuilder =
     DocumentUnderstandingServiceSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 documentUnderstandingServiceSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > DocumentUnderstandingServiceSettings

Static Methods

create(DocumentUnderstandingServiceStubSettings stub)

public static final DocumentUnderstandingServiceSettings create(DocumentUnderstandingServiceStubSettings stub)
Parameter
Name Description
stub DocumentUnderstandingServiceStubSettings
Returns
Type Description
DocumentUnderstandingServiceSettings
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 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 DocumentUnderstandingServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
DocumentUnderstandingServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentUnderstandingServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
DocumentUnderstandingServiceSettings.Builder

Constructors

DocumentUnderstandingServiceSettings(DocumentUnderstandingServiceSettings.Builder settingsBuilder)

protected DocumentUnderstandingServiceSettings(DocumentUnderstandingServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder DocumentUnderstandingServiceSettings.Builder

Methods

batchProcessDocumentsOperationSettings()

public OperationCallSettings<BatchProcessDocumentsRequest,BatchProcessDocumentsResponse,OperationMetadata> batchProcessDocumentsOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchProcessDocumentsRequest,BatchProcessDocumentsResponse,OperationMetadata>

batchProcessDocumentsSettings()

public UnaryCallSettings<BatchProcessDocumentsRequest,Operation> batchProcessDocumentsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchProcessDocumentsRequest,Operation>

toBuilder()

public DocumentUnderstandingServiceSettings.Builder toBuilder()

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

Returns
Type Description
DocumentUnderstandingServiceSettings.Builder
Overrides