Class ProjectsResource.LocationsResource.IndexEndpointsResource

The "indexEndpoints" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.IndexEndpointsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Aiplatform.v1

Assembly: Google.Apis.Aiplatform.v1.dll

Syntax

public class ProjectsResource.LocationsResource.IndexEndpointsResource

Constructors

IndexEndpointsResource(IClientService)

Constructs a new resource.

Declaration

public IndexEndpointsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.OperationsResource

Methods

Create(GoogleCloudAiplatformV1IndexEndpoint, string)

Creates an IndexEndpoint.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.CreateRequest Create(GoogleCloudAiplatformV1IndexEndpoint body, string parent)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1IndexEndpoint	body	The body of the request.
string	parent	Required. The resource name of the Location to create the IndexEndpoint in. Format: projects/{project}/locations/{location}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.CreateRequest

Delete(string)

Deletes an IndexEndpoint.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.DeleteRequest Delete(string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.DeleteRequest

DeployIndex(GoogleCloudAiplatformV1DeployIndexRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.DeployIndexRequest DeployIndex(GoogleCloudAiplatformV1DeployIndexRequest body, string indexEndpoint)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1DeployIndexRequest	body	The body of the request.
string	indexEndpoint	Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.DeployIndexRequest

FindNeighbors(GoogleCloudAiplatformV1FindNeighborsRequest, string)

Finds the nearest neighbors of each vector within the request.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.FindNeighborsRequest FindNeighbors(GoogleCloudAiplatformV1FindNeighborsRequest body, string indexEndpoint)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1FindNeighborsRequest	body	The body of the request.
string	indexEndpoint	Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.FindNeighborsRequest

Get(string)

Gets an IndexEndpoint.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.GetRequest Get(string name)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.GetRequest

List(string)

Lists IndexEndpoints in a Location.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.ListRequest List(string parent)

Parameters

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

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.ListRequest

MutateDeployedIndex(GoogleCloudAiplatformV1DeployedIndex, string)

Update an existing DeployedIndex under an IndexEndpoint.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.MutateDeployedIndexRequest MutateDeployedIndex(GoogleCloudAiplatformV1DeployedIndex body, string indexEndpoint)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1DeployedIndex	body	The body of the request.
string	indexEndpoint	Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.MutateDeployedIndexRequest

Patch(GoogleCloudAiplatformV1IndexEndpoint, string)

Updates an IndexEndpoint.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.PatchRequest Patch(GoogleCloudAiplatformV1IndexEndpoint body, string name)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1IndexEndpoint	body	The body of the request.
string	name	Output only. The resource name of the IndexEndpoint.

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.PatchRequest

ReadIndexDatapoints(GoogleCloudAiplatformV1ReadIndexDatapointsRequest, string)

Reads the datapoints/vectors of the given IDs. A maximum of 1000 datapoints can be retrieved in a batch.

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.ReadIndexDatapointsRequest ReadIndexDatapoints(GoogleCloudAiplatformV1ReadIndexDatapointsRequest body, string indexEndpoint)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1ReadIndexDatapointsRequest	body	The body of the request.
string	indexEndpoint	Required. The name of the index endpoint. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.ReadIndexDatapointsRequest

UndeployIndex(GoogleCloudAiplatformV1UndeployIndexRequest, string)

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

Declaration

public virtual ProjectsResource.LocationsResource.IndexEndpointsResource.UndeployIndexRequest UndeployIndex(GoogleCloudAiplatformV1UndeployIndexRequest body, string indexEndpoint)

Parameters

Type	Name	Description
GoogleCloudAiplatformV1UndeployIndexRequest	body	The body of the request.
string	indexEndpoint	Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}

Returns

Type	Description
ProjectsResource.LocationsResource.IndexEndpointsResource.UndeployIndexRequest