Class FeatureMap.Builder (0.40.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FeatureMap.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FeatureMap.Builder
Overrides

build()

public FeatureMap build()
Returns
TypeDescription
FeatureMap

buildPartial()

public FeatureMap buildPartial()
Returns
TypeDescription
FeatureMap

clear()

public FeatureMap.Builder clear()
Returns
TypeDescription
FeatureMap.Builder
Overrides

clearCategoricalFeatures()

public FeatureMap.Builder clearCategoricalFeatures()
Returns
TypeDescription
FeatureMap.Builder

clearField(Descriptors.FieldDescriptor field)

public FeatureMap.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
FeatureMap.Builder
Overrides

clearNumericalFeatures()

public FeatureMap.Builder clearNumericalFeatures()
Returns
TypeDescription
FeatureMap.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public FeatureMap.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
FeatureMap.Builder
Overrides

clone()

public FeatureMap.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getCategoricalFeatures() (deprecated)

public Map<String,FeatureMap.StringList> getCategoricalFeatures()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueFeatureMap.StringList
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
FeatureMap.StringList

getDefaultInstanceForType()

public FeatureMap getDefaultInstanceForType()
Returns
TypeDescription
FeatureMap

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getMutableCategoricalFeatures() (deprecated)

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

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,StringList>

getMutableNumericalFeatures() (deprecated)

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

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,FloatList>

getNumericalFeatures() (deprecated)

public Map<String,FeatureMap.FloatList> getNumericalFeatures()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueFeatureMap.FloatList
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
FeatureMap.FloatList

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(FeatureMap other)

public FeatureMap.Builder mergeFrom(FeatureMap other)
Parameter
NameDescription
otherFeatureMap
Returns
TypeDescription
FeatureMap.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FeatureMap.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
FeatureMap.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public FeatureMap.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
FeatureMap.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FeatureMap.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,StringList>
Returns
TypeDescription
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
NameDescription
valuesMap<String,FloatList>
Returns
TypeDescription
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
NameDescription
keyString
valueFeatureMap.StringList
Returns
TypeDescription
FeatureMap.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
NameDescription
keyString
valueFeatureMap.FloatList
Returns
TypeDescription
FeatureMap.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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
FeatureMap.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public FeatureMap.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
FeatureMap.Builder
Overrides

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

public FeatureMap.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
FeatureMap.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FeatureMap.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
FeatureMap.Builder
Overrides