Class IndexEndpointServiceClient (2.9.8)

public class IndexEndpointServiceClient implements BackgroundResource

Service Description: A service for managing Vertex AI's IndexEndpoints.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   IndexEndpoint response = indexEndpointServiceClient.getIndexEndpoint(name);
 }
 

Note: close() needs to be called on the IndexEndpointServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

  1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
  2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
  3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of IndexEndpointServiceSettings to create(). For example:

To customize credentials:


 IndexEndpointServiceSettings indexEndpointServiceSettings =
     IndexEndpointServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create(indexEndpointServiceSettings);
 

To customize the endpoint:


 IndexEndpointServiceSettings indexEndpointServiceSettings =
     IndexEndpointServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create(indexEndpointServiceSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > IndexEndpointServiceClient

Implements

BackgroundResource

Static Methods

create()

public static final IndexEndpointServiceClient create()

Constructs an instance of IndexEndpointServiceClient with default settings.

Returns
TypeDescription
IndexEndpointServiceClient
Exceptions
TypeDescription
IOException

create(IndexEndpointServiceSettings settings)

public static final IndexEndpointServiceClient create(IndexEndpointServiceSettings settings)

Constructs an instance of IndexEndpointServiceClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
NameDescription
settingsIndexEndpointServiceSettings
Returns
TypeDescription
IndexEndpointServiceClient
Exceptions
TypeDescription
IOException

create(IndexEndpointServiceStub stub)

public static final IndexEndpointServiceClient create(IndexEndpointServiceStub stub)

Constructs an instance of IndexEndpointServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(IndexEndpointServiceSettings).

Parameter
NameDescription
stubIndexEndpointServiceStub
Returns
TypeDescription
IndexEndpointServiceClient

Constructors

IndexEndpointServiceClient(IndexEndpointServiceSettings settings)

protected IndexEndpointServiceClient(IndexEndpointServiceSettings settings)

Constructs an instance of IndexEndpointServiceClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
NameDescription
settingsIndexEndpointServiceSettings

IndexEndpointServiceClient(IndexEndpointServiceStub stub)

protected IndexEndpointServiceClient(IndexEndpointServiceStub stub)
Parameter
NameDescription
stubIndexEndpointServiceStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)
Parameters
NameDescription
durationlong
unitTimeUnit
Returns
TypeDescription
boolean
Exceptions
TypeDescription
InterruptedException

close()

public final void close()

createIndexEndpointAsync(CreateIndexEndpointRequest request)

public final OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointAsync(CreateIndexEndpointRequest request)

Creates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   CreateIndexEndpointRequest request =
       CreateIndexEndpointRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIndexEndpoint(IndexEndpoint.newBuilder().build())
           .build();
   IndexEndpoint response = indexEndpointServiceClient.createIndexEndpointAsync(request).get();
 }
 
Parameter
NameDescription
requestCreateIndexEndpointRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata>

createIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint)

public final OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointAsync(LocationName parent, IndexEndpoint indexEndpoint)

Creates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   IndexEndpoint indexEndpoint = IndexEndpoint.newBuilder().build();
   IndexEndpoint response =
       indexEndpointServiceClient.createIndexEndpointAsync(parent, indexEndpoint).get();
 }
 
Parameters
NameDescription
parentLocationName

Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}

indexEndpointIndexEndpoint

Required. The IndexEndpoint to create.

Returns
TypeDescription
OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata>

createIndexEndpointAsync(String parent, IndexEndpoint indexEndpoint)

public final OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointAsync(String parent, IndexEndpoint indexEndpoint)

Creates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   IndexEndpoint indexEndpoint = IndexEndpoint.newBuilder().build();
   IndexEndpoint response =
       indexEndpointServiceClient.createIndexEndpointAsync(parent, indexEndpoint).get();
 }
 
Parameters
NameDescription
parentString

Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}

indexEndpointIndexEndpoint

Required. The IndexEndpoint to create.

Returns
TypeDescription
OperationFuture<IndexEndpoint,CreateIndexEndpointOperationMetadata>

createIndexEndpointCallable()

public final UnaryCallable<CreateIndexEndpointRequest,Operation> createIndexEndpointCallable()

Creates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   CreateIndexEndpointRequest request =
       CreateIndexEndpointRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIndexEndpoint(IndexEndpoint.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       indexEndpointServiceClient.createIndexEndpointCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<CreateIndexEndpointRequest,Operation>

createIndexEndpointOperationCallable()

public final OperationCallable<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata> createIndexEndpointOperationCallable()

Creates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   CreateIndexEndpointRequest request =
       CreateIndexEndpointRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setIndexEndpoint(IndexEndpoint.newBuilder().build())
           .build();
   OperationFuture<IndexEndpoint, CreateIndexEndpointOperationMetadata> future =
       indexEndpointServiceClient.createIndexEndpointOperationCallable().futureCall(request);
   // Do something.
   IndexEndpoint response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<CreateIndexEndpointRequest,IndexEndpoint,CreateIndexEndpointOperationMetadata>

deleteIndexEndpointAsync(DeleteIndexEndpointRequest request)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteIndexEndpointAsync(DeleteIndexEndpointRequest request)

Deletes an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeleteIndexEndpointRequest request =
       DeleteIndexEndpointRequest.newBuilder()
           .setName(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .build();
   indexEndpointServiceClient.deleteIndexEndpointAsync(request).get();
 }
 
Parameter
NameDescription
requestDeleteIndexEndpointRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteIndexEndpointAsync(IndexEndpointName name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteIndexEndpointAsync(IndexEndpointName name)

Deletes an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   indexEndpointServiceClient.deleteIndexEndpointAsync(name).get();
 }
 
Parameter
NameDescription
nameIndexEndpointName

Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteIndexEndpointAsync(String name)

public final OperationFuture<Empty,DeleteOperationMetadata> deleteIndexEndpointAsync(String name)

Deletes an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString();
   indexEndpointServiceClient.deleteIndexEndpointAsync(name).get();
 }
 
Parameter
NameDescription
nameString

Required. The name of the IndexEndpoint resource to be deleted. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns
TypeDescription
OperationFuture<Empty,DeleteOperationMetadata>

deleteIndexEndpointCallable()

public final UnaryCallable<DeleteIndexEndpointRequest,Operation> deleteIndexEndpointCallable()

Deletes an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeleteIndexEndpointRequest request =
       DeleteIndexEndpointRequest.newBuilder()
           .setName(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .build();
   ApiFuture<Operation> future =
       indexEndpointServiceClient.deleteIndexEndpointCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeleteIndexEndpointRequest,Operation>

deleteIndexEndpointOperationCallable()

public final OperationCallable<DeleteIndexEndpointRequest,Empty,DeleteOperationMetadata> deleteIndexEndpointOperationCallable()

Deletes an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeleteIndexEndpointRequest request =
       DeleteIndexEndpointRequest.newBuilder()
           .setName(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .build();
   OperationFuture<Empty, DeleteOperationMetadata> future =
       indexEndpointServiceClient.deleteIndexEndpointOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeleteIndexEndpointRequest,Empty,DeleteOperationMetadata>

deployIndexAsync(DeployIndexRequest request)

public final OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata> deployIndexAsync(DeployIndexRequest request)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeployIndexRequest request =
       DeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   DeployIndexResponse response = indexEndpointServiceClient.deployIndexAsync(request).get();
 }
 
Parameter
NameDescription
requestDeployIndexRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata>

deployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex)

public final OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata> deployIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   DeployedIndex deployedIndex = DeployedIndex.newBuilder().build();
   DeployIndexResponse response =
       indexEndpointServiceClient.deployIndexAsync(indexEndpoint, deployedIndex).get();
 }
 
Parameters
NameDescription
indexEndpointIndexEndpointName

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexDeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint.

Returns
TypeDescription
OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata>

deployIndexAsync(String indexEndpoint, DeployedIndex deployedIndex)

public final OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata> deployIndexAsync(String indexEndpoint, DeployedIndex deployedIndex)

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString();
   DeployedIndex deployedIndex = DeployedIndex.newBuilder().build();
   DeployIndexResponse response =
       indexEndpointServiceClient.deployIndexAsync(indexEndpoint, deployedIndex).get();
 }
 
Parameters
NameDescription
indexEndpointString

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexDeployedIndex

Required. The DeployedIndex to be created within the IndexEndpoint.

Returns
TypeDescription
OperationFuture<DeployIndexResponse,DeployIndexOperationMetadata>

deployIndexCallable()

public final UnaryCallable<DeployIndexRequest,Operation> deployIndexCallable()

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeployIndexRequest request =
       DeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       indexEndpointServiceClient.deployIndexCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<DeployIndexRequest,Operation>

deployIndexOperationCallable()

public final OperationCallable<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata> deployIndexOperationCallable()

Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it. Only non-empty Indexes can be deployed.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   DeployIndexRequest request =
       DeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   OperationFuture<DeployIndexResponse, DeployIndexOperationMetadata> future =
       indexEndpointServiceClient.deployIndexOperationCallable().futureCall(request);
   // Do something.
   DeployIndexResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<DeployIndexRequest,DeployIndexResponse,DeployIndexOperationMetadata>

getIndexEndpoint(GetIndexEndpointRequest request)

public final IndexEndpoint getIndexEndpoint(GetIndexEndpointRequest request)

Gets an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   GetIndexEndpointRequest request =
       GetIndexEndpointRequest.newBuilder()
           .setName(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .build();
   IndexEndpoint response = indexEndpointServiceClient.getIndexEndpoint(request);
 }
 
Parameter
NameDescription
requestGetIndexEndpointRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
IndexEndpoint

getIndexEndpoint(IndexEndpointName name)

public final IndexEndpoint getIndexEndpoint(IndexEndpointName name)

Gets an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   IndexEndpoint response = indexEndpointServiceClient.getIndexEndpoint(name);
 }
 
Parameter
NameDescription
nameIndexEndpointName

Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns
TypeDescription
IndexEndpoint

getIndexEndpoint(String name)

public final IndexEndpoint getIndexEndpoint(String name)

Gets an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String name = IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString();
   IndexEndpoint response = indexEndpointServiceClient.getIndexEndpoint(name);
 }
 
Parameter
NameDescription
nameString

Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns
TypeDescription
IndexEndpoint

getIndexEndpointCallable()

public final UnaryCallable<GetIndexEndpointRequest,IndexEndpoint> getIndexEndpointCallable()

Gets an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   GetIndexEndpointRequest request =
       GetIndexEndpointRequest.newBuilder()
           .setName(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .build();
   ApiFuture<IndexEndpoint> future =
       indexEndpointServiceClient.getIndexEndpointCallable().futureCall(request);
   // Do something.
   IndexEndpoint response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<GetIndexEndpointRequest,IndexEndpoint>

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns
TypeDescription
OperationsClient

getSettings()

public final IndexEndpointServiceSettings getSettings()
Returns
TypeDescription
IndexEndpointServiceSettings

getStub()

public IndexEndpointServiceStub getStub()
Returns
TypeDescription
IndexEndpointServiceStub

isShutdown()

public boolean isShutdown()
Returns
TypeDescription
boolean

isTerminated()

public boolean isTerminated()
Returns
TypeDescription
boolean

listIndexEndpoints(ListIndexEndpointsRequest request)

public final IndexEndpointServiceClient.ListIndexEndpointsPagedResponse listIndexEndpoints(ListIndexEndpointsRequest request)

Lists IndexEndpoints in a Location.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   ListIndexEndpointsRequest request =
       ListIndexEndpointsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   for (IndexEndpoint element :
       indexEndpointServiceClient.listIndexEndpoints(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
requestListIndexEndpointsRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
IndexEndpointServiceClient.ListIndexEndpointsPagedResponse

listIndexEndpoints(LocationName parent)

public final IndexEndpointServiceClient.ListIndexEndpointsPagedResponse listIndexEndpoints(LocationName parent)

Lists IndexEndpoints in a Location.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (IndexEndpoint element :
       indexEndpointServiceClient.listIndexEndpoints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentLocationName

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}

Returns
TypeDescription
IndexEndpointServiceClient.ListIndexEndpointsPagedResponse

listIndexEndpoints(String parent)

public final IndexEndpointServiceClient.ListIndexEndpointsPagedResponse listIndexEndpoints(String parent)

Lists IndexEndpoints in a Location.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (IndexEndpoint element :
       indexEndpointServiceClient.listIndexEndpoints(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Parameter
NameDescription
parentString

Required. The resource name of the Location from which to list the IndexEndpoints. Format: projects/{project}/locations/{location}

Returns
TypeDescription
IndexEndpointServiceClient.ListIndexEndpointsPagedResponse

listIndexEndpointsCallable()

public final UnaryCallable<ListIndexEndpointsRequest,ListIndexEndpointsResponse> listIndexEndpointsCallable()

Lists IndexEndpoints in a Location.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   ListIndexEndpointsRequest request =
       ListIndexEndpointsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   while (true) {
     ListIndexEndpointsResponse response =
         indexEndpointServiceClient.listIndexEndpointsCallable().call(request);
     for (IndexEndpoint element : response.getResponsesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListIndexEndpointsRequest,ListIndexEndpointsResponse>

listIndexEndpointsPagedCallable()

public final UnaryCallable<ListIndexEndpointsRequest,IndexEndpointServiceClient.ListIndexEndpointsPagedResponse> listIndexEndpointsPagedCallable()

Lists IndexEndpoints in a Location.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   ListIndexEndpointsRequest request =
       ListIndexEndpointsRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setReadMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<IndexEndpoint> future =
       indexEndpointServiceClient.listIndexEndpointsPagedCallable().futureCall(request);
   // Do something.
   for (IndexEndpoint element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 
Returns
TypeDescription
UnaryCallable<ListIndexEndpointsRequest,ListIndexEndpointsPagedResponse>

mutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex)

public final OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexAsync(IndexEndpointName indexEndpoint, DeployedIndex deployedIndex)

Update an existing DeployedIndex under an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   DeployedIndex deployedIndex = DeployedIndex.newBuilder().build();
   MutateDeployedIndexResponse response =
       indexEndpointServiceClient.mutateDeployedIndexAsync(indexEndpoint, deployedIndex).get();
 }
 
Parameters
NameDescription
indexEndpointIndexEndpointName

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexDeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex and DeployedIndex

Returns
TypeDescription
OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata>

mutateDeployedIndexAsync(MutateDeployedIndexRequest request)

public final OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexAsync(MutateDeployedIndexRequest request)

Update an existing DeployedIndex under an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   MutateDeployedIndexRequest request =
       MutateDeployedIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   MutateDeployedIndexResponse response =
       indexEndpointServiceClient.mutateDeployedIndexAsync(request).get();
 }
 
Parameter
NameDescription
requestMutateDeployedIndexRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata>

mutateDeployedIndexAsync(String indexEndpoint, DeployedIndex deployedIndex)

public final OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexAsync(String indexEndpoint, DeployedIndex deployedIndex)

Update an existing DeployedIndex under an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString();
   DeployedIndex deployedIndex = DeployedIndex.newBuilder().build();
   MutateDeployedIndexResponse response =
       indexEndpointServiceClient.mutateDeployedIndexAsync(indexEndpoint, deployedIndex).get();
 }
 
Parameters
NameDescription
indexEndpointString

Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexDeployedIndex

Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are DeployedIndex and DeployedIndex

Returns
TypeDescription
OperationFuture<MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata>

mutateDeployedIndexCallable()

public final UnaryCallable<MutateDeployedIndexRequest,Operation> mutateDeployedIndexCallable()

Update an existing DeployedIndex under an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   MutateDeployedIndexRequest request =
       MutateDeployedIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   ApiFuture<Operation> future =
       indexEndpointServiceClient.mutateDeployedIndexCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<MutateDeployedIndexRequest,Operation>

mutateDeployedIndexOperationCallable()

public final OperationCallable<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata> mutateDeployedIndexOperationCallable()

Update an existing DeployedIndex under an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   MutateDeployedIndexRequest request =
       MutateDeployedIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndex(DeployedIndex.newBuilder().build())
           .build();
   OperationFuture<MutateDeployedIndexResponse, MutateDeployedIndexOperationMetadata> future =
       indexEndpointServiceClient.mutateDeployedIndexOperationCallable().futureCall(request);
   // Do something.
   MutateDeployedIndexResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<MutateDeployedIndexRequest,MutateDeployedIndexResponse,MutateDeployedIndexOperationMetadata>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

undeployIndexAsync(IndexEndpointName indexEndpoint, String deployedIndexId)

public final OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexAsync(IndexEndpointName indexEndpoint, String deployedIndexId)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpointName indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]");
   String deployedIndexId = "deployedIndexId-1101212953";
   UndeployIndexResponse response =
       indexEndpointServiceClient.undeployIndexAsync(indexEndpoint, deployedIndexId).get();
 }
 
Parameters
NameDescription
indexEndpointIndexEndpointName

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexIdString

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Returns
TypeDescription
OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata>

undeployIndexAsync(UndeployIndexRequest request)

public final OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexAsync(UndeployIndexRequest request)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   UndeployIndexRequest request =
       UndeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndexId("deployedIndexId-1101212953")
           .build();
   UndeployIndexResponse response = indexEndpointServiceClient.undeployIndexAsync(request).get();
 }
 
Parameter
NameDescription
requestUndeployIndexRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata>

undeployIndexAsync(String indexEndpoint, String deployedIndexId)

public final OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexAsync(String indexEndpoint, String deployedIndexId)

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   String indexEndpoint =
       IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString();
   String deployedIndexId = "deployedIndexId-1101212953";
   UndeployIndexResponse response =
       indexEndpointServiceClient.undeployIndexAsync(indexEndpoint, deployedIndexId).get();
 }
 
Parameters
NameDescription
indexEndpointString

Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

deployedIndexIdString

Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint.

Returns
TypeDescription
OperationFuture<UndeployIndexResponse,UndeployIndexOperationMetadata>

undeployIndexCallable()

public final UnaryCallable<UndeployIndexRequest,Operation> undeployIndexCallable()

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   UndeployIndexRequest request =
       UndeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndexId("deployedIndexId-1101212953")
           .build();
   ApiFuture<Operation> future =
       indexEndpointServiceClient.undeployIndexCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UndeployIndexRequest,Operation>

undeployIndexOperationCallable()

public final OperationCallable<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata> undeployIndexOperationCallable()

Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   UndeployIndexRequest request =
       UndeployIndexRequest.newBuilder()
           .setIndexEndpoint(
               IndexEndpointName.of("[PROJECT]", "[LOCATION]", "[INDEX_ENDPOINT]").toString())
           .setDeployedIndexId("deployedIndexId-1101212953")
           .build();
   OperationFuture<UndeployIndexResponse, UndeployIndexOperationMetadata> future =
       indexEndpointServiceClient.undeployIndexOperationCallable().futureCall(request);
   // Do something.
   UndeployIndexResponse response = future.get();
 }
 
Returns
TypeDescription
OperationCallable<UndeployIndexRequest,UndeployIndexResponse,UndeployIndexOperationMetadata>

updateIndexEndpoint(IndexEndpoint indexEndpoint, FieldMask updateMask)

public final IndexEndpoint updateIndexEndpoint(IndexEndpoint indexEndpoint, FieldMask updateMask)

Updates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   IndexEndpoint indexEndpoint = IndexEndpoint.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   IndexEndpoint response =
       indexEndpointServiceClient.updateIndexEndpoint(indexEndpoint, updateMask);
 }
 
Parameters
NameDescription
indexEndpointIndexEndpoint

Required. The IndexEndpoint which replaces the resource on the server.

updateMaskFieldMask

Required. The update mask applies to the resource. See google.protobuf.FieldMask.

Returns
TypeDescription
IndexEndpoint

updateIndexEndpoint(UpdateIndexEndpointRequest request)

public final IndexEndpoint updateIndexEndpoint(UpdateIndexEndpointRequest request)

Updates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   UpdateIndexEndpointRequest request =
       UpdateIndexEndpointRequest.newBuilder()
           .setIndexEndpoint(IndexEndpoint.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   IndexEndpoint response = indexEndpointServiceClient.updateIndexEndpoint(request);
 }
 
Parameter
NameDescription
requestUpdateIndexEndpointRequest

The request object containing all of the parameters for the API call.

Returns
TypeDescription
IndexEndpoint

updateIndexEndpointCallable()

public final UnaryCallable<UpdateIndexEndpointRequest,IndexEndpoint> updateIndexEndpointCallable()

Updates an IndexEndpoint.

Sample code:


 try (IndexEndpointServiceClient indexEndpointServiceClient =
     IndexEndpointServiceClient.create()) {
   UpdateIndexEndpointRequest request =
       UpdateIndexEndpointRequest.newBuilder()
           .setIndexEndpoint(IndexEndpoint.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<IndexEndpoint> future =
       indexEndpointServiceClient.updateIndexEndpointCallable().futureCall(request);
   // Do something.
   IndexEndpoint response = future.get();
 }
 
Returns
TypeDescription
UnaryCallable<UpdateIndexEndpointRequest,IndexEndpoint>