- 4.59.0 (latest)
- 4.58.0
- 4.57.0
- 4.55.0
- 4.54.0
- 4.53.0
- 4.52.0
- 4.51.0
- 4.50.0
- 4.49.0
- 4.48.0
- 4.47.0
- 4.46.0
- 4.45.0
- 4.43.0
- 4.42.0
- 4.41.0
- 4.40.0
- 4.39.0
- 4.38.0
- 4.37.0
- 4.36.0
- 4.35.0
- 4.34.0
- 4.33.0
- 4.30.0
- 4.29.0
- 4.28.0
- 4.27.0
- 4.26.0
- 4.25.0
- 4.24.0
- 4.23.0
- 4.22.0
- 4.21.0
- 4.20.0
- 4.19.0
- 4.18.0
- 4.17.0
- 4.15.0
- 4.14.0
- 4.13.0
- 4.12.0
- 4.11.0
- 4.10.0
- 4.9.1
- 4.8.6
- 4.7.5
- 4.6.0
- 4.5.11
- 4.4.0
- 4.3.1
public class DocumentsSettings extends ClientSettings<DocumentsSettings>Settings class to configure an instance of DocumentsClient.
The default instance has everything set to sensible defaults:
- The default service address (dialogflow.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
DocumentsSettings.Builder documentsSettingsBuilder = DocumentsSettings.newBuilder();
documentsSettingsBuilder
.getDocumentSettings()
.setRetrySettings(
documentsSettingsBuilder
.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());
DocumentsSettings documentsSettings = documentsSettingsBuilder.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 createDocument:
// 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
DocumentsSettings.Builder documentsSettingsBuilder = DocumentsSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
documentsSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(DocumentsStubSettings stub)
public static final DocumentsSettings create(DocumentsStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
DocumentsStubSettings |
| Returns | |
|---|---|
| Type | Description |
DocumentsSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
|
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default gRPC ChannelProvider for this service.
| 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 |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static DocumentsSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
DocumentsSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static DocumentsSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
DocumentsSettings.Builder |
|
newHttpJsonBuilder()
public static DocumentsSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
DocumentsSettings.Builder |
|
Constructors
DocumentsSettings(DocumentsSettings.Builder settingsBuilder)
protected DocumentsSettings(DocumentsSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
DocumentsSettings.Builder |
Methods
createDocumentOperationSettings()
public OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata> createDocumentOperationSettings()Returns the object with the settings used for calls to createDocument.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateDocumentRequest,Document,KnowledgeOperationMetadata> |
|
createDocumentSettings()
public UnaryCallSettings<CreateDocumentRequest,Operation> createDocumentSettings()Returns the object with the settings used for calls to createDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateDocumentRequest,Operation> |
|
deleteDocumentOperationSettings()
public OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> deleteDocumentOperationSettings()Returns the object with the settings used for calls to deleteDocument.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteDocumentRequest,Empty,KnowledgeOperationMetadata> |
|
deleteDocumentSettings()
public UnaryCallSettings<DeleteDocumentRequest,Operation> deleteDocumentSettings()Returns the object with the settings used for calls to deleteDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteDocumentRequest,Operation> |
|
exportDocumentOperationSettings()
public OperationCallSettings<ExportDocumentRequest,Document,KnowledgeOperationMetadata> exportDocumentOperationSettings()Returns the object with the settings used for calls to exportDocument.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ExportDocumentRequest,Document,KnowledgeOperationMetadata> |
|
exportDocumentSettings()
public UnaryCallSettings<ExportDocumentRequest,Operation> exportDocumentSettings()Returns the object with the settings used for calls to exportDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ExportDocumentRequest,Operation> |
|
getDocumentSettings()
public UnaryCallSettings<GetDocumentRequest,Document> getDocumentSettings()Returns the object with the settings used for calls to getDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetDocumentRequest,Document> |
|
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> |
|
importDocumentsOperationSettings()
public OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> importDocumentsOperationSettings()Returns the object with the settings used for calls to importDocuments.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ImportDocumentsRequest,ImportDocumentsResponse,KnowledgeOperationMetadata> |
|
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,DocumentsClient.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,DocumentsClient.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> |
|
reloadDocumentOperationSettings()
public OperationCallSettings<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> reloadDocumentOperationSettings()Returns the object with the settings used for calls to reloadDocument.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ReloadDocumentRequest,Document,KnowledgeOperationMetadata> |
|
reloadDocumentSettings()
public UnaryCallSettings<ReloadDocumentRequest,Operation> reloadDocumentSettings()Returns the object with the settings used for calls to reloadDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ReloadDocumentRequest,Operation> |
|
toBuilder()
public DocumentsSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
DocumentsSettings.Builder |
|
updateDocumentOperationSettings()
public OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> updateDocumentOperationSettings()Returns the object with the settings used for calls to updateDocument.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateDocumentRequest,Document,KnowledgeOperationMetadata> |
|
updateDocumentSettings()
public UnaryCallSettings<UpdateDocumentRequest,Operation> updateDocumentSettings()Returns the object with the settings used for calls to updateDocument.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateDocumentRequest,Operation> |
|