Cloud AI Platform v1 API - Class MatchService.MatchServiceClient (2.22.0)

Version 2.22.0

• 3.11.0 (latest)
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

public class MatchService.MatchServiceClient : ClientBase<MatchService.MatchServiceClient>

Reference documentation and code samples for the Cloud AI Platform v1 API class MatchService.MatchServiceClient.

Client for MatchService

Inheritance

object > ClientBase > ClientBaseMatchServiceMatchServiceClient > MatchService.MatchServiceClient

Inherited Members

ClientBase<MatchService.MatchServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.dll

Constructors

MatchServiceClient()

protected MatchServiceClient()

Protected parameterless constructor to allow creation of test doubles.

MatchServiceClient(CallInvoker)

public MatchServiceClient(CallInvoker callInvoker)

Creates a new client for MatchService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

MatchServiceClient(ChannelBase)

public MatchServiceClient(ChannelBase channel)

Creates a new client for MatchService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

MatchServiceClient(ClientBaseConfiguration)

protected MatchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient for the same target as this client.

FindNeighbors(FindNeighborsRequest, CallOptions)

public virtual FindNeighborsResponse FindNeighbors(FindNeighborsRequest request, CallOptions options)

Finds the nearest neighbors of each vector within the request.

Parameters
Name	Description
request	FindNeighborsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
FindNeighborsResponse	The response received from the server.

FindNeighbors(FindNeighborsRequest, Metadata, DateTime?, CancellationToken)

public virtual FindNeighborsResponse FindNeighbors(FindNeighborsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Finds the nearest neighbors of each vector within the request.

Parameters
Name	Description
request	FindNeighborsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
FindNeighborsResponse	The response received from the server.

FindNeighborsAsync(FindNeighborsRequest, CallOptions)

public virtual AsyncUnaryCall<FindNeighborsResponse> FindNeighborsAsync(FindNeighborsRequest request, CallOptions options)

Finds the nearest neighbors of each vector within the request.

Parameters
Name	Description
request	FindNeighborsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallFindNeighborsResponse	The call object.

FindNeighborsAsync(FindNeighborsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<FindNeighborsResponse> FindNeighborsAsync(FindNeighborsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Finds the nearest neighbors of each vector within the request.

Parameters
Name	Description
request	FindNeighborsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallFindNeighborsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override MatchService.MatchServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
MatchServiceMatchServiceClient

Overrides

ClientBase<MatchService.MatchServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

ReadIndexDatapoints(ReadIndexDatapointsRequest, CallOptions)

public virtual ReadIndexDatapointsResponse ReadIndexDatapoints(ReadIndexDatapointsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ReadIndexDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
ReadIndexDatapointsResponse	The response received from the server.

ReadIndexDatapoints(ReadIndexDatapointsRequest, Metadata, DateTime?, CancellationToken)

public virtual ReadIndexDatapointsResponse ReadIndexDatapoints(ReadIndexDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ReadIndexDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
ReadIndexDatapointsResponse	The response received from the server.

ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, CallOptions)

public virtual AsyncUnaryCall<ReadIndexDatapointsResponse> ReadIndexDatapointsAsync(ReadIndexDatapointsRequest request, CallOptions options)

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

Parameters
Name	Description
request	ReadIndexDatapointsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallReadIndexDatapointsResponse	The call object.

ReadIndexDatapointsAsync(ReadIndexDatapointsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ReadIndexDatapointsResponse> ReadIndexDatapointsAsync(ReadIndexDatapointsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ReadIndexDatapointsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallReadIndexDatapointsResponse	The call object.