Class FeatureMap.Builder (0.52.0)

public static final class FeatureMap.Builder extends GeneratedMessageV3.Builder<FeatureMap.Builder> implements FeatureMapOrBuilder

FeatureMap represents extra features that customers want to include in the recommendation model for catalogs/user events as categorical/numerical features.

Protobuf type google.cloud.recommendationengine.v1beta1.FeatureMap

Implements

FeatureMapOrBuilder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FeatureMap.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FeatureMap.Builder
Overrides

build()

public FeatureMap build()
Returns
Type Description
FeatureMap

buildPartial()

public FeatureMap buildPartial()
Returns
Type Description
FeatureMap

clear()

public FeatureMap.Builder clear()
Returns
Type Description
FeatureMap.Builder
Overrides

clearCategoricalFeatures()

public FeatureMap.Builder clearCategoricalFeatures()
Returns
Type Description
FeatureMap.Builder

clearField(Descriptors.FieldDescriptor field)

public FeatureMap.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FeatureMap.Builder
Overrides

clearNumericalFeatures()

public FeatureMap.Builder clearNumericalFeatures()
Returns
Type Description
FeatureMap.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FeatureMap.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FeatureMap.Builder
Overrides

clone()

public FeatureMap.Builder clone()
Returns
Type Description
FeatureMap.Builder
Overrides

containsCategoricalFeatures(String key)

public boolean containsCategoricalFeatures(String key)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameter
Name Description
key String
Returns
Type Description
boolean

containsNumericalFeatures(String key)

public boolean containsNumericalFeatures(String key)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameter
Name Description
key String
Returns
Type Description
boolean

getCategoricalFeatures() (deprecated)

public Map<String,FeatureMap.StringList> getCategoricalFeatures()
Returns
Type Description
Map<String,StringList>

getCategoricalFeaturesCount()

public int getCategoricalFeaturesCount()

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Returns
Type Description
int

getCategoricalFeaturesMap()

public Map<String,FeatureMap.StringList> getCategoricalFeaturesMap()

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Returns
Type Description
Map<String,StringList>

getCategoricalFeaturesOrDefault(String key, FeatureMap.StringList defaultValue)

public FeatureMap.StringList getCategoricalFeaturesOrDefault(String key, FeatureMap.StringList defaultValue)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameters
Name Description
key String
defaultValue FeatureMap.StringList
Returns
Type Description
FeatureMap.StringList

getCategoricalFeaturesOrThrow(String key)

public FeatureMap.StringList getCategoricalFeaturesOrThrow(String key)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.StringList

getDefaultInstanceForType()

public FeatureMap getDefaultInstanceForType()
Returns
Type Description
FeatureMap

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableCategoricalFeatures() (deprecated)

public Map<String,FeatureMap.StringList> getMutableCategoricalFeatures()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,StringList>

getMutableNumericalFeatures() (deprecated)

public Map<String,FeatureMap.FloatList> getMutableNumericalFeatures()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,FloatList>

getNumericalFeatures() (deprecated)

public Map<String,FeatureMap.FloatList> getNumericalFeatures()
Returns
Type Description
Map<String,FloatList>

getNumericalFeaturesCount()

public int getNumericalFeaturesCount()

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Returns
Type Description
int

getNumericalFeaturesMap()

public Map<String,FeatureMap.FloatList> getNumericalFeaturesMap()

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Returns
Type Description
Map<String,FloatList>

getNumericalFeaturesOrDefault(String key, FeatureMap.FloatList defaultValue)

public FeatureMap.FloatList getNumericalFeaturesOrDefault(String key, FeatureMap.FloatList defaultValue)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameters
Name Description
key String
defaultValue FeatureMap.FloatList
Returns
Type Description
FeatureMap.FloatList

getNumericalFeaturesOrThrow(String key)

public FeatureMap.FloatList getNumericalFeaturesOrThrow(String key)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.FloatList

internalGetFieldAccessorTable()

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

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FeatureMap other)

public FeatureMap.Builder mergeFrom(FeatureMap other)
Parameter
Name Description
other FeatureMap
Returns
Type Description
FeatureMap.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FeatureMap.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FeatureMap.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FeatureMap.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FeatureMap.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FeatureMap.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FeatureMap.Builder
Overrides

putAllCategoricalFeatures(Map<String,FeatureMap.StringList> values)

public FeatureMap.Builder putAllCategoricalFeatures(Map<String,FeatureMap.StringList> values)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameter
Name Description
values Map<String,StringList>
Returns
Type Description
FeatureMap.Builder

putAllNumericalFeatures(Map<String,FeatureMap.FloatList> values)

public FeatureMap.Builder putAllNumericalFeatures(Map<String,FeatureMap.FloatList> values)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameter
Name Description
values Map<String,FloatList>
Returns
Type Description
FeatureMap.Builder

putCategoricalFeatures(String key, FeatureMap.StringList value)

public FeatureMap.Builder putCategoricalFeatures(String key, FeatureMap.StringList value)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameters
Name Description
key String
value FeatureMap.StringList
Returns
Type Description
FeatureMap.Builder

putCategoricalFeaturesBuilderIfAbsent(String key)

public FeatureMap.StringList.Builder putCategoricalFeaturesBuilderIfAbsent(String key)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.StringList.Builder

putNumericalFeatures(String key, FeatureMap.FloatList value)

public FeatureMap.Builder putNumericalFeatures(String key, FeatureMap.FloatList value)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameters
Name Description
key String
value FeatureMap.FloatList
Returns
Type Description
FeatureMap.Builder

putNumericalFeaturesBuilderIfAbsent(String key)

public FeatureMap.FloatList.Builder putNumericalFeaturesBuilderIfAbsent(String key)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.FloatList.Builder

removeCategoricalFeatures(String key)

public FeatureMap.Builder removeCategoricalFeatures(String key)

Categorical features that can take on one of a limited number of possible values. Some examples would be the brand/maker of a product, or country of a customer.

Feature names and values must be UTF-8 encoded strings.

For example: { "colors": {"value": ["yellow", "green"]}, "sizes": {"value":["S", "M"]}

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.StringList> categorical_features = 1;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.Builder

removeNumericalFeatures(String key)

public FeatureMap.Builder removeNumericalFeatures(String key)

Numerical features. Some examples would be the height/weight of a product, or age of a customer.

Feature names must be UTF-8 encoded strings.

For example: { "lengths_cm": {"value":[2.3, 15.4]}, "heights_cm": {"value":[8.1, 6.4]} }

map<string, .google.cloud.recommendationengine.v1beta1.FeatureMap.FloatList> numerical_features = 2;

Parameter
Name Description
key String
Returns
Type Description
FeatureMap.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FeatureMap.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FeatureMap.Builder
Overrides

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

public FeatureMap.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FeatureMap.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FeatureMap.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FeatureMap.Builder
Overrides