Cloud AI Platform v1 API - Class MatchService.MatchServiceClient (2.22.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

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
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

MatchServiceClient(ChannelBase)

public MatchServiceClient(ChannelBase channel)

Creates a new client for MatchService

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

MatchServiceClient(ClientBaseConfiguration)

protected MatchServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

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
TypeDescription
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
TypeDescription
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
NameDescription
requestFindNeighborsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestFindNeighborsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestFindNeighborsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestFindNeighborsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallFindNeighborsResponse

The call object.

NewInstance(ClientBaseConfiguration)

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

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
MatchServiceMatchServiceClient
Overrides

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
NameDescription
requestReadIndexDatapointsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestReadIndexDatapointsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
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
NameDescription
requestReadIndexDatapointsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
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
NameDescription
requestReadIndexDatapointsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallReadIndexDatapointsResponse

The call object.