Vector Search v1 API - Class DataObjectSearchServiceClientImpl (1.0.0-beta01)

public sealed class DataObjectSearchServiceClientImpl : DataObjectSearchServiceClient

Reference documentation and code samples for the Vector Search v1 API class DataObjectSearchServiceClientImpl.

DataObjectSearchService client wrapper implementation, for convenient use.

Inheritance

object > DataObjectSearchServiceClient > DataObjectSearchServiceClientImpl

Inherited Members

DataObjectSearchServiceClient.DefaultEndpoint

DataObjectSearchServiceClient.DefaultScopes

DataObjectSearchServiceClient.ServiceMetadata

DataObjectSearchServiceClient.CreateAsync(CancellationToken)

DataObjectSearchServiceClient.Create()

DataObjectSearchServiceClient.ShutdownDefaultChannelsAsync()

DataObjectSearchServiceClient.AggregateDataObjectsAsync(AggregateDataObjectsRequest, CancellationToken)

DataObjectSearchServiceClient.BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.VectorSearch.V1

Assembly

Google.Cloud.VectorSearch.V1.dll

Remarks

Service for searching data objects.

Constructors

DataObjectSearchServiceClientImpl(DataObjectSearchServiceClient, DataObjectSearchServiceSettings, ILogger)

public DataObjectSearchServiceClientImpl(DataObjectSearchService.DataObjectSearchServiceClient grpcClient, DataObjectSearchServiceSettings settings, ILogger logger)

Constructs a client wrapper for the DataObjectSearchService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	DataObjectSearchServiceDataObjectSearchServiceClient The underlying gRPC client.
settings	DataObjectSearchServiceSettings The base DataObjectSearchServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override DataObjectSearchService.DataObjectSearchServiceClient GrpcClient { get; }

The underlying gRPC DataObjectSearchService client

Property Value
Type	Description
DataObjectSearchServiceDataObjectSearchServiceClient

Overrides

DataObjectSearchServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

DataObjectSearchServiceClient.LocationsClient

Methods

AggregateDataObjects(AggregateDataObjectsRequest, CallSettings)

public override AggregateDataObjectsResponse AggregateDataObjects(AggregateDataObjectsRequest request, CallSettings callSettings = null)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
AggregateDataObjectsResponse	The RPC response.

Overrides

DataObjectSearchServiceClient.AggregateDataObjects(AggregateDataObjectsRequest, CallSettings)

AggregateDataObjectsAsync(AggregateDataObjectsRequest, CallSettings)

public override Task<AggregateDataObjectsResponse> AggregateDataObjectsAsync(AggregateDataObjectsRequest request, CallSettings callSettings = null)

Aggregates data objects.

Parameters
Name	Description
request	AggregateDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskAggregateDataObjectsResponse	A Task containing the RPC response.

Overrides

DataObjectSearchServiceClient.AggregateDataObjectsAsync(AggregateDataObjectsRequest, CallSettings)

BatchSearchDataObjects(BatchSearchDataObjectsRequest, CallSettings)

public override BatchSearchDataObjectsResponse BatchSearchDataObjects(BatchSearchDataObjectsRequest request, CallSettings callSettings = null)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
BatchSearchDataObjectsResponse	The RPC response.

Overrides

DataObjectSearchServiceClient.BatchSearchDataObjects(BatchSearchDataObjectsRequest, CallSettings)

BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest, CallSettings)

public override Task<BatchSearchDataObjectsResponse> BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest request, CallSettings callSettings = null)

Batch searches data objects.

Parameters
Name	Description
request	BatchSearchDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBatchSearchDataObjectsResponse	A Task containing the RPC response.

Overrides

DataObjectSearchServiceClient.BatchSearchDataObjectsAsync(BatchSearchDataObjectsRequest, CallSettings)

QueryDataObjects(QueryDataObjectsRequest, CallSettings)

public override PagedEnumerable<QueryDataObjectsResponse, DataObject> QueryDataObjects(QueryDataObjectsRequest request, CallSettings callSettings = null)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableQueryDataObjectsResponseDataObject	A pageable sequence of DataObject resources.

Overrides

DataObjectSearchServiceClient.QueryDataObjects(QueryDataObjectsRequest, CallSettings)

QueryDataObjectsAsync(QueryDataObjectsRequest, CallSettings)

public override PagedAsyncEnumerable<QueryDataObjectsResponse, DataObject> QueryDataObjectsAsync(QueryDataObjectsRequest request, CallSettings callSettings = null)

Queries data objects.

Parameters
Name	Description
request	QueryDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableQueryDataObjectsResponseDataObject	A pageable asynchronous sequence of DataObject resources.

Overrides

DataObjectSearchServiceClient.QueryDataObjectsAsync(QueryDataObjectsRequest, CallSettings)

SearchDataObjects(SearchDataObjectsRequest, CallSettings)

public override PagedEnumerable<SearchDataObjectsResponse, SearchResult> SearchDataObjects(SearchDataObjectsRequest request, CallSettings callSettings = null)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableSearchDataObjectsResponseSearchResult	A pageable sequence of SearchResult resources.

Overrides

DataObjectSearchServiceClient.SearchDataObjects(SearchDataObjectsRequest, CallSettings)

SearchDataObjectsAsync(SearchDataObjectsRequest, CallSettings)

public override PagedAsyncEnumerable<SearchDataObjectsResponse, SearchResult> SearchDataObjectsAsync(SearchDataObjectsRequest request, CallSettings callSettings = null)

Searches data objects.

Parameters
Name	Description
request	SearchDataObjectsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableSearchDataObjectsResponseSearchResult	A pageable asynchronous sequence of SearchResult resources.

Overrides

DataObjectSearchServiceClient.SearchDataObjectsAsync(SearchDataObjectsRequest, CallSettings)