com.databricks.sdk.service.vectorsearch

Class VectorSearchEndpointsAPI

java.lang.Object

com.databricks.sdk.service.vectorsearch.VectorSearchEndpointsAPI

@Generated
public class VectorSearchEndpointsAPI
extends Object

Endpoint**: Represents the compute resources to host vector search indexes.

Constructor Summary

Constructors

Constructor and Description
VectorSearchEndpointsAPI(ApiClient apiClient) Regular-use constructor
VectorSearchEndpointsAPI(VectorSearchEndpointsService mock) Constructor for mocks

Method Summary

Modifier and Type	Method and Description
Wait<EndpointInfo,EndpointInfo>	createEndpoint(CreateEndpoint request) Create a new endpoint.
void	deleteEndpoint(DeleteEndpointRequest request) Delete a vector search endpoint.
void	deleteEndpoint(String endpointName)
EndpointInfo	getEndpoint(GetEndpointRequest request) Get details for a single vector search endpoint.
EndpointInfo	getEndpoint(String endpointName)
VectorSearchEndpointsService	impl()
Iterable<EndpointInfo>	listEndpoints(ListEndpointsRequest request) List all vector search endpoints in the workspace.
EndpointInfo	patchEndpoint(PatchEndpointRequest request) Update an endpoint
RetrieveUserVisibleMetricsResponse	retrieveUserVisibleMetrics(RetrieveUserVisibleMetricsRequest request) Retrieve user-visible metrics for an endpoint
PatchEndpointBudgetPolicyResponse	updateEndpointBudgetPolicy(PatchEndpointBudgetPolicyRequest request) Update the budget policy of an endpoint
UpdateEndpointCustomTagsResponse	updateEndpointCustomTags(UpdateEndpointCustomTagsRequest request) Update the custom tags of an endpoint.
EndpointInfo	waitGetEndpointVectorSearchEndpointOnline(String endpointName)
EndpointInfo	waitGetEndpointVectorSearchEndpointOnline(String endpointName, Duration timeout, Consumer<EndpointInfo> callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

VectorSearchEndpointsAPI

public VectorSearchEndpointsAPI(ApiClient apiClient)

Regular-use constructor

VectorSearchEndpointsAPI

public VectorSearchEndpointsAPI(VectorSearchEndpointsService mock)

Constructor for mocks

Method Detail

waitGetEndpointVectorSearchEndpointOnline

public EndpointInfo waitGetEndpointVectorSearchEndpointOnline(String endpointName)
                                                       throws TimeoutException

Throws:

TimeoutException

waitGetEndpointVectorSearchEndpointOnline

public EndpointInfo waitGetEndpointVectorSearchEndpointOnline(String endpointName,
                                                              Duration timeout,
                                                              Consumer<EndpointInfo> callback)
                                                       throws TimeoutException

Throws:

TimeoutException

createEndpoint

public Wait<EndpointInfo,EndpointInfo> createEndpoint(CreateEndpoint request)

Create a new endpoint.

deleteEndpoint

public void deleteEndpoint(String endpointName)

deleteEndpoint

public void deleteEndpoint(DeleteEndpointRequest request)

Delete a vector search endpoint.

getEndpoint

public EndpointInfo getEndpoint(String endpointName)

getEndpoint

public EndpointInfo getEndpoint(GetEndpointRequest request)

Get details for a single vector search endpoint.

listEndpoints

public Iterable<EndpointInfo> listEndpoints(ListEndpointsRequest request)

List all vector search endpoints in the workspace.

patchEndpoint

public EndpointInfo patchEndpoint(PatchEndpointRequest request)

Update an endpoint

retrieveUserVisibleMetrics

public RetrieveUserVisibleMetricsResponse retrieveUserVisibleMetrics(RetrieveUserVisibleMetricsRequest request)

Retrieve user-visible metrics for an endpoint

updateEndpointBudgetPolicy

public PatchEndpointBudgetPolicyResponse updateEndpointBudgetPolicy(PatchEndpointBudgetPolicyRequest request)

Update the budget policy of an endpoint

updateEndpointCustomTags

public UpdateEndpointCustomTagsResponse updateEndpointCustomTags(UpdateEndpointCustomTagsRequest request)

Update the custom tags of an endpoint.

impl

public VectorSearchEndpointsService impl()