Class Control (2.47.0)

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.v2alpha.Control

Implements

ControlOrBuilder

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()
Returns
Type Description
Control

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Control.Builder newBuilder()
Returns
Type Description
Control.Builder

newBuilder(Control prototype)

public static Control.Builder newBuilder(Control prototype)
Parameter
Name Description
prototype Control
Returns
Type Description
Control.Builder

parseDelimitedFrom(InputStream input)

public static Control parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Control parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Control parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Control parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Control parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Control parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Control parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Control parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Control parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Control parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Control parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Control parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Control
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Control> parser()
Returns
Type Description
Parser<Control>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
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];

Returns
Type Description
ProtocolStringList

A list containing the associatedServingConfigIds.

getControlCase()

public Control.ControlCase getControlCase()
Returns
Type Description
Control.ControlCase

getDefaultInstanceForType()

public Control getDefaultInstanceForType()
Returns
Type Description
Control

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.v2alpha.Control.facet_spec is deprecated. See google/cloud/retail/v2alpha/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.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

Returns
Type Description
SearchRequest.FacetSpec

The facetSpec.

getFacetSpecOrBuilder() (deprecated)

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.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

Returns
Type Description
SearchRequest.FacetSpecOrBuilder

getName()

public String 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()
Returns
Type Description
Parser<Control>
Overrides

getRule()

public 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.v2alpha.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.v2alpha.Rule rule = 4;

Returns
Type Description
RuleOrBuilder

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.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
SearchSolutionUseCase

The searchSolutionUseCase at the given index.

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.v2alpha.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.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Returns
Type Description
List<SearchSolutionUseCase>

A list containing the searchSolutionUseCase.

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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.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.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type Description
List<SolutionType>

A list containing the solutionTypes.

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.v2alpha.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.v2alpha.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.v2alpha.Control.facet_spec is deprecated. See google/cloud/retail/v2alpha/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.v2alpha.SearchRequest.FacetSpec facet_spec = 3 [deprecated = true];

Returns
Type Description
boolean

Whether the facetSpec field is set.

hasRule()

public 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.v2alpha.Rule rule = 4;

Returns
Type Description
boolean

Whether the rule field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Control.Builder newBuilderForType()
Returns
Type Description
Control.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Control.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Control.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Control.Builder toBuilder()
Returns
Type Description
Control.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException