Package com.google.cloud.datacatalog.v1

Class DataCatalogGrpc.DataCatalogBlockingStub

  • Enclosing class:
    DataCatalogGrpc
    public static final class DataCatalogGrpc.DataCatalogBlockingStub
extends io.grpc.stub.AbstractBlockingStub<DataCatalogGrpc.DataCatalogBlockingStub>
    A stub to allow clients to do synchronous rpc calls to service DataCatalog. 
     Data Catalog API service allows you to discover, understand, and manage
 your data.

    • Method Detail

      • searchCatalog

        public SearchCatalogResponse searchCatalog​(SearchCatalogRequest request)
         Searches Data Catalog for multiple resources like entries and tags that
 match a query.
 This is a [Custom Method]
 (https://cloud.google.com/apis/design/custom_methods) that doesn't return
 all information on a resource, only its ID and high level fields. To get
 more information, you can subsequently call specific get methods.
 Note: Data Catalog search queries don't guarantee full recall. Results
 that match your query might not be returned, even in subsequent
 result pages. Additionally, returned (and not returned) results can vary
 if you repeat search queries.
 For more information, see [Data Catalog search syntax]
 (https://cloud.google.com/data-catalog/docs/how-to/search-reference).

      • createEntryGroup

        public EntryGroup createEntryGroup​(CreateEntryGroupRequest request)
         Creates an entry group.
 An entry group contains logically related entries together with [Cloud
 Identity and Access Management](/data-catalog/docs/concepts/iam) 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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • updateEntryGroup

        public EntryGroup updateEntryGroup​(UpdateEntryGroupRequest request)
         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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • deleteEntryGroup

        public com.google.protobuf.Empty deleteEntryGroup​(DeleteEntryGroupRequest request)
         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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • createEntry

        public Entry createEntry​(CreateEntryRequest request)
         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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).
 An entry group can have a maximum of 100,000 entries.

      • updateEntry

        public Entry updateEntry​(UpdateEntryRequest request)
         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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • deleteEntry

        public com.google.protobuf.Empty deleteEntry​(DeleteEntryRequest request)
         Deletes an existing entry.
 You can delete only the entries created by the
 [CreateEntry][google.cloud.datacatalog.v1.DataCatalog.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](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • lookupEntry

        public Entry lookupEntry​(LookupEntryRequest request)
         Gets an entry by its target resource name.
 The resource name comes from the source Google Cloud Platform service.

      • listEntries

        public ListEntriesResponse listEntries​(ListEntriesRequest request)
         Lists entries.
 Note: Currently, this method can list only custom entries.
 To get a list of both custom and automatically created entries, use
 [SearchCatalog][google.cloud.datacatalog.v1.DataCatalog.SearchCatalog].

      • modifyEntryOverview

        public EntryOverview modifyEntryOverview​(ModifyEntryOverviewRequest request)
         Modifies entry overview, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateOverview`
 IAM permission on the corresponding project.

      • modifyEntryContacts

        public Contacts modifyEntryContacts​(ModifyEntryContactsRequest request)
         Modifies contacts, part of the business context of an
 [Entry][google.cloud.datacatalog.v1.Entry].
 To call this method, you must have the `datacatalog.entries.updateContacts`
 IAM permission on the corresponding project.

      • createTagTemplate

        public TagTemplate createTagTemplate​(CreateTagTemplateRequest request)
         Creates a tag template.
 You must enable the Data Catalog API in the project identified by the
 `parent` parameter.
 For more information, see [Data Catalog resource project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • updateTagTemplate

        public TagTemplate updateTagTemplate​(UpdateTagTemplateRequest request)
         Updates a tag template.
 You can't update template fields with this method. These fields are
 separate resources with their own create, update, and delete methods.
 You must enable the Data Catalog API in the project identified by
 the `tag_template.name` parameter. For more information, see [Data Catalog
 resource
 project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • deleteTagTemplate

        public com.google.protobuf.Empty deleteTagTemplate​(DeleteTagTemplateRequest request)
         Deletes a tag template and all tags that use it.
 You must enable the Data Catalog API in the project identified by
 the `name` parameter. For more information, see [Data Catalog resource
 project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • createTagTemplateField

        public TagTemplateField createTagTemplateField​(CreateTagTemplateFieldRequest request)
         Creates a field in a tag template.
 You must enable the Data Catalog API in the project identified by
 the `parent` parameter. For more information, see [Data Catalog resource
 project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • updateTagTemplateField

        public TagTemplateField updateTagTemplateField​(UpdateTagTemplateFieldRequest request)
         Updates a field in a tag template.
 You can't update the field type with this method.
 You must enable the Data Catalog API in the project
 identified by the `name` parameter. For more information, see [Data Catalog
 resource
 project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • renameTagTemplateField

        public TagTemplateField renameTagTemplateField​(RenameTagTemplateFieldRequest request)
         Renames a field in a tag template.
 You must enable the Data Catalog API in the project identified by the
 `name` parameter. For more information, see [Data Catalog resource project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • deleteTagTemplateField

        public com.google.protobuf.Empty deleteTagTemplateField​(DeleteTagTemplateFieldRequest request)
         Deletes a field in a tag template and all uses of this field from the tags
 based on this template.
 You must enable the Data Catalog API in the project identified by
 the `name` parameter. For more information, see [Data Catalog resource
 project](https://cloud.google.com/data-catalog/docs/concepts/resource-project).

      • createTag

        public Tag createTag​(CreateTagRequest request)
         Creates a tag and assigns it to:
 * An [Entry][google.cloud.datacatalog.v1.Entry] if the method name is
   `projects.locations.entryGroups.entries.tags.create`.
 * Or [EntryGroup][google.cloud.datacatalog.v1.EntryGroup]if the method
   name is `projects.locations.entryGroups.tags.create`.
 Note: The project identified by the `parent` parameter for the [tag]
 (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.entryGroups.entries.tags/create#path-parameters)
 and the [tag template]
 (https://cloud.google.com/data-catalog/docs/reference/rest/v1/projects.locations.tagTemplates/create#path-parameters)
 used to create the tag must be in the same organization.

      • deleteTag

        public com.google.protobuf.Empty deleteTag​(DeleteTagRequest request)
         Deletes a tag.

      • listTags

        public ListTagsResponse listTags​(ListTagsRequest request)
         Lists tags assigned to an [Entry][google.cloud.datacatalog.v1.Entry].
 The [columns][google.cloud.datacatalog.v1.Tag.column] in the response are
 lowercased.

      • reconcileTags

        public com.google.longrunning.Operation reconcileTags​(ReconcileTagsRequest request)
         `ReconcileTags` creates or updates a list of tags on the entry.
 If the
 [ReconcileTagsRequest.force_delete_missing][google.cloud.datacatalog.v1.ReconcileTagsRequest.force_delete_missing]
 parameter is set, the operation deletes tags not included in the input tag
 list.
 `ReconcileTags` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return [ReconcileTagsMetadata]
 [google.cloud.datacatalog.v1.ReconcileTagsMetadata] and
 a [ReconcileTagsResponse]
 [google.cloud.datacatalog.v1.ReconcileTagsResponse] message.

      • starEntry

        public StarEntryResponse starEntry​(StarEntryRequest request)
         Marks an [Entry][google.cloud.datacatalog.v1.Entry] as starred by
 the current user. Starring information is private to each user.

      • unstarEntry

        public UnstarEntryResponse unstarEntry​(UnstarEntryRequest request)
         Marks an [Entry][google.cloud.datacatalog.v1.Entry] as NOT starred by
 the current user. Starring information is private to each user.

      • setIamPolicy

        public com.google.iam.v1.Policy setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request)
         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.

      • getIamPolicy

        public com.google.iam.v1.Policy getIamPolicy​(com.google.iam.v1.GetIamPolicyRequest request)
         Gets the access control policy for a resource.
 May return:
 * A`NOT_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.

      • testIamPermissions

        public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request)
         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.

      • importEntries

        public com.google.longrunning.Operation importEntries​(ImportEntriesRequest request)
         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][google.cloud.datacatalog.v1.DumpItem] type.
 `ImportEntries` returns a [long-running operation]
 [google.longrunning.Operation] resource that can be queried with
 [Operations.GetOperation][google.longrunning.Operations.GetOperation]
 to return
 [ImportEntriesMetadata][google.cloud.datacatalog.v1.ImportEntriesMetadata]
 and an
 [ImportEntriesResponse][google.cloud.datacatalog.v1.ImportEntriesResponse]
 message.