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.v2beta.Control
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
public static final int ASSOCIATED_SERVING_CONFIG_IDS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FACET_SPEC_FIELD_NUMBER
public static final int FACET_SPEC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
RULE_FIELD_NUMBER
public static final int RULE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER
public static final int SEARCH_SOLUTION_USE_CASE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SOLUTION_TYPES_FIELD_NUMBER
public static final int SOLUTION_TYPES_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
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];
| 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 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];
| 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 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];
| Returns |
|---|
| 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()
getDefaultInstanceForType()
public Control getDefaultInstanceForType()
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];
| Returns |
|---|
| 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];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for displayName.
|
getFacetSpec() (deprecated)
public SearchRequest.FacetSpec getFacetSpec()
Deprecated. google.cloud.retail.v2beta.Control.facet_spec is deprecated. See
google/cloud/retail/v2beta/control.proto;l=51
A facet specification to perform faceted search.
Note that this field is deprecated and will throw NOT_IMPLEMENTED if
used for creating a control.
.google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
getFacetSpecOrBuilder()
public SearchRequest.FacetSpecOrBuilder getFacetSpecOrBuilder()
A facet specification to perform faceted search.
Note that this field is deprecated and will throw NOT_IMPLEMENTED if
used for creating a control.
.google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
getName()
Immutable. Fully qualified name
projects/*/locations/global/catalogs/*/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/catalogs/*/controls/*
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getParserForType()
public Parser<Control> getParserForType()
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.v2beta.Rule rule = 4;
| Returns |
|---|
| 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.v2beta.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.v2beta.SearchSolutionUseCase search_solution_use_case = 7;
| Parameter |
|---|
| Name | Description |
index | int
The index of the element to return.
|
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.v2beta.SearchSolutionUseCase search_solution_use_case = 7;
| Returns |
|---|
| 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.v2beta.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.v2beta.SearchSolutionUseCase search_solution_use_case = 7;
| Parameter |
|---|
| 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.v2beta.SearchSolutionUseCase search_solution_use_case = 7;
| Returns |
|---|
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for searchSolutionUseCase.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
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.v2beta.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter |
|---|
| 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.v2beta.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| 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.v2beta.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.v2beta.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Parameter |
|---|
| 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.v2beta.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
List<Integer> | A list containing the enum numeric values on the wire for solutionTypes.
|
hasFacetSpec() (deprecated)
public boolean hasFacetSpec()
Deprecated. google.cloud.retail.v2beta.Control.facet_spec is deprecated. See
google/cloud/retail/v2beta/control.proto;l=51
A facet specification to perform faceted search.
Note that this field is deprecated and will throw NOT_IMPLEMENTED if
used for creating a control.
.google.cloud.retail.v2beta.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];
| Returns |
|---|
| Type | Description |
boolean | Whether the facetSpec field is set.
|
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.v2beta.Rule rule = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the rule 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)
Overrides
toBuilder()
public Control.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
