1. class
  2. Google
  3. \
  4. Service
  5. \
  6. DiscoveryEngine
  7. \
  8. Resource
  9. \
  10. ProjectsLocationsCollectionsEnginesSessions

ProjectsLocationsCollectionsEnginesSessions

class ProjectsLocationsCollectionsEnginesSessions extends Resource (View source)

The "sessions" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $sessions = $discoveryengineService->projects_locations_collections_engines_sessions;

Methods

GoogleCloudDiscoveryengineV1Session
create(string $parent, GoogleCloudDiscoveryengineV1Session $postBody, array $optParams = [])

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. (sessions.create)

GoogleProtobufEmpty
delete(string $name, array $optParams = [])

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. (sessions.delete)

GoogleCloudDiscoveryengineV1Session
get(string $name, array $optParams = [])

Gets a Session. (sessions.get)

GoogleCloudDiscoveryengineV1ListSessionsResponse
listProjectsLocationsCollectionsEnginesSessions(string $parent, array $optParams = [])

Lists all Sessions by their parent DataStore.

GoogleCloudDiscoveryengineV1Session
patch(string $name, GoogleCloudDiscoveryengineV1Session $postBody, array $optParams = [])

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. (sessions.patch)

Details

at line 46
GoogleCloudDiscoveryengineV1Session create(string $parent, GoogleCloudDiscoveryengineV1Session $postBody, array $optParams = [])

Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. (sessions.create)

Parameters

string $parent

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}
GoogleCloudDiscoveryengineV1Session $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Session

Exceptions

Exception

at line 63
GoogleProtobufEmpty delete(string $name, array $optParams = [])

Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. (sessions.delete)

Parameters

string $name

Required. The resource name of the Session to delete. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}/sessions/{session_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 79
GoogleCloudDiscoveryengineV1Session get(string $name, array $optParams = [])

Gets a Session. (sessions.get)

Parameters

string $name

Required. The resource name of the Session to get. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction}/dataStores/{data_store_id}/sessions/{session_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Session

Exceptions

Exception

at line 107
GoogleCloudDiscoveryengineV1ListSessionsResponse listProjectsLocationsCollectionsEnginesSessions(string $parent, array $optParams = [])

Lists all Sessions by their parent DataStore.

(sessions.listProjectsLocationsCollectionsEnginesSessions)

Parameters

string $parent

Required. The data store resource name. Format: projec ts/{project_number}/locations/{location_id}/collections/{collection}/dataStor es/{data_store_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListSessionsResponse

Exceptions

Exception

at line 128
GoogleCloudDiscoveryengineV1Session patch(string $name, GoogleCloudDiscoveryengineV1Session $postBody, array $optParams = [])

Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. (sessions.patch)

Parameters

string $name

Immutable. Fully qualified name projects/{project}/locat ions/global/collections/{collection}/engines/{engine}/sessions
GoogleCloudDiscoveryengineV1Session $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Session

Exceptions

Exception