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

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/datacatalog/v1/datacatalog.rb

Overview

The criteria that select the subspace used for query matching.

Instance Attribute Summary collapse

Instance Attribute Details

#include_gcp_public_datasets ⇒ ::Boolean

Returns If true, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded.

See Google Cloud Public Datasets for more information.

Returns:

  • (::Boolean) —

    If true, include Google Cloud Platform (GCP) public datasets in search results. By default, they are excluded.

    See Google Cloud Public Datasets for more information.



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_org_ids ⇒ ::Array<::String>

Returns The list of organization IDs to search within.

To find your organization ID, follow the steps from Creating and managing organizations.

Returns:



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_project_ids ⇒ ::Array<::String>

Returns The list of project IDs to search within.

For more information on the distinction between project names, IDs, and numbers, see Projects.

Returns:

  • (::Array<::String>) —

    The list of project IDs to search within.

    For more information on the distinction between project names, IDs, and numbers, see Projects.



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#include_public_tag_templates ⇒ ::Boolean

Returns Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.

Returns:

  • (::Boolean) —

    Optional. This field is deprecated. The search mechanism for public and private tag templates is the same.



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#restricted_locations ⇒ ::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.

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.

Returns:

  • (::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.

    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.



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#starred_only ⇒ ::Boolean

Returns Optional. If true, search only among starred entries.

By default, all results are returned, starred or not.

Returns:

  • (::Boolean) —

    Optional. If true, search only among starred entries.

    By default, all results are returned, starred or not.



121
122
123
124
 
# File 'proto_docs/google/cloud/datacatalog/v1/datacatalog.rb', line 121

class Scope
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end