class ProjectsLocationsEntryGroupsEntries extends Resource (View source)

The "entries" collection of methods.

Typical usage is:

 $datacatalogService = new Google\Service\DataCatalog(...);
 $entries = $datacatalogService->projects_locations_entryGroups_entries;

Methods

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

Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries.

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

Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project. (entries.delete)

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

Gets an entry. (entries.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.

import(string $parent, GoogleCloudDatacatalogV1ImportEntriesRequest $postBody, array $optParams = [])

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.

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

Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. (entries.listProjectsLocationsEntryGroupsEntries)

modifyEntryContacts(string $name, GoogleCloudDatacatalogV1ModifyEntryContactsRequest $postBody, array $optParams = [])

Modifies contacts, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project. (entries.modifyEntryContacts)

modifyEntryOverview(string $name, GoogleCloudDatacatalogV1ModifyEntryOverviewRequest $postBody, array $optParams = [])

Modifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project. (entries.modifyEntryOverview)

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

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

star(string $name, GoogleCloudDatacatalogV1StarEntryRequest $postBody, array $optParams = [])

Marks an Entry as starred by the current user. Starring information is private to each user. (entries.star)

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.

unstar(string $name, GoogleCloudDatacatalogV1UnstarEntryRequest $postBody, array $optParams = [])

Marks an Entry as NOT starred by the current user. Starring information is private to each user. (entries.unstar)

Details

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

Creates an entry. You can create entries only with 'FILESET', 'CLUSTER', 'DATA_STREAM', or custom types. Data Catalog automatically creates entries with other types during metadata ingestion from integrated systems. You must enable the Data Catalog API in the project identified by the parent parameter. For more information, see Data Catalog resource project. An entry group can have a maximum of 100,000 entries.

(entries.create)

Parameters

string $parent

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

GoogleCloudDatacatalogV1Entry $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Entry

Exceptions

Exception

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

Deletes an existing entry. You can delete only the entries created by the CreateEntry method. You must enable the Data Catalog API in the project identified by the name parameter. For more information, see Data Catalog resource project. (entries.delete)

Parameters

string $name

Required. The name of the entry to delete.

array $optParams

Optional parameters.

Return Value

DatacatalogEmpty

Exceptions

Exception

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

Gets an entry. (entries.get)

Parameters

string $name

Required. The name of the entry to get.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Entry

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. (entries.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

Operation import(string $parent, GoogleCloudDatacatalogV1ImportEntriesRequest $postBody, array $optParams = [])

Imports entries from a source, such as data previously dumped into a Cloud Storage bucket, into Data Catalog. Import of entries is a sync operation that reconciles the state of the third-party system with the Data Catalog.

ImportEntries accepts source data snapshots of a third-party system. Snapshot should be delivered as a .wire or base65-encoded .txt file containing a sequence of Protocol Buffer messages of DumpItem type. ImportEntries returns a long-running operation resource that can be queried with Operations.GetOperation to return ImportEntriesMetadata and an ImportEntriesResponse message. (entries.import)

Parameters

string $parent

Required. Target entry group for ingested entries.

GoogleCloudDatacatalogV1ImportEntriesRequest $postBody
array $optParams

Optional parameters.

Return Value

Operation

Exceptions

Exception

GoogleCloudDatacatalogV1ListEntriesResponse listProjectsLocationsEntryGroupsEntries(string $parent, array $optParams = [])

Lists entries. Note: Currently, this method can list only custom entries. To get a list of both custom and automatically created entries, use SearchCatalog. (entries.listProjectsLocationsEntryGroupsEntries)

Parameters

string $parent

Required. The name of the entry group that contains the entries to list. Can be provided in URL format.

array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1ListEntriesResponse

Exceptions

Exception

GoogleCloudDatacatalogV1Contacts modifyEntryContacts(string $name, GoogleCloudDatacatalogV1ModifyEntryContactsRequest $postBody, array $optParams = [])

Modifies contacts, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateContacts IAM permission on the corresponding project. (entries.modifyEntryContacts)

Parameters

string $name

Required. The full resource name of the entry.

GoogleCloudDatacatalogV1ModifyEntryContactsRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Contacts

Exceptions

Exception

GoogleCloudDatacatalogV1EntryOverview modifyEntryOverview(string $name, GoogleCloudDatacatalogV1ModifyEntryOverviewRequest $postBody, array $optParams = [])

Modifies entry overview, part of the business context of an Entry. To call this method, you must have the datacatalog.entries.updateOverview IAM permission on the corresponding project. (entries.modifyEntryOverview)

Parameters

string $name

Required. The full resource name of the entry.

GoogleCloudDatacatalogV1ModifyEntryOverviewRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1EntryOverview

Exceptions

Exception

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

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

Parameters

string $name

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

GoogleCloudDatacatalogV1Entry $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1Entry

Exceptions

Exception

GoogleCloudDatacatalogV1StarEntryResponse star(string $name, GoogleCloudDatacatalogV1StarEntryRequest $postBody, array $optParams = [])

Marks an Entry as starred by the current user. Starring information is private to each user. (entries.star)

Parameters

string $name

Required. The name of the entry to mark as starred.

GoogleCloudDatacatalogV1StarEntryRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1StarEntryResponse

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.

(entries.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

GoogleCloudDatacatalogV1UnstarEntryResponse unstar(string $name, GoogleCloudDatacatalogV1UnstarEntryRequest $postBody, array $optParams = [])

Marks an Entry as NOT starred by the current user. Starring information is private to each user. (entries.unstar)

Parameters

string $name

Required. The name of the entry to mark as not starred.

GoogleCloudDatacatalogV1UnstarEntryRequest $postBody
array $optParams

Optional parameters.

Return Value

GoogleCloudDatacatalogV1UnstarEntryResponse

Exceptions

Exception