Google Cloud Data Catalog V1 Client - Class Scope (2.0.0)

Reference documentation and code samples for the Google Cloud Data Catalog V1 Client class Scope.

The criteria that select the subspace used for query matching.

Generated from protobuf message google.cloud.datacatalog.v1.SearchCatalogRequest.Scope

Namespace

Google \ Cloud \ DataCatalog \ V1 \ SearchCatalogRequest

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ include_org_ids array

The list of organization IDs to search within. To find your organization ID, follow the steps from Creating and managing organizations.

↳ include_project_ids array

The list of project IDs to search within. For more information on the distinction between project names, IDs, and numbers, see Projects.

↳ include_gcp_public_datasets bool

If true, include Google Cloud public datasets in search results. By default, they are excluded. See Google Cloud Public Datasets for more information.

↳ restricted_locations array

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.

↳ starred_only bool

Optional. If true, search only among starred entries. By default, all results are returned, starred or not.

↳ include_public_tag_templates bool

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

getIncludeOrgIds

The list of organization IDs to search within.

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIncludeOrgIds

The list of organization IDs to search within.

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getIncludeProjectIds

The list of project IDs to search within.

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

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setIncludeProjectIds

The list of project IDs to search within.

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

Parameter
Name Description
var string[]
Returns
Type Description
$this

getIncludeGcpPublicDatasets

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

See Google Cloud Public Datasets for more information.

Returns
Type Description
bool

setIncludeGcpPublicDatasets

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

See Google Cloud Public Datasets for more information.

Parameter
Name Description
var bool
Returns
Type Description
$this

getRestrictedLocations

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
Type Description
Google\Protobuf\Internal\RepeatedField

setRestrictedLocations

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getStarredOnly

Optional. If true, search only among starred entries.

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

Returns
Type Description
bool

setStarredOnly

Optional. If true, search only among starred entries.

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

Parameter
Name Description
var bool
Returns
Type Description
$this

getIncludePublicTagTemplates

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

Returns
Type Description
bool

setIncludePublicTagTemplates

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

Parameter
Name Description
var bool
Returns
Type Description
$this