Control (proto-google-cloud-discoveryengine-v1beta 0.53.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.discoveryengine.v1beta.Control

All Implemented Interfaces:: ControlOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Control
extends com.google.protobuf.GeneratedMessageV3
implements ControlOrBuilder

 Defines a conditioned behavior to employ during serving.
 Must be attached to a
 [ServingConfig][google.cloud.discoveryengine.v1beta.ServingConfig] to be
 considered at serving time. Permitted actions dependent on `SolutionType`.

Protobuf type google.cloud.discoveryengine.v1beta.Control

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Control.ActionCase`
`static class`	`Control.BoostAction` Adjusts order of products in returned list.
`static interface`	`Control.BoostActionOrBuilder`
`static class`	`Control.Builder` Defines a conditioned behavior to employ during serving.
`static class`	`Control.FilterAction` Specified which products may be included in results.
`static interface`	`Control.FilterActionOrBuilder`
`static class`	`Control.RedirectAction` Redirects a shopper to the provided URI.
`static interface`	`Control.RedirectActionOrBuilder`
`static class`	`Control.SynonymsAction` Creates a set of terms that will act as synonyms of one another.
`static interface`	`Control.SynonymsActionOrBuilder`

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER`
`static int`	`BOOST_ACTION_FIELD_NUMBER`
`static int`	`CONDITIONS_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`FILTER_ACTION_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`REDIRECT_ACTION_FIELD_NUMBER`
`static int`	`SOLUTION_TYPE_FIELD_NUMBER`
`static int`	`SYNONYMS_ACTION_FIELD_NUMBER`
`static int`	`USE_CASES_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Control.ActionCase`	`getActionCase()`
`String`	`getAssociatedServingConfigIds(int index)` Output only.
`com.google.protobuf.ByteString`	`getAssociatedServingConfigIdsBytes(int index)` Output only.
`int`	`getAssociatedServingConfigIdsCount()` Output only.
`com.google.protobuf.ProtocolStringList`	`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.
`static Control`	`getDefaultInstance()`
`Control`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`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.
`com.google.protobuf.Parser<Control>`	`getParserForType()`
`Control.RedirectAction`	`getRedirectAction()` Defines a redirect-type control.
`Control.RedirectActionOrBuilder`	`getRedirectActionOrBuilder()` Defines a redirect-type control.
`int`	`getSerializedSize()`
`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;`
`int`	`hashCode()`
`boolean`	`hasRedirectAction()` Defines a redirect-type control.
`boolean`	`hasSynonymsAction()` Treats a group of terms as synonyms of one another.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Control.Builder`	`newBuilder()`
`static Control.Builder`	`newBuilder(Control prototype)`
`Control.Builder`	`newBuilderForType()`
`protected Control.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Control`	`parseDelimitedFrom(InputStream input)`
`static Control`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Control`	`parseFrom(byte[] data)`
`static Control`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Control`	`parseFrom(ByteBuffer data)`
`static Control`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Control`	`parseFrom(com.google.protobuf.ByteString data)`
`static Control`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Control`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Control`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Control`	`parseFrom(InputStream input)`
`static Control`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Control>`	`parser()`
`Control.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

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

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- BOOST_ACTION_FIELD_NUMBER
```
public static final int BOOST_ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FILTER_ACTION_FIELD_NUMBER
```
public static final int FILTER_ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REDIRECT_ACTION_FIELD_NUMBER
```
public static final int REDIRECT_ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SYNONYMS_ACTION_FIELD_NUMBER
```
public static final int SYNONYMS_ACTION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
```
public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SOLUTION_TYPE_FIELD_NUMBER
```
public static final int SOLUTION_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- USE_CASES_FIELD_NUMBER
```
public static final int USE_CASES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONDITIONS_FIELD_NUMBER
```
public static final int CONDITIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getActionCase
```
public Control.ActionCase getActionCase()
```
Specified by:

getActionCase in interface ControlOrBuilder

hasBoostAction
```
public boolean hasBoostAction()
```
```
 Defines a boost-type control
 
```
.google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
Specified by:

hasBoostAction in interface ControlOrBuilder

Returns:

Whether the boostAction field is set.

getBoostAction
```
public Control.BoostAction getBoostAction()
```
```
 Defines a boost-type control
 
```
.google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
Specified by:

getBoostAction in interface ControlOrBuilder

Returns:

The boostAction.

getBoostActionOrBuilder
```
public Control.BoostActionOrBuilder getBoostActionOrBuilder()
```
```
 Defines a boost-type control
 
```
.google.cloud.discoveryengine.v1beta.Control.BoostAction boost_action = 6;
Specified by:

getBoostActionOrBuilder in interface ControlOrBuilder

hasFilterAction
```
public boolean hasFilterAction()
```
```
 Defines a filter-type control
 Currently not supported by Recommendation
 
```
.google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
Specified by:

hasFilterAction in interface ControlOrBuilder

Returns:

Whether the filterAction field is set.

getFilterAction
```
public Control.FilterAction getFilterAction()
```
```
 Defines a filter-type control
 Currently not supported by Recommendation
 
```
.google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
Specified by:

getFilterAction in interface ControlOrBuilder

Returns:

The filterAction.

getFilterActionOrBuilder
```
public Control.FilterActionOrBuilder getFilterActionOrBuilder()
```
```
 Defines a filter-type control
 Currently not supported by Recommendation
 
```
.google.cloud.discoveryengine.v1beta.Control.FilterAction filter_action = 7;
Specified by:

getFilterActionOrBuilder in interface ControlOrBuilder

hasRedirectAction
```
public boolean hasRedirectAction()
```
```
 Defines a redirect-type control.
 
```
.google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
Specified by:

hasRedirectAction in interface ControlOrBuilder

Returns:

Whether the redirectAction field is set.

getRedirectAction
```
public Control.RedirectAction getRedirectAction()
```
```
 Defines a redirect-type control.
 
```
.google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
Specified by:

getRedirectAction in interface ControlOrBuilder

Returns:

The redirectAction.

getRedirectActionOrBuilder
```
public Control.RedirectActionOrBuilder getRedirectActionOrBuilder()
```
```
 Defines a redirect-type control.
 
```
.google.cloud.discoveryengine.v1beta.Control.RedirectAction redirect_action = 9;
Specified by:

getRedirectActionOrBuilder in interface ControlOrBuilder

hasSynonymsAction
```
public boolean hasSynonymsAction()
```
```
 Treats a group of terms as synonyms of one another.
 
```
.google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
Specified by:

hasSynonymsAction in interface ControlOrBuilder

Returns:

Whether the synonymsAction field is set.

getSynonymsAction
```
public Control.SynonymsAction getSynonymsAction()
```
```
 Treats a group of terms as synonyms of one another.
 
```
.google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
Specified by:

getSynonymsAction in interface ControlOrBuilder

Returns:

The synonymsAction.

getSynonymsActionOrBuilder
```
public Control.SynonymsActionOrBuilder getSynonymsActionOrBuilder()
```
```
 Treats a group of terms as synonyms of one another.
 
```
.google.cloud.discoveryengine.v1beta.Control.SynonymsAction synonyms_action = 10;
Specified by:

getSynonymsActionOrBuilder in interface ControlOrBuilder

getName
```
public String getName()
```
```
 Immutable. Fully qualified name
 `projects/*/locations/global/dataStore/*/controls/*`
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getName in interface ControlOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Immutable. Fully qualified name
 `projects/*/locations/global/dataStore/*/controls/*`
 
```
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
Specified by:

getNameBytes in interface ControlOrBuilder

Returns:

The bytes for name.

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

Specified by:: getDisplayName in interface ControlOrBuilder
Returns:: The displayName.

getDisplayNameBytes

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

Specified by:: getDisplayNameBytes in interface ControlOrBuilder
Returns:: The bytes for displayName.

getAssociatedServingConfigIdsList

public com.google.protobuf.ProtocolStringList 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];

Specified by:: getAssociatedServingConfigIdsList in interface ControlOrBuilder
Returns:: A list containing the associatedServingConfigIds.

getAssociatedServingConfigIdsCount
```
public 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];
Specified by:

getAssociatedServingConfigIdsCount in interface ControlOrBuilder

Returns:

The count of associatedServingConfigIds.

getAssociatedServingConfigIds
```
public 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];
Specified by:

getAssociatedServingConfigIds in interface ControlOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The associatedServingConfigIds at the given index.

getAssociatedServingConfigIdsBytes
```
public 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];
Specified by:

getAssociatedServingConfigIdsBytes in interface ControlOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the associatedServingConfigIds at the given index.

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

getSolutionTypeValue in interface ControlOrBuilder

Returns:

The enum numeric value on the wire for solutionType.

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

getSolutionType in interface ControlOrBuilder

Returns:

The solutionType.