Class DocumentServiceStubSettings (2.59.0)

public class DocumentServiceStubSettings extends StubSettings<DocumentServiceStubSettings>

Settings class to configure an instance of DocumentServiceStub.

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

Inheritance

java.lang.Object > StubSettings > DocumentServiceStubSettings

Inherited Members

StubSettings.getApiKey()

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.getStreamWatchdogCheckIntervalDuration()

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

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`

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns
Type	Description
`Builder`

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()

Returns
Type	Description
`Builder`

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 DocumentServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type	Description
`DocumentServiceStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static DocumentServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`DocumentServiceStubSettings.Builder`

newHttpJsonBuilder()

public static DocumentServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type	Description
`DocumentServiceStubSettings.Builder`

Constructors

DocumentServiceStubSettings(DocumentServiceStubSettings.Builder settingsBuilder)

protected DocumentServiceStubSettings(DocumentServiceStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`DocumentServiceStubSettings.Builder`

Methods

batchDeleteDocumentsOperationSettings()

public OperationCallSettings<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata> batchDeleteDocumentsOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<BatchDeleteDocumentsRequest,BatchDeleteDocumentsResponse,BatchDeleteDocumentsMetadata>`

batchDeleteDocumentsSettings()

public UnaryCallSettings<BatchDeleteDocumentsRequest,Operation> batchDeleteDocumentsSettings()

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

Returns
Type	Description
`UnaryCallSettings<BatchDeleteDocumentsRequest,Operation>`

createStub()

public DocumentServiceStub createStub()

Returns
Type	Description
`DocumentServiceStub`

Exceptions
Type	Description
`IOException`

getDatasetSchemaSettings()

public UnaryCallSettings<GetDatasetSchemaRequest,DatasetSchema> getDatasetSchemaSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDatasetSchemaRequest,DatasetSchema>`

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,GetDocumentResponse> getDocumentSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetDocumentRequest,GetDocumentResponse>`

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

importDocumentsOperationSettings()

public OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata> importDocumentsOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,ImportDocumentsMetadata>`

importDocumentsSettings()

public UnaryCallSettings<ImportDocumentsRequest,Operation> importDocumentsSettings()

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

Returns
Type	Description
`UnaryCallSettings<ImportDocumentsRequest,Operation>`

listDocumentsSettings()

public PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,DocumentServiceClient.ListDocumentsPagedResponse> listDocumentsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListDocumentsRequest,ListDocumentsResponse,ListDocumentsPagedResponse>`

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,DocumentServiceClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>`

toBuilder()

public DocumentServiceStubSettings.Builder toBuilder()

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

Returns
Type	Description
`DocumentServiceStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateDatasetOperationSettings()

public OperationCallSettings<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata> updateDatasetOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateDatasetRequest,Dataset,UpdateDatasetOperationMetadata>`

updateDatasetSchemaSettings()

public UnaryCallSettings<UpdateDatasetSchemaRequest,DatasetSchema> updateDatasetSchemaSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDatasetSchemaRequest,DatasetSchema>`

updateDatasetSettings()

public UnaryCallSettings<UpdateDatasetRequest,Operation> updateDatasetSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateDatasetRequest,Operation>`