Interface SearchCatalogRequest.ScopeOrBuilder

Version 1.5.4

• 1.60.0 (latest)
• 1.59.0
• 1.58.0
• 1.57.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.5
• 1.8.4
• 1.7.2
• 1.6.2
• 1.5.4

public static interface SearchCatalogRequest.ScopeOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIncludeGcpPublicDatasets()

public abstract boolean getIncludeGcpPublicDatasets()

If `true`, include Google Cloud Platform (GCP) public datasets in
 search results. By default, they are excluded.
 See [Google Cloud Public Datasets](/public-datasets) for more
 information.

bool include_gcp_public_datasets = 7;

Returns

Type	Description
boolean	The includeGcpPublicDatasets.

getIncludeOrgIds(int index)

public abstract String getIncludeOrgIds(int index)

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).

repeated string include_org_ids = 2;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The includeOrgIds at the given index.

getIncludeOrgIdsBytes(int index)

public abstract ByteString getIncludeOrgIdsBytes(int index)

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).

repeated string include_org_ids = 2;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the includeOrgIds at the given index.

getIncludeOrgIdsCount()

public abstract int getIncludeOrgIdsCount()

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).

repeated string include_org_ids = 2;

Returns

Type	Description
int	The count of includeOrgIds.

getIncludeOrgIdsList()

public abstract List<String> getIncludeOrgIdsList()

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).

repeated string include_org_ids = 2;

Returns

Type	Description
List<String>	A list containing the includeOrgIds.

getIncludeProjectIds(int index)

public abstract String getIncludeProjectIds(int index)

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).

repeated string include_project_ids = 3;

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The includeProjectIds at the given index.

getIncludeProjectIdsBytes(int index)

public abstract ByteString getIncludeProjectIdsBytes(int index)

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).

repeated string include_project_ids = 3;

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the includeProjectIds at the given index.

getIncludeProjectIdsCount()

public abstract int getIncludeProjectIdsCount()

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).

repeated string include_project_ids = 3;

Returns

Type	Description
int	The count of includeProjectIds.

getIncludeProjectIdsList()

public abstract List<String> getIncludeProjectIdsList()

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).

repeated string include_project_ids = 3;

Returns

Type	Description
List<String>	A list containing the includeProjectIds.

getIncludePublicTagTemplates()

public abstract boolean getIncludePublicTagTemplates()

Optional. If `true`, include [public tag
 templates][google.cloud.datacatalog.v1.TagTemplate.is_publicly_readable]
 in the search results. By default, they are included only if you have
 explicit permissions on them to view them. For example, if you are the
 owner.
 Other scope fields, for example, ``include_org_ids``,
 still restrict the returned public tag templates and at least one of
 them is required.

bool include_public_tag_templates = 19 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
boolean	The includePublicTagTemplates.

getRestrictedLocations(int index)

public abstract String getRestrictedLocations(int index)

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.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int The index of the element to return.

Returns

Type	Description
String	The restrictedLocations at the given index.

getRestrictedLocationsBytes(int index)

public abstract ByteString getRestrictedLocationsBytes(int index)

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.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Parameter

Name	Description
index	int The index of the value to return.

Returns

Type	Description
ByteString	The bytes of the restrictedLocations at the given index.

getRestrictedLocationsCount()

public abstract int getRestrictedLocationsCount()

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.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
int	The count of restrictedLocations.

getRestrictedLocationsList()

public abstract List<String> getRestrictedLocationsList()

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.

repeated string restricted_locations = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns

Type	Description
List<String>	A list containing the restrictedLocations.