Class Control.Builder (2.17.0)

public static final class Control.Builder extends GeneratedMessageV3.Builder<Control.Builder> 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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Control.Builder

Implements

ControlOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addAllAssociatedServingConfigIds(Iterable<String> values)

public Control.Builder addAllAssociatedServingConfigIds(Iterable<String> values)

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
`values`	`Iterable<String>` The associatedServingConfigIds to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAllSearchSolutionUseCase(Iterable<? extends SearchSolutionUseCase> values)

public Control.Builder addAllSearchSolutionUseCase(Iterable<? extends SearchSolutionUseCase> values)

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
`values`	`Iterable<? extends com.google.cloud.retail.v2alpha.SearchSolutionUseCase>` The searchSolutionUseCase to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAllSearchSolutionUseCaseValue(Iterable<Integer> values)

public Control.Builder addAllSearchSolutionUseCaseValue(Iterable<Integer> values)

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameter
Name	Description
`values`	`Iterable<Integer>` The enum numeric values on the wire for searchSolutionUseCase to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAllSolutionTypes(Iterable<? extends SolutionType> values)

public Control.Builder addAllSolutionTypes(Iterable<? extends SolutionType> values)

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
`values`	`Iterable<? extends com.google.cloud.retail.v2alpha.SolutionType>` The solutionTypes to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAllSolutionTypesValue(Iterable<Integer> values)

public Control.Builder addAllSolutionTypesValue(Iterable<Integer> values)

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`values`	`Iterable<Integer>` The enum numeric values on the wire for solutionTypes to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAssociatedServingConfigIds(String value)

public Control.Builder addAssociatedServingConfigIds(String value)

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
`value`	`String` The associatedServingConfigIds to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addAssociatedServingConfigIdsBytes(ByteString value)

public Control.Builder addAssociatedServingConfigIdsBytes(ByteString value)

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
`value`	`ByteString` The bytes of the associatedServingConfigIds to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Control.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addSearchSolutionUseCase(SearchSolutionUseCase value)

public Control.Builder addSearchSolutionUseCase(SearchSolutionUseCase value)

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameter
Name	Description
`value`	`SearchSolutionUseCase` The searchSolutionUseCase to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addSearchSolutionUseCaseValue(int value)

public Control.Builder addSearchSolutionUseCaseValue(int value)

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for searchSolutionUseCase to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addSolutionTypes(SolutionType value)

public Control.Builder addSolutionTypes(SolutionType value)

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`SolutionType` The solutionTypes to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

addSolutionTypesValue(int value)

public Control.Builder addSolutionTypesValue(int value)

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`int` The enum numeric value on the wire for solutionTypes to add.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

build()

public Control build()

Returns
Type	Description
`Control`

buildPartial()

public Control buildPartial()

Returns
Type	Description
`Control`

clear()

public Control.Builder clear()

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAssociatedServingConfigIds()

public Control.Builder clearAssociatedServingConfigIds()

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
`Control.Builder`	This builder for chaining.

clearControl()

public Control.Builder clearControl()

Returns
Type	Description
`Control.Builder`

clearDisplayName()

public Control.Builder clearDisplayName()

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
`Control.Builder`	This builder for chaining.

clearFacetSpec()

public Control.Builder clearFacetSpec()

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
`Control.Builder`

clearField(Descriptors.FieldDescriptor field)

public Control.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearName()

public Control.Builder clearName()

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`Control.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Control.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRule()

public Control.Builder clearRule()

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
`Control.Builder`

clearSearchSolutionUseCase()

public Control.Builder clearSearchSolutionUseCase()

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Returns
Type	Description
`Control.Builder`	This builder for chaining.

clearSolutionTypes()

public Control.Builder clearSolutionTypes()

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
`Control.Builder`	This builder for chaining.

clone()

public Control.Builder clone()

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

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`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getFacetSpecBuilder()

public SearchRequest.FacetSpec.Builder getFacetSpecBuilder()

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.Builder`

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

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.

getRuleBuilder()

public Rule.Builder getRuleBuilder()

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.Builder`

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)

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()

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Returns
Type	Description
`int`	The count of searchSolutionUseCase.

getSearchSolutionUseCaseList()

public List<SearchSolutionUseCase> getSearchSolutionUseCaseList()

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)

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()

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.

getSolutionTypes(int index)

public SolutionType getSolutionTypes(int index)

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()

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()

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)

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()

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFacetSpec(SearchRequest.FacetSpec value)

public Control.Builder mergeFacetSpec(SearchRequest.FacetSpec value)

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

Parameter
Name	Description
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`Control.Builder`

mergeFrom(Control other)

public Control.Builder mergeFrom(Control other)

Parameter
Name	Description
`other`	`Control`

Returns
Type	Description
`Control.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Control.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`Control.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public Control.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`Control.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeRule(Rule value)

public Control.Builder mergeRule(Rule value)

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;

Parameter
Name	Description
`value`	`Rule`

Returns
Type	Description
`Control.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Control.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setAssociatedServingConfigIds(int index, String value)

public Control.Builder setAssociatedServingConfigIds(int index, String value)

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

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`String` The associatedServingConfigIds to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setDisplayName(String value)

public Control.Builder setDisplayName(String value)

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

Parameter
Name	Description
`value`	`String` The displayName to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Control.Builder setDisplayNameBytes(ByteString value)

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

Parameter
Name	Description
`value`	`ByteString` The bytes for displayName to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setFacetSpec(SearchRequest.FacetSpec value)

public Control.Builder setFacetSpec(SearchRequest.FacetSpec value)

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

Parameter
Name	Description
`value`	`SearchRequest.FacetSpec`

Returns
Type	Description
`Control.Builder`

setFacetSpec(SearchRequest.FacetSpec.Builder builderForValue)

public Control.Builder setFacetSpec(SearchRequest.FacetSpec.Builder builderForValue)

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

Parameter
Name	Description
`builderForValue`	`SearchRequest.FacetSpec.Builder`

Returns
Type	Description
`Control.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public Control.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setName(String value)

public Control.Builder setName(String value)

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`String` The name to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setNameBytes(ByteString value)

public Control.Builder setNameBytes(ByteString value)

Immutable. Fully qualified name projects/*/locations/global/catalogs/*/controls/*

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Parameter
Name	Description
`value`	`ByteString` The bytes for name to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Control.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRule(Rule value)

public Control.Builder setRule(Rule value)

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;

Parameter
Name	Description
`value`	`Rule`

Returns
Type	Description
`Control.Builder`

setRule(Rule.Builder builderForValue)

public Control.Builder setRule(Rule.Builder builderForValue)

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;

Parameter
Name	Description
`builderForValue`	`Rule.Builder`

Returns
Type	Description
`Control.Builder`

setSearchSolutionUseCase(int index, SearchSolutionUseCase value)

public Control.Builder setSearchSolutionUseCase(int index, SearchSolutionUseCase value)

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`SearchSolutionUseCase` The searchSolutionUseCase to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setSearchSolutionUseCaseValue(int index, int value)

public Control.Builder setSearchSolutionUseCaseValue(int index, int value)

repeated .google.cloud.retail.v2alpha.SearchSolutionUseCase search_solution_use_case = 7;

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`int` The enum numeric value on the wire for searchSolutionUseCase to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setSolutionTypes(int index, SolutionType value)

public Control.Builder setSolutionTypes(int index, SolutionType value)

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`SolutionType` The solutionTypes to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setSolutionTypesValue(int index, int value)

public Control.Builder setSolutionTypesValue(int index, int value)

repeated .google.cloud.retail.v2alpha.SolutionType solution_types = 6 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];

Parameters
Name	Description
`index`	`int` The index to set the value at.
`value`	`int` The enum numeric value on the wire for solutionTypes to set.

Returns
Type	Description
`Control.Builder`	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Control.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`Control.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)