Package com.google.cloud.datacatalog.v1beta1

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 clients to discover, understand, and manage
 their data.

    • Method Detail

      • searchCatalog

        public SearchCatalogResponse searchCatalog​(SearchCatalogRequest request)
         Searches Data Catalog for multiple resources like entries, tags that
 match a query.
 This is a custom method
 (https://cloud.google.com/apis/design/custom_methods) and does not return
 the complete resource, only the resource identifier and high level
 fields. Clients can subsequently call `Get` methods.
 Note that Data Catalog search queries do not guarantee full recall. Query
 results that match your query may not be returned, even in subsequent
 result pages. Also note that results returned (and not returned) can vary
 across repeated search queries.
 See [Data Catalog Search
 Syntax](https://cloud.google.com/data-catalog/docs/how-to/search-reference)
 for more information.

      • createEntryGroup

        public EntryGroup createEntryGroup​(CreateEntryGroupRequest request)
         A maximum of 10,000 entry groups may be created per organization across all
 locations.
 Users should enable the Data Catalog API in the project identified by
 the `parent` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • updateEntryGroup

        public EntryGroup updateEntryGroup​(UpdateEntryGroupRequest request)
         Updates an EntryGroup. The user should enable the Data Catalog API in the
 project identified by the `entry_group.name` parameter (see [Data Catalog
 Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • deleteEntryGroup

        public com.google.protobuf.Empty deleteEntryGroup​(DeleteEntryGroupRequest request)
         Deletes an EntryGroup. Only entry groups that do not contain entries can be
 deleted. Users should enable the Data Catalog API in the project
 identified by the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • createEntry

        public Entry createEntry​(CreateEntryRequest request)
         Creates an entry. Only entries of 'FILESET' type or user-specified type can
 be created.
 Users should enable the Data Catalog API in the project identified by
 the `parent` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).
 A maximum of 100,000 entries may be created per entry group.

      • updateEntry

        public Entry updateEntry​(UpdateEntryRequest request)
         Updates an existing entry.
 Users should enable the Data Catalog API in the project identified by
 the `entry.name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • deleteEntry

        public com.google.protobuf.Empty deleteEntry​(DeleteEntryRequest request)
         Deletes an existing entry. Only entries created through
 [CreateEntry][google.cloud.datacatalog.v1beta1.DataCatalog.CreateEntry]
 method can be deleted.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • lookupEntry

        public Entry lookupEntry​(LookupEntryRequest request)
         Get an entry by target resource name. This method allows clients to use
 the resource name from the source Google Cloud Platform service to get the
 Data Catalog Entry.

      • createTagTemplate

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

      • updateTagTemplate

        public TagTemplate updateTagTemplate​(UpdateTagTemplateRequest request)
         Updates a tag template. This method cannot be used to update the fields of
 a template. The tag template fields are represented as separate resources
 and should be updated using their own create/update/delete methods.
 Users should enable the Data Catalog API in the project identified by
 the `tag_template.name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • deleteTagTemplate

        public com.google.protobuf.Empty deleteTagTemplate​(DeleteTagTemplateRequest request)
         Deletes a tag template and all tags using the template.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • createTagTemplateField

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

      • updateTagTemplateField

        public TagTemplateField updateTagTemplateField​(UpdateTagTemplateFieldRequest request)
         Updates a field in a tag template. This method cannot be used to update the
 field type. Users should enable the Data Catalog API in the project
 identified by the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • renameTagTemplateField

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

      • renameTagTemplateFieldEnumValue

        public TagTemplateField renameTagTemplateFieldEnumValue​(RenameTagTemplateFieldEnumValueRequest request)
         Renames an enum value in a tag template. The enum values have to be unique
 within one enum field. Thus, an enum value cannot be renamed with a name
 used in any other enum value within the same enum field.

      • deleteTagTemplateField

        public com.google.protobuf.Empty deleteTagTemplateField​(DeleteTagTemplateFieldRequest request)
         Deletes a field in a tag template and all uses of that field.
 Users should enable the Data Catalog API in the project identified by
 the `name` parameter (see [Data Catalog Resource Project]
 (https://cloud.google.com/data-catalog/docs/concepts/resource-project) for
 more information).

      • createTag

        public Tag createTag​(CreateTagRequest request)
         Creates a tag on an [Entry][google.cloud.datacatalog.v1beta1.Entry].
 Note: The project identified by the `parent` parameter for the
 [tag](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.entryGroups.entries.tags/create#path-parameters)
 and the
 [tag
 template](https://cloud.google.com/data-catalog/docs/reference/rest/v1beta1/projects.locations.tagTemplates/create#path-parameters)
 used to create the tag must be from 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.v1beta1.Entry].
 The [columns][google.cloud.datacatalog.v1beta1.Tag.column] in the response
 are lowercased.

      • setIamPolicy

        public com.google.iam.v1.Policy setIamPolicy​(com.google.iam.v1.SetIamPolicyRequest request)
         Sets the access control policy for a resource. Replaces any existing
 policy.
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 Callers must have following Google IAM permission
   - `datacatalog.tagTemplates.setIamPolicy` to set policies on tag
     templates.
   - `datacatalog.entries.setIamPolicy` to set policies on entries.
   - `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. A `NOT_FOUND` error
 is returned if the resource does not exist. An empty policy is returned
 if the resource exists but does not have a policy set on it.
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 Callers must have following Google IAM permission
   - `datacatalog.tagTemplates.getIamPolicy` to get policies on tag
     templates.
   - `datacatalog.entries.getIamPolicy` to get policies on entries.
   - `datacatalog.entryGroups.getIamPolicy` to get policies on entry groups.

      • testIamPermissions

        public com.google.iam.v1.TestIamPermissionsResponse testIamPermissions​(com.google.iam.v1.TestIamPermissionsRequest request)
         Returns the caller's permissions on a resource.
 If the resource does not exist, an empty set of permissions is returned
 (We don't return a `NOT_FOUND` error).
 Supported resources are:
   - Tag templates.
   - Entries.
   - Entry groups.
 Note, this method cannot be used to manage policies for BigQuery, Pub/Sub
 and any external Google Cloud Platform resources synced to Data Catalog.
 A caller is not required to have Google IAM permission to make this
 request.