controls

Creates, updates, deletes, gets or lists a controls resource.

Overview

Name	controls
Type	Resource
Id	google.discoveryengine.controls

Fields

The following fields are returned by SELECT queries:

projects_locations_collections_data_stores_controls_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

projects_locations_collections_engines_controls_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

projects_locations_data_stores_controls_get

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

projects_locations_collections_data_stores_controls_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

projects_locations_collections_engines_controls_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

projects_locations_data_stores_controls_list

Name	Datatype	Description
name	string	Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*
associatedServingConfigIds	array	Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
boostAction	object	Defines a boost-type control (id: GoogleCloudDiscoveryengineV1ControlBoostAction)
conditions	array	Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
displayName	string	Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
filterAction	object	Defines a filter-type control Currently not supported by Recommendation (id: GoogleCloudDiscoveryengineV1ControlFilterAction)
promoteAction	object	Promote certain links based on predefined trigger queries. (id: GoogleCloudDiscoveryengineV1ControlPromoteAction)
redirectAction	object	Defines a redirect-type control. (id: GoogleCloudDiscoveryengineV1ControlRedirectAction)
solutionType	string	Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. (SOLUTION_TYPE_UNSPECIFIED, SOLUTION_TYPE_RECOMMENDATION, SOLUTION_TYPE_SEARCH, SOLUTION_TYPE_CHAT, SOLUTION_TYPE_GENERATIVE_CHAT, SOLUTION_TYPE_AI_MODE)
synonymsAction	object	Treats a group of terms as synonyms of one another. (id: GoogleCloudDiscoveryengineV1ControlSynonymsAction)
useCases	array	Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
projects_locations_collections_data_stores_controls_get	select	projectsId, locationsId, collectionsId, dataStoresId, controlsId		Gets a Control.
projects_locations_collections_engines_controls_get	select	projectsId, locationsId, collectionsId, enginesId, controlsId		Gets a Control.
projects_locations_data_stores_controls_get	select	projectsId, locationsId, dataStoresId, controlsId		Gets a Control.
projects_locations_collections_data_stores_controls_list	select	projectsId, locationsId, collectionsId, dataStoresId	pageToken, filter, pageSize	Lists all Controls by their parent DataStore.
projects_locations_collections_engines_controls_list	select	projectsId, locationsId, collectionsId, enginesId	pageToken, filter, pageSize	Lists all Controls by their parent DataStore.
projects_locations_data_stores_controls_list	select	projectsId, locationsId, dataStoresId	pageToken, filter, pageSize	Lists all Controls by their parent DataStore.
projects_locations_collections_data_stores_controls_create	insert	projectsId, locationsId, collectionsId, dataStoresId	controlId	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.
projects_locations_collections_engines_controls_create	insert	projectsId, locationsId, collectionsId, enginesId	controlId	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.
projects_locations_data_stores_controls_create	insert	projectsId, locationsId, dataStoresId	controlId	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.
projects_locations_collections_data_stores_controls_patch	update	projectsId, locationsId, collectionsId, dataStoresId, controlsId	updateMask	Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
projects_locations_collections_engines_controls_patch	update	projectsId, locationsId, collectionsId, enginesId, controlsId	updateMask	Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
projects_locations_data_stores_controls_patch	update	projectsId, locationsId, dataStoresId, controlsId	updateMask	Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.
projects_locations_collections_data_stores_controls_delete	delete	projectsId, locationsId, collectionsId, dataStoresId, controlsId		Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
projects_locations_collections_engines_controls_delete	delete	projectsId, locationsId, collectionsId, enginesId, controlsId		Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.
projects_locations_data_stores_controls_delete	delete	projectsId, locationsId, dataStoresId, controlsId		Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
collectionsId	string
controlsId	string
dataStoresId	string
enginesId	string
locationsId	string
projectsId	string
controlId	string
filter	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

projects_locations_collections_data_stores_controls_get

Gets a Control.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND controlsId = '{{ controlsId }}' -- required
;

projects_locations_collections_engines_controls_get

Gets a Control.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND controlsId = '{{ controlsId }}' -- required
;

projects_locations_data_stores_controls_get

Gets a Control.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND controlsId = '{{ controlsId }}' -- required
;

projects_locations_collections_data_stores_controls_list

Lists all Controls by their parent DataStore.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_collections_engines_controls_list

Lists all Controls by their parent DataStore.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND collectionsId = '{{ collectionsId }}' -- required
AND enginesId = '{{ enginesId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

projects_locations_data_stores_controls_list

Lists all Controls by their parent DataStore.

SELECT
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND dataStoresId = '{{ dataStoresId }}' -- required
AND pageToken = '{{ pageToken }}'
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
;

INSERT examples

projects_locations_collections_data_stores_controls_create

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.

INSERT INTO google.discoveryengine.controls (
data__solutionType,
data__filterAction,
data__useCases,
data__name,
data__displayName,
data__conditions,
data__boostAction,
data__synonymsAction,
data__redirectAction,
data__promoteAction,
projectsId,
locationsId,
collectionsId,
dataStoresId,
controlId
)
SELECT 
'{{ solutionType }}',
'{{ filterAction }}',
'{{ useCases }}',
'{{ name }}',
'{{ displayName }}',
'{{ conditions }}',
'{{ boostAction }}',
'{{ synonymsAction }}',
'{{ redirectAction }}',
'{{ promoteAction }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ dataStoresId }}',
'{{ controlId }}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
;

projects_locations_collections_engines_controls_create

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.

INSERT INTO google.discoveryengine.controls (
data__solutionType,
data__filterAction,
data__useCases,
data__name,
data__displayName,
data__conditions,
data__boostAction,
data__synonymsAction,
data__redirectAction,
data__promoteAction,
projectsId,
locationsId,
collectionsId,
enginesId,
controlId
)
SELECT 
'{{ solutionType }}',
'{{ filterAction }}',
'{{ useCases }}',
'{{ name }}',
'{{ displayName }}',
'{{ conditions }}',
'{{ boostAction }}',
'{{ synonymsAction }}',
'{{ redirectAction }}',
'{{ promoteAction }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ collectionsId }}',
'{{ enginesId }}',
'{{ controlId }}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
;

projects_locations_data_stores_controls_create

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.

INSERT INTO google.discoveryengine.controls (
data__solutionType,
data__filterAction,
data__useCases,
data__name,
data__displayName,
data__conditions,
data__boostAction,
data__synonymsAction,
data__redirectAction,
data__promoteAction,
projectsId,
locationsId,
dataStoresId,
controlId
)
SELECT 
'{{ solutionType }}',
'{{ filterAction }}',
'{{ useCases }}',
'{{ name }}',
'{{ displayName }}',
'{{ conditions }}',
'{{ boostAction }}',
'{{ synonymsAction }}',
'{{ redirectAction }}',
'{{ promoteAction }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ dataStoresId }}',
'{{ controlId }}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases
;

Manifest

# Description fields are for documentation purposes
- name: controls
props:
  - name: projectsId
    value: "{{ projectsId }}"
    description: Required parameter for the controls resource.
  - name: locationsId
    value: "{{ locationsId }}"
    description: Required parameter for the controls resource.
  - name: collectionsId
    value: "{{ collectionsId }}"
    description: Required parameter for the controls resource.
  - name: dataStoresId
    value: "{{ dataStoresId }}"
    description: Required parameter for the controls resource.
  - name: enginesId
    value: "{{ enginesId }}"
    description: Required parameter for the controls resource.
  - name: solutionType
    value: "{{ solutionType }}"
    description: |
      Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
    valid_values: ['SOLUTION_TYPE_UNSPECIFIED', 'SOLUTION_TYPE_RECOMMENDATION', 'SOLUTION_TYPE_SEARCH', 'SOLUTION_TYPE_CHAT', 'SOLUTION_TYPE_GENERATIVE_CHAT', 'SOLUTION_TYPE_AI_MODE']
  - name: filterAction
    description: |
      Defines a filter-type control Currently not supported by Recommendation
    value:
      dataStore: "{{ dataStore }}"
      filter: "{{ filter }}"
  - name: useCases
    value:
      - "{{ useCases }}"
    description: |
      Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.
  - name: name
    value: "{{ name }}"
    description: |
      Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.
  - name: conditions
    description: |
      Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.
    value:
      - queryRegex: "{{ queryRegex }}"
        queryTerms: "{{ queryTerms }}"
        activeTimeRange: "{{ activeTimeRange }}"
  - name: boostAction
    description: |
      Defines a boost-type control
    value:
      filter: "{{ filter }}"
      fixedBoost: {{ fixedBoost }}
      dataStore: "{{ dataStore }}"
      interpolationBoostSpec:
        attributeType: "{{ attributeType }}"
        interpolationType: "{{ interpolationType }}"
        controlPoints:
          - attributeValue: "{{ attributeValue }}"
            boostAmount: {{ boostAmount }}
        fieldName: "{{ fieldName }}"
      boost: {{ boost }}
  - name: synonymsAction
    description: |
      Treats a group of terms as synonyms of one another.
    value:
      synonyms:
        - "{{ synonyms }}"
  - name: redirectAction
    description: |
      Defines a redirect-type control.
    value:
      redirectUri: "{{ redirectUri }}"
  - name: promoteAction
    description: |
      Promote certain links based on predefined trigger queries.
    value:
      dataStore: "{{ dataStore }}"
      searchLinkPromotion:
        imageUri: "{{ imageUri }}"
        enabled: {{ enabled }}
        description: "{{ description }}"
        title: "{{ title }}"
        uri: "{{ uri }}"
        document: "{{ document }}"
  - name: controlId
    value: "{{ controlId }}"

UPDATE examples

projects_locations_collections_data_stores_controls_patch

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

UPDATE google.discoveryengine.controls
SET 
data__solutionType = '{{ solutionType }}',
data__filterAction = '{{ filterAction }}',
data__useCases = '{{ useCases }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__conditions = '{{ conditions }}',
data__boostAction = '{{ boostAction }}',
data__synonymsAction = '{{ synonymsAction }}',
data__redirectAction = '{{ redirectAction }}',
data__promoteAction = '{{ promoteAction }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND controlsId = '{{ controlsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases;

projects_locations_collections_engines_controls_patch

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

UPDATE google.discoveryengine.controls
SET 
data__solutionType = '{{ solutionType }}',
data__filterAction = '{{ filterAction }}',
data__useCases = '{{ useCases }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__conditions = '{{ conditions }}',
data__boostAction = '{{ boostAction }}',
data__synonymsAction = '{{ synonymsAction }}',
data__redirectAction = '{{ redirectAction }}',
data__promoteAction = '{{ promoteAction }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND controlsId = '{{ controlsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases;

projects_locations_data_stores_controls_patch

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

UPDATE google.discoveryengine.controls
SET 
data__solutionType = '{{ solutionType }}',
data__filterAction = '{{ filterAction }}',
data__useCases = '{{ useCases }}',
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__conditions = '{{ conditions }}',
data__boostAction = '{{ boostAction }}',
data__synonymsAction = '{{ synonymsAction }}',
data__redirectAction = '{{ redirectAction }}',
data__promoteAction = '{{ promoteAction }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND controlsId = '{{ controlsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
associatedServingConfigIds,
boostAction,
conditions,
displayName,
filterAction,
promoteAction,
redirectAction,
solutionType,
synonymsAction,
useCases;

DELETE examples

projects_locations_collections_data_stores_controls_delete

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

DELETE FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND controlsId = '{{ controlsId }}' --required
;

projects_locations_collections_engines_controls_delete

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

DELETE FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND collectionsId = '{{ collectionsId }}' --required
AND enginesId = '{{ enginesId }}' --required
AND controlsId = '{{ controlsId }}' --required
;

projects_locations_data_stores_controls_delete

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

DELETE FROM google.discoveryengine.controls
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND dataStoresId = '{{ dataStoresId }}' --required
AND controlsId = '{{ controlsId }}' --required
;