Package com.google.cloud.visionai.v1

Class SearchConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.visionai.v1.SearchConfig
All Implemented Interfaces:
SearchConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchConfig extends com.google.protobuf.GeneratedMessage implements SearchConfigOrBuilder
 SearchConfig stores different properties that will affect search
 behaviors and search results.
Protobuf type google.cloud.visionai.v1.SearchConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchConfig.Builder
    SearchConfig stores different properties that will affect search behaviors and search results.

    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
    FACET_PROPERTY_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    SEARCH_CRITERIA_PROPERTY_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 SearchConfig
    getDefaultInstance()
     
    SearchConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    FacetProperty
    getFacetProperty()
    Establishes a FacetDimension and associated specifications.
    FacetPropertyOrBuilder
    getFacetPropertyOrBuilder()
    Establishes a FacetDimension and associated specifications.
    String
    getName()
    Resource name of the search configuration.
    com.google.protobuf.ByteString
    getNameBytes()
    Resource name of the search configuration.
    com.google.protobuf.Parser<SearchConfig>
    getParserForType()
     
    SearchCriteriaProperty
    getSearchCriteriaProperty()
    Creates a mapping between a custom SearchCriteria and one or more UGA keys.
    SearchCriteriaPropertyOrBuilder
    getSearchCriteriaPropertyOrBuilder()
    Creates a mapping between a custom SearchCriteria and one or more UGA keys.
    int
    getSerializedSize()
     
    boolean
    hasFacetProperty()
    Establishes a FacetDimension and associated specifications.
    int
    hashCode()
     
    boolean
    hasSearchCriteriaProperty()
    Creates a mapping between a custom SearchCriteria and one or more UGA keys.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchConfig.Builder
    newBuilder()
     
    static SearchConfig.Builder
    newBuilder(SearchConfig prototype)
     
    SearchConfig.Builder
    newBuilderForType()
     
    protected SearchConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchConfig
    parseDelimitedFrom(InputStream input)
     
    static SearchConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchConfig
    parseFrom(byte[] data)
     
    static SearchConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchConfig
    parseFrom(InputStream input)
     
    static SearchConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchConfig
    parseFrom(ByteBuffer data)
     
    static SearchConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchConfig>
    parser()
     
    SearchConfig.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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • FACET_PROPERTY_FIELD_NUMBER

      public static final int FACET_PROPERTY_FIELD_NUMBER
      See Also:

    • SEARCH_CRITERIA_PROPERTY_FIELD_NUMBER

      public static final int SEARCH_CRITERIA_PROPERTY_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

    • getName

      public String getName()
       Resource name of the search configuration.
 For CustomSearchCriteria, search_config would be the search
 operator name. For Facets, search_config would be the facet
 dimension name.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}`
      string name = 1;
      Specified by:
      getName in interface SearchConfigOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Resource name of the search configuration.
 For CustomSearchCriteria, search_config would be the search
 operator name. For Facets, search_config would be the facet
 dimension name.
 Format:
 `projects/{project_number}/locations/{location}/corpora/{corpus}/searchConfigs/{search_config}`
      string name = 1;
      Specified by:
      getNameBytes in interface SearchConfigOrBuilder
      Returns:
      The bytes for name.

    • hasFacetProperty

      public boolean hasFacetProperty()
       Establishes a FacetDimension and associated specifications.
      .google.cloud.visionai.v1.FacetProperty facet_property = 2;
      Specified by:
      hasFacetProperty in interface SearchConfigOrBuilder
      Returns:
      Whether the facetProperty field is set.

    • getFacetProperty

      public FacetProperty getFacetProperty()
       Establishes a FacetDimension and associated specifications.
      .google.cloud.visionai.v1.FacetProperty facet_property = 2;
      Specified by:
      getFacetProperty in interface SearchConfigOrBuilder
      Returns:
      The facetProperty.

    • getFacetPropertyOrBuilder

      public FacetPropertyOrBuilder getFacetPropertyOrBuilder()
       Establishes a FacetDimension and associated specifications.
      .google.cloud.visionai.v1.FacetProperty facet_property = 2;
      Specified by:
      getFacetPropertyOrBuilder in interface SearchConfigOrBuilder

    • hasSearchCriteriaProperty

      public boolean hasSearchCriteriaProperty()
       Creates a mapping between a custom SearchCriteria and one or more UGA keys.
      .google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;
      Specified by:
      hasSearchCriteriaProperty in interface SearchConfigOrBuilder
      Returns:
      Whether the searchCriteriaProperty field is set.

    • getSearchCriteriaProperty

      public SearchCriteriaProperty getSearchCriteriaProperty()
       Creates a mapping between a custom SearchCriteria and one or more UGA keys.
      .google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;
      Specified by:
      getSearchCriteriaProperty in interface SearchConfigOrBuilder
      Returns:
      The searchCriteriaProperty.

    • getSearchCriteriaPropertyOrBuilder

      public SearchCriteriaPropertyOrBuilder getSearchCriteriaPropertyOrBuilder()
       Creates a mapping between a custom SearchCriteria and one or more UGA keys.
      .google.cloud.visionai.v1.SearchCriteriaProperty search_criteria_property = 3;
      Specified by:
      getSearchCriteriaPropertyOrBuilder in interface SearchConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchConfig.Builder newBuilder()

    • newBuilder

      public static SearchConfig.Builder newBuilder(SearchConfig prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchConfig getDefaultInstance()

    • parser

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

    • getParserForType

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