Console
    Start free

    Method: projects.locations.searchEntries

    Searches for Entries matching the given query and scope.

    HTTP request

    POST https://dataplex.googleapis.com/v1/{name=projects/*/locations/*}:searchEntries

    The URL uses gRPC Transcoding syntax.

    Path parameters

    Parameters
    name

    string

    Required. The project to which the request should be attributed in the following form: projects/{project}/locations/global .

    Authorization requires the following IAM permission on the specified resource name :

    • dataplex.projects.search

    Query parameters

    Parameters
    query

    string

    Required. The query against which entries in scope should be matched. The query syntax is defined in Search syntax for Dataplex Universal Catalog .

    pageSize

    integer

    Optional. Number of results in the search page. If <=0, then defaults to 10. Max limit for pageSize is 1000. Throws an invalid argument for pageSize > 1000.

    pageToken

    string

    Optional. Page token received from a previous locations.searchEntries call. Provide this to retrieve the subsequent page.

    orderBy

    string

    Optional. Specifies the ordering of results. Supported values are:

    • relevance
    • last_modified_timestamp
    • last_modified_timestamp asc
    scope

    string

    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.

    Request body

    The request body must be empty.

    Response body

    If successful, the response body contains data with the following structure:

    JSON representation 
     { 
 "results" 
 : 
 [ 
 { 
 object (  SearchEntriesResult 
 
) 
 } 
 ] 
 , 
 "totalSize" 
 : 
 integer 
 , 
 "nextPageToken" 
 : 
 string 
 , 
 "unreachable" 
 : 
 [ 
 string 
 ] 
 }
    Fields
    results[]

    object ( SearchEntriesResult )

    The results matching the search query.
    totalSize

    integer

    The estimated total number of matching entries. This number isn't guaranteed to be accurate.
    nextPageToken

    string

    Token to retrieve the next page of results, or empty if there are no more results in the list.
    unreachable[]

    string

    Locations that the service couldn't reach. locations.search results don't include data from these locations.

    Authorization scopes

    Requires the following OAuth scope:

    • https://www.googleapis.com/auth/cloud-platform

    For more information, see the Authentication Overview .

    IAM Permissions

    Requires the following IAM permission on the name resource:

    • dataplex.projects.search

    For more information, see the IAM documentation .

    SearchEntriesResult

    A single result of a locations.searchEntries request.

    JSON representation 
     { 
 "linkedResource" 
 : 
 string 
 , 
 "dataplexEntry" 
 : 
 { 
 object (  Entry 
 
) 
 } 
 , 
 "snippets" 
 : 
 { 
 object (  Snippets 
 
) 
 } 
 }
    Fields
    linkedResource
    (deprecated)

    string

    Linked resource name.
    dataplexEntry

    object ( Entry )

    snippets
    (deprecated)

    object ( Snippets )

    Snippets.

    Snippets

    Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI.

    JSON representation 
     { 
 "dataplexEntry" 
 : 
 { 
 object (  Entry 
 
) 
 } 
 }
    Fields
    dataplexEntry
    (deprecated)

    object ( Entry )

    Entry
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: