Class DocumentProcessorServiceStubSettings

public class DocumentProcessorServiceStubSettings extends StubSettings<DocumentProcessorServiceStubSettings>

Settings class to configure an instance of DocumentProcessorServiceStub.

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 processDocument to 30 seconds:


 DocumentProcessorServiceStubSettings.Builder documentProcessorServiceSettingsBuilder =
     DocumentProcessorServiceStubSettings.newBuilder();
 documentProcessorServiceSettingsBuilder
     .processDocumentSettings()
     .setRetrySettings(
         documentProcessorServiceSettingsBuilder
             .processDocumentSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 DocumentProcessorServiceStubSettings documentProcessorServiceSettings =
     documentProcessorServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > DocumentProcessorServiceStubSettings

Constructors

DocumentProcessorServiceStubSettings(DocumentProcessorServiceStubSettings.Builder settingsBuilder)

protected DocumentProcessorServiceStubSettings(DocumentProcessorServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderDocumentProcessorServiceStubSettings.Builder

Methods

batchProcessDocumentsOperationSettings()

public OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata> batchProcessDocumentsOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<BatchProcessRequest,BatchProcessResponse,BatchProcessMetadata>

batchProcessDocumentsSettings()

public UnaryCallSettings<BatchProcessRequest,Operation> batchProcessDocumentsSettings()

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

Returns
TypeDescription
UnaryCallSettings<BatchProcessRequest,Operation>

createProcessorSettings()

public UnaryCallSettings<CreateProcessorRequest,Processor> createProcessorSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateProcessorRequest,Processor>

createStub()

public DocumentProcessorServiceStub createStub()
Returns
TypeDescription
DocumentProcessorServiceStub
Exceptions
TypeDescription
IOException

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

deleteProcessorOperationSettings()

public OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata> deleteProcessorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteProcessorRequest,Empty,DeleteProcessorMetadata>

deleteProcessorSettings()

public UnaryCallSettings<DeleteProcessorRequest,Operation> deleteProcessorSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteProcessorRequest,Operation>

disableProcessorOperationSettings()

public OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata> disableProcessorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DisableProcessorRequest,DisableProcessorResponse,DisableProcessorMetadata>

disableProcessorSettings()

public UnaryCallSettings<DisableProcessorRequest,Operation> disableProcessorSettings()

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

Returns
TypeDescription
UnaryCallSettings<DisableProcessorRequest,Operation>

enableProcessorOperationSettings()

public OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata> enableProcessorOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<EnableProcessorRequest,EnableProcessorResponse,EnableProcessorMetadata>

enableProcessorSettings()

public UnaryCallSettings<EnableProcessorRequest,Operation> enableProcessorSettings()

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

Returns
TypeDescription
UnaryCallSettings<EnableProcessorRequest,Operation>

fetchProcessorTypesSettings()

public UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse> fetchProcessorTypesSettings()

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

Returns
TypeDescription
UnaryCallSettings<FetchProcessorTypesRequest,FetchProcessorTypesResponse>

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>

listProcessorsSettings()

public PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,DocumentProcessorServiceClient.ListProcessorsPagedResponse> listProcessorsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListProcessorsRequest,ListProcessorsResponse,ListProcessorsPagedResponse>

newBuilder()

public static DocumentProcessorServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
DocumentProcessorServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static DocumentProcessorServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
DocumentProcessorServiceStubSettings.Builder

processDocumentSettings()

public UnaryCallSettings<ProcessRequest,ProcessResponse> processDocumentSettings()

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

Returns
TypeDescription
UnaryCallSettings<ProcessRequest,ProcessResponse>

reviewDocumentOperationSettings()

public OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata> reviewDocumentOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<ReviewDocumentRequest,ReviewDocumentResponse,ReviewDocumentOperationMetadata>

reviewDocumentSettings()

public UnaryCallSettings<ReviewDocumentRequest,Operation> reviewDocumentSettings()

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

Returns
TypeDescription
UnaryCallSettings<ReviewDocumentRequest,Operation>

toBuilder()

public DocumentProcessorServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
DocumentProcessorServiceStubSettings.Builder
Overrides