GoogleCloudDiscoveryengineV1alphaControl (Discovery Engine API v1-rev20260427-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1alphaControl

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class GoogleCloudDiscoveryengineV1alphaControl
extends com.google.api.client.json.GenericJson
```
Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

GoogleCloudDiscoveryengineV1alphaControl()

Constructors
Constructor and Description
`GoogleCloudDiscoveryengineV1alphaControl()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GoogleCloudDiscoveryengineV1alphaControl`	`clone()`
`List<String>`	`getAssociatedServingConfigIds()` Output only.
`GoogleCloudDiscoveryengineV1alphaControlBoostAction`	`getBoostAction()` Defines a boost-type control
`List<GoogleCloudDiscoveryengineV1alphaCondition>`	`getConditions()` Determines when the associated action will trigger.
`String`	`getDisplayName()` Required.
`GoogleCloudDiscoveryengineV1alphaControlFilterAction`	`getFilterAction()` Defines a filter-type control Currently not supported by Recommendation
`String`	`getName()` Immutable.
`GoogleCloudDiscoveryengineV1alphaControlPromoteAction`	`getPromoteAction()` Promote certain links based on predefined trigger queries.
`GoogleCloudDiscoveryengineV1alphaControlRedirectAction`	`getRedirectAction()` Defines a redirect-type control.
`String`	`getSolutionType()` Required.
`GoogleCloudDiscoveryengineV1alphaControlSynonymsAction`	`getSynonymsAction()` Treats a group of terms as synonyms of one another.
`List<String>`	`getUseCases()` Specifies the use case for the control.
`GoogleCloudDiscoveryengineV1alphaControl`	`set(String fieldName, Object value)`
`GoogleCloudDiscoveryengineV1alphaControl`	`setAssociatedServingConfigIds(List<String> associatedServingConfigIds)` Output only.
`GoogleCloudDiscoveryengineV1alphaControl`	`setBoostAction(GoogleCloudDiscoveryengineV1alphaControlBoostAction boostAction)` Defines a boost-type control
`GoogleCloudDiscoveryengineV1alphaControl`	`setConditions(List<GoogleCloudDiscoveryengineV1alphaCondition> conditions)` Determines when the associated action will trigger.
`GoogleCloudDiscoveryengineV1alphaControl`	`setDisplayName(String displayName)` Required.
`GoogleCloudDiscoveryengineV1alphaControl`	`setFilterAction(GoogleCloudDiscoveryengineV1alphaControlFilterAction filterAction)` Defines a filter-type control Currently not supported by Recommendation
`GoogleCloudDiscoveryengineV1alphaControl`	`setName(String name)` Immutable.
`GoogleCloudDiscoveryengineV1alphaControl`	`setPromoteAction(GoogleCloudDiscoveryengineV1alphaControlPromoteAction promoteAction)` Promote certain links based on predefined trigger queries.
`GoogleCloudDiscoveryengineV1alphaControl`	`setRedirectAction(GoogleCloudDiscoveryengineV1alphaControlRedirectAction redirectAction)` Defines a redirect-type control.
`GoogleCloudDiscoveryengineV1alphaControl`	`setSolutionType(String solutionType)` Required.
`GoogleCloudDiscoveryengineV1alphaControl`	`setSynonymsAction(GoogleCloudDiscoveryengineV1alphaControlSynonymsAction synonymsAction)` Treats a group of terms as synonyms of one another.
`GoogleCloudDiscoveryengineV1alphaControl`	`setUseCases(List<String> useCases)` Specifies the use case for the control.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - GoogleCloudDiscoveryengineV1alphaControl
```
public GoogleCloudDiscoveryengineV1alphaControl()
```
- Method Detail
  - getAssociatedServingConfigIds
```
public List<String> getAssociatedServingConfigIds()
```
    Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
    
    Returns:
    
    value or null for none
  - setAssociatedServingConfigIds
```
public GoogleCloudDiscoveryengineV1alphaControl setAssociatedServingConfigIds(List<String> associatedServingConfigIds)
```
    Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.
    
    Parameters:
    
    associatedServingConfigIds - associatedServingConfigIds or null for none
  - getBoostAction
```
public GoogleCloudDiscoveryengineV1alphaControlBoostAction getBoostAction()
```
    Defines a boost-type control
    
    Returns:
    
    value or null for none
  - setBoostAction
```
public GoogleCloudDiscoveryengineV1alphaControl setBoostAction(GoogleCloudDiscoveryengineV1alphaControlBoostAction boostAction)
```
    Defines a boost-type control
    
    Parameters:
    
    boostAction - boostAction or null for none
  - getConditions
```
public List<GoogleCloudDiscoveryengineV1alphaCondition> getConditions()
```
    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.
    
    Returns:
    
    value or null for none
  - setConditions
```
public GoogleCloudDiscoveryengineV1alphaControl setConditions(List<GoogleCloudDiscoveryengineV1alphaCondition> conditions)
```
    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.
    
    Parameters:
    
    conditions - conditions or null for none
  - getDisplayName
```
public String getDisplayName()
```
    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.
    
    Returns:
    
    value or null for none
  - setDisplayName
```
public GoogleCloudDiscoveryengineV1alphaControl setDisplayName(String displayName)
```
    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.
    
    Parameters:
    
    displayName - displayName or null for none
  - getFilterAction
```
public GoogleCloudDiscoveryengineV1alphaControlFilterAction getFilterAction()
```
    Defines a filter-type control Currently not supported by Recommendation
    
    Returns:
    
    value or null for none
  - setFilterAction
```
public GoogleCloudDiscoveryengineV1alphaControl setFilterAction(GoogleCloudDiscoveryengineV1alphaControlFilterAction filterAction)
```
    Defines a filter-type control Currently not supported by Recommendation
    
    Parameters:
    
    filterAction - filterAction or null for none
  - getName
```
public String getName()
```
    Immutable. Fully qualified name `projects/locations/global/dataStore/controls`
    
    Returns:
    
    value or null for none
  - setName
```
public GoogleCloudDiscoveryengineV1alphaControl setName(String name)
```
    Immutable. Fully qualified name `projects/locations/global/dataStore/controls`
    
    Parameters:
    
    name - name or null for none
  - getPromoteAction
```
public GoogleCloudDiscoveryengineV1alphaControlPromoteAction getPromoteAction()
```
    Promote certain links based on predefined trigger queries.
    
    Returns:
    
    value or null for none
  - setPromoteAction
```
public GoogleCloudDiscoveryengineV1alphaControl setPromoteAction(GoogleCloudDiscoveryengineV1alphaControlPromoteAction promoteAction)
```
    Promote certain links based on predefined trigger queries.
    
    Parameters:
    
    promoteAction - promoteAction or null for none
  - getRedirectAction
```
public GoogleCloudDiscoveryengineV1alphaControlRedirectAction getRedirectAction()
```
    Defines a redirect-type control.
    
    Returns:
    
    value or null for none
  - setRedirectAction
```
public GoogleCloudDiscoveryengineV1alphaControl setRedirectAction(GoogleCloudDiscoveryengineV1alphaControlRedirectAction redirectAction)
```
    Defines a redirect-type control.
    
    Parameters:
    
    redirectAction - redirectAction or null for none
  - getSolutionType
```
public String getSolutionType()
```
    Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
    
    Returns:
    
    value or null for none
  - setSolutionType
```
public GoogleCloudDiscoveryengineV1alphaControl setSolutionType(String solutionType)
```
    Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.
    
    Parameters:
    
    solutionType - solutionType or null for none
  - getSynonymsAction
```
public GoogleCloudDiscoveryengineV1alphaControlSynonymsAction getSynonymsAction()
```
    Treats a group of terms as synonyms of one another.
    
    Returns:
    
    value or null for none
  - setSynonymsAction
```
public GoogleCloudDiscoveryengineV1alphaControl setSynonymsAction(GoogleCloudDiscoveryengineV1alphaControlSynonymsAction synonymsAction)
```
    Treats a group of terms as synonyms of one another.
    
    Parameters:
    
    synonymsAction - synonymsAction or null for none
  - getUseCases
```
public List<String> getUseCases()
```
    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.
    
    Returns:
    
    value or null for none
  - setUseCases
```
public GoogleCloudDiscoveryengineV1alphaControl setUseCases(List<String> useCases)
```
    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.
    
    Parameters:
    
    useCases - useCases or null for none
  - set
```
public GoogleCloudDiscoveryengineV1alphaControl set(String fieldName,
                                                    Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public GoogleCloudDiscoveryengineV1alphaControl clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class GoogleCloudDiscoveryengineV1alphaControl

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

GoogleCloudDiscoveryengineV1alphaControl

Method Detail

getAssociatedServingConfigIds

setAssociatedServingConfigIds

getBoostAction

setBoostAction

getConditions

setConditions

getDisplayName

setDisplayName

getFilterAction

setFilterAction

getName

setName

getPromoteAction

setPromoteAction

getRedirectAction

setRedirectAction

getSolutionType

setSolutionType

getSynonymsAction

setSynonymsAction

getUseCases

setUseCases

set

clone