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

ProjectsLocationsCollectionsEngines

class ProjectsLocationsCollectionsEngines extends Resource (View source)

The "engines" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $engines = $discoveryengineService->projects_locations_collections_engines;

Methods

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

Creates a Engine. (engines.create)

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

Deletes a Engine. (engines.delete)

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

Gets a Engine. (engines.get)

GoogleCloudDiscoveryengineV1ListEnginesResponse
listProjectsLocationsCollectionsEngines(string $parent, array $optParams = [])

Lists all the Engines associated with the project.

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

Updates an Engine (engines.patch)

Details

at line 50
GoogleLongrunningOperation create(string $parent, GoogleCloudDiscoveryengineV1Engine $postBody, array $optParams = [])

Creates a Engine. (engines.create)

Parameters

string $parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.
GoogleCloudDiscoveryengineV1Engine $postBody
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 68
GoogleLongrunningOperation delete(string $name, array $optParams = [])

Deletes a Engine. (engines.delete)

Parameters

string $name

Required. Full resource name of Engine, such as projects /{project}/locations/{location}/collections/{collection_id}/engines/{engine_i d}. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned.
array $optParams

Optional parameters.

Return Value

GoogleLongrunningOperation

Exceptions

Exception

at line 84
GoogleCloudDiscoveryengineV1Engine get(string $name, array $optParams = [])

Gets a Engine. (engines.get)

Parameters

string $name

Required. Full resource name of Engine, such as projects /{project}/locations/{location}/collections/{collection_id}/engines/{engine_i d}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Engine

Exceptions

Exception

at line 105
GoogleCloudDiscoveryengineV1ListEnginesResponse listProjectsLocationsCollectionsEngines(string $parent, array $optParams = [])

Lists all the Engines associated with the project.

(engines.listProjectsLocationsCollectionsEngines)

Parameters

string $parent

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListEnginesResponse

Exceptions

Exception

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

Updates an Engine (engines.patch)

Parameters

string $name

Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: projects/{project_number}/locations/{location}/collectio ns/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /a-z0-9. Otherwise, an INVALID_ARGUMENT error is returned.
GoogleCloudDiscoveryengineV1Engine $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Engine

Exceptions

Exception