Discovery Engine v1 API - Class DataStoreServiceClientImpl (1.3.0)

Version 1.3.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 sealed class DataStoreServiceClientImpl : DataStoreServiceClient

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

DataStoreService client wrapper implementation, for convenient use.

Inheritance

object > DataStoreServiceClient > DataStoreServiceClientImpl

Inherited Members

DataStoreServiceClient.DefaultEndpoint

DataStoreServiceClient.DefaultScopes

DataStoreServiceClient.ServiceMetadata

DataStoreServiceClient.CreateAsync(CancellationToken)

DataStoreServiceClient.Create()

DataStoreServiceClient.ShutdownDefaultChannelsAsync()

DataStoreServiceClient.CreateDataStoreAsync(CreateDataStoreRequest, CancellationToken)

DataStoreServiceClient.PollOnceCreateDataStore(string, CallSettings)

DataStoreServiceClient.PollOnceCreateDataStoreAsync(string, CallSettings)

DataStoreServiceClient.CreateDataStore(string, DataStore, string, CallSettings)

DataStoreServiceClient.CreateDataStoreAsync(string, DataStore, string, CallSettings)

DataStoreServiceClient.CreateDataStoreAsync(string, DataStore, string, CancellationToken)

DataStoreServiceClient.CreateDataStore(CollectionName, DataStore, string, CallSettings)

DataStoreServiceClient.CreateDataStoreAsync(CollectionName, DataStore, string, CallSettings)

DataStoreServiceClient.CreateDataStoreAsync(CollectionName, DataStore, string, CancellationToken)

DataStoreServiceClient.GetDataStoreAsync(GetDataStoreRequest, CancellationToken)

DataStoreServiceClient.GetDataStore(string, CallSettings)

DataStoreServiceClient.GetDataStoreAsync(string, CallSettings)

DataStoreServiceClient.GetDataStoreAsync(string, CancellationToken)

DataStoreServiceClient.GetDataStore(DataStoreName, CallSettings)

DataStoreServiceClient.GetDataStoreAsync(DataStoreName, CallSettings)

DataStoreServiceClient.GetDataStoreAsync(DataStoreName, CancellationToken)

DataStoreServiceClient.ListDataStores(string, string, int?, CallSettings)

DataStoreServiceClient.ListDataStoresAsync(string, string, int?, CallSettings)

DataStoreServiceClient.ListDataStores(CollectionName, string, int?, CallSettings)

DataStoreServiceClient.ListDataStoresAsync(CollectionName, string, int?, CallSettings)

DataStoreServiceClient.DeleteDataStoreAsync(DeleteDataStoreRequest, CancellationToken)

DataStoreServiceClient.PollOnceDeleteDataStore(string, CallSettings)

DataStoreServiceClient.PollOnceDeleteDataStoreAsync(string, CallSettings)

DataStoreServiceClient.DeleteDataStore(string, CallSettings)

DataStoreServiceClient.DeleteDataStoreAsync(string, CallSettings)

DataStoreServiceClient.DeleteDataStoreAsync(string, CancellationToken)

DataStoreServiceClient.DeleteDataStore(DataStoreName, CallSettings)

DataStoreServiceClient.DeleteDataStoreAsync(DataStoreName, CallSettings)

DataStoreServiceClient.DeleteDataStoreAsync(DataStoreName, CancellationToken)

DataStoreServiceClient.UpdateDataStoreAsync(UpdateDataStoreRequest, CancellationToken)

DataStoreServiceClient.UpdateDataStore(DataStore, FieldMask, CallSettings)

DataStoreServiceClient.UpdateDataStoreAsync(DataStore, FieldMask, CallSettings)

DataStoreServiceClient.UpdateDataStoreAsync(DataStore, FieldMask, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Remarks

Service for managing [DataStore][google.cloud.discoveryengine.v1.DataStore] configuration.

Constructors

DataStoreServiceClientImpl(DataStoreServiceClient, DataStoreServiceSettings, ILogger)

public DataStoreServiceClientImpl(DataStoreService.DataStoreServiceClient grpcClient, DataStoreServiceSettings settings, ILogger logger)

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

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

Properties

CreateDataStoreOperationsClient

public override OperationsClient CreateDataStoreOperationsClient { get; }

The long-running operations client for CreateDataStore.

Property Value
Type	Description
OperationsClient

Overrides

DataStoreServiceClient.CreateDataStoreOperationsClient

DeleteDataStoreOperationsClient

public override OperationsClient DeleteDataStoreOperationsClient { get; }

The long-running operations client for DeleteDataStore.

Property Value
Type	Description
OperationsClient

Overrides

DataStoreServiceClient.DeleteDataStoreOperationsClient

GrpcClient

public override DataStoreService.DataStoreServiceClient GrpcClient { get; }

The underlying gRPC DataStoreService client

Property Value
Type	Description
DataStoreServiceDataStoreServiceClient

Overrides

DataStoreServiceClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

DataStoreServiceClient.LocationsClient

Methods

CreateDataStore(CreateDataStoreRequest, CallSettings)

public override Operation<DataStore, CreateDataStoreMetadata> CreateDataStore(CreateDataStoreRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
OperationDataStoreCreateDataStoreMetadata	The RPC response.

Overrides

DataStoreServiceClient.CreateDataStore(CreateDataStoreRequest, CallSettings)

CreateDataStoreAsync(CreateDataStoreRequest, CallSettings)

public override Task<Operation<DataStore, CreateDataStoreMetadata>> CreateDataStoreAsync(CreateDataStoreRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskOperationDataStoreCreateDataStoreMetadata	A Task containing the RPC response.

Overrides

DataStoreServiceClient.CreateDataStoreAsync(CreateDataStoreRequest, CallSettings)

DeleteDataStore(DeleteDataStoreRequest, CallSettings)

public override Operation<Empty, DeleteDataStoreMetadata> DeleteDataStore(DeleteDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	DeleteDataStoreRequest 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
OperationEmptyDeleteDataStoreMetadata	The RPC response.

Overrides

DataStoreServiceClient.DeleteDataStore(DeleteDataStoreRequest, CallSettings)

DeleteDataStoreAsync(DeleteDataStoreRequest, CallSettings)

public override Task<Operation<Empty, DeleteDataStoreMetadata>> DeleteDataStoreAsync(DeleteDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	DeleteDataStoreRequest 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
TaskOperationEmptyDeleteDataStoreMetadata	A Task containing the RPC response.

Overrides

DataStoreServiceClient.DeleteDataStoreAsync(DeleteDataStoreRequest, CallSettings)

GetDataStore(GetDataStoreRequest, CallSettings)

public override DataStore GetDataStore(GetDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetDataStoreRequest 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
DataStore	The RPC response.

Overrides

DataStoreServiceClient.GetDataStore(GetDataStoreRequest, CallSettings)

GetDataStoreAsync(GetDataStoreRequest, CallSettings)

public override Task<DataStore> GetDataStoreAsync(GetDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	GetDataStoreRequest 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
TaskDataStore	A Task containing the RPC response.

Overrides

DataStoreServiceClient.GetDataStoreAsync(GetDataStoreRequest, CallSettings)

ListDataStores(ListDataStoresRequest, CallSettings)

public override PagedEnumerable<ListDataStoresResponse, DataStore> ListDataStores(ListDataStoresRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListDataStoresRequest 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
PagedEnumerableListDataStoresResponseDataStore	A pageable sequence of DataStore resources.

Overrides

DataStoreServiceClient.ListDataStores(ListDataStoresRequest, CallSettings)

ListDataStoresAsync(ListDataStoresRequest, CallSettings)

public override PagedAsyncEnumerable<ListDataStoresResponse, DataStore> ListDataStoresAsync(ListDataStoresRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	ListDataStoresRequest 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
PagedAsyncEnumerableListDataStoresResponseDataStore	A pageable asynchronous sequence of DataStore resources.

Overrides

DataStoreServiceClient.ListDataStoresAsync(ListDataStoresRequest, CallSettings)

UpdateDataStore(UpdateDataStoreRequest, CallSettings)

public override DataStore UpdateDataStore(UpdateDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateDataStoreRequest 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
DataStore	The RPC response.

Overrides

DataStoreServiceClient.UpdateDataStore(UpdateDataStoreRequest, CallSettings)

UpdateDataStoreAsync(UpdateDataStoreRequest, CallSettings)

public override Task<DataStore> UpdateDataStoreAsync(UpdateDataStoreRequest request, CallSettings callSettings = null)

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

Parameters
Name	Description
request	UpdateDataStoreRequest 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
TaskDataStore	A Task containing the RPC response.

Overrides

DataStoreServiceClient.UpdateDataStoreAsync(UpdateDataStoreRequest, CallSettings)