public final class FacetGroup extends GeneratedMessageV3 implements FacetGroupOrBuilder
A group of facet buckets to be passed back and forth between backend &
frontend.
Protobuf type google.cloud.visionai.v1.FacetGroup
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BUCKETS_FIELD_NUMBER
public static final int BUCKETS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
BUCKET_TYPE_FIELD_NUMBER
public static final int BUCKET_TYPE_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
FACET_ID_FIELD_NUMBER
public static final int FACET_ID_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER
public static final int FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER
Field Value |
Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static FacetGroup getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static FacetGroup.Builder newBuilder()
newBuilder(FacetGroup prototype)
public static FacetGroup.Builder newBuilder(FacetGroup prototype)
public static FacetGroup parseDelimitedFrom(InputStream input)
public static FacetGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static FacetGroup parseFrom(byte[] data)
Parameter |
Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static FacetGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static FacetGroup parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FacetGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static FacetGroup parseFrom(CodedInputStream input)
public static FacetGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static FacetGroup parseFrom(InputStream input)
public static FacetGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static FacetGroup parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static FacetGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<FacetGroup> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter |
Name |
Description |
obj |
Object
|
Overrides
getBucketType()
public FacetBucketType getBucketType()
Facet bucket type.
.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
getBucketTypeValue()
public 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 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
|
getBucketsCount()
public 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 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;
getBucketsOrBuilder(int index)
public 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
|
getBucketsOrBuilderList()
public 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> |
|
getDefaultInstanceForType()
public FacetGroup getDefaultInstanceForType()
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.
|
getFacetId()
public String getFacetId()
Unique id of the facet group.
string facet_id = 1;
Returns |
Type |
Description |
String |
The facetId.
|
getFacetIdBytes()
public ByteString getFacetIdBytes()
Unique id of the facet group.
string facet_id = 1;
Returns |
Type |
Description |
ByteString |
The bytes for facetId.
|
getFetchMatchedAnnotations()
public 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.
|
getParserForType()
public Parser<FacetGroup> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
Returns |
Type |
Description |
int |
|
Overrides
hashCode()
Returns |
Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public FacetGroup.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected FacetGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Returns |
Type |
Description |
Object |
|
Overrides
toBuilder()
public FacetGroup.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides