Class ProjectsResource.LocationsResource.DataStoresResource

The "dataStores" collection of methods.

Inheritance

object

ProjectsResource.LocationsResource.DataStoresResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.DiscoveryEngine.v1alpha

Assembly: Google.Apis.DiscoveryEngine.v1alpha.dll

Syntax

public class ProjectsResource.LocationsResource.DataStoresResource

Constructors

DataStoresResource(IClientService)

Constructs a new resource.

Declaration

public DataStoresResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Branches

Gets the Branches resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.BranchesResource Branches { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.BranchesResource

CompletionConfig

Gets the CompletionConfig resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.CompletionConfigResource CompletionConfig { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.CompletionConfigResource

CompletionSuggestions

Gets the CompletionSuggestions resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.CompletionSuggestionsResource CompletionSuggestions { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.CompletionSuggestionsResource

Controls

Gets the Controls resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ControlsResource Controls { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ControlsResource

Conversations

Gets the Conversations resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource Conversations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ConversationsResource

Models

Gets the Models resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ModelsResource Models { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ModelsResource

Operations

Gets the Operations resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.OperationsResource Operations { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.OperationsResource

Schemas

Gets the Schemas resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.SchemasResource Schemas { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.SchemasResource

ServingConfigs

Gets the ServingConfigs resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource ServingConfigs { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ServingConfigsResource

Sessions

Gets the Sessions resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.SessionsResource Sessions { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.SessionsResource

SiteSearchEngine

Gets the SiteSearchEngine resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource SiteSearchEngine { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.SiteSearchEngineResource

SuggestionDenyListEntries

Gets the SuggestionDenyListEntries resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.SuggestionDenyListEntriesResource SuggestionDenyListEntries { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.SuggestionDenyListEntriesResource

UserEvents

Gets the UserEvents resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource UserEvents { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.UserEventsResource

WidgetConfigs

Gets the WidgetConfigs resource.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.WidgetConfigsResource WidgetConfigs { get; }

Property Value

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.WidgetConfigsResource

Methods

AddPatientFilter(GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest, string)

Adds a group of patient IDs as a patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. The filter group must be a FHIR resource name of type Group, and the filter will be constructed from the direct members of the group which are Patient resources.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.AddPatientFilterRequest AddPatientFilter(GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest body, string dataStore)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaAddPatientFilterRequest	body	The body of the request.
string	dataStore	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.AddPatientFilterRequest

CompleteQuery(string)

Completes the specified user input with keyword suggestions.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.CompleteQueryRequest CompleteQuery(string dataStore)

Parameters

Type	Name	Description
string	dataStore	Required. The parent data store resource name for which the completion is performed, such as projects/*/locations/global/collections/default_collection/dataStores/default_data_store.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.CompleteQueryRequest

Create(GoogleCloudDiscoveryengineV1alphaDataStore, string)

Creates a DataStore. DataStore is for storing Documents. To serve these documents for Search, or Recommendation use case, an Engine needs to be created separately.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.CreateRequest Create(GoogleCloudDiscoveryengineV1alphaDataStore body, string parent)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaDataStore	body	The body of the request.
string	parent	Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.CreateRequest

Delete(string)

Deletes a DataStore.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.DeleteRequest Delete(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the DataStore to delete does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.DeleteRequest

DeletePatientFilter(GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest, string)

Deletes the entire patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.DeletePatientFilterRequest DeletePatientFilter(GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest body, string dataStore)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaDeletePatientFiltersRequest	body	The body of the request.
string	dataStore	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.DeletePatientFilterRequest

Get(string)

Gets a DataStore.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.GetRequest Get(string name)

Parameters

Type	Name	Description
string	name	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.GetRequest

GetDocumentProcessingConfig(string)

Gets a DocumentProcessingConfig.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.GetDocumentProcessingConfigRequest GetDocumentProcessingConfig(string name)

Parameters

Type	Name	Description
string	name	Required. Full DocumentProcessingConfig resource name. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/documentProcessingConfig

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.GetDocumentProcessingConfigRequest

GetSiteSearchEngine(string)

Gets the SiteSearchEngine.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.GetSiteSearchEngineRequest GetSiteSearchEngine(string name)

Parameters

Type	Name	Description
string	name	Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.GetSiteSearchEngineRequest

List(string)

Lists all the DataStores associated with the project.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ListRequest List(string parent)

Parameters

Type	Name	Description
string	parent	Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection_id}. If the caller does not have permission to list DataStores under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ListRequest

Patch(GoogleCloudDiscoveryengineV1alphaDataStore, string)

Updates a DataStore

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.PatchRequest Patch(GoogleCloudDiscoveryengineV1alphaDataStore body, string name)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaDataStore	body	The body of the request.
string	name	Immutable. Identifier. The full resource name of the data store. Format: projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.PatchRequest

RemovePatientFilter(GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest, string)

Removes a group of patient IDs from the patient filter for the data store. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the list of patient IDs to remove will be constructed from the direct members of the group which are Patient resources.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.RemovePatientFilterRequest RemovePatientFilter(GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest body, string dataStore)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaRemovePatientFilterRequest	body	The body of the request.
string	dataStore	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore does not have a patient filter, a NOT_FOUND error will be returned

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.RemovePatientFilterRequest

ReplacePatientFilter(GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest, string)

Replaces the patient filter for the data store. This method is essentially a combination of DeletePatientFilters and AddPatientFilter. Patient filters are empty by default when a data store is created, and are stored in a separate table. The data store must first be created, and must be a healthcare data store. This method will fail if the data store does not have a patient filter. The filter group must be a FHIR resource name of type Group, and the new filter will be constructed from the direct members of the group which are Patient resources.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.ReplacePatientFilterRequest ReplacePatientFilter(GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest body, string dataStore)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaReplacePatientFilterRequest	body	The body of the request.
string	dataStore	Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}. If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested DataStore does not exist, a NOT_FOUND error is returned. If the requested DataStore already has a patient filter, an ALREADY_EXISTS error will be returned.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.ReplacePatientFilterRequest

UpdateDocumentProcessingConfig(GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig, string)

Updates the DocumentProcessingConfig. DocumentProcessingConfig is a singleon resource of DataStore. It's empty when DataStore is created. The first call to this method will set up DocumentProcessingConfig.

Declaration

public virtual ProjectsResource.LocationsResource.DataStoresResource.UpdateDocumentProcessingConfigRequest UpdateDocumentProcessingConfig(GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig body, string name)

Parameters

Type	Name	Description
GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig	body	The body of the request.
string	name	The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

Returns

Type	Description
ProjectsResource.LocationsResource.DataStoresResource.UpdateDocumentProcessingConfigRequest