Class: Google::Cloud::DataCatalog::V1::SearchCatalogRequest

Inherits:
Object
  • Object
show all
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

Instance Attribute Details

#admin_search ⇒ ::Boolean

Returns Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.

Returns:

  • (::Boolean) —

    Optional. If set, use searchAll permission granted on organizations from include_org_ids and projects from include_project_ids instead of the fine grained per resource permissions when filtering the search results. The only allowed order_by criteria for admin_search mode is default. Using this flags guarantees a full recall of the search results.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#order_by ⇒ ::String

Specifies the order of results.

Currently supported case-sensitive values are:

  • relevance that can only be descending
  • last_modified_timestamp [asc|desc] with descending (desc) as default
  • default that can only be descending

Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.

If this parameter is omitted, it defaults to the descending relevance.

Returns:

  • (::String) —

    Specifies the order of results.

    Currently supported case-sensitive values are:

    • relevance that can only be descending
    • last_modified_timestamp [asc|desc] with descending (desc) as default
    • default that can only be descending

    Search queries don't guarantee full recall. Results that match your query might not be returned, even in subsequent result pages. Additionally, returned (and not returned) results can vary if you repeat search queries. If you are experiencing recall issues and you don't have to fetch the results in any specific order, consider setting this parameter to default.

    If this parameter is omitted, it defaults to the descending relevance.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_size ⇒ ::Integer

Returns Upper bound on the number of results you can get in a single response.

Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.

Returns:

  • (::Integer) —

    Upper bound on the number of results you can get in a single response.

    Can't be negative or 0, defaults to 10 in this case. The maximum number is 1000. If exceeded, throws an "invalid argument" exception.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#page_token ⇒ ::String

Returns Optional. Pagination token that, if specified, returns the next page of search results. If empty, returns the first page.

This token is returned in the SearchCatalogResponse.next_page_token field of the response to a previous SearchCatalogRequest call.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#query ⇒ ::String

Returns Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.

An empty query string returns all data assets (in the specified scope) that you have access to.

A query string can be a simple xyz or qualified by predicates:

  • name:x
  • column:y
  • description:z.

Returns:

  • (::String) —

    Optional. The query string with a minimum of 3 characters and specific syntax. For more information, see Data Catalog search syntax.

    An empty query string returns all data assets (in the specified scope) that you have access to.

    A query string can be a simple xyz or qualified by predicates:

    • name:x
    • column:y
    • description:z


89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#scope ⇒ ::Google::Cloud::DataCatalog::V1::SearchCatalogRequest::Scope

Returns Required. The scope of this search request.

The scope is invalid if include_org_ids, include_project_ids are empty AND include_gcp_public_datasets is set to false. In this case, the request returns an error.

Returns:



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 89

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 the steps from
  #     [Creating and managing organizations]
  #     (/resource-manager/docs/creating-managing-organization).
  # @!attribute [rw] include_project_ids
  #   @return [::Array<::String>]
  #     The list of project IDs to search within.
  #
  #     For more information on the distinction between project names, IDs, and
  #     numbers, see [Projects](/docs/overview/#projects).
  # @!attribute [rw] include_gcp_public_datasets
  #   @return [::Boolean]
  #     If `true`, include Google Cloud public datasets in
  #     search results. By default, they are excluded.
  #
  #     See [Google Cloud Public Datasets](/public-datasets) for more
  #     information.
  # @!attribute [rw] restricted_locations
  #   @return [::Array<::String>]
  #     Optional. The list of locations to search within. If empty, all locations
  #     are searched.
  #
  #     Returns an error if any location in the list isn't one of the [Supported
  #     regions](https://cloud.google.com/data-catalog/docs/concepts/regions#supported_regions).
  #
  #     If a location is unreachable, its name is returned in the
  #     `SearchCatalogResponse.unreachable` field. To get additional information
  #     on the error, repeat the search request and set the location name as the
  #     value of this parameter.
  # @!attribute [rw] starred_only
  #   @return [::Boolean]
  #     Optional. If `true`, search only among starred entries.
  #
  #     By default, all results are returned, starred or not.
  # @!attribute [rw] include_public_tag_templates
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. This field is deprecated. The search mechanism for public and
  #     private tag templates is the same.
  class Scope
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end