public static final class FacetProperty.Builder extends GeneratedMessageV3.Builder<FacetProperty.Builder> implements FacetPropertyOrBuilderCentral configuration for a facet.
Protobuf type google.cloud.visionai.v1.FacetProperty
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > FacetProperty.BuilderImplements
FacetPropertyOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAllMappedFields(Iterable<String> values)
public FacetProperty.Builder addAllMappedFields(Iterable<String> values) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The mappedFields to add. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
addMappedFields(String value)
public FacetProperty.Builder addMappedFields(String value) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mappedFields to add. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
addMappedFieldsBytes(ByteString value)
public FacetProperty.Builder addMappedFieldsBytes(ByteString value) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the mappedFields to add. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public FacetProperty.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
build()
public FacetProperty build()| Returns | |
|---|---|
| Type | Description |
FacetProperty |
|
buildPartial()
public FacetProperty buildPartial()| Returns | |
|---|---|
| Type | Description |
FacetProperty |
|
clear()
public FacetProperty.Builder clear()| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearBucketType()
public FacetProperty.Builder clearBucketType()Facet bucket type e.g. value, range.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
clearCustomRangeBucketSpec()
public FacetProperty.Builder clearCustomRangeBucketSpec()Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearDatetimeBucketSpec()
public FacetProperty.Builder clearDatetimeBucketSpec()Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearDisplayName()
public FacetProperty.Builder clearDisplayName()Display name of the facet. To be used by UI for facet rendering.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public FacetProperty.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearFixedRangeBucketSpec()
public FacetProperty.Builder clearFixedRangeBucketSpec()Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearMappedFields()
public FacetProperty.Builder clearMappedFields() Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public FacetProperty.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearRangeFacetConfig()
public FacetProperty.Builder clearRangeFacetConfig()| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
clearResultSize()
public FacetProperty.Builder clearResultSize()Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size.
int64 result_size = 3;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
clone()
public FacetProperty.Builder clone()| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
getBucketType()
public FacetBucketType getBucketType()Facet bucket type e.g. value, range.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Returns | |
|---|---|
| Type | Description |
FacetBucketType |
The bucketType. |
getBucketTypeValue()
public int getBucketTypeValue()Facet bucket type e.g. value, range.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for bucketType. |
getCustomRangeBucketSpec()
public FacetProperty.CustomRangeBucketSpec getCustomRangeBucketSpec()Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.CustomRangeBucketSpec |
The customRangeBucketSpec. |
getCustomRangeBucketSpecBuilder()
public FacetProperty.CustomRangeBucketSpec.Builder getCustomRangeBucketSpecBuilder()Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.CustomRangeBucketSpec.Builder |
|
getCustomRangeBucketSpecOrBuilder()
public FacetProperty.CustomRangeBucketSpecOrBuilder getCustomRangeBucketSpecOrBuilder()Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.CustomRangeBucketSpecOrBuilder |
|
getDatetimeBucketSpec()
public FacetProperty.DateTimeBucketSpec getDatetimeBucketSpec()Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.DateTimeBucketSpec |
The datetimeBucketSpec. |
getDatetimeBucketSpecBuilder()
public FacetProperty.DateTimeBucketSpec.Builder getDatetimeBucketSpecBuilder()Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.DateTimeBucketSpec.Builder |
|
getDatetimeBucketSpecOrBuilder()
public FacetProperty.DateTimeBucketSpecOrBuilder getDatetimeBucketSpecOrBuilder()Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.DateTimeBucketSpecOrBuilder |
|
getDefaultInstanceForType()
public FacetProperty getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
FacetProperty |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisplayName()
public String getDisplayName()Display name of the facet. To be used by UI for facet rendering.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The displayName. |
getDisplayNameBytes()
public ByteString getDisplayNameBytes()Display name of the facet. To be used by UI for facet rendering.
string display_name = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayName. |
getFixedRangeBucketSpec()
public FacetProperty.FixedRangeBucketSpec getFixedRangeBucketSpec()Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.FixedRangeBucketSpec |
The fixedRangeBucketSpec. |
getFixedRangeBucketSpecBuilder()
public FacetProperty.FixedRangeBucketSpec.Builder getFixedRangeBucketSpecBuilder()Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.FixedRangeBucketSpec.Builder |
|
getFixedRangeBucketSpecOrBuilder()
public FacetProperty.FixedRangeBucketSpecOrBuilder getFixedRangeBucketSpecOrBuilder()Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Returns | |
|---|---|
| Type | Description |
FacetProperty.FixedRangeBucketSpecOrBuilder |
|
getMappedFields(int index)
public String getMappedFields(int index) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The mappedFields at the given index. |
getMappedFieldsBytes(int index)
public ByteString getMappedFieldsBytes(int index) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the mappedFields at the given index. |
getMappedFieldsCount()
public int getMappedFieldsCount() Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The count of mappedFields. |
getMappedFieldsList()
public ProtocolStringList getMappedFieldsList() Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the mappedFields. |
getRangeFacetConfigCase()
public FacetProperty.RangeFacetConfigCase getRangeFacetConfigCase()| Returns | |
|---|---|
| Type | Description |
FacetProperty.RangeFacetConfigCase |
|
getResultSize()
public long getResultSize()Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size.
int64 result_size = 3;
| Returns | |
|---|---|
| Type | Description |
long |
The resultSize. |
hasCustomRangeBucketSpec()
public boolean hasCustomRangeBucketSpec()Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customRangeBucketSpec field is set. |
hasDatetimeBucketSpec()
public boolean hasDatetimeBucketSpec()Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the datetimeBucketSpec field is set. |
hasFixedRangeBucketSpec()
public boolean hasFixedRangeBucketSpec()Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the fixedRangeBucketSpec field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)
public FacetProperty.Builder mergeCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.CustomRangeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
mergeDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)
public FacetProperty.Builder mergeDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.DateTimeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
mergeFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)
public FacetProperty.Builder mergeFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.FixedRangeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
mergeFrom(FacetProperty other)
public FacetProperty.Builder mergeFrom(FacetProperty other)| Parameter | |
|---|---|
| Name | Description |
other |
FacetProperty |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public FacetProperty.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public FacetProperty.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final FacetProperty.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setBucketType(FacetBucketType value)
public FacetProperty.Builder setBucketType(FacetBucketType value)Facet bucket type e.g. value, range.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetBucketTypeThe bucketType to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setBucketTypeValue(int value)
public FacetProperty.Builder setBucketTypeValue(int value)Facet bucket type e.g. value, range.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for bucketType to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)
public FacetProperty.Builder setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec value)Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.CustomRangeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec.Builder builderForValue)
public FacetProperty.Builder setCustomRangeBucketSpec(FacetProperty.CustomRangeBucketSpec.Builder builderForValue)Custom range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FacetProperty.CustomRangeBucketSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)
public FacetProperty.Builder setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec value)Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.DateTimeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec.Builder builderForValue)
public FacetProperty.Builder setDatetimeBucketSpec(FacetProperty.DateTimeBucketSpec.Builder builderForValue)Datetime range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FacetProperty.DateTimeBucketSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setDisplayName(String value)
public FacetProperty.Builder setDisplayName(String value)Display name of the facet. To be used by UI for facet rendering.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayName to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setDisplayNameBytes(ByteString value)
public FacetProperty.Builder setDisplayNameBytes(ByteString value)Display name of the facet. To be used by UI for facet rendering.
string display_name = 2;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayName to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public FacetProperty.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)
public FacetProperty.Builder setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec value)Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
FacetProperty.FixedRangeBucketSpec |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec.Builder builderForValue)
public FacetProperty.Builder setFixedRangeBucketSpec(FacetProperty.FixedRangeBucketSpec.Builder builderForValue)Fixed range facet bucket config.
.google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FacetProperty.FixedRangeBucketSpec.Builder |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setMappedFields(int index, String value)
public FacetProperty.Builder setMappedFields(int index, String value) Name of the facets, which are the dimensions users want to use to refine
search results. mapped_fields will match UserSpecifiedDataSchema keys.
For example, user can add a bunch of UGAs with the same key, such as player:adam, player:bob, player:charles. When multiple mapped_fields are specified, will merge their value together as final facet value. E.g. home_team: a, home_team:b, away_team:a, away_team:c, when facet_field = [home_team, away_team], facet_value will be [a, b, c].
UNLESS this is a 1:1 facet dimension (mapped_fields.size() == 1) AND the mapped_field equals the parent SearchConfig.name, the parent must also contain a SearchCriteriaProperty that maps to the same fields. mapped_fields must not be empty.
repeated string mapped_fields = 1;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe mappedFields to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public FacetProperty.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|
setResultSize(long value)
public FacetProperty.Builder setResultSize(long value)Maximum number of unique bucket to return for one facet. Bucket number can be large for high-cardinality facet such as "player". We only return top-n most related ones to user. If it's <= 0, the server will decide the appropriate result_size.
int64 result_size = 3;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe resultSize to set. |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
This builder for chaining. |
setUnknownFields(UnknownFieldSet unknownFields)
public final FacetProperty.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
FacetProperty.Builder |
|