public interface FacetGroupOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBucketType()
public abstract FacetBucketType getBucketType()Facet bucket type.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Returns | |
|---|---|
| Type | Description |
FacetBucketType |
The bucketType. |
getBucketTypeValue()
public abstract int getBucketTypeValue()Facet bucket type.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for bucketType. |
getBuckets(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FacetBucket |
|
getBucketsCount()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
int |
|
getBucketsList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<FacetBucket> |
|
getBucketsOrBuilder(int index)
public abstract 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;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FacetBucketOrBuilder |
|
getBucketsOrBuilderList()
public abstract 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;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.visionai.v1.FacetBucketOrBuilder> |
|
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. |
getFacetId()
public abstract String getFacetId()Unique id of the facet group.
string facet_id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The facetId. |
getFacetIdBytes()
public abstract ByteString getFacetIdBytes()Unique id of the facet group.
string facet_id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for facetId. |
getFetchMatchedAnnotations()
public abstract 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 | |
|---|---|
| Type | Description |
boolean |
The fetchMatchedAnnotations. |