com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.DataStores

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.DataStores

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections

public class DiscoveryEngine.Projects.Locations.Collections.DataStores
extends Object

The "dataStores" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches The "branches" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionConfig The "completionConfig" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionSuggestions The "completionSuggestions" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Controls The "controls" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations The "conversations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Create
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.CustomModels The "customModels" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Delete
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Get
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.GetSiteSearchEngine
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.List
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Models The "models" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Operations The "operations" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Patch
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Schemas The "schemas" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.ServingConfigs The "servingConfigs" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.Sessions The "sessions" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine The "siteSearchEngine" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.SuggestionDenyListEntries The "suggestionDenyListEntries" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents The "userEvents" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.DataStores.WidgetConfigs The "widgetConfigs" collection of methods.

Constructor Summary

Constructors

Constructor and Description
DataStores()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches	branches() An accessor for creating requests from the Branches collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery	completeQuery(String dataStore) Completes the specified user input with keyword suggestions.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionConfig	completionConfig() An accessor for creating requests from the CompletionConfig collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionSuggestions	completionSuggestions() An accessor for creating requests from the CompletionSuggestions collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Controls	controls() An accessor for creating requests from the Controls collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations	conversations() An accessor for creating requests from the Conversations collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Create	create(String parent, GoogleCloudDiscoveryengineV1DataStore content) Creates a DataStore.
DiscoveryEngine.Projects.Locations.Collections.DataStores.CustomModels	customModels() An accessor for creating requests from the CustomModels collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Delete	delete(String name) Deletes a DataStore.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Get	get(String name) Gets a DataStore.
DiscoveryEngine.Projects.Locations.Collections.DataStores.GetSiteSearchEngine	getSiteSearchEngine(String name) Gets the SiteSearchEngine.
DiscoveryEngine.Projects.Locations.Collections.DataStores.List	list(String parent) Lists all the DataStores associated with the project.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Models	models() An accessor for creating requests from the Models collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Operations	operations() An accessor for creating requests from the Operations collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Patch	patch(String name, GoogleCloudDiscoveryengineV1DataStore content) Updates a DataStore Create a request for the method "dataStores.patch".
DiscoveryEngine.Projects.Locations.Collections.DataStores.Schemas	schemas() An accessor for creating requests from the Schemas collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.ServingConfigs	servingConfigs() An accessor for creating requests from the ServingConfigs collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.Sessions	sessions() An accessor for creating requests from the Sessions collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine	siteSearchEngine() An accessor for creating requests from the SiteSearchEngine collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.SuggestionDenyListEntries	suggestionDenyListEntries() An accessor for creating requests from the SuggestionDenyListEntries collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel	trainCustomModel(String dataStore, GoogleCloudDiscoveryengineV1TrainCustomModelRequest content) Trains a custom model.
DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents	userEvents() An accessor for creating requests from the UserEvents collection.
DiscoveryEngine.Projects.Locations.Collections.DataStores.WidgetConfigs	widgetConfigs() An accessor for creating requests from the WidgetConfigs collection.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DataStores

public DataStores()

Method Detail

completeQuery

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompleteQuery completeQuery(String dataStore)
                                                                                      throws IOException

Completes the specified user input with keyword suggestions. Create a request for the method "dataStores.completeQuery". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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:

the request

Throws:

IOException

create

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Create create(String parent,
                                                                               GoogleCloudDiscoveryengineV1DataStore content)
                                                                        throws IOException

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. Create a request for the method "dataStores.create". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

parent - Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.

content - the GoogleCloudDiscoveryengineV1DataStore

Returns:

the request

Throws:

IOException

delete

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Delete delete(String name)
                                                                        throws IOException

Deletes a DataStore. Create a request for the method "dataStores.delete". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_stor e_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:

the request

Throws:

IOException

get

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Get get(String name)
                                                                  throws IOException

Gets a DataStore. Create a request for the method "dataStores.get". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_stor e_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:

the request

Throws:

IOException

getSiteSearchEngine

public DiscoveryEngine.Projects.Locations.Collections.DataStores.GetSiteSearchEngine getSiteSearchEngine(String name)
                                                                                                  throws IOException

Gets the SiteSearchEngine. Create a request for the method "dataStores.getSiteSearchEngine". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Required. Resource name of SiteSearchEngine, such as `projects/{project}/locations/{location}/collec tions/{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:

the request

Throws:

IOException

list

public DiscoveryEngine.Projects.Locations.Collections.DataStores.List list(String parent)
                                                                    throws IOException

Lists all the DataStores associated with the project. Create a request for the method "dataStores.list". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

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:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Patch patch(String name,
                                                                             GoogleCloudDiscoveryengineV1DataStore content)
                                                                      throws IOException

Updates a DataStore Create a request for the method "dataStores.patch". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

name - Immutable. Identifier. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_stor e_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

content - the GoogleCloudDiscoveryengineV1DataStore

Returns:

the request

Throws:

IOException

trainCustomModel

public DiscoveryEngine.Projects.Locations.Collections.DataStores.TrainCustomModel trainCustomModel(String dataStore,
                                                                                                   GoogleCloudDiscoveryengineV1TrainCustomModelRequest content)
                                                                                            throws IOException

Trains a custom model. Create a request for the method "dataStores.trainCustomModel". This request holds the parameters needed by the discoveryengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Parameters:

dataStore - Required. The resource name of the Data Store, such as `projects/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.

content - the GoogleCloudDiscoveryengineV1TrainCustomModelRequest

Returns:

the request

Throws:

IOException

branches

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Branches branches()

An accessor for creating requests from the Branches collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Branches.List request = discoveryengine.branches().list(parameters ...)
 

Returns:

the resource collection

completionConfig

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionConfig completionConfig()

An accessor for creating requests from the CompletionConfig collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.CompletionConfig.List request = discoveryengine.completionConfig().list(parameters ...)
 

Returns:

the resource collection

completionSuggestions

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CompletionSuggestions completionSuggestions()

An accessor for creating requests from the CompletionSuggestions collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.CompletionSuggestions.List request = discoveryengine.completionSuggestions().list(parameters ...)
 

Returns:

the resource collection

controls

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Controls controls()

An accessor for creating requests from the Controls collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Controls.List request = discoveryengine.controls().list(parameters ...)
 

Returns:

the resource collection

conversations

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Conversations conversations()

An accessor for creating requests from the Conversations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Conversations.List request = discoveryengine.conversations().list(parameters ...)
 

Returns:

the resource collection

customModels

public DiscoveryEngine.Projects.Locations.Collections.DataStores.CustomModels customModels()

An accessor for creating requests from the CustomModels collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.CustomModels.List request = discoveryengine.customModels().list(parameters ...)
 

Returns:

the resource collection

models

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Models models()

An accessor for creating requests from the Models collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Models.List request = discoveryengine.models().list(parameters ...)
 

Returns:

the resource collection

operations

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Operations operations()

An accessor for creating requests from the Operations collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Operations.List request = discoveryengine.operations().list(parameters ...)
 

Returns:

the resource collection

schemas

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Schemas schemas()

An accessor for creating requests from the Schemas collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Schemas.List request = discoveryengine.schemas().list(parameters ...)
 

Returns:

the resource collection

servingConfigs

public DiscoveryEngine.Projects.Locations.Collections.DataStores.ServingConfigs servingConfigs()

An accessor for creating requests from the ServingConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.ServingConfigs.List request = discoveryengine.servingConfigs().list(parameters ...)
 

Returns:

the resource collection

sessions

public DiscoveryEngine.Projects.Locations.Collections.DataStores.Sessions sessions()

An accessor for creating requests from the Sessions collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Sessions.List request = discoveryengine.sessions().list(parameters ...)
 

Returns:

the resource collection

siteSearchEngine

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SiteSearchEngine siteSearchEngine()

An accessor for creating requests from the SiteSearchEngine collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.SiteSearchEngine.List request = discoveryengine.siteSearchEngine().list(parameters ...)
 

Returns:

the resource collection

suggestionDenyListEntries

public DiscoveryEngine.Projects.Locations.Collections.DataStores.SuggestionDenyListEntries suggestionDenyListEntries()

An accessor for creating requests from the SuggestionDenyListEntries collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.SuggestionDenyListEntries.List request = discoveryengine.suggestionDenyListEntries().list(parameters ...)
 

Returns:

the resource collection

userEvents

public DiscoveryEngine.Projects.Locations.Collections.DataStores.UserEvents userEvents()

An accessor for creating requests from the UserEvents collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.UserEvents.List request = discoveryengine.userEvents().list(parameters ...)
 

Returns:

the resource collection

widgetConfigs

public DiscoveryEngine.Projects.Locations.Collections.DataStores.WidgetConfigs widgetConfigs()

An accessor for creating requests from the WidgetConfigs collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.WidgetConfigs.List request = discoveryengine.widgetConfigs().list(parameters ...)
 

Returns:

the resource collection