Interface ControlOrBuilder (0.48.0)

Version 0.48.0

• 0.51.0 (latest)
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public interface ControlOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getActionCase()

public abstract Control.ActionCase getActionCase()

Returns
Type	Description
Control.ActionCase

getAssociatedServingConfigIds(int index)

public abstract String getAssociatedServingConfigIds(int index)

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The associatedServingConfigIds at the given index.

getAssociatedServingConfigIdsBytes(int index)

public abstract ByteString getAssociatedServingConfigIdsBytes(int index)

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the associatedServingConfigIds at the given index.

getAssociatedServingConfigIdsCount()

public abstract int getAssociatedServingConfigIdsCount()

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The count of associatedServingConfigIds.

getAssociatedServingConfigIdsList()

public abstract List<String> getAssociatedServingConfigIdsList()

Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes.

repeated string associated_serving_config_ids = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
List<String>	A list containing the associatedServingConfigIds.

getBoostAction()

public abstract Control.BoostAction getBoostAction()

Defines a boost-type control

.google.cloud.discoveryengine.v1.Control.BoostAction boost_action = 6;

Returns
Type	Description
Control.BoostAction	The boostAction.

getBoostActionOrBuilder()

public abstract Control.BoostActionOrBuilder getBoostActionOrBuilder()

Defines a boost-type control

.google.cloud.discoveryengine.v1.Control.BoostAction boost_action = 6;

Returns
Type	Description
Control.BoostActionOrBuilder

getConditions(int index)

public abstract Condition getConditions(int index)

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.

repeated .google.cloud.discoveryengine.v1.Condition conditions = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Condition

getConditionsCount()

public abstract int getConditionsCount()

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.

repeated .google.cloud.discoveryengine.v1.Condition conditions = 5;

Returns
Type	Description
int

getConditionsList()

public abstract List<Condition> getConditionsList()

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.

repeated .google.cloud.discoveryengine.v1.Condition conditions = 5;

Returns
Type	Description
List<Condition>

getConditionsOrBuilder(int index)

public abstract ConditionOrBuilder getConditionsOrBuilder(int index)

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.

repeated .google.cloud.discoveryengine.v1.Condition conditions = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
ConditionOrBuilder

getConditionsOrBuilderList()

public abstract List<? extends ConditionOrBuilder> getConditionsOrBuilderList()

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.

repeated .google.cloud.discoveryengine.v1.Condition conditions = 5;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.ConditionOrBuilder>

getDisplayName()

public abstract 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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

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.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getFilterAction()

public abstract Control.FilterAction getFilterAction()

Defines a filter-type control Currently not supported by Recommendation

.google.cloud.discoveryengine.v1.Control.FilterAction filter_action = 7;

Returns
Type	Description
Control.FilterAction	The filterAction.

getFilterActionOrBuilder()

public abstract Control.FilterActionOrBuilder getFilterActionOrBuilder()

Defines a filter-type control Currently not supported by Recommendation

.google.cloud.discoveryengine.v1.Control.FilterAction filter_action = 7;

Returns
Type	Description
Control.FilterActionOrBuilder

getName()

public abstract String getName()

Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

Immutable. Fully qualified name projects/*/locations/global/dataStore/*/controls/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getRedirectAction()

public abstract Control.RedirectAction getRedirectAction()

Defines a redirect-type control.

.google.cloud.discoveryengine.v1.Control.RedirectAction redirect_action = 9;

Returns
Type	Description
Control.RedirectAction	The redirectAction.

getRedirectActionOrBuilder()

public abstract Control.RedirectActionOrBuilder getRedirectActionOrBuilder()

Defines a redirect-type control.

.google.cloud.discoveryengine.v1.Control.RedirectAction redirect_action = 9;

Returns
Type	Description
Control.RedirectActionOrBuilder

getSolutionType()

public abstract SolutionType getSolutionType()

Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

.google.cloud.discoveryengine.v1.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
SolutionType	The solutionType.

getSolutionTypeValue()

public abstract int getSolutionTypeValue()

Required. Immutable. What solution the control belongs to.

Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.

.google.cloud.discoveryengine.v1.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
int	The enum numeric value on the wire for solutionType.

getSynonymsAction()

public abstract Control.SynonymsAction getSynonymsAction()

Treats a group of terms as synonyms of one another.

.google.cloud.discoveryengine.v1.Control.SynonymsAction synonyms_action = 10;

Returns
Type	Description
Control.SynonymsAction	The synonymsAction.

getSynonymsActionOrBuilder()

public abstract Control.SynonymsActionOrBuilder getSynonymsActionOrBuilder()

Treats a group of terms as synonyms of one another.

.google.cloud.discoveryengine.v1.Control.SynonymsAction synonyms_action = 10;

Returns
Type	Description
Control.SynonymsActionOrBuilder

getUseCases(int index)

public abstract SearchUseCase getUseCases(int index)

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.

repeated .google.cloud.discoveryengine.v1.SearchUseCase use_cases = 8;

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
SearchUseCase	The useCases at the given index.

getUseCasesCount()

public abstract int getUseCasesCount()

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.

repeated .google.cloud.discoveryengine.v1.SearchUseCase use_cases = 8;

Returns
Type	Description
int	The count of useCases.

getUseCasesList()

public abstract List<SearchUseCase> getUseCasesList()

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.

repeated .google.cloud.discoveryengine.v1.SearchUseCase use_cases = 8;

Returns
Type	Description
List<SearchUseCase>	A list containing the useCases.

getUseCasesValue(int index)

public abstract int getUseCasesValue(int index)

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.

repeated .google.cloud.discoveryengine.v1.SearchUseCase use_cases = 8;

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
int	The enum numeric value on the wire of useCases at the given index.

getUseCasesValueList()

public abstract List<Integer> getUseCasesValueList()

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.

repeated .google.cloud.discoveryengine.v1.SearchUseCase use_cases = 8;

Returns
Type	Description
List<Integer>	A list containing the enum numeric values on the wire for useCases.

hasBoostAction()

public abstract boolean hasBoostAction()

Defines a boost-type control

.google.cloud.discoveryengine.v1.Control.BoostAction boost_action = 6;

Returns
Type	Description
boolean	Whether the boostAction field is set.

hasFilterAction()

public abstract boolean hasFilterAction()

Defines a filter-type control Currently not supported by Recommendation

.google.cloud.discoveryengine.v1.Control.FilterAction filter_action = 7;

Returns
Type	Description
boolean	Whether the filterAction field is set.

hasRedirectAction()

public abstract boolean hasRedirectAction()

Defines a redirect-type control.

.google.cloud.discoveryengine.v1.Control.RedirectAction redirect_action = 9;

Returns
Type	Description
boolean	Whether the redirectAction field is set.

hasSynonymsAction()

public abstract boolean hasSynonymsAction()

Treats a group of terms as synonyms of one another.

.google.cloud.discoveryengine.v1.Control.SynonymsAction synonyms_action = 10;

Returns
Type	Description
boolean	Whether the synonymsAction field is set.