Interface FacetPropertyOrBuilder (0.2.0)

public interface FacetPropertyOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getBucketType()

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

getCustomRangeBucketSpecOrBuilder()

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

getDatetimeBucketSpecOrBuilder()

public abstract FacetProperty.DateTimeBucketSpecOrBuilder getDatetimeBucketSpecOrBuilder()

Datetime range facet bucket config.

.google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

Returns
Type Description
FacetProperty.DateTimeBucketSpecOrBuilder

getDisplayName()

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

getFixedRangeBucketSpecOrBuilder()

public abstract 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 abstract 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 int

The index of the element to return.
Returns
Type Description
String

The mappedFields at the given index.

getMappedFieldsBytes(int index)

public abstract 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 int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the mappedFields at the given index.

getMappedFieldsCount()

public abstract 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 abstract List<String> 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
List<String>

A list containing the mappedFields.

getRangeFacetConfigCase()

public abstract FacetProperty.RangeFacetConfigCase getRangeFacetConfigCase()
Returns
Type Description
FacetProperty.RangeFacetConfigCase

getResultSize()

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