Discovery Engine v1 API - Class DataStoreServiceClientImpl (1.17.0) 

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

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

DeleteDataStoreOperationsClient

public override OperationsClient DeleteDataStoreOperationsClient { get; }

The long-running operations client for DeleteDataStore.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override DataStoreService.DataStoreServiceClient GrpcClient { get; }

The underlying gRPC DataStoreService client

Property Value
Type Description
DataStoreServiceDataStoreServiceClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

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

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

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

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

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

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

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Parameters
Name Description
request GetIamPolicyRequest

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
Policy

The RPC response.
Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

Gets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist. An empty policy is returned if the resource exists but does not have a policy set on it.

Parameters
Name Description
request GetIamPolicyRequest

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
TaskPolicy

A Task containing the RPC response.
Overrides

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

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

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: roles/discoveryengine.admin roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer roles/discoveryengine.agentspaceViewer roles/discoveryengine.user roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a warning in logging.

Parameters
Name Description
request SetIamPolicyRequest

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
Policy

The RPC response.
Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

Sets the IAM access control policy for a [DataStore][google.cloud.discoveryengine.v1.DataStore]. A NOT_FOUND error is returned if the resource does not exist.

Important: When setting a policy directly on a DataStore resource, the only recommended roles in the bindings are: roles/discoveryengine.admin roles/discoveryengine.agentspaceAdmin roles/discoveryengine.viewer roles/discoveryengine.agentspaceViewer roles/discoveryengine.user roles/discoveryengine.agentspaceUser Attempting to grant any other role will result in a warning in logging.

Parameters
Name Description
request SetIamPolicyRequest

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
TaskPolicy

A Task containing the RPC response.
Overrides

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

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