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

ProjectsLocationsCollectionsEnginesControls

class ProjectsLocationsCollectionsEnginesControls extends Resource (View source)

The "controls" collection of methods.

Typical usage is:

 $discoveryengineService = new Google\Service\DiscoveryEngine(...);
 $controls = $discoveryengineService->projects_locations_collections_engines_controls;

Methods

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

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. (controls.create)

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

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

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

Gets a Control. (controls.get)

GoogleCloudDiscoveryengineV1ListControlsResponse
listProjectsLocationsCollectionsEnginesControls(string $parent, array $optParams = [])

Lists all Controls by their parent DataStore.

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

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

Details

at line 52
GoogleCloudDiscoveryengineV1Control create(string $parent, GoogleCloudDiscoveryengineV1Control $postBody, array $optParams = [])

Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. (controls.create)

Parameters

string $parent

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction_id}/dataStores/{data_store_id} or projects/{project_number}/locations /{location_id}/collections/{collection_id}/engines/{engine_id}.
GoogleCloudDiscoveryengineV1Control $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Control

Exceptions

Exception

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

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

Parameters

string $name

Required. The resource name of the Control to delete. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction_id}/dataStores/{data_store_id}/controls/{control_id}
array $optParams

Optional parameters.

Return Value

GoogleProtobufEmpty

Exceptions

Exception

at line 85
GoogleCloudDiscoveryengineV1Control get(string $name, array $optParams = [])

Gets a Control. (controls.get)

Parameters

string $name

Required. The resource name of the Control to get. Format: projects/{project_number}/locations/{location_id}/collections/{colle ction_id}/dataStores/{data_store_id}/controls/{control_id}
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Control

Exceptions

Exception

at line 111
GoogleCloudDiscoveryengineV1ListControlsResponse listProjectsLocationsCollectionsEnginesControls(string $parent, array $optParams = [])

Lists all Controls by their parent DataStore.

(controls.listProjectsLocationsCollectionsEnginesControls)

Parameters

string $parent

Required. The data store resource name. Format: projec ts/{project_number}/locations/{location_id}/collections/{collection_id}/dataS tores/{data_store_id} or projects/{project_number}/locations/{location_id}/ collections/{collection_id}/engines/{engine_id}.
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1ListControlsResponse

Exceptions

Exception

at line 132
GoogleCloudDiscoveryengineV1Control patch(string $name, GoogleCloudDiscoveryengineV1Control $postBody, array $optParams = [])

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

Parameters

string $name

Immutable. Fully qualified name projects/locations/global/dataStore/controls
GoogleCloudDiscoveryengineV1Control $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDiscoveryengineV1Control

Exceptions

Exception