Class: Google::Cloud::DataCatalog::V1::SearchCatalogRequest
- Inherits:
-
Object
- Object
- Google::Cloud::DataCatalog::V1::SearchCatalogRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/datacatalog/v1/datacatalog.rb
Overview
Request message for SearchCatalog.
Defined Under Namespace
Classes: Scope
Instance Attribute Summary collapse
-
#order_by ⇒ String
Specifies the ordering of results, currently supported case-sensitive choices are:.
-
#page_size ⇒ Integer
Number of results in the search page.
-
#page_token ⇒ String
Optional.
-
#query ⇒ String
Required.
-
#scope ⇒ Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope
Required.
Instance Attribute Details
#order_by ⇒ String
Returns Specifies the ordering of results, currently supported case-sensitive choices are:
relevance
, only supports descendinglast_modified_timestamp [asc|desc]
, defaults to descending if not specified
If not specified, defaults to relevance
descending.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 67 class SearchCatalogRequest include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods # The criteria that select the subspace used for query matching. # @!attribute [rw] include_org_ids # @return [Array<String>] # 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. # @!attribute [rw] include_project_ids # @return [Array<String>] # 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. # @!attribute [rw] include_gcp_public_datasets # @return [Boolean] # 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. class Scope include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods end end |
#page_size ⇒ Integer
Returns 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.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 67 class SearchCatalogRequest include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods # The criteria that select the subspace used for query matching. # @!attribute [rw] include_org_ids # @return [Array<String>] # 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. # @!attribute [rw] include_project_ids # @return [Array<String>] # 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. # @!attribute [rw] include_gcp_public_datasets # @return [Boolean] # 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. class Scope include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods end end |
#page_token ⇒ String
Returns 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.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 67 class SearchCatalogRequest include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods # The criteria that select the subspace used for query matching. # @!attribute [rw] include_org_ids # @return [Array<String>] # 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. # @!attribute [rw] include_project_ids # @return [Array<String>] # 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. # @!attribute [rw] include_gcp_public_datasets # @return [Boolean] # 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. class Scope include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods end end |
#query ⇒ String
Returns 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 for more information.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 67 class SearchCatalogRequest include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods # The criteria that select the subspace used for query matching. # @!attribute [rw] include_org_ids # @return [Array<String>] # 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. # @!attribute [rw] include_project_ids # @return [Array<String>] # 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. # @!attribute [rw] include_gcp_public_datasets # @return [Boolean] # 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. class Scope include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods end end |
#scope ⇒ Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope
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.
67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 67 class SearchCatalogRequest include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods # The criteria that select the subspace used for query matching. # @!attribute [rw] include_org_ids # @return [Array<String>] # 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. # @!attribute [rw] include_project_ids # @return [Array<String>] # 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. # @!attribute [rw] include_gcp_public_datasets # @return [Boolean] # 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. class Scope include Google::Protobuf::MessageExts extend Google::Protobuf::MessageExts::ClassMethods end end |