Package com.google.cloud.enterpriseknowledgegraph.v1

Class SearchRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.enterpriseknowledgegraph.v1.SearchRequest
All Implemented Interfaces:
SearchRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class SearchRequest extends com.google.protobuf.GeneratedMessage implements SearchRequestOrBuilder
 Request message for
 [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search].
Protobuf type google.cloud.enterpriseknowledgegraph.v1.SearchRequest
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    SearchRequest.Builder
    Request message for [EnterpriseKnowledgeGraphService.Search][google.cloud.enterpriseknowledgegraph.v1.EnterpriseKnowledgeGraphService.Search].

    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
    LANGUAGES_FIELD_NUMBER
     
    static final int
    LIMIT_FIELD_NUMBER
     
    static final int
    PARENT_FIELD_NUMBER
     
    static final int
    QUERY_FIELD_NUMBER
     
    static final int
    TYPES_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 SearchRequest
    getDefaultInstance()
     
    SearchRequest
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getLanguages(int index)
    The list of language codes (defined in ISO 693) to run the query with, e.g.
    com.google.protobuf.ByteString
    getLanguagesBytes(int index)
    The list of language codes (defined in ISO 693) to run the query with, e.g.
    int
    getLanguagesCount()
    The list of language codes (defined in ISO 693) to run the query with, e.g.
    com.google.protobuf.ProtocolStringList
    getLanguagesList()
    The list of language codes (defined in ISO 693) to run the query with, e.g.
    com.google.protobuf.Int32Value
    getLimit()
    Limits the number of entities to be returned.
    com.google.protobuf.Int32ValueOrBuilder
    getLimitOrBuilder()
    Limits the number of entities to be returned.
    String
    getParent()
    Required.
    com.google.protobuf.ByteString
    getParentBytes()
    Required.
    com.google.protobuf.Parser<SearchRequest>
    getParserForType()
     
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    int
    getSerializedSize()
     
    String
    getTypes(int index)
    Restricts returned entities with these types, e.g.
    com.google.protobuf.ByteString
    getTypesBytes(int index)
    Restricts returned entities with these types, e.g.
    int
    getTypesCount()
    Restricts returned entities with these types, e.g.
    com.google.protobuf.ProtocolStringList
    getTypesList()
    Restricts returned entities with these types, e.g.
    int
    hashCode()
     
    boolean
    hasLimit()
    Limits the number of entities to be returned.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static SearchRequest.Builder
    newBuilder()
     
    static SearchRequest.Builder
    newBuilder(SearchRequest prototype)
     
    SearchRequest.Builder
    newBuilderForType()
     
    protected SearchRequest.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static SearchRequest
    parseDelimitedFrom(InputStream input)
     
    static SearchRequest
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchRequest
    parseFrom(byte[] data)
     
    static SearchRequest
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchRequest
    parseFrom(com.google.protobuf.ByteString data)
     
    static SearchRequest
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchRequest
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static SearchRequest
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchRequest
    parseFrom(InputStream input)
     
    static SearchRequest
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static SearchRequest
    parseFrom(ByteBuffer data)
     
    static SearchRequest
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<SearchRequest>
    parser()
     
    SearchRequest.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

    • getParent

      public String getParent()
       Required. The name of the Entity's parent resource.
 Format:
 `projects/{project}/locations/{location}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParent in interface SearchRequestOrBuilder
      Returns:
      The parent.

    • getParentBytes

      public com.google.protobuf.ByteString getParentBytes()
       Required. The name of the Entity's parent resource.
 Format:
 `projects/{project}/locations/{location}`
      string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getParentBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for parent.

    • getQuery

      public String getQuery()
       Required. The literal query string for search.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQuery in interface SearchRequestOrBuilder
      Returns:
      The query.

    • getQueryBytes

      public com.google.protobuf.ByteString getQueryBytes()
       Required. The literal query string for search.
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getQueryBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for query.

    • getLanguagesList

      public com.google.protobuf.ProtocolStringList getLanguagesList()
       The list of language codes (defined in ISO 693) to run the query with,
 e.g. 'en'.
      repeated string languages = 3;
      Specified by:
      getLanguagesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the languages.

    • getLanguagesCount

      public int getLanguagesCount()
       The list of language codes (defined in ISO 693) to run the query with,
 e.g. 'en'.
      repeated string languages = 3;
      Specified by:
      getLanguagesCount in interface SearchRequestOrBuilder
      Returns:
      The count of languages.

    • getLanguages

      public String getLanguages(int index)
       The list of language codes (defined in ISO 693) to run the query with,
 e.g. 'en'.
      repeated string languages = 3;
      Specified by:
      getLanguages in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The languages at the given index.

    • getLanguagesBytes

      public com.google.protobuf.ByteString getLanguagesBytes(int index)
       The list of language codes (defined in ISO 693) to run the query with,
 e.g. 'en'.
      repeated string languages = 3;
      Specified by:
      getLanguagesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the languages at the given index.

    • getTypesList

      public com.google.protobuf.ProtocolStringList getTypesList()
       Restricts returned entities with these types, e.g. Person
 (as defined in http://schema.org/Person). If multiple types are specified,
 returned entities will contain one or more of these types.
      repeated string types = 4;
      Specified by:
      getTypesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the types.

    • getTypesCount

      public int getTypesCount()
       Restricts returned entities with these types, e.g. Person
 (as defined in http://schema.org/Person). If multiple types are specified,
 returned entities will contain one or more of these types.
      repeated string types = 4;
      Specified by:
      getTypesCount in interface SearchRequestOrBuilder
      Returns:
      The count of types.

    • getTypes

      public String getTypes(int index)
       Restricts returned entities with these types, e.g. Person
 (as defined in http://schema.org/Person). If multiple types are specified,
 returned entities will contain one or more of these types.
      repeated string types = 4;
      Specified by:
      getTypes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The types at the given index.

    • getTypesBytes

      public com.google.protobuf.ByteString getTypesBytes(int index)
       Restricts returned entities with these types, e.g. Person
 (as defined in http://schema.org/Person). If multiple types are specified,
 returned entities will contain one or more of these types.
      repeated string types = 4;
      Specified by:
      getTypesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the types at the given index.

    • hasLimit

      public boolean hasLimit()
       Limits the number of entities to be returned.
      .google.protobuf.Int32Value limit = 6;
      Specified by:
      hasLimit in interface SearchRequestOrBuilder
      Returns:
      Whether the limit field is set.

    • getLimit

      public com.google.protobuf.Int32Value getLimit()
       Limits the number of entities to be returned.
      .google.protobuf.Int32Value limit = 6;
      Specified by:
      getLimit in interface SearchRequestOrBuilder
      Returns:
      The limit.

    • getLimitOrBuilder

      public com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
       Limits the number of entities to be returned.
      .google.protobuf.Int32Value limit = 6;
      Specified by:
      getLimitOrBuilder in interface SearchRequestOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SearchRequest.Builder newBuilder()

    • newBuilder

      public static SearchRequest.Builder newBuilder(SearchRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static SearchRequest getDefaultInstance()

    • parser

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

    • getParserForType

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