Class DocumentUnderstandingServiceStubSettings (2.37.0)

Version 2.37.0

• 2.59.0 (latest)
• 2.58.0
• 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

Beta

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

public class DocumentUnderstandingServiceStubSettings extends StubSettings<DocumentUnderstandingServiceStubSettings>

Settings class to configure an instance of DocumentUnderstandingServiceStub.

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 batchProcessDocuments 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
 DocumentUnderstandingServiceStubSettings.Builder documentUnderstandingServiceSettingsBuilder =
     DocumentUnderstandingServiceStubSettings.newBuilder();
 documentUnderstandingServiceSettingsBuilder
     .batchProcessDocumentsSettings()
     .setRetrySettings(
         documentUnderstandingServiceSettingsBuilder
             .batchProcessDocumentsSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentUnderstandingServiceStubSettings documentUnderstandingServiceSettings =
     documentUnderstandingServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > DocumentUnderstandingServiceStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.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

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Beta

The surface for customizing headers is not stable yet and may change in the future.

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
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

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 DocumentUnderstandingServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
DocumentUnderstandingServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentUnderstandingServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
DocumentUnderstandingServiceStubSettings.Builder

Constructors

DocumentUnderstandingServiceStubSettings(DocumentUnderstandingServiceStubSettings.Builder settingsBuilder)

protected DocumentUnderstandingServiceStubSettings(DocumentUnderstandingServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	DocumentUnderstandingServiceStubSettings.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>

createStub()

public DocumentUnderstandingServiceStub createStub()

Returns
Type	Description
DocumentUnderstandingServiceStub

Exceptions
Type	Description
IOException

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

toBuilder()

public DocumentUnderstandingServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
DocumentUnderstandingServiceStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()