public class VectorSearchServiceStubSettings extends StubSettings<VectorSearchServiceStubSettings>Settings class to configure an instance of VectorSearchServiceStub.
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 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
VectorSearchServiceStubSettings.Builder vectorSearchServiceSettingsBuilder =
VectorSearchServiceStubSettings.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());
VectorSearchServiceStubSettings vectorSearchServiceSettings =
vectorSearchServiceSettingsBuilder.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 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
VectorSearchServiceStubSettings.Builder vectorSearchServiceSettingsBuilder =
VectorSearchServiceStubSettings.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();
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()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 |
|
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 VectorSearchServiceStubSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
VectorSearchServiceStubSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static VectorSearchServiceStubSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
VectorSearchServiceStubSettings.Builder |
|
newHttpJsonBuilder()
public static VectorSearchServiceStubSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
VectorSearchServiceStubSettings.Builder |
|
Constructors
VectorSearchServiceStubSettings(VectorSearchServiceStubSettings.Builder settingsBuilder)
protected VectorSearchServiceStubSettings(VectorSearchServiceStubSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
VectorSearchServiceStubSettings.Builder |
Methods
createCollectionOperationSettings()
public OperationCallSettings<CreateCollectionRequest,Collection,OperationMetadata> createCollectionOperationSettings()Returns the object with the settings used for calls to createCollection.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateCollectionRequest,Collection,OperationMetadata> |
|
createCollectionSettings()
public UnaryCallSettings<CreateCollectionRequest,Operation> createCollectionSettings()Returns the object with the settings used for calls to createCollection.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateCollectionRequest,Operation> |
|
createIndexOperationSettings()
public OperationCallSettings<CreateIndexRequest,Index,OperationMetadata> createIndexOperationSettings()Returns the object with the settings used for calls to createIndex.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateIndexRequest,Index,OperationMetadata> |
|
createIndexSettings()
public UnaryCallSettings<CreateIndexRequest,Operation> createIndexSettings()Returns the object with the settings used for calls to createIndex.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateIndexRequest,Operation> |
|
createStub()
public VectorSearchServiceStub createStub()| Returns | |
|---|---|
| Type | Description |
VectorSearchServiceStub |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
deleteCollectionOperationSettings()
public OperationCallSettings<DeleteCollectionRequest,Empty,OperationMetadata> deleteCollectionOperationSettings()Returns the object with the settings used for calls to deleteCollection.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteCollectionRequest,Empty,OperationMetadata> |
|
deleteCollectionSettings()
public UnaryCallSettings<DeleteCollectionRequest,Operation> deleteCollectionSettings()Returns the object with the settings used for calls to deleteCollection.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteCollectionRequest,Operation> |
|
deleteIndexOperationSettings()
public OperationCallSettings<DeleteIndexRequest,Empty,OperationMetadata> deleteIndexOperationSettings()Returns the object with the settings used for calls to deleteIndex.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteIndexRequest,Empty,OperationMetadata> |
|
deleteIndexSettings()
public UnaryCallSettings<DeleteIndexRequest,Operation> deleteIndexSettings()Returns the object with the settings used for calls to deleteIndex.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteIndexRequest,Operation> |
|
getCollectionSettings()
public UnaryCallSettings<GetCollectionRequest,Collection> getCollectionSettings()Returns the object with the settings used for calls to getCollection.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetCollectionRequest,Collection> |
|
getIndexSettings()
public UnaryCallSettings<GetIndexRequest,Index> getIndexSettings()Returns the object with the settings used for calls to getIndex.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetIndexRequest,Index> |
|
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> |
|
getServiceName()
public String getServiceName()Returns the default service name.
| Returns | |
|---|---|
| Type | Description |
String |
|
importDataObjectsOperationSettings()
public OperationCallSettings<ImportDataObjectsRequest,ImportDataObjectsResponse,ImportDataObjectsMetadata> importDataObjectsOperationSettings()Returns the object with the settings used for calls to importDataObjects.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ImportDataObjectsRequest,ImportDataObjectsResponse,ImportDataObjectsMetadata> |
|
importDataObjectsSettings()
public UnaryCallSettings<ImportDataObjectsRequest,Operation> importDataObjectsSettings()Returns the object with the settings used for calls to importDataObjects.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ImportDataObjectsRequest,Operation> |
|
listCollectionsSettings()
public PagedCallSettings<ListCollectionsRequest,ListCollectionsResponse,VectorSearchServiceClient.ListCollectionsPagedResponse> listCollectionsSettings()Returns the object with the settings used for calls to listCollections.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListCollectionsRequest,ListCollectionsResponse,ListCollectionsPagedResponse> |
|
listIndexesSettings()
public PagedCallSettings<ListIndexesRequest,ListIndexesResponse,VectorSearchServiceClient.ListIndexesPagedResponse> listIndexesSettings()Returns the object with the settings used for calls to listIndexes.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListIndexesRequest,ListIndexesResponse,ListIndexesPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,VectorSearchServiceClient.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> |
|
toBuilder()
public VectorSearchServiceStubSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
VectorSearchServiceStubSettings.Builder |
|
updateCollectionOperationSettings()
public OperationCallSettings<UpdateCollectionRequest,Collection,OperationMetadata> updateCollectionOperationSettings()Returns the object with the settings used for calls to updateCollection.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateCollectionRequest,Collection,OperationMetadata> |
|
updateCollectionSettings()
public UnaryCallSettings<UpdateCollectionRequest,Operation> updateCollectionSettings()Returns the object with the settings used for calls to updateCollection.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateCollectionRequest,Operation> |
|