com.google.api.services.discoveryengine.v1

Class DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions

java.lang.Object

com.google.api.services.discoveryengine.v1.DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions

Enclosing class:

DiscoveryEngine.Projects.Locations.Collections.Engines

public class DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions
extends Object

The "sessions" collection of methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Answers The "answers" collection of methods.
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Create
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Delete
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Get
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.List
class	DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Patch

Constructor Summary

Constructors

Constructor and Description
Sessions()

Method Summary

Modifier and Type	Method and Description
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Answers	answers() An accessor for creating requests from the Answers collection.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Create	create(String parent, GoogleCloudDiscoveryengineV1Session content) Creates a Session.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Delete	delete(String name) Deletes a Session.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Get	get(String name) Gets a Session.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.List	list(String parent) Lists all Sessions by their parent DataStore.
DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Patch	patch(String name, GoogleCloudDiscoveryengineV1Session content) Updates a Session.

Methods inherited from class java.lang.Object

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

Constructor Detail

Sessions

public Sessions()

Method Detail

create

public DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Create create(String parent,
                                                                                     GoogleCloudDiscoveryengineV1Session content)
                                                                              throws IOException

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. Create a request for the method "sessions.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. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_i d}`

content - the GoogleCloudDiscoveryengineV1Session

Returns:

the request

Throws:

IOException

delete

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

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. Create a request for the method "sessions.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. The resource name of the Session to delete. Format: `projects/{project}/locations/{locatio n}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Returns:

the request

Throws:

IOException

get

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

Gets a Session. Create a request for the method "sessions.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. The resource name of the Session to get. Format: `projects/{project}/locations/{location}/ collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}`

Returns:

the request

Throws:

IOException

list

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

Lists all Sessions by their parent DataStore. Create a request for the method "sessions.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 data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_i d}`

Returns:

the request

Throws:

IOException

patch

public DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Patch patch(String name,
                                                                                   GoogleCloudDiscoveryengineV1Session content)
                                                                            throws IOException

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. Create a request for the method "sessions.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. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions`

content - the GoogleCloudDiscoveryengineV1Session

Returns:

the request

Throws:

IOException

answers

public DiscoveryEngine.Projects.Locations.Collections.Engines.Sessions.Answers answers()

An accessor for creating requests from the Answers collection.

The typical use is:

    DiscoveryEngine discoveryengine = new DiscoveryEngine(...);
    DiscoveryEngine.Answers.List request = discoveryengine.answers().list(parameters ...)
 

Returns:

the resource collection