public final class Control extends GeneratedMessageV3 implements ControlOrBuilder
Configures dynamic metadata that can be linked to a
ServingConfig and affect search or
recommendation results at serving time.
Protobuf type google.cloud.retail.v2.Control
Static Fields
ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
Field Value
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
RULE_FIELD_NUMBER
public static final int RULE_FIELD_NUMBER
Field Value
SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER
public static final int SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER
Field Value
SOLUTION_TYPES_FIELD_NUMBER
public static final int SOLUTION_TYPES_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Control getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Control.Builder newBuilder()
Returns
newBuilder(Control prototype)
public static Control.Builder newBuilder(Control prototype)
Parameter
Returns
public static Control parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Control parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Control parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Control parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Control parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Control parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Control parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Control parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Control parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Control parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Control> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getAssociatedServingConfigIds(int index)
public String getAssociatedServingConfigIds(int index)
Output only. List of serving config
ids that are associated with this control in the same
Catalog.
Note the association is managed via the
ServingConfig, this is an output
only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 serving config
ids that are associated with this control in the same
Catalog.
Note the association is managed via the
ServingConfig, this is an output
only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| 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 serving config
ids that are associated with this control in the same
Catalog.
Note the association is managed via the
ServingConfig, this is an output
only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Type | Description |
int | The count of associatedServingConfigIds.
|
getAssociatedServingConfigIdsList()
public ProtocolStringList getAssociatedServingConfigIdsList()
Output only. List of serving config
ids that are associated with this control in the same
Catalog.
Note the association is managed via the
ServingConfig, this is an output
only denormalized view.
repeated string associated_serving_config_ids = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
getControlCase()
public Control.ControlCase getControlCase()
Returns
getDefaultInstanceForType()
public Control getDefaultInstanceForType()
Returns
getDisplayName()
public 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];
| Type | Description |
String | The displayName.
|
getDisplayNameBytes()
public 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];
| Type | Description |
ByteString | The bytes for displayName.
|
getName()
Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/controls/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
getParserForType()
public Parser<Control> getParserForType()
Returns
Overrides
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;
| Type | Description |
Rule | The rule.
|
getRuleOrBuilder()
public 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;
getSearchSolutionUseCase(int index)
public 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
if not specified. Currently only allow one search_solution_use_case per
control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
| Name | Description |
index | int
The index of the element to return.
|
Returns
getSearchSolutionUseCaseCount()
public 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
if not specified. Currently only allow one search_solution_use_case per
control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
| Type | Description |
int | The count of searchSolutionUseCase.
|
getSearchSolutionUseCaseList()
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
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(int index)
public 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
if not specified. Currently only allow one search_solution_use_case per
control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
| Name | Description |
index | int
The index of the value to return.
|
Returns
| Type | Description |
int | The enum numeric value on the wire of searchSolutionUseCase at the given index.
|
getSearchSolutionUseCaseValueList()
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
if not specified. Currently only allow one search_solution_use_case per
control.
repeated .google.cloud.retail.v2.SearchSolutionUseCase search_solution_use_case = 7;
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for searchSolutionUseCase.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSolutionTypes(int index)
public 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.
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
index | int
The index of the element to return.
|
Returns
| Type | Description |
SolutionType | The solutionTypes at the given index.
|
getSolutionTypesCount()
public 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.
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
int | The count of solutionTypes.
|
getSolutionTypesList()
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.
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
getSolutionTypesValue(int index)
public 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.
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Name | Description |
index | int
The index of the value to return.
|
Returns
| Type | Description |
int | The enum numeric value on the wire of solutionTypes at the given index.
|
getSolutionTypesValueList()
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.
repeated .google.cloud.retail.v2.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for solutionTypes.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
boolean | Whether the rule field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Control.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Control.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Control.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
