Class FacetGroup (0.2.0)

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

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FacetGroup

Implements

FacetGroupOrBuilder

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()
Returns
Type Description
FacetGroup

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static FacetGroup.Builder newBuilder()
Returns
Type Description
FacetGroup.Builder

newBuilder(FacetGroup prototype)

public static FacetGroup.Builder newBuilder(FacetGroup prototype)
Parameter
Name Description
prototype FacetGroup
Returns
Type Description
FacetGroup.Builder

parseDelimitedFrom(InputStream input)

public static FacetGroup parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static FacetGroup parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static FacetGroup parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static FacetGroup parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static FacetGroup parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static FacetGroup parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static FacetGroup parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FacetGroup
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<FacetGroup> parser()
Returns
Type Description
Parser<FacetGroup>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBucketType()

public FacetBucketType getBucketType()

Facet bucket type.

.google.cloud.visionai.v1.FacetBucketType bucket_type = 4;

Returns
Type Description
FacetBucketType

The bucketType.

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
Returns
Type Description
FacetBucket

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;

Returns
Type Description
List<FacetBucket>

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
Returns
Type Description
FacetBucketOrBuilder

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()
Returns
Type Description
FacetGroup

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()
Returns
Type Description
Parser<FacetGroup>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public FacetGroup.Builder newBuilderForType()
Returns
Type Description
FacetGroup.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected FacetGroup.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
FacetGroup.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public FacetGroup.Builder toBuilder()
Returns
Type Description
FacetGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException