Package com.google.cloud.visionai.v1

Class SearchHypernym

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.SearchHypernym
All Implemented Interfaces:
SearchHypernymOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchHypernym extends com.google.protobuf.GeneratedMessage implements SearchHypernymOrBuilder
 Search resource: SearchHypernym.
 For example,
 { hypernym: "vehicle"
 hyponyms: ["sedan", "truck"] }
 This means in SMART_SEARCH mode, searching for "vehicle" will also return
 results with "sedan" or "truck" as annotations.
Protobuf type google.cloud.visionai.v1.SearchHypernym
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchHypernym.Builder
    Search resource: SearchHypernym.

    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
    HYPERNYM_FIELD_NUMBER
     
    static final int
    HYPONYMS_FIELD_NUMBER
     
    static final int
    NAME_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)
     
    static SearchHypernym
    getDefaultInstance()
     
    SearchHypernym
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getHypernym()
    Optional.
    com.google.protobuf.ByteString
    getHypernymBytes()
    Optional.
    String
    getHyponyms(int index)
    Optional.
    com.google.protobuf.ByteString
    getHyponymsBytes(int index)
    Optional.
    int
    getHyponymsCount()
    Optional.
    com.google.protobuf.ProtocolStringList
    getHyponymsList()
    Optional.
    String
    getName()
    Resource name of the SearchHypernym.
    com.google.protobuf.ByteString
    getNameBytes()
    Resource name of the SearchHypernym.
    com.google.protobuf.Parser<SearchHypernym>
    getParserForType()
     
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchHypernym.Builder
    newBuilder()
     
    static SearchHypernym.Builder
    newBuilder(SearchHypernym prototype)
     
    SearchHypernym.Builder
    newBuilderForType()
     
    protected SearchHypernym.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchHypernym
    parseDelimitedFrom(InputStream input)
     
    static SearchHypernym
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchHypernym
    parseFrom(byte[] data)
     
    static SearchHypernym
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchHypernym
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchHypernym
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchHypernym
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchHypernym
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchHypernym
    parseFrom(InputStream input)
     
    static SearchHypernym
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchHypernym
    parseFrom(ByteBuffer data)
     
    static SearchHypernym
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchHypernym>
    parser()
     
    SearchHypernym.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

  • 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

    • getName

      public String getName()
       Resource name of the SearchHypernym.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}`
      string name = 1;
      Specified by:
      getName in interface SearchHypernymOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Resource name of the SearchHypernym.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/searchHypernyms/{search_hypernym}`
      string name = 1;
      Specified by:
      getNameBytes in interface SearchHypernymOrBuilder
      Returns:
      The bytes for name.

    • getHypernym

      public String getHypernym()
       Optional. The hypernym.
      string hypernym = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHypernym in interface SearchHypernymOrBuilder
      Returns:
      The hypernym.

    • getHypernymBytes

      public com.google.protobuf.ByteString getHypernymBytes()
       Optional. The hypernym.
      string hypernym = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHypernymBytes in interface SearchHypernymOrBuilder
      Returns:
      The bytes for hypernym.

    • getHyponymsList

      public com.google.protobuf.ProtocolStringList getHyponymsList()
       Optional. Hyponyms that the hypernym is mapped to.
      repeated string hyponyms = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHyponymsList in interface SearchHypernymOrBuilder
      Returns:
      A list containing the hyponyms.

    • getHyponymsCount

      public int getHyponymsCount()
       Optional. Hyponyms that the hypernym is mapped to.
      repeated string hyponyms = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHyponymsCount in interface SearchHypernymOrBuilder
      Returns:
      The count of hyponyms.

    • getHyponyms

      public String getHyponyms(int index)
       Optional. Hyponyms that the hypernym is mapped to.
      repeated string hyponyms = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHyponyms in interface SearchHypernymOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The hyponyms at the given index.

    • getHyponymsBytes

      public com.google.protobuf.ByteString getHyponymsBytes(int index)
       Optional. Hyponyms that the hypernym is mapped to.
      repeated string hyponyms = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getHyponymsBytes in interface SearchHypernymOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the hyponyms at the given index.

    • 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 SearchHypernym parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchHypernym.Builder newBuilder()

    • newBuilder

      public static SearchHypernym.Builder newBuilder(SearchHypernym prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchHypernym getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<SearchHypernym> 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 SearchHypernym getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder