Class DocumentServiceStubSettings (0.49.0)

Version latest

• 0.49.0 (latest)
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

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 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 (discoveryengine.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 importDocuments:

 // 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)
             .setMaxRetryDelay(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()

Beta

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

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

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

batchGetDocumentsMetadataSettings()

public UnaryCallSettings<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse> batchGetDocumentsMetadataSettings()

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

Returns
Type	Description
UnaryCallSettings<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse>

createDocumentSettings()

public UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()

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

Returns
Type	Description
UnaryCallSettings<CreateDocumentRequest,Document>

createStub()

public DocumentServiceStub createStub()

Returns
Type	Description
DocumentServiceStub

Exceptions
Type	Description
IOException

deleteDocumentSettings()

public UnaryCallSettings<DeleteDocumentRequest,Empty> deleteDocumentSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteDocumentRequest,Empty>

getDocumentSettings()

public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetDocumentRequest,Document>

getProcessedDocumentSettings()

public UnaryCallSettings<GetProcessedDocumentRequest,ProcessedDocument> getProcessedDocumentSettings()

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

Returns
Type	Description
UnaryCallSettings<GetProcessedDocumentRequest,ProcessedDocument>

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>

purgeDocumentsOperationSettings()

public OperationCallSettings<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata> purgeDocumentsOperationSettings()

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

Returns
Type	Description
OperationCallSettings<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata>

purgeDocumentsSettings()

public UnaryCallSettings<PurgeDocumentsRequest,Operation> purgeDocumentsSettings()

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

Returns
Type	Description
UnaryCallSettings<PurgeDocumentsRequest,Operation>

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

updateDocumentSettings()

public UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateDocumentRequest,Document>