public sealed class DataCatalogClientImpl : DataCatalogClientReference documentation and code samples for the Data Catalog v1 API class DataCatalogClientImpl.
DataCatalog client wrapper implementation, for convenient use.
Namespace
Google.Cloud.DataCatalog.V1Assembly
Google.Cloud.DataCatalog.V1.dll
Remarks
Data Catalog API service allows you to discover, understand, and manage your data.
Constructors
DataCatalogClientImpl(DataCatalog.DataCatalogClient, DataCatalogSettings, ILogger)
public DataCatalogClientImpl(DataCatalog.DataCatalogClient grpcClient, DataCatalogSettings settings, ILogger logger)Constructs a client wrapper for the DataCatalog service, with the specified gRPC client and settings.
| Name | Description |
| grpcClient | DataCatalog.DataCatalogClientThe underlying gRPC client. |
| settings | DataCatalogSettingsThe base DataCatalogSettings used within this client. |
| logger | ILoggerOptional ILogger to use within this client. |
Properties
GrpcClient
public override DataCatalog.DataCatalogClient GrpcClient { get; }The underlying gRPC DataCatalog client
| Type | Description |
| DataCatalog.DataCatalogClient |
IAMPolicyClient
public override IAMPolicyClient IAMPolicyClient { get; }The IAMPolicyClient associated with this client.
| Type | Description |
| IAMPolicyClient |
Methods
CreateEntry(CreateEntryRequest, CallSettings)
public override Entry CreateEntry(CreateEntryRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateEntryRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Entry | The RPC response. |
CreateEntryAsync(CreateEntryRequest, CallSettings)
public override Task<Entry> CreateEntryAsync(CreateEntryRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateEntryRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task<Entry> | A Task containing the RPC response. |
CreateEntryGroup(CreateEntryGroupRequest, CallSettings)
public override EntryGroup CreateEntryGroup(CreateEntryGroupRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateEntryGroupRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| EntryGroup | The RPC response. |
CreateEntryGroupAsync(CreateEntryGroupRequest, CallSettings)
public override Task<EntryGroup> CreateEntryGroupAsync(CreateEntryGroupRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateEntryGroupRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task<EntryGroup> | A Task containing the RPC response. |
CreateTag(CreateTagRequest, CallSettings)
public override Tag CreateTag(CreateTagRequest request, CallSettings callSettings = null)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
and the tag template
used to create the tag must be in the same organization.
| Name | Description |
| request | CreateTagRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Tag | The RPC response. |
CreateTagAsync(CreateTagRequest, CallSettings)
public override Task<Tag> CreateTagAsync(CreateTagRequest request, CallSettings callSettings = null)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
and the tag template
used to create the tag must be in the same organization.
| Name | Description |
| request | CreateTagRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task<Tag> | A Task containing the RPC response. |
CreateTagTemplate(CreateTagTemplateRequest, CallSettings)
public override TagTemplate CreateTagTemplate(CreateTagTemplateRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateTagTemplateRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| TagTemplate | The RPC response. |
CreateTagTemplateAsync(CreateTagTemplateRequest, CallSettings)
public override Task<TagTemplate> CreateTagTemplateAsync(CreateTagTemplateRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateTagTemplateRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task<TagTemplate> | A Task containing the RPC response. |
CreateTagTemplateField(CreateTagTemplateFieldRequest, CallSettings)
public override TagTemplateField CreateTagTemplateField(CreateTagTemplateFieldRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateTagTemplateFieldRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| TagTemplateField | The RPC response. |
CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest, CallSettings)
public override Task<TagTemplateField> CreateTagTemplateFieldAsync(CreateTagTemplateFieldRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | CreateTagTemplateFieldRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task<TagTemplateField> | A Task containing the RPC response. |
DeleteEntry(DeleteEntryRequest, CallSettings)
public override void DeleteEntry(DeleteEntryRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | DeleteEntryRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteEntryAsync(DeleteEntryRequest, CallSettings)
public override Task DeleteEntryAsync(DeleteEntryRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | DeleteEntryRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task | A Task containing the RPC response. |
DeleteEntryGroup(DeleteEntryGroupRequest, CallSettings)
public override void DeleteEntryGroup(DeleteEntryGroupRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | DeleteEntryGroupRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteEntryGroupAsync(DeleteEntryGroupRequest, CallSettings)
public override Task DeleteEntryGroupAsync(DeleteEntryGroupRequest request, CallSettings callSettings = null)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.
| Name | Description |
| request | DeleteEntryGroupRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Type | Description |
| Task | A Task containing the RPC response. |
DeleteTag(DeleteTagRequest, CallSettings)
public override void DeleteTag(DeleteTagRequest request, CallSettings callSettings = null)Deletes a tag.
| Name | Description |
| request | DeleteTagRequestThe request object containing all of the parameters for the API call. |
| callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteTagAsync(DeleteTagRequest, CallSettings)
public override Task DeleteTagAsync(DeleteTagRequest request, CallSettings callSettings = null)Deletes a tag.
| Name | Description |
| request | DeleteTagRequestThe request object containing all of the parameters for the API call. |
| callSettings | |