[BindServiceMethod(typeof(DataCatalog), "BindService")]
public abstract class DataCatalogBase
Base class for server-side implementations of DataCatalog
Namespace
Google.Cloud.DataCatalog.V1Assembly
Google.Cloud.DataCatalog.V1.dll
Methods
CreateEntry(CreateEntryRequest, ServerCallContext)
public virtual Task<Entry> CreateEntry(CreateEntryRequest request, ServerCallContext context)
Creates an entry. Only entries of types 'FILESET', 'CLUSTER', 'DATA_STREAM' or with a 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 for
more information).
A maximum of 100,000 entries may be created per entry group.
Parameters | |
---|---|
Name | Description |
request | CreateEntryRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Entry> | The response to send back to the client (wrapped by a task). |
CreateEntryGroup(CreateEntryGroupRequest, ServerCallContext)
public virtual Task<EntryGroup> CreateEntryGroup(CreateEntryGroupRequest request, ServerCallContext context)
Creates an EntryGroup.
An entry group contains logically related entries together with Cloud Identity and Access Management policies that specify the users who can create, edit, and view entries within the entry group.
Data Catalog automatically creates an entry group for BigQuery entries ("@bigquery") and Pub/Sub topics ("@pubsub"). Users create their own entry group to contain Cloud Storage fileset entries or custom type entries, and the IAM policies associated with those entries. Entry groups, like entries, can be searched.
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | CreateEntryGroupRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<EntryGroup> | The response to send back to the client (wrapped by a task). |
CreateTag(CreateTagRequest, ServerCallContext)
public virtual Task<Tag> CreateTag(CreateTagRequest request, ServerCallContext context)
Creates a tag on an [Entry][google.cloud.datacatalog.v1.Entry].
Note: The project identified by the parent
parameter for the
tag
and the
tag
template
used to create the tag must be from the same organization.
Parameters | |
---|---|
Name | Description |
request | CreateTagRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Tag> | The response to send back to the client (wrapped by a task). |
CreateTagTemplate(CreateTagTemplateRequest, ServerCallContext)
public virtual Task<TagTemplate> CreateTagTemplate(CreateTagTemplateRequest request, ServerCallContext context)
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
for more information).
Parameters | |
---|---|
Name | Description |
request | CreateTagTemplateRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplate> | The response to send back to the client (wrapped by a task). |
CreateTagTemplateField(CreateTagTemplateFieldRequest, ServerCallContext)
public virtual Task<TagTemplateField> CreateTagTemplateField(CreateTagTemplateFieldRequest request, ServerCallContext context)
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
for more information).
Parameters | |
---|---|
Name | Description |
request | CreateTagTemplateFieldRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplateField> | The response to send back to the client (wrapped by a task). |
DeleteEntry(DeleteEntryRequest, ServerCallContext)
public virtual Task<Empty> DeleteEntry(DeleteEntryRequest request, ServerCallContext context)
Deletes an existing entry. Only entries created through
[CreateEntry][google.cloud.datacatalog.v1.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 for
more information).
Parameters | |
---|---|
Name | Description |
request | DeleteEntryRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteEntryGroup(DeleteEntryGroupRequest, ServerCallContext)
public virtual Task<Empty> DeleteEntryGroup(DeleteEntryGroupRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | DeleteEntryGroupRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteTag(DeleteTagRequest, ServerCallContext)
public virtual Task<Empty> DeleteTag(DeleteTagRequest request, ServerCallContext context)
Deletes a tag.
Parameters | |
---|---|
Name | Description |
request | DeleteTagRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteTagTemplate(DeleteTagTemplateRequest, ServerCallContext)
public virtual Task<Empty> DeleteTagTemplate(DeleteTagTemplateRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | DeleteTagTemplateRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Empty> | The response to send back to the client (wrapped by a task). |
DeleteTagTemplateField(DeleteTagTemplateFieldRequest, ServerCallContext)
public virtual Task<Empty> DeleteTagTemplateField(DeleteTagTemplateFieldRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | DeleteTagTemplateFieldRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Empty> | The response to send back to the client (wrapped by a task). |
GetEntry(GetEntryRequest, ServerCallContext)
public virtual Task<Entry> GetEntry(GetEntryRequest request, ServerCallContext context)
Gets an entry.
Parameters | |
---|---|
Name | Description |
request | GetEntryRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Entry> | The response to send back to the client (wrapped by a task). |
GetEntryGroup(GetEntryGroupRequest, ServerCallContext)
public virtual Task<EntryGroup> GetEntryGroup(GetEntryGroupRequest request, ServerCallContext context)
Gets an EntryGroup.
Parameters | |
---|---|
Name | Description |
request | GetEntryGroupRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<EntryGroup> | The response to send back to the client (wrapped by a task). |
GetIamPolicy(GetIamPolicyRequest, ServerCallContext)
public virtual Task<Policy> GetIamPolicy(GetIamPolicyRequest request, ServerCallContext context)
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.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.GetIamPolicyRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Google.Cloud.Iam.V1.Policy> | The response to send back to the client (wrapped by a task). |
GetTagTemplate(GetTagTemplateRequest, ServerCallContext)
public virtual Task<TagTemplate> GetTagTemplate(GetTagTemplateRequest request, ServerCallContext context)
Gets a tag template.
Parameters | |
---|---|
Name | Description |
request | GetTagTemplateRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplate> | The response to send back to the client (wrapped by a task). |
ListEntries(ListEntriesRequest, ServerCallContext)
public virtual Task<ListEntriesResponse> ListEntries(ListEntriesRequest request, ServerCallContext context)
Lists entries.
Parameters | |
---|---|
Name | Description |
request | ListEntriesRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<ListEntriesResponse> | The response to send back to the client (wrapped by a task). |
ListEntryGroups(ListEntryGroupsRequest, ServerCallContext)
public virtual Task<ListEntryGroupsResponse> ListEntryGroups(ListEntryGroupsRequest request, ServerCallContext context)
Lists entry groups.
Parameters | |
---|---|
Name | Description |
request | ListEntryGroupsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<ListEntryGroupsResponse> | The response to send back to the client (wrapped by a task). |
ListTags(ListTagsRequest, ServerCallContext)
public virtual Task<ListTagsResponse> ListTags(ListTagsRequest request, ServerCallContext context)
Lists the tags on an [Entry][google.cloud.datacatalog.v1.Entry].
Parameters | |
---|---|
Name | Description |
request | ListTagsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<ListTagsResponse> | The response to send back to the client (wrapped by a task). |
LookupEntry(LookupEntryRequest, ServerCallContext)
public virtual Task<Entry> LookupEntry(LookupEntryRequest request, ServerCallContext context)
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.
Parameters | |
---|---|
Name | Description |
request | LookupEntryRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Entry> | The response to send back to the client (wrapped by a task). |
RenameTagTemplateField(RenameTagTemplateFieldRequest, ServerCallContext)
public virtual Task<TagTemplateField> RenameTagTemplateField(RenameTagTemplateFieldRequest request, ServerCallContext context)
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
for more information).
Parameters | |
---|---|
Name | Description |
request | RenameTagTemplateFieldRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplateField> | The response to send back to the client (wrapped by a task). |
RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest, ServerCallContext)
public virtual Task<TagTemplateField> RenameTagTemplateFieldEnumValue(RenameTagTemplateFieldEnumValueRequest request, ServerCallContext context)
Renames an enum value in a tag template. The enum values have to be unique within one enum field.
Parameters | |
---|---|
Name | Description |
request | RenameTagTemplateFieldEnumValueRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplateField> | The response to send back to the client (wrapped by a task). |
SearchCatalog(SearchCatalogRequest, ServerCallContext)
public virtual Task<SearchCatalogResponse> SearchCatalog(SearchCatalogRequest request, ServerCallContext context)
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 for more information.
Parameters | |
---|---|
Name | Description |
request | SearchCatalogRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<SearchCatalogResponse> | The response to send back to the client (wrapped by a task). |
SetIamPolicy(SetIamPolicyRequest, ServerCallContext)
public virtual Task<Policy> SetIamPolicy(SetIamPolicyRequest request, ServerCallContext context)
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.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.SetIamPolicyRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Google.Cloud.Iam.V1.Policy> | The response to send back to the client (wrapped by a task). |
TestIamPermissions(TestIamPermissionsRequest, ServerCallContext)
public virtual Task<TestIamPermissionsResponse> TestIamPermissions(TestIamPermissionsRequest request, ServerCallContext context)
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.
Parameters | |
---|---|
Name | Description |
request | Google.Cloud.Iam.V1.TestIamPermissionsRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Google.Cloud.Iam.V1.TestIamPermissionsResponse> | The response to send back to the client (wrapped by a task). |
UpdateEntry(UpdateEntryRequest, ServerCallContext)
public virtual Task<Entry> UpdateEntry(UpdateEntryRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | UpdateEntryRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Entry> | The response to send back to the client (wrapped by a task). |
UpdateEntryGroup(UpdateEntryGroupRequest, ServerCallContext)
public virtual Task<EntryGroup> UpdateEntryGroup(UpdateEntryGroupRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | UpdateEntryGroupRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<EntryGroup> | The response to send back to the client (wrapped by a task). |
UpdateTag(UpdateTagRequest, ServerCallContext)
public virtual Task<Tag> UpdateTag(UpdateTagRequest request, ServerCallContext context)
Updates an existing tag.
Parameters | |
---|---|
Name | Description |
request | UpdateTagRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<Tag> | The response to send back to the client (wrapped by a task). |
UpdateTagTemplate(UpdateTagTemplateRequest, ServerCallContext)
public virtual Task<TagTemplate> UpdateTagTemplate(UpdateTagTemplateRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | UpdateTagTemplateRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplate> | The response to send back to the client (wrapped by a task). |
UpdateTagTemplateField(UpdateTagTemplateFieldRequest, ServerCallContext)
public virtual Task<TagTemplateField> UpdateTagTemplateField(UpdateTagTemplateFieldRequest request, ServerCallContext context)
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 for
more information).
Parameters | |
---|---|
Name | Description |
request | UpdateTagTemplateFieldRequest The request received from the client. |
context | ServerCallContext The context of the server-side call handler being invoked. |
Returns | |
---|---|
Type | Description |
Task<TagTemplateField> | The response to send back to the client (wrapped by a task). |