Class FacetGroup (0.10.0)

Version latest

• 0.10.0 (latest)
• 0.9.0
• 0.8.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.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

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,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()

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

AbstractMessage.equals(Object other)

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

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

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

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public FacetGroup.Builder toBuilder()

Returns
Type	Description
FacetGroup.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException