Class Control.Builder (0.44.0)

Version 0.44.0

• 0.49.0 (latest)
• 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 static final class Control.Builder extends GeneratedMessageV3.Builder<Control.Builder> implements ControlOrBuilder

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.

Protobuf type google.cloud.discoveryengine.v1.Control

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Control.Builder

Implements

ControlOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllAssociatedServingConfigIds(Iterable<String> values)

public Control.Builder addAllAssociatedServingConfigIds(Iterable<String> values)

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
values	Iterable<String> The associatedServingConfigIds to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addAllConditions(Iterable<? extends Condition> values)

public Control.Builder addAllConditions(Iterable<? extends Condition> values)

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
values	Iterable<? extends com.google.cloud.discoveryengine.v1.Condition>

Returns
Type	Description
Control.Builder

addAllUseCases(Iterable<? extends SearchUseCase> values)

public Control.Builder addAllUseCases(Iterable<? extends SearchUseCase> values)

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
values	Iterable<? extends com.google.cloud.discoveryengine.v1.SearchUseCase> The useCases to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addAllUseCasesValue(Iterable<Integer> values)

public Control.Builder addAllUseCasesValue(Iterable<Integer> values)

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
values	Iterable<Integer> The enum numeric values on the wire for useCases to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addAssociatedServingConfigIds(String value)

public Control.Builder addAssociatedServingConfigIds(String value)

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
value	String The associatedServingConfigIds to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addAssociatedServingConfigIdsBytes(ByteString value)

public Control.Builder addAssociatedServingConfigIdsBytes(ByteString value)

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
value	ByteString The bytes of the associatedServingConfigIds to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addConditions(Condition value)

public Control.Builder addConditions(Condition value)

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
value	Condition

Returns
Type	Description
Control.Builder

addConditions(Condition.Builder builderForValue)

public Control.Builder addConditions(Condition.Builder builderForValue)

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
builderForValue	Condition.Builder

Returns
Type	Description
Control.Builder

addConditions(int index, Condition value)

public Control.Builder addConditions(int index, Condition value)

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;

Parameters
Name	Description
index	int
value	Condition

Returns
Type	Description
Control.Builder

addConditions(int index, Condition.Builder builderForValue)

public Control.Builder addConditions(int index, Condition.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	Condition.Builder

Returns
Type	Description
Control.Builder

addConditionsBuilder()

public Condition.Builder addConditionsBuilder()

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
Condition.Builder

addConditionsBuilder(int index)

public Condition.Builder addConditionsBuilder(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.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Control.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addUseCases(SearchUseCase value)

public Control.Builder addUseCases(SearchUseCase value)

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
value	SearchUseCase The useCases to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

addUseCasesValue(int value)

public Control.Builder addUseCasesValue(int value)

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
value	int The enum numeric value on the wire for useCases to add.

Returns
Type	Description
Control.Builder	This builder for chaining.

build()

public Control build()

Returns
Type	Description
Control

buildPartial()

public Control buildPartial()

Returns
Type	Description
Control

clear()

public Control.Builder clear()

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAction()

public Control.Builder clearAction()

Returns
Type	Description
Control.Builder

clearAssociatedServingConfigIds()

public Control.Builder clearAssociatedServingConfigIds()

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
Control.Builder	This builder for chaining.

clearBoostAction()

public Control.Builder clearBoostAction()

Defines a boost-type control

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

Returns
Type	Description
Control.Builder

clearConditions()

public Control.Builder clearConditions()

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
Control.Builder

clearDisplayName()

public Control.Builder clearDisplayName()

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
Control.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Control.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFilterAction()

public Control.Builder clearFilterAction()

Defines a filter-type control Currently not supported by Recommendation

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

Returns
Type	Description
Control.Builder

clearName()

public Control.Builder clearName()

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

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

Returns
Type	Description
Control.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Control.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRedirectAction()

public Control.Builder clearRedirectAction()

Defines a redirect-type control.

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

Returns
Type	Description
Control.Builder

clearSolutionType()

public Control.Builder clearSolutionType()

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
Control.Builder	This builder for chaining.

clearSynonymsAction()

public Control.Builder clearSynonymsAction()

Treats a group of terms as synonyms of one another.

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

Returns
Type	Description
Control.Builder

clearUseCases()

public Control.Builder clearUseCases()

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
Control.Builder	This builder for chaining.

clone()

public Control.Builder clone()

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getActionCase()

public Control.ActionCase getActionCase()

Returns
Type	Description
Control.ActionCase

getAssociatedServingConfigIds(int index)

public 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 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 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 ProtocolStringList 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
ProtocolStringList	A list containing the associatedServingConfigIds.

getBoostAction()

public Control.BoostAction getBoostAction()

Defines a boost-type control

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

Returns
Type	Description
Control.BoostAction	The boostAction.

getBoostActionBuilder()

public Control.BoostAction.Builder getBoostActionBuilder()

Defines a boost-type control

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

Returns
Type	Description
Control.BoostAction.Builder

getBoostActionOrBuilder()

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

getConditionsBuilder(int index)

public Condition.Builder getConditionsBuilder(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.Builder

getConditionsBuilderList()

public List<Condition.Builder> getConditionsBuilderList()

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<Builder>

getConditionsCount()

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

getDefaultInstanceForType()

public Control getDefaultInstanceForType()

Returns
Type	Description
Control

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

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

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

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

getFilterActionBuilder()

public Control.FilterAction.Builder getFilterActionBuilder()

Defines a filter-type control Currently not supported by Recommendation

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

Returns
Type	Description
Control.FilterAction.Builder

getFilterActionOrBuilder()

public 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 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 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 Control.RedirectAction getRedirectAction()

Defines a redirect-type control.

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

Returns
Type	Description
Control.RedirectAction	The redirectAction.

getRedirectActionBuilder()

public Control.RedirectAction.Builder getRedirectActionBuilder()

Defines a redirect-type control.

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

Returns
Type	Description
Control.RedirectAction.Builder

getRedirectActionOrBuilder()

public Control.RedirectActionOrBuilder getRedirectActionOrBuilder()

Defines a redirect-type control.

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

Returns
Type	Description
Control.RedirectActionOrBuilder

getSolutionType()

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

getSynonymsActionBuilder()

public Control.SynonymsAction.Builder getSynonymsActionBuilder()

Treats a group of terms as synonyms of one another.

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

Returns
Type	Description
Control.SynonymsAction.Builder

getSynonymsActionOrBuilder()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeBoostAction(Control.BoostAction value)

public Control.Builder mergeBoostAction(Control.BoostAction value)

Defines a boost-type control

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

Parameter
Name	Description
value	Control.BoostAction

Returns
Type	Description
Control.Builder

mergeFilterAction(Control.FilterAction value)

public Control.Builder mergeFilterAction(Control.FilterAction value)

Defines a filter-type control Currently not supported by Recommendation

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

Parameter
Name	Description
value	Control.FilterAction

Returns
Type	Description
Control.Builder

mergeFrom(Control other)

public Control.Builder mergeFrom(Control other)

Parameter
Name	Description
other	Control

Returns
Type	Description
Control.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Control.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Control.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Control.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Control.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRedirectAction(Control.RedirectAction value)

public Control.Builder mergeRedirectAction(Control.RedirectAction value)

Defines a redirect-type control.

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

Parameter
Name	Description
value	Control.RedirectAction

Returns
Type	Description
Control.Builder

mergeSynonymsAction(Control.SynonymsAction value)

public Control.Builder mergeSynonymsAction(Control.SynonymsAction value)

Treats a group of terms as synonyms of one another.

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

Parameter
Name	Description
value	Control.SynonymsAction

Returns
Type	Description
Control.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Control.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

removeConditions(int index)

public Control.Builder removeConditions(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
Control.Builder

setAssociatedServingConfigIds(int index, String value)

public Control.Builder setAssociatedServingConfigIds(int index, String value)

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];

Parameters
Name	Description
index	int The index to set the value at.
value	String The associatedServingConfigIds to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setBoostAction(Control.BoostAction value)

public Control.Builder setBoostAction(Control.BoostAction value)

Defines a boost-type control

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

Parameter
Name	Description
value	Control.BoostAction

Returns
Type	Description
Control.Builder

setBoostAction(Control.BoostAction.Builder builderForValue)

public Control.Builder setBoostAction(Control.BoostAction.Builder builderForValue)

Defines a boost-type control

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

Parameter
Name	Description
builderForValue	Control.BoostAction.Builder

Returns
Type	Description
Control.Builder

setConditions(int index, Condition value)

public Control.Builder setConditions(int index, Condition value)

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;

Parameters
Name	Description
index	int
value	Condition

Returns
Type	Description
Control.Builder

setConditions(int index, Condition.Builder builderForValue)

public Control.Builder setConditions(int index, Condition.Builder builderForValue)

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;

Parameters
Name	Description
index	int
builderForValue	Condition.Builder

Returns
Type	Description
Control.Builder

setDisplayName(String value)

public Control.Builder setDisplayName(String value)

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];

Parameter
Name	Description
value	String The displayName to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Control.Builder setDisplayNameBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for displayName to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Control.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFilterAction(Control.FilterAction value)

public Control.Builder setFilterAction(Control.FilterAction value)

Defines a filter-type control Currently not supported by Recommendation

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

Parameter
Name	Description
value	Control.FilterAction

Returns
Type	Description
Control.Builder

setFilterAction(Control.FilterAction.Builder builderForValue)

public Control.Builder setFilterAction(Control.FilterAction.Builder builderForValue)

Defines a filter-type control Currently not supported by Recommendation

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

Parameter
Name	Description
builderForValue	Control.FilterAction.Builder

Returns
Type	Description
Control.Builder

setName(String value)

public Control.Builder setName(String value)

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

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Control.Builder setNameBytes(ByteString value)

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

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setRedirectAction(Control.RedirectAction value)

public Control.Builder setRedirectAction(Control.RedirectAction value)

Defines a redirect-type control.

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

Parameter
Name	Description
value	Control.RedirectAction

Returns
Type	Description
Control.Builder

setRedirectAction(Control.RedirectAction.Builder builderForValue)

public Control.Builder setRedirectAction(Control.RedirectAction.Builder builderForValue)

Defines a redirect-type control.

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

Parameter
Name	Description
builderForValue	Control.RedirectAction.Builder

Returns
Type	Description
Control.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Control.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setSolutionType(SolutionType value)

public Control.Builder setSolutionType(SolutionType value)

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];

Parameter
Name	Description
value	SolutionType The solutionType to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setSolutionTypeValue(int value)

public Control.Builder setSolutionTypeValue(int value)

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];

Parameter
Name	Description
value	int The enum numeric value on the wire for solutionType to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setSynonymsAction(Control.SynonymsAction value)

public Control.Builder setSynonymsAction(Control.SynonymsAction value)

Treats a group of terms as synonyms of one another.

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

Parameter
Name	Description
value	Control.SynonymsAction

Returns
Type	Description
Control.Builder

setSynonymsAction(Control.SynonymsAction.Builder builderForValue)

public Control.Builder setSynonymsAction(Control.SynonymsAction.Builder builderForValue)

Treats a group of terms as synonyms of one another.

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

Parameter
Name	Description
builderForValue	Control.SynonymsAction.Builder

Returns
Type	Description
Control.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Control.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Control.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUseCases(int index, SearchUseCase value)

public Control.Builder setUseCases(int index, SearchUseCase value)

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;

Parameters
Name	Description
index	int The index to set the value at.
value	SearchUseCase The useCases to set.

Returns
Type	Description
Control.Builder	This builder for chaining.

setUseCasesValue(int index, int value)

public Control.Builder setUseCasesValue(int index, int value)

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;

Parameters
Name	Description
index	int The index to set the value at.
value	int The enum numeric value on the wire for useCases to set.

Returns
Type	Description
Control.Builder	This builder for chaining.