com.google.cloud.documentai.v1beta3

Class DocumentServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<DocumentServiceSettings>

com.google.cloud.documentai.v1beta3.DocumentServiceSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class DocumentServiceSettings
extends com.google.api.gax.rpc.ClientSettings<DocumentServiceSettings>

Settings class to configure an instance of DocumentServiceClient.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getDocument:

 // 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
 DocumentServiceSettings.Builder documentServiceSettingsBuilder =
     DocumentServiceSettings.newBuilder();
 documentServiceSettingsBuilder
     .getDocumentSettings()
     .setRetrySettings(
         documentServiceSettingsBuilder
             .getDocumentSettings()
             .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());
 DocumentServiceSettings documentServiceSettings = documentServiceSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) 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 updateDataset:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentServiceSettings.Builder Builder for DocumentServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentServiceSettings(DocumentServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.OperationCallSettings<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>	batchDeleteDocumentsOperationSettings() Returns the object with the settings used for calls to batchDeleteDocuments.
com.google.api.gax.rpc.UnaryCallSettings<BatchDeleteDocumentsRequest,com.google.longrunning.Operation>	batchDeleteDocumentsSettings() Returns the object with the settings used for calls to batchDeleteDocuments.
static DocumentServiceSettings	create(DocumentServiceStubSettings stub)
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.UnaryCallSettings<GetDatasetSchemaRequest,DatasetSchema>	getDatasetSchemaSettings() Returns the object with the settings used for calls to getDatasetSchema.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,GetDocumentResponse>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
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.OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata>	importDocumentsOperationSettings() Returns the object with the settings used for calls to importDocuments.
com.google.api.gax.rpc.UnaryCallSettings<ImportDocumentsRequest,com.google.longrunning.Operation>	importDocumentsSettings() Returns the object with the settings used for calls to importDocuments.
com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentServiceClient.ListDocumentsPagedResponse>	listDocumentsSettings() Returns the object with the settings used for calls to listDocuments.
com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DocumentServiceClient.ListLocationsPagedResponse>	listLocationsSettings() Returns the object with the settings used for calls to listLocations.
static DocumentServiceSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DocumentServiceSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static DocumentServiceSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
DocumentServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata>	updateDatasetOperationSettings() Returns the object with the settings used for calls to updateDataset.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDatasetSchemaRequest,DatasetSchema>	updateDatasetSchemaSettings() Returns the object with the settings used for calls to updateDatasetSchema.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDatasetRequest,com.google.longrunning.Operation>	updateDatasetSettings() Returns the object with the settings used for calls to updateDataset.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentServiceSettings

protected DocumentServiceSettings(DocumentServiceSettings.Builder settingsBuilder)
                           throws IOException

Throws:

IOException

Method Detail

updateDatasetSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDatasetRequest,com.google.longrunning.Operation> updateDatasetSettings()

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

updateDatasetOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata> updateDatasetOperationSettings()

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

importDocumentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<ImportDocumentsRequest,com.google.longrunning.Operation> importDocumentsSettings()

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

importDocumentsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsOperationSettings()

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

getDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,GetDocumentResponse> getDocumentSettings()

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

listDocumentsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentServiceClient.ListDocumentsPagedResponse> listDocumentsSettings()

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

batchDeleteDocumentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchDeleteDocumentsRequest,com.google.longrunning.Operation> batchDeleteDocumentsSettings()

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

batchDeleteDocumentsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata> batchDeleteDocumentsOperationSettings()

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

getDatasetSchemaSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDatasetSchemaRequest,DatasetSchema> getDatasetSchemaSettings()

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

updateDatasetSchemaSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDatasetSchemaRequest,DatasetSchema> updateDatasetSchemaSettings()

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

listLocationsSettings

public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,DocumentServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

getLocationSettings

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

create

public static final DocumentServiceSettings create(DocumentServiceStubSettings stub)
                                            throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static DocumentServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static DocumentServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

public static DocumentServiceSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public DocumentServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<DocumentServiceSettings>