com.google.cloud.discoveryengine.v1alpha.stub

Class DocumentServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<DocumentServiceStubSettings>

com.google.cloud.discoveryengine.v1alpha.stub.DocumentServiceStubSettings

@BetaApi
 @Generated(value="by gapic-generator-java")
public class DocumentServiceStubSettings
extends com.google.api.gax.rpc.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](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
 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](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 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)
             .setMaxRetryDelayDuration(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	DocumentServiceStubSettings.Builder Builder for DocumentServiceStubSettings.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse>	batchGetDocumentsMetadataSettings() Returns the object with the settings used for calls to batchGetDocumentsMetadata.
com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,Document>	createDocumentSettings() Returns the object with the settings used for calls to createDocument.
DocumentServiceStub	createStub()
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.rpc.ApiClientHeaderProvider.Builder	defaultGrpcApiClientHeaderProviderBuilder()
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.rpc.ApiClientHeaderProvider.Builder	defaultHttpJsonApiClientHeaderProviderBuilder()
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<DeleteDocumentRequest,com.google.protobuf.Empty>	deleteDocumentSettings() Returns the object with the settings used for calls to deleteDocument.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document>	getDocumentSettings() Returns the object with the settings used for calls to getDocument.
com.google.api.gax.rpc.UnaryCallSettings<GetProcessedDocumentRequest,ProcessedDocument>	getProcessedDocumentSettings() Returns the object with the settings used for calls to getProcessedDocument.
String	getServiceName() Returns the default service name.
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.
static DocumentServiceStubSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static DocumentServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static DocumentServiceStubSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
com.google.api.gax.rpc.OperationCallSettings<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata>	purgeDocumentsOperationSettings() Returns the object with the settings used for calls to purgeDocuments.
com.google.api.gax.rpc.UnaryCallSettings<PurgeDocumentsRequest,com.google.longrunning.Operation>	purgeDocumentsSettings() Returns the object with the settings used for calls to purgeDocuments.
DocumentServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,Document>	updateDocumentSettings() Returns the object with the settings used for calls to updateDocument.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentServiceStubSettings

protected DocumentServiceStubSettings(DocumentServiceStubSettings.Builder settingsBuilder)
                               throws IOException

Throws:

IOException

Method Detail

getDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetDocumentRequest,Document> 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.

createDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateDocumentRequest,Document> createDocumentSettings()

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

updateDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDocumentRequest,Document> updateDocumentSettings()

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

deleteDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteDocumentRequest,com.google.protobuf.Empty> deleteDocumentSettings()

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

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.

purgeDocumentsSettings

public com.google.api.gax.rpc.UnaryCallSettings<PurgeDocumentsRequest,com.google.longrunning.Operation> purgeDocumentsSettings()

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

purgeDocumentsOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<PurgeDocumentsRequest,PurgeDocumentsResponse,PurgeDocumentsMetadata> purgeDocumentsOperationSettings()

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

getProcessedDocumentSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetProcessedDocumentRequest,ProcessedDocument> getProcessedDocumentSettings()

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

batchGetDocumentsMetadataSettings

public com.google.api.gax.rpc.UnaryCallSettings<BatchGetDocumentsMetadataRequest,BatchGetDocumentsMetadataResponse> batchGetDocumentsMetadataSettings()

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

createStub

public DocumentServiceStub createStub()
                               throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<DocumentServiceStubSettings>

defaultExecutorProviderBuilder

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

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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()

defaultGrpcApiClientHeaderProviderBuilder

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

defaultHttpJsonApiClientHeaderProviderBuilder

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

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static DocumentServiceStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static DocumentServiceStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public DocumentServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<DocumentServiceStubSettings>