1. class
  2. Google
  3. \
  4. Service
  5. \
  6. Aiplatform
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsIndexes

ProjectsLocationsIndexes

class ProjectsLocationsIndexes extends Resource (View source)

The "indexes" collection of methods.

Typical usage is:

 $aiplatformService = new Google\Service\Aiplatform(...);
 $indexes = $aiplatformService->projects_locations_indexes;

Methods

GoogleLongrunningOperation
create(string $parent, GoogleCloudAiplatformV1Index $postBody, array $optParams = [])

Creates an Index. (indexes.create)

GoogleLongrunningOperation
delete(string $name, array $optParams = [])

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. (indexes.delete)

GoogleCloudAiplatformV1Index
get(string $name, array $optParams = [])

Gets an Index. (indexes.get)

GoogleCloudAiplatformV1ListIndexesResponse
listProjectsLocationsIndexes(string $parent, array $optParams = [])

Lists Indexes in a Location. (indexes.listProjectsLocationsIndexes)

GoogleLongrunningOperation
patch(string $name, GoogleCloudAiplatformV1Index $postBody, array $optParams = [])

Updates an Index. (indexes.patch)

GoogleCloudAiplatformV1RemoveDatapointsResponse
removeDatapoints(string $index, GoogleCloudAiplatformV1RemoveDatapointsRequest $postBody, array $optParams = [])

Remove Datapoints from an Index. (indexes.removeDatapoints)

GoogleCloudAiplatformV1UpsertDatapointsResponse
upsertDatapoints(string $index, GoogleCloudAiplatformV1UpsertDatapointsRequest $postBody, array $optParams = [])

Add/update Datapoints into an Index. (indexes.upsertDatapoints)

Details

at line 48
GoogleLongrunningOperation create(string $parent, GoogleCloudAiplatformV1Index $postBody, array $optParams = [])

Creates an Index. (indexes.create)

Parameters

string $parent

Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
GoogleCloudAiplatformV1Index $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 64
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes an Index. An Index can only be deleted when all its DeployedIndexes had been undeployed. (indexes.delete)

Parameters

string $name

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 79
GoogleCloudAiplatformV1Index get(string $name, array $optParams = [])

Gets an Index. (indexes.get)

Parameters

string $name

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1Index

Exceptions

Exception

at line 101
GoogleCloudAiplatformV1ListIndexesResponse listProjectsLocationsIndexes(string $parent, array $optParams = [])

Lists Indexes in a Location. (indexes.listProjectsLocationsIndexes)

Parameters

string $parent

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

Optional parameters.

Return Value

GoogleCloudAiplatformV1ListIndexesResponse

Exceptions

Exception

at line 119
GoogleLongrunningOperation patch(string $name, GoogleCloudAiplatformV1Index $postBody, array $optParams = [])

Updates an Index. (indexes.patch)

Parameters

string $name

Output only. The resource name of the Index.
GoogleCloudAiplatformV1Index $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 135
GoogleCloudAiplatformV1RemoveDatapointsResponse removeDatapoints(string $index, GoogleCloudAiplatformV1RemoveDatapointsRequest $postBody, array $optParams = [])

Remove Datapoints from an Index. (indexes.removeDatapoints)

Parameters

string $index

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}
GoogleCloudAiplatformV1RemoveDatapointsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1RemoveDatapointsResponse

Exceptions

Exception

at line 151
GoogleCloudAiplatformV1UpsertDatapointsResponse upsertDatapoints(string $index, GoogleCloudAiplatformV1UpsertDatapointsRequest $postBody, array $optParams = [])

Add/update Datapoints into an Index. (indexes.upsertDatapoints)

Parameters

string $index

Required. The name of the Index resource to be updated. Format: projects/{project}/locations/{location}/indexes/{index}
GoogleCloudAiplatformV1UpsertDatapointsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudAiplatformV1UpsertDatapointsResponse

Exceptions

Exception