class ProjectsLocationsEntryGroups extends Resource (View source)

The "entryGroups" collection of methods.

Typical usage is:

 $datacatalogService = new Google\Service\DataCatalog(...);
 $entryGroups = $datacatalogService->projects_locations_entryGroups;

Methods

create(string $parent, GoogleCloudDatacatalogV1EntryGroup $postBody, array $optParams = [])

Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: BigQuery entries (@bigquery) Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. (entryGroups.create)

delete(string $name, array $optParams = [])

Deletes an entry group. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project. (entryGroups.delete)

get(string $name, array $optParams = [])

Gets an entry group. (entryGroups.get)

getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a resource. May return: ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it. An empty policy if the resource exists but doesn't have a set policy.

listProjectsLocationsEntryGroups(string $parent, array $optParams = [])

Lists entry groups. (entryGroups.listProjectsLocationsEntryGroups)

patch(string $name, GoogleCloudDatacatalogV1EntryGroup $postBody, array $optParams = [])

Updates an entry group. You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project. (entryGroups.patch)

setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets an access control policy for a resource. Replaces any existing policy.

testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.

Details

GoogleCloudDatacatalogV1EntryGroup create(string $parent, GoogleCloudDatacatalogV1EntryGroup $postBody, array $optParams = [])

Creates an entry group. An entry group contains logically related entries together with Cloud Identity and Access Management policies. These policies specify users who can create, edit, and view entries within entry groups. Data Catalog automatically creates entry groups with names that start with the @ symbol for the following resources: BigQuery entries (@bigquery) Pub/Sub topics (@pubsub) * Dataproc Metastore services (@dataproc_metastore_{SERVICE_NAME_HASH}) You can create your own entry groups for Cloud Storage fileset entries and custom entries together with the corresponding IAM policies. User-created entry groups can't contain the @ symbol, it is reserved for automatically created groups. Entry groups, like entries, can be searched. A maximum of 10,000 entry groups may be created per organization across all locations. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. (entryGroups.create)

Parameters

string $parent

Required. The names of the project and location that the new entry group belongs to. Note: The entry group itself and its child resources might not be stored in the location specified in its name.

GoogleCloudDatacatalogV1EntryGroup $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1EntryGroup

Exceptions

Exception

DatacatalogEmpty delete(string $name, array $optParams = [])

Deletes an entry group. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project. (entryGroups.delete)

Parameters

string $name

Required. The name of the entry group to delete.

array $optParams

Optional parameters.

Return Value

DatacatalogEmpty

Exceptions

Exception

GoogleCloudDatacatalogV1EntryGroup get(string $name, array $optParams = [])

Gets an entry group. (entryGroups.get)

Parameters

string $name

Required. The name of the entry group to get.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1EntryGroup

Exceptions

Exception

Policy getIamPolicy(string $resource, GetIamPolicyRequest $postBody, array $optParams = [])

Gets the access control policy for a resource. May return: ANOT_FOUND error if the resource doesn't exist or you don't have the permission to view it. An empty policy if the resource exists but doesn't have a set policy.

Supported resources are: - Tag templates - Entry groups Note: This method doesn't get policies from Google Cloud Platform resources ingested into Data Catalog. To call this method, you must have the following Google IAM permissions: - datacatalog.tagTemplates.getIamPolicy to get policies on tag templates. - datacatalog.entryGroups.getIamPolicy to get policies on entry groups. (entryGroups.getIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.

GetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

GoogleCloudDatacatalogV1ListEntryGroupsResponse listProjectsLocationsEntryGroups(string $parent, array $optParams = [])

Lists entry groups. (entryGroups.listProjectsLocationsEntryGroups)

Parameters

string $parent

Required. The name of the location that contains the entry groups to list. Can be provided as a URL.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1ListEntryGroupsResponse

Exceptions

Exception

GoogleCloudDatacatalogV1EntryGroup patch(string $name, GoogleCloudDatacatalogV1EntryGroup $postBody, array $optParams = [])

Updates an entry group. You must enable the Data Catalog API in the project identified by the entry_group.name parameter. For more information, see Data Catalog resource project. (entryGroups.patch)

Parameters

string $name

Identifier. The resource name of the entry group in URL format. Note: The entry group itself and its child resources might not be stored in the location specified in its name.

GoogleCloudDatacatalogV1EntryGroup $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1EntryGroup

Exceptions

Exception

Policy setIamPolicy(string $resource, SetIamPolicyRequest $postBody, array $optParams = [])

Sets an access control policy for a resource. Replaces any existing policy.

Supported resources are: - Tag templates - Entry groups Note: This method sets policies only within Data Catalog and can't be used to manage policies in BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources synced with the Data Catalog. To call this method, you must have the following Google IAM permissions: - datacatalog.tagTemplates.setIamPolicy to set policies on tag templates. - datacatalog.entryGroups.setIamPolicy to set policies on entry groups. (entryGroups.setIamPolicy)

Parameters

string $resource

REQUIRED: The resource for which the policy is being specified. See Resource names for the appropriate value for this field.

SetIamPolicyRequest $postBody
array $optParams

Optional parameters.

Return Value

Policy

Exceptions

Exception

TestIamPermissionsResponse testIamPermissions(string $resource, TestIamPermissionsRequest $postBody, array $optParams = [])

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Tag templates - Entry groups Note: This method gets policies only within Data Catalog and can't be used to get policies from BigQuery, Pub/Sub, Dataproc Metastore, and any external Google Cloud Platform resources ingested into Data Catalog. No Google IAM permissions are required to call this method.

(entryGroups.testIamPermissions)

Parameters

string $resource

REQUIRED: The resource for which the policy detail is being requested. See Resource names for the appropriate value for this field.

TestIamPermissionsRequest $postBody
array $optParams

Optional parameters.

Return Value

TestIamPermissionsResponse

Exceptions

Exception