public final class Control extends GeneratedMessageV3 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BOOST_ACTION_FIELD_NUMBER
public static final int BOOST_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONDITIONS_FIELD_NUMBER
public static final int CONDITIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FILTER_ACTION_FIELD_NUMBER
public static final int FILTER_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
REDIRECT_ACTION_FIELD_NUMBER
public static final int REDIRECT_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SOLUTION_TYPE_FIELD_NUMBER
public static final int SOLUTION_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
SYNONYMS_ACTION_FIELD_NUMBER
public static final int SYNONYMS_ACTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
USE_CASES_FIELD_NUMBER
public static final int USE_CASES_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Control getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Control.Builder newBuilder()
newBuilder(Control prototype)
public static Control.Builder newBuilder(Control prototype)
| Parameter |
| Name |
Description |
prototype |
Control
|
public static Control parseDelimitedFrom(InputStream input)
public static Control parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Control parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Control parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(CodedInputStream input)
public static Control parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(InputStream input)
public static Control parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Control parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Control> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getActionCase()
public Control.ActionCase getActionCase()
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;
getBoostActionOrBuilder()
public Control.BoostActionOrBuilder getBoostActionOrBuilder()
Defines a boost-type control
.google.cloud.discoveryengine.v1.Control.BoostAction boost_action = 6;
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
|
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;
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
|
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()
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;
getFilterActionOrBuilder()
public Control.FilterActionOrBuilder getFilterActionOrBuilder()
Defines a filter-type control
Currently not supported by Recommendation
.google.cloud.discoveryengine.v1.Control.FilterAction filter_action = 7;
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.
|
getParserForType()
public Parser<Control> getParserForType()
Overrides
getRedirectAction()
public Control.RedirectAction getRedirectAction()
Defines a redirect-type control.
.google.cloud.discoveryengine.v1.Control.RedirectAction redirect_action = 9;
getRedirectActionOrBuilder()
public Control.RedirectActionOrBuilder getRedirectActionOrBuilder()
Defines a redirect-type control.
.google.cloud.discoveryengine.v1.Control.RedirectAction redirect_action = 9;
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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;
getSynonymsActionOrBuilder()
public Control.SynonymsActionOrBuilder getSynonymsActionOrBuilder()
Treats a group of terms as synonyms of one another.
.google.cloud.discoveryengine.v1.Control.SynonymsAction synonyms_action = 10;
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;
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Control.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Control.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Control.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
