Package com.google.cloud.visionai.v1

Interface FacetPropertyOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FacetProperty, FacetProperty.Builder
@Generated public interface FacetPropertyOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasFixedRangeBucketSpec

      boolean hasFixedRangeBucketSpec()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
      Returns:
      Whether the fixedRangeBucketSpec field is set.

    • getFixedRangeBucketSpec

      FacetProperty.FixedRangeBucketSpec getFixedRangeBucketSpec()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;
      Returns:
      The fixedRangeBucketSpec.

    • getFixedRangeBucketSpecOrBuilder

      FacetProperty.FixedRangeBucketSpecOrBuilder getFixedRangeBucketSpecOrBuilder()
       Fixed range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.FixedRangeBucketSpec fixed_range_bucket_spec = 5;

    • hasCustomRangeBucketSpec

      boolean hasCustomRangeBucketSpec()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
      Returns:
      Whether the customRangeBucketSpec field is set.

    • getCustomRangeBucketSpec

      FacetProperty.CustomRangeBucketSpec getCustomRangeBucketSpec()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;
      Returns:
      The customRangeBucketSpec.

    • getCustomRangeBucketSpecOrBuilder

      FacetProperty.CustomRangeBucketSpecOrBuilder getCustomRangeBucketSpecOrBuilder()
       Custom range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.CustomRangeBucketSpec custom_range_bucket_spec = 6;

    • hasDatetimeBucketSpec

      boolean hasDatetimeBucketSpec()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
      Returns:
      Whether the datetimeBucketSpec field is set.

    • getDatetimeBucketSpec

      FacetProperty.DateTimeBucketSpec getDatetimeBucketSpec()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;
      Returns:
      The datetimeBucketSpec.

    • getDatetimeBucketSpecOrBuilder

      FacetProperty.DateTimeBucketSpecOrBuilder getDatetimeBucketSpecOrBuilder()
       Datetime range facet bucket config.
      .google.cloud.visionai.v1.FacetProperty.DateTimeBucketSpec datetime_bucket_spec = 7;

    • getMappedFieldsList

      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:
      A list containing the mappedFields.

    • getMappedFieldsCount

      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:
      The count of mappedFields.

    • getMappedFields

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The mappedFields at the given index.

    • getMappedFieldsBytes

      com.google.protobuf.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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the mappedFields at the given index.

    • getDisplayName

      String getDisplayName()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Returns:
      The displayName.

    • getDisplayNameBytes

      com.google.protobuf.ByteString getDisplayNameBytes()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Returns:
      The bytes for displayName.

    • getResultSize

      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:
      The resultSize.

    • getBucketTypeValue

      int getBucketTypeValue()
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Returns:
      The enum numeric value on the wire for bucketType.

    • getBucketType

      FacetBucketType getBucketType()
       Facet bucket type e.g. value, range.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Returns:
      The bucketType.

    • getRangeFacetConfigCase

      FacetProperty.RangeFacetConfigCase getRangeFacetConfigCase()