Interface FacetGroupOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FacetGroup, FacetGroup.Builder

@Generated public interface FacetGroupOrBuilder extends com.google.protobuf.MessageOrBuilder
  • Method Details

    • getFacetId

      String getFacetId()
       Unique id of the facet group.
       
      string facet_id = 1;
      Returns:
      The facetId.
    • getFacetIdBytes

      com.google.protobuf.ByteString getFacetIdBytes()
       Unique id of the facet group.
       
      string facet_id = 1;
      Returns:
      The bytes for facetId.
    • 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.
    • getBucketsList

      List<FacetBucket> getBucketsList()
       Buckets associated with the facet. E.g. for "Team" facet, the bucket
       can be 49ers, patriots, etc.
       
      repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
    • getBuckets

      FacetBucket getBuckets(int index)
       Buckets associated with the facet. E.g. for "Team" facet, the bucket
       can be 49ers, patriots, etc.
       
      repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
    • getBucketsCount

      int getBucketsCount()
       Buckets associated with the facet. E.g. for "Team" facet, the bucket
       can be 49ers, patriots, etc.
       
      repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
    • getBucketsOrBuilderList

      List<? extends FacetBucketOrBuilder> getBucketsOrBuilderList()
       Buckets associated with the facet. E.g. for "Team" facet, the bucket
       can be 49ers, patriots, etc.
       
      repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
    • getBucketsOrBuilder

      FacetBucketOrBuilder getBucketsOrBuilder(int index)
       Buckets associated with the facet. E.g. for "Team" facet, the bucket
       can be 49ers, patriots, etc.
       
      repeated .google.cloud.visionai.v1.FacetBucket buckets = 3;
    • getBucketTypeValue

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

      FacetBucketType getBucketType()
       Facet bucket type.
       
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Returns:
      The bucketType.
    • getFetchMatchedAnnotations

      boolean getFetchMatchedAnnotations()
       If true, return query matched annotations for this facet group's selection.
       This option is only applicable for facets based on partition level
       annotations. It supports the following facet values:
       - INTEGER
       - STRING (DataSchema.SearchStrategy.EXACT_SEARCH only)
       
      bool fetch_matched_annotations = 5;
      Returns:
      The fetchMatchedAnnotations.