public final class Control extends com.google.protobuf.GeneratedMessageV3 implements ControlOrBuilder
Configures dynamic metadata that can be linked to a [ServingConfig][google.cloud.retail.v2.ServingConfig] and affect search or recommendation results at serving time.Protobuf type
google.cloud.retail.v2.Control| Modifier and Type | Class and Description |
|---|---|
static class |
Control.Builder
Configures dynamic metadata that can be linked to a
[ServingConfig][google.cloud.retail.v2.ServingConfig] and affect search or
recommendation results at serving time.
|
static class |
Control.ControlCase |
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| Modifier and Type | Field and Description |
|---|---|
static int |
ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER |
static int |
DISPLAY_NAME_FIELD_NUMBER |
static int |
NAME_FIELD_NUMBER |
static int |
RULE_FIELD_NUMBER |
static int |
SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER |
static int |
SOLUTION_TYPES_FIELD_NUMBER |
| Modifier and Type | Method and Description |
|---|---|
boolean |
equals(Object obj) |
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.ControlCase |
getControlCase() |
static Control |
getDefaultInstance() |
Control |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getDisplayName()
Required.
|
com.google.protobuf.ByteString |
getDisplayNameBytes()
Required.
|
String |
getName()
Immutable.
|
com.google.protobuf.ByteString |
getNameBytes()
Immutable.
|
com.google.protobuf.Parser<Control> |
getParserForType() |
Rule |
getRule()
A rule control - a condition-action pair.
|
RuleOrBuilder |
getRuleOrBuilder()
A rule control - a condition-action pair.
|
SearchSolutionUseCase |
getSearchSolutionUseCase(int index)
Specifies the use case for the control.
|
int |
getSearchSolutionUseCaseCount()
Specifies the use case for the control.
|
List<SearchSolutionUseCase> |
getSearchSolutionUseCaseList()
Specifies the use case for the control.
|
int |
getSearchSolutionUseCaseValue(int index)
Specifies the use case for the control.
|
List<Integer> |
getSearchSolutionUseCaseValueList()
Specifies the use case for the control.
|
int |
getSerializedSize() |
SolutionType |
getSolutionTypes(int index)
Required.
|
int |
getSolutionTypesCount()
Required.
|
List<SolutionType> |
getSolutionTypesList()
Required.
|
int |
getSolutionTypesValue(int index)
Required.
|
List<Integer> |
getSolutionTypesValueList()
Required.
|
int |
hashCode() |
boolean |
hasRule()
A rule control - a condition-action pair.
|
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) |
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, writeStringNoTagfindInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringaddAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToclone, finalize, getClass, notify, notifyAll, wait, wait, waitpublic static final int RULE_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
public static final int SOLUTION_TYPES_FIELD_NUMBER
public static final int SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance in class com.google.protobuf.GeneratedMessageV3public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3public Control.ControlCase getControlCase()
getControlCase in interface ControlOrBuilderpublic boolean hasRule()
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
.google.cloud.retail.v2.Rule rule = 4;hasRule in interface ControlOrBuilderpublic Rule getRule()
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
.google.cloud.retail.v2.Rule rule = 4;getRule in interface ControlOrBuilderpublic RuleOrBuilder getRuleOrBuilder()
A rule control - a condition-action pair. Enacts a set action when the condition is triggered. For example: Boost "gShoe" when query full matches "Running Shoes".
.google.cloud.retail.v2.Rule rule = 4;getRuleOrBuilder in interface ControlOrBuilderpublic String getName()
Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getName in interface ControlOrBuilderpublic com.google.protobuf.ByteString getNameBytes()
Immutable. Fully qualified name `projects/*/locations/global/catalogs/*/controls/*`
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];getNameBytes in interface ControlOrBuilderpublic String getDisplayName()
Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayName in interface ControlOrBuilderpublic com.google.protobuf.ByteString getDisplayNameBytes()
Required. The human readable control display name. Used in Retail UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is thrown.
string display_name = 2 [(.google.api.field_behavior) = REQUIRED];getDisplayNameBytes in interface ControlOrBuilderpublic com.google.protobuf.ProtocolStringList getAssociatedServingConfigIdsList()
Output only. List of [serving config][google.cloud.retail.v2.ServingConfig] ids that are associated with this control in the same [Catalog][google.cloud.retail.v2.Catalog]. Note the association is managed via the [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAssociatedServingConfigIdsList in interface ControlOrBuilderpublic int getAssociatedServingConfigIdsCount()
Output only. List of [serving config][google.cloud.retail.v2.ServingConfig] ids that are associated with this control in the same [Catalog][google.cloud.retail.v2.Catalog]. Note the association is managed via the [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAssociatedServingConfigIdsCount in interface ControlOrBuilderpublic String getAssociatedServingConfigIds(int index)
Output only. List of [serving config][google.cloud.retail.v2.ServingConfig] ids that are associated with this control in the same [Catalog][google.cloud.retail.v2.Catalog]. Note the association is managed via the [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAssociatedServingConfigIds in interface ControlOrBuilderindex - The index of the element to return.public com.google.protobuf.ByteString getAssociatedServingConfigIdsBytes(int index)
Output only. List of [serving config][google.cloud.retail.v2.ServingConfig] ids that are associated with this control in the same [Catalog][google.cloud.retail.v2.Catalog]. Note the association is managed via the [ServingConfig][google.cloud.retail.v2.ServingConfig], this is an output only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getAssociatedServingConfigIdsBytes in interface ControlOrBuilderindex - The index of the value to return.public List<SolutionType> getSolutionTypesList()
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypesList in interface ControlOrBuilderpublic int getSolutionTypesCount()
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypesCount in interface ControlOrBuilderpublic SolutionType getSolutionTypes(int index)
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypes in interface ControlOrBuilderindex - The index of the element to return.public List<Integer> getSolutionTypesValueList()
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypesValueList in interface ControlOrBuilderpublic int getSolutionTypesValue(int index)
Required. Immutable. The solution types that the control is used for. Currently we support setting only one type of solution at creation time. Only `SOLUTION_TYPE_SEARCH` value is supported at the moment. If no solution type is provided at creation time, will default to [SOLUTION_TYPE_SEARCH][google.cloud.retail.v2.SolutionType.SOLUTION_TYPE_SEARCH].
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypesValue in interface ControlOrBuilderindex - The index of the value to return.public List<SearchSolutionUseCase> getSearchSolutionUseCaseList()
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
getSearchSolutionUseCaseList in interface ControlOrBuilderpublic int getSearchSolutionUseCaseCount()
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
getSearchSolutionUseCaseCount in interface ControlOrBuilderpublic SearchSolutionUseCase getSearchSolutionUseCase(int index)
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
getSearchSolutionUseCase in interface ControlOrBuilderindex - The index of the element to return.public List<Integer> getSearchSolutionUseCaseValueList()
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
getSearchSolutionUseCaseValueList in interface ControlOrBuilderpublic int getSearchSolutionUseCaseValue(int index)
Specifies the use case for the control. Affects what condition fields can be set. Only settable by search controls. Will default to [SEARCH_SOLUTION_USE_CASE_SEARCH][google.cloud.retail.v2.SearchSolutionUseCase.SEARCH_SOLUTION_USE_CASE_SEARCH] if not specified. Currently only allow one search_solution_use_case per control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
getSearchSolutionUseCaseValue in interface ControlOrBuilderindex - The index of the value to return.public final boolean isInitialized()
isInitialized in interface com.google.protobuf.MessageLiteOrBuilderisInitialized in class com.google.protobuf.GeneratedMessageV3public void writeTo(com.google.protobuf.CodedOutputStream output)
throws IOException
writeTo in interface com.google.protobuf.MessageLitewriteTo in class com.google.protobuf.GeneratedMessageV3IOExceptionpublic int getSerializedSize()
getSerializedSize in interface com.google.protobuf.MessageLitegetSerializedSize in class com.google.protobuf.GeneratedMessageV3public boolean equals(Object obj)
equals in interface com.google.protobuf.Messageequals in class com.google.protobuf.AbstractMessagepublic int hashCode()
hashCode in interface com.google.protobuf.MessagehashCode in class com.google.protobuf.AbstractMessagepublic static Control parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferExceptionpublic static Control parseFrom(InputStream input) throws IOException
IOExceptionpublic static Control parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Control parseDelimitedFrom(InputStream input) throws IOException
IOExceptionpublic static Control parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic static Control parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOExceptionpublic static Control parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOExceptionpublic Control.Builder newBuilderForType()
newBuilderForType in interface com.google.protobuf.MessagenewBuilderForType in interface com.google.protobuf.MessageLitepublic static Control.Builder newBuilder()
public static Control.Builder newBuilder(Control prototype)
public Control.Builder toBuilder()
toBuilder in interface com.google.protobuf.MessagetoBuilder in interface com.google.protobuf.MessageLiteprotected Control.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType in class com.google.protobuf.GeneratedMessageV3public static Control getDefaultInstance()
public static com.google.protobuf.Parser<Control> parser()
public com.google.protobuf.Parser<Control> getParserForType()
getParserForType in interface com.google.protobuf.MessagegetParserForType in interface com.google.protobuf.MessageLitegetParserForType in class com.google.protobuf.GeneratedMessageV3public Control getDefaultInstanceForType()
getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuildergetDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilderCopyright © 2023 Google LLC. All rights reserved.