IndexService class final
A service for creating and managing Vertex AI's Index resources.
Constructors
- IndexService({required Client client})
-
Creates a
IndexServiceusingclientfor transport. - IndexService.fromApiKey([String? apiKey])
-
Creates a
IndexServicethat does authentication through an API key.factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
cancelOperation(
CancelOperationRequest request) → Future< void> -
Provides the
Operationsservice functionality in this service. -
close(
) → void - Closes the client and cleans up any resources associated with it.
-
createIndex(
CreateIndexRequest request) → Future< Operation< Index, CreateIndexOperationMetadata> > - Creates an Index.
-
deleteIndex(
DeleteIndexRequest request) → Future< Operation< Empty, DeleteOperationMetadata> > -
Deletes an Index.
An Index can only be deleted when all its
DeployedIndexeshad been undeployed. -
deleteOperation(
DeleteOperationRequest request) → Future< void> -
Provides the
Operationsservice functionality in this service. -
getIamPolicy(
GetIamPolicyRequest request) → Future< Policy> - Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
-
getIndex(
GetIndexRequest request) → Future< Index> - Gets an Index.
-
getLocation(
GetLocationRequest request) → Future< Location> - Gets information about a location.
-
getOperation<
T extends ProtoMessage, S extends ProtoMessage> (Operation< T, S> request) → Future<Operation< T, S> > -
Provides the
Operationsservice functionality in this service. -
importIndex(
ImportIndexRequest request) → Future< Operation< Index, ImportIndexOperationMetadata> > - Imports an Index from an external source (e.g., BigQuery).
-
listIndexes(
ListIndexesRequest request) → Future< ListIndexesResponse> - Lists Indexes in a Location.
-
listLocations(
ListLocationsRequest request) → Future< ListLocationsResponse> - Lists information about the supported locations for this service.
-
listOperations(
ListOperationsRequest request) → Future< ListOperationsResponse> -
Provides the
Operationsservice functionality in this service. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
removeDatapoints(
RemoveDatapointsRequest request) → Future< RemoveDatapointsResponse> - Remove Datapoints from an Index.
-
setIamPolicy(
SetIamPolicyRequest request) → Future< Policy> - Sets the access control policy on the specified resource. Replaces any existing policy.
-
testIamPermissions(
TestIamPermissionsRequest request) → Future< TestIamPermissionsResponse> -
Returns permissions that a caller has on the specified resource. If the
resource does not exist, this will return an empty set of
permissions, not a
NOT_FOUNDerror. -
toString(
) → String -
A string representation of this object.
inherited
-
updateIndex(
UpdateIndexRequest request) → Future< Operation< Index, UpdateIndexOperationMetadata> > - Updates an Index.
-
upsertDatapoints(
UpsertDatapointsRequest request) → Future< UpsertDatapointsResponse> - Add/update Datapoints into an Index.
-
waitOperation(
WaitOperationRequest request) → Future< Operation< ProtoMessage, ProtoMessage> > -
Provides the
Operationsservice functionality in this service.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited