Discovery Engine v1 API - Class DataStoreService.DataStoreServiceClient (1.1.0)

Version 1.1.0

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0-beta06

public class DataStoreService.DataStoreServiceClient : ClientBase<DataStoreService.DataStoreServiceClient>

Reference documentation and code samples for the Discovery Engine v1 API class DataStoreService.DataStoreServiceClient.

Client for DataStoreService

Inheritance

object > ClientBase > ClientBaseDataStoreServiceDataStoreServiceClient > DataStoreService.DataStoreServiceClient

Inherited Members

ClientBase<DataStoreService.DataStoreServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

DataStoreServiceClient()

protected DataStoreServiceClient()

Protected parameterless constructor to allow creation of test doubles.

DataStoreServiceClient(CallInvoker)

public DataStoreServiceClient(CallInvoker callInvoker)

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

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

DataStoreServiceClient(ChannelBase)

public DataStoreServiceClient(ChannelBase channel)

Creates a new client for DataStoreService

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

DataStoreServiceClient(ClientBaseConfiguration)

protected DataStoreServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateDataStore(CreateDataStoreRequest, CallOptions)

public virtual Operation CreateDataStore(CreateDataStoreRequest request, CallOptions options)

Creates a [DataStore][google.cloud.discoveryengine.v1.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

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

Returns
Type	Description
Operation	The response received from the server.

CreateDataStore(CreateDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateDataStore(CreateDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a [DataStore][google.cloud.discoveryengine.v1.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

Parameters
Name	Description
request	CreateDataStoreRequest 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
Operation	The response received from the server.

CreateDataStoreAsync(CreateDataStoreRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDataStoreAsync(CreateDataStoreRequest request, CallOptions options)

Creates a [DataStore][google.cloud.discoveryengine.v1.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateDataStoreAsync(CreateDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDataStoreAsync(CreateDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a [DataStore][google.cloud.discoveryengine.v1.DataStore].

DataStore is for storing [Documents][google.cloud.discoveryengine.v1.Document]. To serve these documents for Search, or Recommendation use case, an [Engine][google.cloud.discoveryengine.v1.Engine] needs to be created separately.

Parameters
Name	Description
request	CreateDataStoreRequest 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
AsyncUnaryCallOperation	The call object.

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.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

DeleteDataStore(DeleteDataStoreRequest, CallOptions)

public virtual Operation DeleteDataStore(DeleteDataStoreRequest request, CallOptions options)

Deletes a [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

Returns
Type	Description
Operation	The response received from the server.

DeleteDataStore(DeleteDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteDataStore(DeleteDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	DeleteDataStoreRequest 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
Operation	The response received from the server.

DeleteDataStoreAsync(DeleteDataStoreRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDataStoreAsync(DeleteDataStoreRequest request, CallOptions options)

Deletes a [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteDataStoreAsync(DeleteDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDataStoreAsync(DeleteDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	DeleteDataStoreRequest 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
AsyncUnaryCallOperation	The call object.

GetDataStore(GetDataStoreRequest, CallOptions)

public virtual DataStore GetDataStore(GetDataStoreRequest request, CallOptions options)

Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

Returns
Type	Description
DataStore	The response received from the server.

GetDataStore(GetDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual DataStore GetDataStore(GetDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	GetDataStoreRequest 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
DataStore	The response received from the server.

GetDataStoreAsync(GetDataStoreRequest, CallOptions)

public virtual AsyncUnaryCall<DataStore> GetDataStoreAsync(GetDataStoreRequest request, CallOptions options)

Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore].

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

Returns
Type	Description
AsyncUnaryCallDataStore	The call object.

GetDataStoreAsync(GetDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataStore> GetDataStoreAsync(GetDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a [DataStore][google.cloud.discoveryengine.v1.DataStore].

Parameters
Name	Description
request	GetDataStoreRequest 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
AsyncUnaryCallDataStore	The call object.

ListDataStores(ListDataStoresRequest, CallOptions)

public virtual ListDataStoresResponse ListDataStores(ListDataStoresRequest request, CallOptions options)

Lists all the [DataStore][google.cloud.discoveryengine.v1.DataStore]s associated with the project.

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

Returns
Type	Description
ListDataStoresResponse	The response received from the server.

ListDataStores(ListDataStoresRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDataStoresResponse ListDataStores(ListDataStoresRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [DataStore][google.cloud.discoveryengine.v1.DataStore]s associated with the project.

Parameters
Name	Description
request	ListDataStoresRequest 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
ListDataStoresResponse	The response received from the server.

ListDataStoresAsync(ListDataStoresRequest, CallOptions)

public virtual AsyncUnaryCall<ListDataStoresResponse> ListDataStoresAsync(ListDataStoresRequest request, CallOptions options)

Lists all the [DataStore][google.cloud.discoveryengine.v1.DataStore]s associated with the project.

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

Returns
Type	Description
AsyncUnaryCallListDataStoresResponse	The call object.

ListDataStoresAsync(ListDataStoresRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDataStoresResponse> ListDataStoresAsync(ListDataStoresRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the [DataStore][google.cloud.discoveryengine.v1.DataStore]s associated with the project.

Parameters
Name	Description
request	ListDataStoresRequest 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
AsyncUnaryCallListDataStoresResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override DataStoreService.DataStoreServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
DataStoreServiceDataStoreServiceClient

Overrides

ClientBase<DataStoreService.DataStoreServiceClient>.NewInstance(ClientBase.ClientBaseConfiguration)

UpdateDataStore(UpdateDataStoreRequest, CallOptions)

public virtual DataStore UpdateDataStore(UpdateDataStoreRequest request, CallOptions options)

Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore]

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

Returns
Type	Description
DataStore	The response received from the server.

UpdateDataStore(UpdateDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual DataStore UpdateDataStore(UpdateDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore]

Parameters
Name	Description
request	UpdateDataStoreRequest 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
DataStore	The response received from the server.

UpdateDataStoreAsync(UpdateDataStoreRequest, CallOptions)

public virtual AsyncUnaryCall<DataStore> UpdateDataStoreAsync(UpdateDataStoreRequest request, CallOptions options)

Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore]

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

Returns
Type	Description
AsyncUnaryCallDataStore	The call object.

UpdateDataStoreAsync(UpdateDataStoreRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<DataStore> UpdateDataStoreAsync(UpdateDataStoreRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a [DataStore][google.cloud.discoveryengine.v1.DataStore]

Parameters
Name	Description
request	UpdateDataStoreRequest 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
AsyncUnaryCallDataStore	The call object.