Class DocumentUnderstandingServiceStubSettings (2.40.0) 

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

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static DocumentUnderstandingServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DocumentUnderstandingServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentUnderstandingServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DocumentUnderstandingServiceStubSettings.Builder

Constructors

DocumentUnderstandingServiceStubSettings(DocumentUnderstandingServiceStubSettings.Builder settingsBuilder)

protected DocumentUnderstandingServiceStubSettings(DocumentUnderstandingServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDocumentUnderstandingServiceStubSettings.Builder

Methods

batchProcessDocumentsOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<BatchProcessDocumentsRequest,BatchProcessDocumentsResponse,OperationMetadata>

batchProcessDocumentsSettings()

public UnaryCallSettings<BatchProcessDocumentsRequest,Operation> batchProcessDocumentsSettings()

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

Returns
TypeDescription
UnaryCallSettings<BatchProcessDocumentsRequest,Operation>

createStub()

public DocumentUnderstandingServiceStub createStub()
Returns
TypeDescription
DocumentUnderstandingServiceStub
Exceptions
TypeDescription
IOException

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
TypeDescription
String
Overrides

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

toBuilder()

public DocumentUnderstandingServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
DocumentUnderstandingServiceStubSettings.Builder
Overrides