Class VectorSearchServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<VectorSearchServiceSettings>
com.google.cloud.vectorsearch.v1beta.VectorSearchServiceSettings
@BetaApi
@Generated("by gapic-generator-java")
public class VectorSearchServiceSettings
extends ClientSettings<VectorSearchServiceSettings>
Settings class to configure an instance of
VectorSearchServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (vectorsearch.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 getCollection:
// 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
VectorSearchServiceSettings.Builder vectorSearchServiceSettingsBuilder =
VectorSearchServiceSettings.newBuilder();
vectorSearchServiceSettingsBuilder
.getCollectionSettings()
.setRetrySettings(
vectorSearchServiceSettingsBuilder
.getCollectionSettings()
.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());
VectorSearchServiceSettings vectorSearchServiceSettings =
vectorSearchServiceSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createCollection:
// 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
VectorSearchServiceSettings.Builder vectorSearchServiceSettingsBuilder =
VectorSearchServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
vectorSearchServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for VectorSearchServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedVectorSearchServiceSettings(VectorSearchServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final VectorSearchServiceSettingsReturns the object with the settings used for calls to createCollection.Returns the object with the settings used for calls to createCollection.Returns the object with the settings used for calls to createIndex.Returns the object with the settings used for calls to createIndex.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteCollectionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteCollection.Returns the object with the settings used for calls to deleteCollection.OperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteIndex.Returns the object with the settings used for calls to deleteIndex.Returns the object with the settings used for calls to exportDataObjects.Returns the object with the settings used for calls to exportDataObjects.Returns the object with the settings used for calls to getCollection.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIndex.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to importDataObjects.Returns the object with the settings used for calls to importDataObjects.PagedCallSettings<ListCollectionsRequest,ListCollectionsResponse, VectorSearchServiceClient.ListCollectionsPagedResponse> Returns the object with the settings used for calls to listCollections.PagedCallSettings<ListIndexesRequest,ListIndexesResponse, VectorSearchServiceClient.ListIndexesPagedResponse> Returns the object with the settings used for calls to listIndexes.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, VectorSearchServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateCollection.Returns the object with the settings used for calls to updateCollection.Returns the object with the settings used for calls to updateIndex.Returns the object with the settings used for calls to updateIndex.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
VectorSearchServiceSettings
protected VectorSearchServiceSettings(VectorSearchServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listCollectionsSettings
public PagedCallSettings<ListCollectionsRequest,ListCollectionsResponse, listCollectionsSettings()VectorSearchServiceClient.ListCollectionsPagedResponse> Returns the object with the settings used for calls to listCollections. -
getCollectionSettings
Returns the object with the settings used for calls to getCollection. -
createCollectionSettings
Returns the object with the settings used for calls to createCollection. -
createCollectionOperationSettings
public OperationCallSettings<CreateCollectionRequest,Collection, createCollectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCollection. -
updateCollectionSettings
Returns the object with the settings used for calls to updateCollection. -
updateCollectionOperationSettings
public OperationCallSettings<UpdateCollectionRequest,Collection, updateCollectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCollection. -
deleteCollectionSettings
Returns the object with the settings used for calls to deleteCollection. -
deleteCollectionOperationSettings
public OperationCallSettings<DeleteCollectionRequest,com.google.protobuf.Empty, deleteCollectionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteCollection. -
listIndexesSettings
public PagedCallSettings<ListIndexesRequest,ListIndexesResponse, listIndexesSettings()VectorSearchServiceClient.ListIndexesPagedResponse> Returns the object with the settings used for calls to listIndexes. -
getIndexSettings
Returns the object with the settings used for calls to getIndex. -
createIndexSettings
Returns the object with the settings used for calls to createIndex. -
createIndexOperationSettings
public OperationCallSettings<CreateIndexRequest,Index, createIndexOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createIndex. -
updateIndexSettings
Returns the object with the settings used for calls to updateIndex. -
updateIndexOperationSettings
public OperationCallSettings<UpdateIndexRequest,Index, updateIndexOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateIndex. -
deleteIndexSettings
Returns the object with the settings used for calls to deleteIndex. -
deleteIndexOperationSettings
public OperationCallSettings<DeleteIndexRequest,com.google.protobuf.Empty, deleteIndexOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteIndex. -
importDataObjectsSettings
Returns the object with the settings used for calls to importDataObjects. -
importDataObjectsOperationSettings
public OperationCallSettings<ImportDataObjectsRequest,ImportDataObjectsResponse, importDataObjectsOperationSettings()ImportDataObjectsMetadata> Returns the object with the settings used for calls to importDataObjects. -
exportDataObjectsSettings
Returns the object with the settings used for calls to exportDataObjects. -
exportDataObjectsOperationSettings
public OperationCallSettings<ExportDataObjectsRequest,ExportDataObjectsResponse, exportDataObjectsOperationSettings()ExportDataObjectsMetadata> Returns the object with the settings used for calls to exportDataObjects. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()VectorSearchServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final VectorSearchServiceSettings create(VectorSearchServiceStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<VectorSearchServiceSettings>
-