| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="datacatalog_v1beta1.html">Google Cloud Data Catalog API</a> . <a href="datacatalog_v1beta1.catalog.html">catalog</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#search">search(body=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Searches Data Catalog for multiple resources like entries, tags that</p> |
| <p class="toc_element"> |
| <code><a href="#search_next">search_next(previous_request, previous_response)</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="search">search(body=None, x__xgafv=None)</code> |
| <pre>Searches Data Catalog for multiple resources like entries, tags that |
| match a query. |
| |
| This is a custom method |
| (https://cloud.google.com/apis/design/custom_methods) and does not return |
| the complete resource, only the resource identifier and high level |
| fields. Clients can subsequentally call `Get` methods. |
| |
| Note that Data Catalog search queries do not guarantee full recall. Query |
| results that match your query may not be returned, even in subsequent |
| result pages. Also note that results returned (and not returned) can vary |
| across repeated search queries. |
| |
| See [Data Catalog Search |
| Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) |
| for more information. |
| |
| Args: |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Request message for |
| # SearchCatalog. |
| "pageToken": "A String", # Optional. Pagination token returned in an earlier |
| # SearchCatalogResponse.next_page_token, which |
| # indicates that this is a continuation of a prior |
| # SearchCatalogRequest |
| # call, and that the system should return the next page of data. If empty, |
| # the first page is returned. |
| "scope": { # The criteria that select the subspace used for query matching. # Required. The scope of this search request. A `scope` that has empty |
| # `include_org_ids`, `include_project_ids` AND false |
| # `include_gcp_public_datasets` is considered invalid. Data Catalog will |
| # return an error in such a case. |
| "includeGcpPublicDatasets": True or False, # If `true`, include Google Cloud Platform (GCP) public datasets in the |
| # search results. Info on GCP public datasets is available at |
| # https://cloud.google.com/public-datasets/. By default, GCP public |
| # datasets are excluded. |
| "includeProjectIds": [ # The list of project IDs to search within. To learn more about the |
| # distinction between project names/IDs/numbers, go to |
| # https://cloud.google.com/docs/overview/#projects. |
| "A String", |
| ], |
| "restrictedLocations": [ # Optional. The list of locations to search within. |
| # 1. If empty, search will be performed in all locations; |
| # 2. If any of the locations are NOT in the valid locations list, error |
| # will be returned; |
| # 3. Otherwise, search only the given locations for matching results. |
| # Typical usage is to leave this field empty. When a location is |
| # unreachable as returned in the `SearchCatalogResponse.unreachable` field, |
| # users can repeat the search request with this parameter set to get |
| # additional information on the error. |
| # |
| # Valid locations: |
| # * asia-east1 |
| # * asia-east2 |
| # * asia-northeast1 |
| # * asia-northeast2 |
| # * asia-northeast3 |
| # * asia-south1 |
| # * asia-southeast1 |
| # * australia-southeast1 |
| # * eu |
| # * europe-north1 |
| # * europe-west1 |
| # * europe-west2 |
| # * europe-west3 |
| # * europe-west4 |
| # * europe-west6 |
| # * global |
| # * northamerica-northeast1 |
| # * southamerica-east1 |
| # * us |
| # * us-central1 |
| # * us-east1 |
| # * us-east4 |
| # * us-west1 |
| # * us-west2 |
| "A String", |
| ], |
| "includeOrgIds": [ # The list of organization IDs to search within. To find your organization |
| # ID, follow instructions in |
| # https://cloud.google.com/resource-manager/docs/creating-managing-organization. |
| "A String", |
| ], |
| }, |
| "query": "A String", # Required. The query string in search query syntax. The query must be non-empty. |
| # |
| # Query strings can be simple as "x" or more qualified as: |
| # |
| # * name:x |
| # * column:x |
| # * description:y |
| # |
| # Note: Query tokens need to have a minimum of 3 characters for substring |
| # matching to work correctly. See [Data Catalog Search |
| # Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference) |
| # for more information. |
| "pageSize": 42, # 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. |
| "orderBy": "A String", # Specifies the ordering of results, currently supported case-sensitive |
| # choices are: |
| # |
| # * `relevance`, only supports descending |
| # * `last_modified_timestamp [asc|desc]`, defaults to descending if not |
| # specified |
| # |
| # If not specified, defaults to `relevance` descending. |
| } |
| |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response message for |
| # SearchCatalog. |
| "results": [ # Search results. |
| { # A result that appears in the response of a search request. Each result |
| # captures details of one entry that matches the search. |
| "linkedResource": "A String", # The full name of the cloud resource the entry belongs to. See: |
| # https://cloud.google.com/apis/design/resource_names#full_resource_name. |
| # Example: |
| # |
| # * `//bigquery.googleapis.com/projects/projectId/datasets/datasetId/tables/tableId` |
| "searchResultSubtype": "A String", # Sub-type of the search result. This is a dot-delimited description of the |
| # resource's full type, and is the same as the value callers would provide in |
| # the "type" search facet. Examples: `entry.table`, `entry.dataStream`, |
| # `tagTemplate`. |
| "searchResultType": "A String", # Type of the search result. This field can be used to determine which Get |
| # method to call to fetch the full resource. |
| "relativeResourceName": "A String", # The relative resource name of the resource in URL format. |
| # Examples: |
| # |
| # * `projects/{project_id}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}` |
| # * `projects/{project_id}/tagTemplates/{tag_template_id}` |
| }, |
| ], |
| "nextPageToken": "A String", # The token that can be used to retrieve the next page of results. |
| "unreachable": [ # Unreachable locations. Search result does not include data from those |
| # locations. Users can get additional information on the error by repeating |
| # the search request with a more restrictive parameter -- setting the value |
| # for `SearchDataCatalogRequest.scope.include_locations`. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="search_next">search_next(previous_request, previous_response)</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| </body></html> |
