Class CustomAttribute (1.5.0)

public sealed class CustomAttribute : IMessage<CustomAttribute>, IEquatable<CustomAttribute>, IDeepCloneable<CustomAttribute>, IBufferMessage, IMessage

A custom attribute that is not explicitly modeled in [Product][google.cloud.retail.v2.Product].

Inheritance

Object > CustomAttribute

Namespace

Google.Cloud.Retail.V2

Assembly

Google.Cloud.Retail.V2.dll

Constructors

CustomAttribute()

public CustomAttribute()

CustomAttribute(CustomAttribute)

public CustomAttribute(CustomAttribute other)
Parameter
NameDescription
otherCustomAttribute

Properties

HasIndexable

public bool HasIndexable { get; }

Gets whether the "indexable" field is set

Property Value
TypeDescription
Boolean

HasSearchable

public bool HasSearchable { get; }

Gets whether the "searchable" field is set

Property Value
TypeDescription
Boolean

Indexable

public bool Indexable { get; set; }

If true, custom attribute values are indexed, so that it can be filtered, faceted or boosted in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].

See [SearchRequest.filter][google.cloud.retail.v2.SearchRequest.filter], [SearchRequest.facet_specs][google.cloud.retail.v2.SearchRequest.facet_specs] and [SearchRequest.boost_spec][google.cloud.retail.v2.SearchRequest.boost_spec] for more details.

Property Value
TypeDescription
Boolean

Numbers

public RepeatedField<double> Numbers { get; }

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

At most 400 values are allowed.Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
RepeatedField<Double>

Searchable

public bool Searchable { get; set; }

If true, custom attribute values are searchable by text queries in [SearchService.Search][google.cloud.retail.v2.SearchService.Search].

This field is ignored in a [UserEvent][google.cloud.retail.v2.UserEvent].

Only set if type [text][google.cloud.retail.v2.CustomAttribute.text] is set. Otherwise, a INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
Boolean

Text

public RepeatedField<string> Text { get; }

The textual values of this custom attribute. For example, [&quot;yellow&quot;, &quot;green&quot;] when the key is "color".

At most 400 values are allowed. Empty values are not allowed. Each value must be a UTF-8 encoded string with a length limit of 256 characters. Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of [text][google.cloud.retail.v2.CustomAttribute.text] or [numbers][google.cloud.retail.v2.CustomAttribute.numbers] should be set. Otherwise, an INVALID_ARGUMENT error is returned.

Property Value
TypeDescription
RepeatedField<String>