Package com.google.cloud.visionai.v1

Class FacetGroup

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.FacetGroup
All Implemented Interfaces:
FacetGroupOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class FacetGroup extends com.google.protobuf.GeneratedMessage implements FacetGroupOrBuilder
 A group of facet buckets to be passed back and forth between backend &
 frontend.
Protobuf type google.cloud.visionai.v1.FacetGroup
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    FacetGroup.Builder
    A group of facet buckets to be passed back and forth between backend & frontend.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    BUCKET_TYPE_FIELD_NUMBER
     
    static final int
    BUCKETS_FIELD_NUMBER
     
    static final int
    DISPLAY_NAME_FIELD_NUMBER
     
    static final int
    FACET_ID_FIELD_NUMBER
     
    static final int
    FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    FacetBucket
    getBuckets(int index)
    Buckets associated with the facet.
    int
    getBucketsCount()
    Buckets associated with the facet.
    List<FacetBucket>
    getBucketsList()
    Buckets associated with the facet.
    FacetBucketOrBuilder
    getBucketsOrBuilder(int index)
    Buckets associated with the facet.
    List<? extends FacetBucketOrBuilder>
    getBucketsOrBuilderList()
    Buckets associated with the facet.
    FacetBucketType
    getBucketType()
    Facet bucket type.
    int
    getBucketTypeValue()
    Facet bucket type.
    static FacetGroup
    getDefaultInstance()
     
    FacetGroup
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getDisplayName()
    Display name of the facet.
    com.google.protobuf.ByteString
    getDisplayNameBytes()
    Display name of the facet.
    String
    getFacetId()
    Unique id of the facet group.
    com.google.protobuf.ByteString
    getFacetIdBytes()
    Unique id of the facet group.
    boolean
    getFetchMatchedAnnotations()
    If true, return query matched annotations for this facet group's selection.
    com.google.protobuf.Parser<FacetGroup>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static FacetGroup.Builder
    newBuilder()
     
    static FacetGroup.Builder
    newBuilder(FacetGroup prototype)
     
    FacetGroup.Builder
    newBuilderForType()
     
    protected FacetGroup.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static FacetGroup
    parseDelimitedFrom(InputStream input)
     
    static FacetGroup
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FacetGroup
    parseFrom(byte[] data)
     
    static FacetGroup
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FacetGroup
    parseFrom(com.google.protobuf.ByteString data)
     
    static FacetGroup
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FacetGroup
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static FacetGroup
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FacetGroup
    parseFrom(InputStream input)
     
    static FacetGroup
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static FacetGroup
    parseFrom(ByteBuffer data)
     
    static FacetGroup
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<FacetGroup>
    parser()
     
    FacetGroup.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • FACET_ID_FIELD_NUMBER

      public static final int FACET_ID_FIELD_NUMBER
      See Also:

    • DISPLAY_NAME_FIELD_NUMBER

      public static final int DISPLAY_NAME_FIELD_NUMBER
      See Also:

    • BUCKETS_FIELD_NUMBER

      public static final int BUCKETS_FIELD_NUMBER
      See Also:

    • BUCKET_TYPE_FIELD_NUMBER

      public static final int BUCKET_TYPE_FIELD_NUMBER
      See Also:

    • FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER

      public static final int FETCH_MATCHED_ANNOTATIONS_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getFacetId

      public String getFacetId()
       Unique id of the facet group.
      string facet_id = 1;
      Specified by:
      getFacetId in interface FacetGroupOrBuilder
      Returns:
      The facetId.

    • getFacetIdBytes

      public com.google.protobuf.ByteString getFacetIdBytes()
       Unique id of the facet group.
      string facet_id = 1;
      Specified by:
      getFacetIdBytes in interface FacetGroupOrBuilder
      Returns:
      The bytes for facetId.

    • getDisplayName

      public String getDisplayName()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Specified by:
      getDisplayName in interface FacetGroupOrBuilder
      Returns:
      The displayName.

    • getDisplayNameBytes

      public com.google.protobuf.ByteString getDisplayNameBytes()
       Display name of the facet. To be used by UI for facet rendering.
      string display_name = 2;
      Specified by:
      getDisplayNameBytes in interface FacetGroupOrBuilder
      Returns:
      The bytes for displayName.

    • 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;
      Specified by:
      getBucketsList in interface FacetGroupOrBuilder

    • 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;
      Specified by:
      getBucketsOrBuilderList in interface FacetGroupOrBuilder

    • 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;
      Specified by:
      getBucketsCount in interface FacetGroupOrBuilder

    • getBuckets

      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;
      Specified by:
      getBuckets in interface FacetGroupOrBuilder

    • getBucketsOrBuilder

      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;
      Specified by:
      getBucketsOrBuilder in interface FacetGroupOrBuilder

    • getBucketTypeValue

      public int getBucketTypeValue()
       Facet bucket type.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Specified by:
      getBucketTypeValue in interface FacetGroupOrBuilder
      Returns:
      The enum numeric value on the wire for bucketType.

    • getBucketType

      public FacetBucketType getBucketType()
       Facet bucket type.
      .google.cloud.visionai.v1.FacetBucketType bucket_type = 4;
      Specified by:
      getBucketType in interface FacetGroupOrBuilder
      Returns:
      The bucketType.

    • 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;
      Specified by:
      getFetchMatchedAnnotations in interface FacetGroupOrBuilder
      Returns:
      The fetchMatchedAnnotations.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static FacetGroup parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static FacetGroup parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FacetGroup parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FacetGroup parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static FacetGroup parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FacetGroup parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static FacetGroup parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public FacetGroup.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static FacetGroup.Builder newBuilder()

    • newBuilder

      public static FacetGroup.Builder newBuilder(FacetGroup prototype)

    • toBuilder

      public FacetGroup.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected FacetGroup.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static FacetGroup getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<FacetGroup> parser()

    • getParserForType

      public com.google.protobuf.Parser<FacetGroup> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public FacetGroup getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder