Package com.google.cloud.dataplex.v1

Interface SearchEntriesRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
SearchEntriesRequest, SearchEntriesRequest.Builder
@Generated public interface SearchEntriesRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    String
    getOrderBy()
    Optional.
    com.google.protobuf.ByteString
    getOrderByBytes()
    Optional.
    int
    getPageSize()
    Optional.
    String
    getPageToken()
    Optional.
    com.google.protobuf.ByteString
    getPageTokenBytes()
    Optional.
    String
    getQuery()
    Required.
    com.google.protobuf.ByteString
    getQueryBytes()
    Required.
    String
    getScope()
    Optional.
    com.google.protobuf.ByteString
    getScopeBytes()
    Optional.
    boolean
    getSemanticSearch()
    Optional.

    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 Details

    • getName

      String getName()
       Required. The project to which the request should be attributed in the
 following form: `projects/{project}/locations/global`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       Required. The project to which the request should be attributed in the
 following form: `projects/{project}/locations/global`.
      string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      The bytes for name.

    • getQuery

      String getQuery()
       Required. The query against which entries in scope should be matched.
 The query syntax is defined in [Search syntax for Dataplex Universal
 Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The query.

    • getQueryBytes

      com.google.protobuf.ByteString getQueryBytes()
       Required. The query against which entries in scope should be matched.
 The query syntax is defined in [Search syntax for Dataplex Universal
 Catalog](https://cloud.google.com/dataplex/docs/search-syntax).
      string query = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The bytes for query.

    • getPageSize

      int getPageSize()
       Optional. Number of results in the search page. If <=0, then defaults
 to 10. Max limit for page_size is 1000. Throws an invalid argument for
 page_size > 1000.
      int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageSize.

    • getPageToken

      String getPageToken()
       Optional. Page token received from a previous `SearchEntries` call. Provide
 this to retrieve the subsequent page.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The pageToken.

    • getPageTokenBytes

      com.google.protobuf.ByteString getPageTokenBytes()
       Optional. Page token received from a previous `SearchEntries` call. Provide
 this to retrieve the subsequent page.
      string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for pageToken.

    • getOrderBy

      String getOrderBy()
       Optional. Specifies the ordering of results.
 Supported values are:

 * `relevance`
 * `last_modified_timestamp`
 * `last_modified_timestamp asc`
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The orderBy.

    • getOrderByBytes

      com.google.protobuf.ByteString getOrderByBytes()
       Optional. Specifies the ordering of results.
 Supported values are:

 * `relevance`
 * `last_modified_timestamp`
 * `last_modified_timestamp asc`
      string order_by = 5 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for orderBy.

    • getScope

      String getScope()
       Optional. The scope under which the search should be operating. It must
 either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
 unspecified, it defaults to the organization where the project provided in
 `name` is located.
      string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The scope.

    • getScopeBytes

      com.google.protobuf.ByteString getScopeBytes()
       Optional. The scope under which the search should be operating. It must
 either be `organizations/<org_id>` or `projects/<project_ref>`. If it is
 unspecified, it defaults to the organization where the project provided in
 `name` is located.
      string scope = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for scope.

    • getSemanticSearch

      boolean getSemanticSearch()
       Optional. Specifies whether the search should understand the meaning and
 intent behind the query, rather than just matching keywords.
      bool semantic_search = 11 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The semanticSearch.