Package com.google.cloud.enterpriseknowledgegraph.v1

Interface SearchRequestOrBuilder

  • All Superinterfaces:
    com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
    All Known Implementing Classes:
    SearchRequest, SearchRequest.Builder
    public interface SearchRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      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.
      List<String> 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.
      String getQuery()
      Required.
      com.google.protobuf.ByteString getQueryBytes()
      Required.
      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.
      List<String> getTypesList()
      Restricts returned entities with these types, e.g.
      boolean hasLimit()
      Limits the number of entities to be returned.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

    • Method Detail

      • getParent

        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) = { ... }
        Returns:
        The parent.

      • getParentBytes

        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) = { ... }
        Returns:
        The bytes for parent.

      • getQuery

        String getQuery()
         Required. The literal query string for search.
        string query = 2 [(.google.api.field_behavior) = REQUIRED];
        Returns:
        The query.

      • getQueryBytes

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

      • getLanguagesList

        List<String> getLanguagesList()
         The list of language codes (defined in ISO 693) to run the query with,
 e.g. 'en'.
        repeated string languages = 3;
        Returns:
        A list containing the languages.

      • getLanguagesCount

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

      • getLanguages

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The languages at the given index.

      • getLanguagesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the languages at the given index.

      • getTypesList

        List<String> 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;
        Returns:
        A list containing the types.

      • getTypesCount

        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;
        Returns:
        The count of types.

      • getTypes

        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;
        Parameters:
        index - The index of the element to return.
        Returns:
        The types at the given index.

      • getTypesBytes

        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;
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the types at the given index.

      • hasLimit

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

      • getLimit

        com.google.protobuf.Int32Value getLimit()
         Limits the number of entities to be returned.
        .google.protobuf.Int32Value limit = 6;
        Returns:
        The limit.

      • getLimitOrBuilder

        com.google.protobuf.Int32ValueOrBuilder getLimitOrBuilder()
         Limits the number of entities to be returned.
        .google.protobuf.Int32Value limit = 6;