com.google.cloud.discoveryengine.v1beta

Interface ControlOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Control, Control.Builder

public interface ControlOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
Control.ActionCase	getActionCase()
String	getAssociatedServingConfigIds(int index) Output only.
com.google.protobuf.ByteString	getAssociatedServingConfigIdsBytes(int index) Output only.
int	getAssociatedServingConfigIdsCount() Output only.
List<String>	getAssociatedServingConfigIdsList() Output only.
Control.BoostAction	getBoostAction() Defines a boost-type control .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
Control.BoostActionOrBuilder	getBoostActionOrBuilder() Defines a boost-type control .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
Condition	getConditions(int index) Determines when the associated action will trigger.
int	getConditionsCount() Determines when the associated action will trigger.
List<Condition>	getConditionsList() Determines when the associated action will trigger.
ConditionOrBuilder	getConditionsOrBuilder(int index) Determines when the associated action will trigger.
List<? extends ConditionOrBuilder>	getConditionsOrBuilderList() Determines when the associated action will trigger.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
Control.FilterAction	getFilterAction() Defines a filter-type control Currently not supported by Recommendation .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
Control.FilterActionOrBuilder	getFilterActionOrBuilder() Defines a filter-type control Currently not supported by Recommendation .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
String	getName() Immutable.
com.google.protobuf.ByteString	getNameBytes() Immutable.
Control.RedirectAction	getRedirectAction() Defines a redirect-type control.
Control.RedirectActionOrBuilder	getRedirectActionOrBuilder() Defines a redirect-type control.
SolutionType	getSolutionType() Required.
int	getSolutionTypeValue() Required.
Control.SynonymsAction	getSynonymsAction() Treats a group of terms as synonyms of one another.
Control.SynonymsActionOrBuilder	getSynonymsActionOrBuilder() Treats a group of terms as synonyms of one another.
SearchUseCase	getUseCases(int index) Specifies the use case for the control.
int	getUseCasesCount() Specifies the use case for the control.
List<SearchUseCase>	getUseCasesList() Specifies the use case for the control.
int	getUseCasesValue(int index) Specifies the use case for the control.
List<Integer>	getUseCasesValueList() Specifies the use case for the control.
boolean	hasBoostAction() Defines a boost-type control .google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
boolean	hasFilterAction() Defines a filter-type control Currently not supported by Recommendation .google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
boolean	hasRedirectAction() Defines a redirect-type control.
boolean	hasSynonymsAction() Treats a group of terms as synonyms of one another.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasBoostAction

boolean hasBoostAction()

 Defines a boost-type control
 

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

Returns:

Whether the boostAction field is set.

getBoostAction

Control.BoostAction getBoostAction()

 Defines a boost-type control
 

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

Returns:

The boostAction.

getBoostActionOrBuilder

Control.BoostActionOrBuilder getBoostActionOrBuilder()

 Defines a boost-type control
 

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

hasFilterAction

boolean hasFilterAction()

 Defines a filter-type control
 Currently not supported by Recommendation
 

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

Returns:

Whether the filterAction field is set.

getFilterAction

Control.FilterAction getFilterAction()

 Defines a filter-type control
 Currently not supported by Recommendation
 

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

Returns:

The filterAction.

getFilterActionOrBuilder

Control.FilterActionOrBuilder getFilterActionOrBuilder()

 Defines a filter-type control
 Currently not supported by Recommendation
 

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

hasRedirectAction

boolean hasRedirectAction()

 Defines a redirect-type control.
 

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

Returns:

Whether the redirectAction field is set.

getRedirectAction

Control.RedirectAction getRedirectAction()

 Defines a redirect-type control.
 

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

Returns:

The redirectAction.

getRedirectActionOrBuilder

Control.RedirectActionOrBuilder getRedirectActionOrBuilder()

 Defines a redirect-type control.
 

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

hasSynonymsAction

boolean hasSynonymsAction()

 Treats a group of terms as synonyms of one another.
 

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

Returns:

Whether the synonymsAction field is set.

getSynonymsAction

Control.SynonymsAction getSynonymsAction()

 Treats a group of terms as synonyms of one another.
 

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

Returns:

The synonymsAction.

getSynonymsActionOrBuilder

Control.SynonymsActionOrBuilder getSynonymsActionOrBuilder()

 Treats a group of terms as synonyms of one another.
 

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

getName

String getName()

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

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

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

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

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

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

getAssociatedServingConfigIdsList

List<String> getAssociatedServingConfigIdsList()

 Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.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:

A list containing the associatedServingConfigIds.

getAssociatedServingConfigIdsCount

int getAssociatedServingConfigIdsCount()

 Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.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:

The count of associatedServingConfigIds.

getAssociatedServingConfigIds

String getAssociatedServingConfigIds(int index)

 Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.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:

index - The index of the element to return.

Returns:

The associatedServingConfigIds at the given index.

getAssociatedServingConfigIdsBytes

com.google.protobuf.ByteString getAssociatedServingConfigIdsBytes(int index)

 Output only. List of all
 [ServingConfig][google.cloud.discoveryengine.v1beta.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:

index - The index of the value to return.

Returns:

The bytes of the associatedServingConfigIds at the given index.

getSolutionTypeValue

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.v1beta.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns:

The enum numeric value on the wire for solutionType.

getSolutionType

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.v1beta.SolutionType solution_type = 4 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns:

The solutionType.

getUseCasesList

List<SearchUseCase> getUseCasesList()

 Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

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

Returns:

A list containing the useCases.

getUseCasesCount

int getUseCasesCount()

 Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

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

Returns:

The count of useCases.

getUseCases

SearchUseCase getUseCases(int index)

 Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

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

Parameters:

index - The index of the element to return.

Returns:

The useCases at the given index.

getUseCasesValueList

List<Integer> getUseCasesValueList()

 Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

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

Returns:

A list containing the enum numeric values on the wire for useCases.

getUseCasesValue

int getUseCasesValue(int index)

 Specifies the use case for the control.
 Affects what condition fields can be set.
 Only applies to
 [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 Currently only allow one use case per control.
 Must be set when solution_type is
 [SolutionType.SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].
 

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

Parameters:

index - The index of the value to return.

Returns:

The enum numeric value on the wire of useCases at the given index.

getConditionsList

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.v1beta.Condition conditions = 5;

getConditions

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.v1beta.Condition conditions = 5;

getConditionsCount

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.v1beta.Condition conditions = 5;

getConditionsOrBuilderList

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.v1beta.Condition conditions = 5;

getConditionsOrBuilder

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.v1beta.Condition conditions = 5;

getActionCase

Control.ActionCase getActionCase()